ilog.views.chart.action

Class IlvChartAction

java.lang.Object

javax.swing.AbstractAction

ilog.views.chart.action.IlvChartAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

IlvChartFitAction, IlvChartZoomAction

public abstract class IlvChartAction
extends AbstractAction

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

Since:

JViews 5.0

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

Method Summary

Modifier and Type	Method and Description
protected void	attach() Called when the action has been attached to a new chart.
protected void	computeEnabled() Called to refresh the enabled property when a change occurs on the axis or when a new chart has been set.
protected void	detach() Called when the action is about to be detached from its associated chart.
KeyStroke	getAccelerator() Returns the key combination that will invoke the action.
String	getAcceleratorText() Returns the text representation of this action accelerator.
IlvChart	getChart() Returns the chart on which the action will be performed.
IlvCoordinateSystem	getCoordinateSystem() Returns the IlvCoordinateSystem owning the associated y-axis or null if no chart has been attached.
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.
String	getShortDescription() Returns the short description text that will typically be used for tooltips, or null if the action has no short description.
IlvAxis	getXAxis() Returns the x-axis of the attached chart or null if no chart has been attached.
IlvAxis	getYAxis() Returns the associated y-axis or null if no chart has been attached.
int	getYAxisIndex() Returns the index of the associated y-axis.
void	setAccelerator(KeyStroke keyStroke) Sets the key combination that will invoke the action.
void	setChart(IlvChart chart) Sets the chart on which the action will be performed.
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	setShortDescription(String text) Sets the short description text that will typically be used for tooltips.
void	setYAxisIndex(int index) Sets the index of the associated y-axis.

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

IlvChartAction

public IlvChartAction(String name)

Creates an IlvChartAction 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.

IlvChartAction

public IlvChartAction(String name,
                      Icon icon)

Creates an IlvChartAction 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 optional icon.

IlvChartAction

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

Creates an IlvChartAction 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 optional icon.

accelerator - The action optional keyboard accelerator.

IlvChartAction

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

Creates an IlvChartAction object with the specified name, icon, 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 optional icon.

accelerator - The action optional keyboard accelerator.

shortDescription - The action optional short description. If not null, this text will be typically used for tooltips.

longDescription - The action optional long description. If not null, this text will be typically used for display in a status bar.

Method Detail

getChart

public final IlvChart getChart()

Returns the chart on which the action will be performed.

setChart

public void setChart(IlvChart chart)

Sets the chart on which the action will be performed. If the action has already been attached to a chart, its detach() method is called before setting the new chart. Then, if the parameter is not null, the attach() method is called.

See Also:

detach(), attach()

detach

protected void detach()

Called when the action is about to be detached from its associated chart.

attach

protected void attach()

Called when the action has been attached to a new chart.

computeEnabled

protected void computeEnabled()

Called to refresh the enabled property when a change occurs on the axis or when a new chart has been set. The default implementation enables the action unless no chart has been attached yet. You may override this method to take into account your criteria.

See Also:

setChart(ilog.views.chart.IlvChart)

getYAxisIndex

public int getYAxisIndex()

Returns the index of the associated y-axis.

setYAxisIndex

public void setYAxisIndex(int index)

Sets the index of the associated y-axis.

getCoordinateSystem

public final IlvCoordinateSystem getCoordinateSystem()

Returns the IlvCoordinateSystem owning the associated y-axis or null if no chart has been attached.

getYAxis

public final IlvAxis getYAxis()

Returns the associated y-axis or null if no chart has been attached.

getXAxis

public final IlvAxis getXAxis()

Returns the x-axis of the attached chart or null if no chart has been attached.

getIcon

public Icon getIcon()

Returns the icon that represents this action visually, or null if the action has no 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.

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.

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.

getAcceleratorText

public String getAcceleratorText()

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

setAccelerator

public void setAccelerator(KeyStroke keyStroke)

Sets the key combination that will invoke the action.

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.

setShortDescription

public void setShortDescription(String text)

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

Parameters:

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

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.

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 long description or null if the action has no long description.