ilog.views.accelerator

Class IlvPopupMenuAccelerator

java.lang.Object

ilog.views.IlvAccelerator

ilog.views.accelerator.IlvPopupMenuAccelerator

All Implemented Interfaces:

Serializable

public class IlvPopupMenuAccelerator
extends IlvAccelerator

IlvPopupMenuAccelerator is an accelerator that allows the user to trigger a pop-up menu for the currently selected object using the keyboard. If several objects are selected, the pop-up menu is triggered only on the first selected object. If no object is selected, the pop-up menu is triggered on the manager of the view. This accelerator does not trigger pop-up menus on arbitrary Swing components, but only on graphic objects.

Example

The following code example shows how to use IlvPopupMenuAccelerator in a simple Java application:

  // Install the select interactor on the view.
  // Use this interactor to select graphic objects with the mouse. You can then
  // trigger the pop-up menu using the pop-up menu accelerator.
  IlvSelectInteractor inter = new IlvSelectInteractor();
  inter.setOpaqueMove(true);
  mgrview.setInteractor(inter);

  // Install the pop-up menu accelerator.
  manager.addAccelerator(
      new IlvPopupMenuAccelerator(KeyEvent.KEY_PRESSED,
                                  KeyEvent.VK_F1,
                                  0, true));
 

About Interactors and Accelerators

All input events are handled by means of interactors or accelerators. Accelerators, such as IlvPopupMenuAccelerator, 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:

• accelerator example
• global view interactor example
• local object interactor example

Since:

JViews 8.8

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvPopupMenuAccelerator(int type, int keyCode, char keyChar, int modifiers, boolean consumeEvents) Creates an IlvPopupMenuAccelerator.
IlvPopupMenuAccelerator(int type, int keyCode, int modifiers) Creates an IlvPopupMenuAccelerator.
IlvPopupMenuAccelerator(int type, int keyCode, int modifiers, boolean consumeEvents) Creates an IlvPopupMenuAccelerator.

Method Summary

Modifier and Type	Method and Description
protected boolean	allowPopup(IlvGraphic obj) Returns whether a pop-up menu is allowed for the graphic object.
protected boolean	handleEvent(IlvManagerView v) Processes the event.

Methods inherited from class ilog.views.IlvAccelerator

CtrlChar, getEventType, getKeyChar, getKeyCode, getModifier, isConsumeEvents, setConsumeEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvPopupMenuAccelerator

public IlvPopupMenuAccelerator(int type,
                               int keyCode,
                               char keyChar,
                               int modifiers,
                               boolean consumeEvents)

Creates an IlvPopupMenuAccelerator. 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.

Parameters:

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.

IlvPopupMenuAccelerator

public IlvPopupMenuAccelerator(int type,
                               int keyCode,
                               int modifiers,
                               boolean consumeEvents)

Creates an IlvPopupMenuAccelerator.

Parameters:

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.

IlvPopupMenuAccelerator

public IlvPopupMenuAccelerator(int type,
                               int keyCode,
                               int modifiers)

Creates an IlvPopupMenuAccelerator.

Parameters:

type - The type of the AWT event.

keyCode - The code associated with the key.

modifiers - The modifiers of the key.

Method Detail

allowPopup

protected boolean allowPopup(IlvGraphic obj)

Returns whether a pop-up menu is allowed for the graphic object. The default implementation always returns true.

Parameters:

obj - The graphic object.

handleEvent

protected boolean handleEvent(IlvManagerView v)

Processes the event.

Specified by:

handleEvent in class IlvAccelerator

Parameters:

v - The manager view.

Returns:

Whether the processing was successful.