ilog.views.accelerator

Class IlvZoomInAccelerator

java.lang.Object

ilog.views.IlvAccelerator

ilog.views.accelerator.IlvZoomInAccelerator

All Implemented Interfaces:

Serializable

public class IlvZoomInAccelerator
extends IlvAccelerator

IlvZoomInAccelerator is used to allow the user to zoom into the manager.

Example

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

  // Install the scroll down accelerator
  manager.addAccelerator(
      new IlvZoomInAccelerator(KeyEvent.KEY_PRESSED,
                               KeyEvent.VK_UNDEFINED,
                               '+', 0, true));
 

About Interactors and Accelerators

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

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
double	getZoomFactor() Returns the zoom factor.
protected boolean	handleEvent(IlvManagerView v) Processes the event.
void	setZoomFactor(double zoomFactor) Changes the zoom factor.

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

IlvZoomInAccelerator

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

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

Since:

JViews 8.8

IlvZoomInAccelerator

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

Creates an IlvZoomInAccelerator.

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.

Since:

JViews 8.5

IlvZoomInAccelerator

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

Creates an IlvZoomInAccelerator.

Parameters:

type - The type of the AWT event.

keyCode - The code associated with the key.

modifiers - The modifiers of the key.

Method Detail

getZoomFactor

public double getZoomFactor()

Returns the zoom factor. The default value is 2.

setZoomFactor

public void setZoomFactor(double zoomFactor)

Changes the zoom factor.

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.