ilog.views.gantt.action

Class IlvVerticalScrollAction

java.lang.Object

javax.swing.AbstractAction

ilog.views.gantt.action.IlvAction

ilog.views.gantt.action.IlvVerticalScrollAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action, SwingConstants

public class IlvVerticalScrollAction
extends IlvAction
implements SwingConstants

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

Since:

JViews 3.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	PIXEL_SCROLL The scrolling mode that indicates that vertical scrolling will occur by the scrollFactor amount.
static int	ROW_SCROLL The scrolling mode that indicates that vertical scrolling will occur by rows.

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

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent event) Performs the vertical scroll action on the IlvVerticalScrollable object.
int	getDirection() Returns the action's scroll direction.
double	getScrollFactor() Returns the scroll factor used in PIXEL_SCROLL scrolling mode, expressed as a fraction of the scrollable's vertical extent.
int	getScrollMode() Returns the vertical scrolling mode.
void	removeFromVerticalScrollable() Removes this action as a registered observer of its IlvVerticalScrollable object.
void	setScrollFactor(double scrollFactor) Sets the scroll factor used in PIXEL_SCROLL scrolling mode, expressed as a fraction of the scrollable's vertical extent.
void	setScrollMode(int mode) Sets the vertical scrolling mode.

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

Field Detail

PIXEL_SCROLL

public static final int PIXEL_SCROLL

The scrolling mode that indicates that vertical scrolling will occur by the scrollFactor amount. This is the default scrolling mode for IlvVerticalScrollable objects other than an IlvHierarchyChart.

Since:

JViews 7.5

See Also:

getScrollMode(), ROW_SCROLL, Constant Field Values

ROW_SCROLL

public static final int ROW_SCROLL

The scrolling mode that indicates that vertical scrolling will occur by rows. This scrolling mode is the default, and is only supported, for IlvHierarchyChart objects. This mode is not valid for other types of IlvVerticalScrollable objects.

Since:

JViews 7.5

See Also:

getScrollMode(), PIXEL_SCROLL, Constant Field Values

Constructor Detail

IlvVerticalScrollAction

public IlvVerticalScrollAction(IlvVerticalScrollable verticalScrollable,
                               int direction,
                               String name,
                               KeyStroke accelerator,
                               String shortDescription,
                               String longDescription)

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

Parameters:

verticalScrollable - The object that will be scrolled by the action.

direction - The scroll direction, which must be one of the constants: TOP to scroll up or BOTTOM to scroll down, 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.

IlvVerticalScrollAction

public IlvVerticalScrollAction(IlvVerticalScrollable verticalScrollable,
                               int direction,
                               String name,
                               Icon icon,
                               KeyStroke accelerator,
                               String shortDescription,
                               String longDescription)

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

Parameters:

verticalScrollable - The object that will be scrolled by the action.

direction - The scroll direction, which must be one of the constants: TOP to scroll up or BOTTOM to scroll down, 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: TOP if the action scrolls up or BOTTOM if the action scrolls down, as defined in SwingConstants.

Returns:

The action's scroll direction.

getScrollMode

public int getScrollMode()

Returns the vertical scrolling mode. The value ROW_SCROLL is the default for IlvHierarchyChart objects. It indicates that vertical scrolling will occur by rows. The value PIXEL_SCROLL is the default for other types of IlvVerticalScrollable objects, which indicates that vertical scrolling will occur by the scrollFactor amount.

Returns:

The scrolling mode.

Since:

JViews 7.5

See Also:

setScrollMode(int)

setScrollMode

public void setScrollMode(int mode)

Sets the vertical scrolling mode. The value of PIXEL_SCROLL indicates that vertical scrolling will occur by the scrollFactor amount. The value ROW_SCROLL is only supported for IlvHierarchyChart objects and indicates that vertical scrolling will occur by rows.

Parameters:

mode - The scrolling mode that must be either PIXEL_SCROLL or ROW_SCROLL.

Since:

JViews 7.5

See Also:

getScrollMode()

getScrollFactor

public double getScrollFactor()

Returns the scroll factor used in PIXEL_SCROLL scrolling mode, expressed as a fraction of the scrollable's vertical extent. The default value is 0.2.

Returns:

The scroll factor.

See Also:

setScrollFactor(double)

setScrollFactor

public void setScrollFactor(double scrollFactor)

Sets the scroll factor used in PIXEL_SCROLL scrolling mode, expressed as a fraction of the scrollable's vertical extent.

Parameters:

scrollFactor - The scroll factor.

See Also:

getScrollFactor()

actionPerformed

public void actionPerformed(ActionEvent event)

Performs the vertical scroll action on the IlvVerticalScrollable object.

Specified by:

actionPerformed in interface ActionListener

Parameters:

event - The event.

removeFromVerticalScrollable

public void removeFromVerticalScrollable()

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