ilog.views.accelerator

Class IlvRotateSelectionAccelerator

java.lang.Object

ilog.views.IlvAccelerator

ilog.views.accelerator.IlvRotateSelectionAccelerator

All Implemented Interfaces:

Serializable

public class IlvRotateSelectionAccelerator
extends IlvAccelerator

IlvRotateSelectionAccelerator is an accelerator that allows the user to rotate the currently selected objects.

Example

The following code example shows how to use IlvRotateSelectionAccelerator 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
  // rotate the objects using the rotate accelerator.
  IlvSelectInteractor inter = new IlvSelectInteractor();
  inter.setOpaqueMove(true);
  mgrview.setInteractor(inter);

  // Install the rotate accelerator.
  manager.addAccelerator(
      new IlvRotateSelectionAccelerator(KeyEvent.KEY_PRESSED,
                                        KeyEvent.VK_R,
                                        InputEvent.CTRL_MASK, true));
 

About Interactors and Accelerators

All input events are handled by means of interactors or accelerators. Accelerators, such as IlvRotateSelectionAccelerator, 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
IlvRotateSelectionAccelerator(int type, int keyCode, char keyChar, int modifiers, boolean consumeEvents) Creates an IlvRotateSelectionAccelerator.
IlvRotateSelectionAccelerator(int type, int keyCode, int modifiers) Creates an IlvRotateSelectionAccelerator.
IlvRotateSelectionAccelerator(int type, int keyCode, int modifiers, boolean consumeEvents) Creates an IlvRotateSelectionAccelerator.

Method Summary

Modifier and Type	Method and Description
protected boolean	allowsRotation(IlvGraphic obj) Checks if the rotation of the specified object is allowed.
double	getRotationAngle() Returns the rotation angle in degrees.
protected boolean	handleEvent(IlvManagerView v) Processes the event.
void	setRotationAngle(double degree) Sets the rotation angle in degrees.

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

IlvRotateSelectionAccelerator

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

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

IlvRotateSelectionAccelerator

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

Creates an IlvRotateSelectionAccelerator.

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.

IlvRotateSelectionAccelerator

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

Creates an IlvRotateSelectionAccelerator.

Parameters:

type - The type of the AWT event.

keyCode - The code associated with the key.

modifiers - The modifiers of the key.

Method Detail

setRotationAngle

public void setRotationAngle(double degree)

Sets the rotation angle in degrees. A positive value rotates clockwise, a negative value rotates counterclockwise.

Parameters:

degree - The number of degrees to rotate the graphic object.

getRotationAngle

public double getRotationAngle()

Returns the rotation angle in degrees.

allowsRotation

protected boolean allowsRotation(IlvGraphic obj)

Checks if the rotation of the specified object is allowed.

Parameters:

obj - The object about to be tested.

Returns:

Whether the passed graphic object can be rotated by this accelerator.

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 sucessful.