IlvCompiledSymbolRotationInteractor (Perforce JViews 10.0 API)

java.lang.Object
- javax.swing.AbstractAction
- - ilog.views.symbol.util.interactor.IlvCompiledSymbolInteractor
  - - ilog.views.symbol.util.interactor.IlvCompiledSymbolRangeInteractor
    - - ilog.views.symbol.util.interactor.IlvCompiledSymbolRotationInteractor

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action
```
public abstract class IlvCompiledSymbolRotationInteractor
extends IlvCompiledSymbolRangeInteractor
```
Base class for rotation interactors of compiled symbols. The use of this class is generated by the Symbol Compiler.

Since:

JViews 8.5

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BOTTOM_CENTER` The rotation center is on the center of the bottom side of the bounding box either of the base or of the rotating part.
`static String`	`BOTTOM_LEFT` The rotation center is on the bottom left corner of the bounding box either of the base or of the rotating part.
`static String`	`BOTTOM_RIGHT` The rotation center is on the bottom right corner of the bounding box either of the base or of the rotating part.
`static String`	`CENTER` The rotation center is the center of the bounding box either of the base or of the rotating part.
`static String`	`LEFT_CENTER` The rotation center is on the center of the left side of the bounding box either of the base or of the rotating part.
`static String`	`RIGHT_CENTER` The rotation center is on the center of the right side of the bounding box either of the base or of the rotating part.
`static String`	`TOP_CENTER` The rotation center is on the center of the top side of the bounding box either of the base or of the rotating part.
`static String`	`TOP_LEFT` The rotation center is on the top left corner of the bounding box either of the base or of the rotating part.
`static String`	`TOP_RIGHT` The rotation center is on the top right corner of the bounding box either of the base or of the rotating part.

Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled

Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors
Constructor and Description

IlvCompiledSymbolRotationInteractor()
Default constructor.

Constructors
Constructor and Description
`IlvCompiledSymbolRotationInteractor()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`actionPerformed(IlvCompositeActionEvent cae)` Computes the angle made by the mouse pointer and the start angle, relatively to the rotation center.
`double`	`getEndAngle()` Returns the end angle allowed for the rotation.
`String`	`getRotationCenter()` Returns the position of the rotation center.
`double`	`getStartAngle()` Returns the start angle.
`IlvMouseGesture[]`	`getSupportedMouseGestures()` Returns the mouse gesture supported by this interactor.
`boolean`	`isRotationCenterRelativeToBase()` Indicates whether the rotation center is relative to the base (the first child of the composite parent of the rotating part) or relative to the rotating part itself.
`void`	`setEndAngle(double endAngle)` Sets the ending angle allowed for the rotation.
`void`	`setRotationCenter(String rotationCenter)` Sets the position of the rotation center.
`void`	`setRotationCenterRelativeToBase(boolean centerRelativeToBase)` Indicates whether the rotation center is relative to the base (the first child of the composite parent of the rotating part) or relative to the rotating part itself.
`void`	`setStartAngle(double start)` Sets the start angle that corresponds to the minimum value.

Methods inherited from class ilog.views.symbol.util.interactor.IlvCompiledSymbolRangeInteractor
applySet, applyStep, getMaximum, getMinimum, getParameterValue, getStep, setMaximum, setMinimum, setParameterValue, setStep

Methods inherited from class ilog.views.symbol.util.interactor.IlvCompiledSymbolInteractor
actionPerformed, getEvent, getLogger, getParameterToModify, setParameterToModify

Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CENTER
```
public static final String CENTER
```
    The rotation center is the center of the bounding box either of the base or of the rotating part.
    
    See Also:
    
    Constant Field Values
  - TOP_CENTER
```
public static final String TOP_CENTER
```
    The rotation center is on the center of the top side of the bounding box either of the base or of the rotating part.
    
    See Also:
    
    Constant Field Values
  - BOTTOM_CENTER
```
public static final String BOTTOM_CENTER
```
    The rotation center is on the center of the bottom side of the bounding box either of the base or of the rotating part.
    
    See Also:
    
    Constant Field Values
  - LEFT_CENTER
```
public static final String LEFT_CENTER
```
    The rotation center is on the center of the left side of the bounding box either of the base or of the rotating part.
    
    See Also:
    
    Constant Field Values
  - RIGHT_CENTER
```
public static final String RIGHT_CENTER
```
    The rotation center is on the center of the right side of the bounding box either of the base or of the rotating part.
    
    See Also:
    
    Constant Field Values
  - TOP_LEFT
```
public static final String TOP_LEFT
```
    The rotation center is on the top left corner of the bounding box either of the base or of the rotating part.
    
    See Also:
    
    Constant Field Values
  - TOP_RIGHT
```
public static final String TOP_RIGHT
```
    The rotation center is on the top right corner of the bounding box either of the base or of the rotating part.
    
    See Also:
    
    Constant Field Values
  - BOTTOM_LEFT
```
public static final String BOTTOM_LEFT
```
    The rotation center is on the bottom left corner of the bounding box either of the base or of the rotating part.
    
    See Also:
    
    Constant Field Values
  - BOTTOM_RIGHT
```
public static final String BOTTOM_RIGHT
```
    The rotation center is on the bottom right corner of the bounding box either of the base or of the rotating part.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvCompiledSymbolRotationInteractor
```
public IlvCompiledSymbolRotationInteractor()
```
    Default constructor. Creates the interactor and sets the default value for start angle, end angle, minimum, and maximum value to 0.
- Method Detail
  - getSupportedMouseGestures
```
public IlvMouseGesture[] getSupportedMouseGestures()
```
    Returns the mouse gesture supported by this interactor. This interactor responds to mouse dragged event (button 1 pressed and mouse move).
    
    Returns:
    
    An array of mouse gestures containing IlvMouseGesture.MOUSE_DRAGGED
  - getEndAngle
```
public double getEndAngle()
```
    Returns the end angle allowed for the rotation.
  - setEndAngle
```
public void setEndAngle(double endAngle)
```
    Sets the ending angle allowed for the rotation. It is defined clockwise relatively to the trigonometric 0 and expressed in degrees
    
    Parameters:
    
    endAngle - The end angle in degrees.
  - getStartAngle
```
public double getStartAngle()
```
    Returns the start angle.
    
    See Also:
    
    setStartAngle(double start)
  - setStartAngle
```
public void setStartAngle(double start)
```
    Sets the start angle that corresponds to the minimum value. This angle is defined clockwise, relatively to the trigonometric 0 and expressed in degrees
    
    Parameters:
    
    start - The start angle in degrees.
  - actionPerformed
```
protected void actionPerformed(IlvCompositeActionEvent cae)
```
    Computes the angle made by the mouse pointer and the start angle, relatively to the rotation center. Then computes the value corresponding to this angle in the range [minimum, maximum].
    
    Specified by:
    
    actionPerformed in class IlvCompiledSymbolInteractor
    
    Parameters:
    
    cae - The composite action event.
    
    See Also:
    
    IlvCompiledSymbolInteractor.actionPerformed(IlvCompositeActionEvent)
  - isRotationCenterRelativeToBase
```
public boolean isRotationCenterRelativeToBase()
```
    Indicates whether the rotation center is relative to the base (the first child of the composite parent of the rotating part) or relative to the rotating part itself.
    
    Returns:
    
    true if the rotation center is relative to the base.
  - setRotationCenterRelativeToBase
```
public void setRotationCenterRelativeToBase(boolean centerRelativeToBase)
```
    Indicates whether the rotation center is relative to the base (the first child of the composite parent of the rotating part) or relative to the rotating part itself.
  - getRotationCenter
```
public String getRotationCenter()
```
    Returns the position of the rotation center.
    
    Returns:
    
    One of following values: CENTER : center of the bounding box TOP_CENTER: center of the top side of the bounding box BOTTOM_CENTER: center of the bottom side LEFT_CENTER: center of the left side RIGHT_CENTER: center of the right side TOP_LEFT: on the top left corner TOP_RIGHT: on the top right corner BOTTOM_LEFT: on the bottom left corner BOTTOM_RIGHT: on the bottom right corner
  - setRotationCenter
```
public void setRotationCenter(String rotationCenter)
```
    Sets the position of the rotation center. This position is relative to the bounds of the base or to the bounds of the rotating part of the symbol.
    
    Parameters:
    
    rotationCenter - It can be one of the following values:
    CENTER: center of the bounding box TOP_CENTER: center of the top side of the bounding box BOTTOM_CENTER: center of the bottom side LEFT_CENTER: center of the left side RIGHT_CENTER: center of the right side TOP_LEFT: on the top left corner TOP_RIGHT: on the top right corner BOTTOM_LEFT: on the bottom left corner BOTTOM_RIGHT: on the bottom right corner

Class IlvCompiledSymbolRotationInteractor

Field Summary

Fields inherited from class javax.swing.AbstractAction

Fields inherited from interface javax.swing.Action

Constructor Summary

Method Summary

Methods inherited from class ilog.views.symbol.util.interactor.IlvCompiledSymbolRangeInteractor

Methods inherited from class ilog.views.symbol.util.interactor.IlvCompiledSymbolInteractor

Methods inherited from class javax.swing.AbstractAction

Methods inherited from class java.lang.Object

Field Detail

CENTER

TOP_CENTER

BOTTOM_CENTER

LEFT_CENTER

RIGHT_CENTER

TOP_LEFT

TOP_RIGHT

BOTTOM_LEFT

BOTTOM_RIGHT

Constructor Detail

IlvCompiledSymbolRotationInteractor

Method Detail

getSupportedMouseGestures

getEndAngle

setEndAngle

getStartAngle

setStartAngle

actionPerformed

isRotationCenterRelativeToBase

setRotationCenterRelativeToBase

getRotationCenter

setRotationCenter