ilog.views.gantt.action

Class IlvTimeScrollAction

java.lang.Object

javax.swing.AbstractAction

ilog.views.gantt.action.IlvAction

ilog.views.gantt.action.IlvTimeScrollAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action, SwingConstants

public class IlvTimeScrollAction
extends IlvAction
implements SwingConstants

The IlvTimeScrollAction class implements an action that will scroll an IlvTimeScrollable right or left. Typically, the scrollable will be an IlvHierarchyChart. When an IlvTimeScrollAction is created, it registers an internal, private event listener with the IlvTimeScrollable so that the action can automatically enable and disable itself appropriately. If, at a later time, you want to remove the IlvTimeScrollAction from the user interface and have it garbage-collected, you will need to explicitly call the removeFromTimeScrollable() method.

Since:

JViews 3.5

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

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
IlvTimeScrollAction(IlvTimeScrollable timeScrollable, int direction, String name, Icon icon, KeyStroke accelerator, String shortDescription, String longDescription) Creates an IlvTimeScrollAction for the specified IlvTimeScrollable object.
IlvTimeScrollAction(IlvTimeScrollable timeScrollable, int direction, String name, KeyStroke accelerator, String shortDescription, String longDescription) Creates an IlvTimeScrollAction for the specified IlvTimeScrollable object with a default icon.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent event) Performs the time scroll action on the IlvTimeScrollable object.
int	getDirection() Returns the action's scroll direction.
double	getScrollFactor() Returns the scroll factor as a fraction of the time scrollable's visible duration.
void	removeFromTimeScrollable() Removes this action as a registered observer of its IlvTimeScrollable object.
void	setScrollFactor(double scrollFactor) Sets the scroll factor as a fraction of the time scrollable's visible duration.

Methods inherited from class ilog.views.gantt.action.IlvAction

getAccelerator, getAcceleratorText, getIcon, getLongDescription, getMnemonic, getName, getShortDescription, setAccelerator, setIcon, setIcon, setLongDescription, setMnemonic, setName, setShortDescription

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

Constructor Detail

IlvTimeScrollAction

public IlvTimeScrollAction(IlvTimeScrollable timeScrollable,
                           int direction,
                           String name,
                           KeyStroke accelerator,
                           String shortDescription,
                           String longDescription)

Creates an IlvTimeScrollAction for the specified IlvTimeScrollable object with a default icon. Typically, the scrollable will be an IlvHierarchyChart. When an IlvTimeScrollAction is created, it registers an internal, private event listener with the IlvTimeScrollable so that the action can automatically enable and disable itself appropriately. If, at a later time, you want to remove the IlvTimeScrollAction from the user interface and have it garbage-collected, you will need to explicitly call the removeFromTimeScrollable() method.

Parameters:

timeScrollable - The time scrollable object that will be scrolled by the action.

direction - The scroll direction, which must be one of the constants: LEFT to scroll backwards in time or RIGHT to scroll forwards, as defined in SwingConstants.

name - The name of the action. If the action is added to a JMenu, the name will be used as the menu item text. If the action is added to a JToolBar, the name will be used as the button text.

accelerator - The action's optional keyboard accelerator.

shortDescription - The action's optional short description. This text, if not null, will be typically used for tooltips.

longDescription - The action's optional long description. This text, if not null, will be typically used for display in a status bar.

IlvTimeScrollAction

public IlvTimeScrollAction(IlvTimeScrollable timeScrollable,
                           int direction,
                           String name,
                           Icon icon,
                           KeyStroke accelerator,
                           String shortDescription,
                           String longDescription)

Creates an IlvTimeScrollAction for the specified IlvTimeScrollable object. Typically, this is will be an IlvHierarchyChart. When an IlvTimeScrollAction is created, it registers an internal, private event listener with the IlvTimeScrollable so that the action can automatically enable and disable itself appropriately. If, at a later time, you want to remove the IlvTimeScrollAction from the user interface and have it garbage-collected, you will need to explicitly call the removeFromTimeScrollable() method.

Parameters:

timeScrollable - The time scrollable object that will be scrolled by the action.

direction - The scroll direction, which must be one of the constants: LEFT to scroll backwards in time or RIGHT to scroll forwards, as defined in SwingConstants.

name - The name of the action. If the action is added to a JMenu, the name will be used as the menu item text. If the action is added to a JToolBar, the name will be used as the button text.

icon - The action's icon or null to use the default icon.

accelerator - The action's optional keyboard accelerator.

shortDescription - The action's optional short description. This text, if not null, will be typically used for tooltips.

longDescription - The action's optional long description. This text, if not null, will be typically used for display in a status bar.

Method Detail

getDirection

public int getDirection()

Returns the action's scroll direction. This will be one of the constants: LEFT if the action scrolls backwards in time or RIGHT if the action scrolls forward in time, defined in SwingConstants.

Returns:

The action's scroll direction.

getScrollFactor

public double getScrollFactor()

Returns the scroll factor as a fraction of the time scrollable's visible duration. The default value is 0.25.

Returns:

The scroll factor.

See Also:

setScrollFactor(double)

setScrollFactor

public void setScrollFactor(double scrollFactor)

Sets the scroll factor as a fraction of the time scrollable's visible duration.

Parameters:

scrollFactor - The scroll factor.

See Also:

getScrollFactor()

actionPerformed

public void actionPerformed(ActionEvent event)

Performs the time scroll action on the IlvTimeScrollable object.

Specified by:

actionPerformed in interface ActionListener

Parameters:

event - The ActionEvent.

removeFromTimeScrollable

public void removeFromTimeScrollable()

Removes this action as a registered observer of its IlvTimeScrollable object.