public class IlvExpandSelectionAccelerator extends IlvAccelerator
IlvExpandSelectionAccelerator
is an accelerator that allows
the user to expand or collapse the currently selected subgraph or
link bundle. It works with any selected object that is a subclass of
IlvObjectWithSelection
.
If the selected object is currently expanded, it collapses the object.
If the selected object is currently collapsed, it expands the object.
The following code example shows how to use
IlvExpandSelectionAccelerator
in a simple Java application:
// Install the select interactor on the view. // Use this interactor to select graphic objects with the mouse. The selected // graphic objects can then be expanded or collapsed using the expand accelerator. IlvSelectInteractor inter = new IlvSelectInteractor(); inter.setOpaqueMove(true); mgrview.setInteractor(inter); // Install the expand accelerator. manager.addAccelerator( new IlvExpandSelectionAccelerator(KeyEvent.KEY_PRESSED, KeyEvent.VK_UNDEFINED, 'e', 0, true));
All input events are handled by means of interactors or accelerators. Accelerators,
such as IlvExpandSelectionAccelerator
, are subclasses of IlvAccelerator
.
Each accelerator listens for a specific key event in the manager. For information on handling
events in a manager, see
Handling Events.
The following code examples show how to handle user events:
Constructor and Description |
---|
IlvExpandSelectionAccelerator(int type,
int keyCode,
char keyChar,
int modifiers,
boolean consumeEvents)
Creates an
IlvExpandSelectionAccelerator . |
IlvExpandSelectionAccelerator(int type,
int keyCode,
int modifiers)
Creates an
IlvExpandSelectionAccelerator . |
IlvExpandSelectionAccelerator(int type,
int keyCode,
int modifiers,
boolean consumeEvents)
Creates an
IlvExpandSelectionAccelerator . |
Modifier and Type | Method and Description |
---|---|
protected boolean |
allowsExpand(IlvGraphic obj)
Checks if expanding/collapsing of the specified object is allowed.
|
protected boolean |
handleEvent(IlvManagerView v)
Processes the event.
|
CtrlChar, getEventType, getKeyChar, getKeyCode, getModifier, isConsumeEvents, setConsumeEvents
public IlvExpandSelectionAccelerator(int type, int keyCode, char keyChar, int modifiers, boolean consumeEvents)
IlvExpandSelectionAccelerator
.
You can specify the associated key either by a key code or by a key
character. Key codes are useful for function keys while
key characters are more useful for regular characters
'a'...'z','A'...'Z','0'...'9','+','-', etc.
which, depending on the keyboard layout may produce different key codes.
For instance, on a US keyboard, the character '+' has the same key code
as the character '=', while on a German keyboard, the character '+' has
the same key code as the character '*', hence specifying the '+'
character by key code instead of key character might be not suitable.
To indicate that only the key code should be checked, pass
KeyEvent.CHAR_UNDEFINED
as key character.
To indicate that only the key character should be checked, pass
KeyEvent.VK_UNDEFINED
as key code.type
- The type of the AWT event.keyCode
- The code associated with the key,
or KeyEvent.VK_UNDEFINED
.keyChar
- The character associated with the key,
or KeyEvent.CHAR_UNDEFINED
.modifiers
- The modifiers of the key.consumeEvents
- If true
, the accelerator handles and
consumes the event, except when the consume flag of the event
is already set to true
. If false
, the
accelerator ignores the event's consume flag, and handles all
events without changing the consume flag.public IlvExpandSelectionAccelerator(int type, int keyCode, int modifiers, boolean consumeEvents)
IlvExpandSelectionAccelerator
.type
- The type of the AWT event.keyCode
- The code associated with the key.modifiers
- The modifiers of the key.consumeEvents
- If true
, the accelerator handles and consumes
the event, except when the consume flag of the event is already set to
true
. If false
, the accelerator ignores the
event's consume flag, and handles all events without changing the
consume flag.public IlvExpandSelectionAccelerator(int type, int keyCode, int modifiers)
IlvExpandSelectionAccelerator
.type
- The type of the AWT event.keyCode
- The code associated with the key.modifiers
- The modifiers of the key.protected boolean allowsExpand(IlvGraphic obj)
obj
- The object to be tested.protected boolean handleEvent(IlvManagerView v)
handleEvent
in class IlvAccelerator
v
- The manager view.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.