ilog.views.gantt.action

Class IlvScrollToTimeIndicatorAction

java.lang.Object

javax.swing.AbstractAction

ilog.views.gantt.action.IlvAction

ilog.views.gantt.action.IlvScrollToTimeIndicatorAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public class IlvScrollToTimeIndicatorAction
extends IlvAction

The IlvScrollToTimeIndicatorAction class implements an action that will scroll to a specific IlvTimeIndicator for the specified IlvGanttSheet. The action keeps the same displayed duration but changes the time interval so that the IlvTimeIndicator is in the center.

Since:

JViews 8.1

See Also:

Serialized Form

Field Summary

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
IlvScrollToTimeIndicatorAction(IlvGanttSheet ganttSheet, IlvTimeIndicator timeIndicator, String name, Icon icon, KeyStroke accelerator, String shortDescription, String longDescription) Creates an IlvScrollToTimeIndicatorAction for the specified IlvGanttSheet object.
IlvScrollToTimeIndicatorAction(IlvGanttSheet ganttSheet, IlvTimeIndicator timeIndicator, String name, KeyStroke accelerator, String shortDescription, String longDescription) Creates an IlvScrollToTimeIndicatorAction for the specified IlvGanttSheet object with a default icon.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Performs the scroll to IlvTimeIndicator action on the IlvGanttSheet object.
IlvTimeIndicator	getTimeIndicator() Returns the target time indicator.
void	setTimeIndicator(IlvTimeIndicator timeIndicator) Sets the target time indicator.

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

IlvScrollToTimeIndicatorAction

public IlvScrollToTimeIndicatorAction(IlvGanttSheet ganttSheet,
                                      IlvTimeIndicator timeIndicator,
                                      String name,
                                      KeyStroke accelerator,
                                      String shortDescription,
                                      String longDescription)

Creates an IlvScrollToTimeIndicatorAction for the specified IlvGanttSheet object with a default icon.

Parameters:

ganttSheet - The Gantt sheet on which the action works.

timeIndicator - The time indicator to scroll to.

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.

IlvScrollToTimeIndicatorAction

public IlvScrollToTimeIndicatorAction(IlvGanttSheet ganttSheet,
                                      IlvTimeIndicator timeIndicator,
                                      String name,
                                      Icon icon,
                                      KeyStroke accelerator,
                                      String shortDescription,
                                      String longDescription)

Creates an IlvScrollToTimeIndicatorAction for the specified IlvGanttSheet object.

Parameters:

ganttSheet - The Gantt sheet on which the action works.

timeIndicator - The time indicator to scroll to.

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.

Method Detail

getTimeIndicator

public IlvTimeIndicator getTimeIndicator()

Returns the target time indicator.

Returns:

The target time indicator.

See Also:

setTimeIndicator(ilog.views.gantt.graphic.IlvTimeIndicator)

setTimeIndicator

public void setTimeIndicator(IlvTimeIndicator timeIndicator)

Sets the target time indicator.

Parameters:

timeIndicator - The target time indicator.

See Also:

getTimeIndicator()

actionPerformed

public void actionPerformed(ActionEvent e)

Performs the scroll to IlvTimeIndicator action on the IlvGanttSheet object.

Parameters:

e - The ActionEvent.