ilog.views.gantt.action

Class IlvAction

java.lang.Object

javax.swing.AbstractAction

ilog.views.gantt.action.IlvAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

IlvScrollToTimeIndicatorAction, IlvTimeScrollAction, IlvVerticalScrollAction, IlvZoomInAction, IlvZoomOutAction, IlvZoomToFitAction

public abstract class IlvAction
extends AbstractAction

The IlvAction class is the abstract superclass of all menu, toolbar, and registered keyboard actions in the Gantt module. The standard Swing AbstractAction class encapsulates an action with a name and an optional icon. The IlvAction class extends this by additionally encapsulating the action with a keyboard accelerator and long and short description strings.

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.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
IlvAction(String name) Creates an IlvAction object with the specified name.
IlvAction(String name, Icon icon) Creates an IlvAction object with the specified name and the specified icon.
IlvAction(String name, Icon icon, KeyStroke accelerator) Creates an IlvAction object with the specified name, icon, and keystroke accelerator.
IlvAction(String name, Icon icon, KeyStroke accelerator, String shortDescription, String longDescription) Creates an IlvAction object with the specified name, icon, and description strings.

Method Summary

Modifier and Type	Method and Description
KeyStroke	getAccelerator() Returns the key combination that will invoke the action.
String	getAcceleratorText() Returns the text representation of this action's accelerator.
Icon	getIcon() Returns the icon that represents this action visually, or null if the action has no icon.
String	getLongDescription() Returns the long description text that will typically be used for display in the status bar, or null if the action has no long description.
int	getMnemonic() Returns the keyboard mnemonic for the action.
String	getName() Returns the name of the action.
String	getShortDescription() Returns the short description text that will typically be used for tooltips, or null if the action has no short description.
void	setAccelerator(KeyStroke keyStroke) Sets the key combination that will invoke the action.
void	setIcon(Class baseClass, String file) Sets the icon that will be used to represent this action visually.
void	setIcon(Icon icon) Sets the icon that will be used to represent this action visually.
void	setLongDescription(String text) Sets the long description text that will typically be used for display in the status bar.
void	setMnemonic(int mnemonic) Sets the keyboard mnemonic for the action.
void	setName(String name) Sets the name of the action.
void	setShortDescription(String text) Sets the short description text that will typically be used for tooltips.

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

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Constructor Detail

IlvAction

public IlvAction(String name)

Creates an IlvAction object with the specified name.

Parameters:

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.

IlvAction

public IlvAction(String name,
                 Icon icon)

Creates an IlvAction object with the specified name and the specified icon.

Parameters:

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 optional icon.

IlvAction

public IlvAction(String name,
                 Icon icon,
                 KeyStroke accelerator)

Creates an IlvAction object with the specified name, icon, and keystroke accelerator.

Parameters:

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 optional icon.

accelerator - The action's optional keyboard accelerator.

IlvAction

public IlvAction(String name,
                 Icon icon,
                 KeyStroke accelerator,
                 String shortDescription,
                 String longDescription)

Creates an IlvAction object with the specified name, icon, and description strings.

Parameters:

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 optional 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

getName

public String getName()

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

Returns:

name The name of the action.

Since:

JViews 5.0

See Also:

setName(java.lang.String)

setName

public void setName(String name)

Sets the name of the action.

Parameters:

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.

Since:

JViews 5.0

See Also:

getName()

getIcon

public Icon getIcon()

Returns the icon that represents this action visually, or null if the action has no icon.

See Also:

setIcon(Icon)

setIcon

public void setIcon(Icon icon)

Sets the icon that will be used to represent this action visually.

Parameters:

icon - The action icon or null if the action has no icon.

See Also:

getIcon()

setIcon

public void setIcon(Class baseClass,
                    String file)

Sets the icon that will be used to represent this action visually.

Parameters:

baseClass - The Class object on which the method getResourceAsStream is called to read the icon image file.

file - The location of the file that contains the icon image to be read. The location must be specified relative to the location of the baseClass class.

See Also:

getIcon()

getAccelerator

public KeyStroke getAccelerator()

Returns the key combination that will invoke the action.

Returns:

The keystroke that will invoke this action or null if the action has no accelerator.

See Also:

setAccelerator(javax.swing.KeyStroke)

getAcceleratorText

public String getAcceleratorText()

Returns the text representation of this action's accelerator. If this action has no accelerator, this method returns null.

See Also:

getAccelerator()

setAccelerator

public void setAccelerator(KeyStroke keyStroke)

Sets the key combination that will invoke the action.

See Also:

getAccelerator()

getMnemonic

public int getMnemonic()

Returns the keyboard mnemonic for the action. The mnemonic will be one of the VK_XXX key codes defined in java.awt.event.KeyEvent, or zero if the action has no mnemonic. If the action is set on a button or a menu item, the mnemonic character will be underlined in the action name used as the button text.

Returns:

The key code that represents the mnemonic, or zero if the action has no mnemonic.

Since:

JViews 5.5

See Also:

setMnemonic(int)

setMnemonic

public void setMnemonic(int mnemonic)

Sets the keyboard mnemonic for the action. The mnemonic must be one of the VK_XXX key codes defined in java.awt.event.KeyEvent, or zero if the action should have no mnemonic. If the action is set on a button or a menu item, the mnemonic character will be underlined in the action name used as the button text.

Parameters:

mnemonic - The key code that represents the mnemonic, or zero for no mnemonic.

Since:

JViews 5.5

See Also:

getMnemonic()

getShortDescription

public String getShortDescription()

Returns the short description text that will typically be used for tooltips, or null if the action has no short description.

See Also:

setShortDescription(java.lang.String)

setShortDescription

public void setShortDescription(String text)

Sets the short description text that will typically be used for tooltips.

Parameters:

text - The action's short description or null if the action has no short description.

See Also:

getShortDescription()

getLongDescription

public String getLongDescription()

Returns the long description text that will typically be used for display in the status bar, or null if the action has no long description.

See Also:

setLongDescription(java.lang.String)

setLongDescription

public void setLongDescription(String text)

Sets the long description text that will typically be used for display in the status bar.

Parameters:

text - The action's long description or null if the action has no long description.

See Also:

getLongDescription()