icy.action

Class IcyAbstractAction

java.lang.Object

javax.swing.AbstractAction

icy.action.IcyAbstractAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

Direct Known Subclasses:

CanvasActions.ToggleLayersAction, IcyAbstractAction, SequenceOperationActions.ExtractChannelAction, SequenceOperationActions.MergeDimensionAction, SequenceOperationActions.RemoveChannelAction, SequenceOperationActions.ToggleVirtualSequenceAction

public abstract class IcyAbstractAction
extends javax.swing.AbstractAction

Icy basic AbstractAction class.

Author:

Stephane

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENABLED_KEY The "enabled" property key.

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
IcyAbstractAction(java.lang.String name)
IcyAbstractAction(java.lang.String name, IcyIcon icon)
IcyAbstractAction(java.lang.String name, IcyIcon icon, java.lang.String description)
IcyAbstractAction(java.lang.String name, IcyIcon icon, java.lang.String description, boolean bgProcess, java.lang.String processMessage)
IcyAbstractAction(java.lang.String name, IcyIcon icon, java.lang.String description, int keyCode)
IcyAbstractAction(java.lang.String name, IcyIcon icon, java.lang.String description, int keyCode, int modifiers)
IcyAbstractAction(java.lang.String name, IcyIcon icon, java.lang.String description, java.lang.String longDescription)
IcyAbstractAction(java.lang.String name, IcyIcon icon, java.lang.String description, java.lang.String longDescription, boolean bgProcess, java.lang.String processMessage)
IcyAbstractAction(java.lang.String name, IcyIcon icon, java.lang.String description, java.lang.String longDescription, int keyCode, int modifiers)
IcyAbstractAction(java.lang.String name, IcyIcon icon, java.lang.String description, java.lang.String longDescription, int keyCode, int modifiers, boolean bgProcess, java.lang.String processMessage)
IcyAbstractAction(java.lang.String name, java.lang.String iconName) Deprecated. Use IcyAbstractAction(String, IcyIcon) instead.
IcyAbstractAction(java.lang.String name, java.lang.String iconName, java.lang.String description) Deprecated. Use IcyAbstractAction(String, IcyIcon, String) instead.
IcyAbstractAction(java.lang.String name, java.lang.String iconName, java.lang.String description, int keyCode) Deprecated. Use IcyAbstractAction(String, IcyIcon, String, int) instead.
IcyAbstractAction(java.lang.String name, java.lang.String iconName, java.lang.String description, int keyCode, int modifiers) Deprecated. Use IcyAbstractAction(String, IcyIcon, String, int, int) instead.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
boolean	doAction() Deprecated. Use executeNow() instead
void	enabledChanged() Helper method to fire enabled changed event (this force component refresh)
void	execute() Execute action (delayed execution if action requires it)
boolean	executeNow() Execute action now (wait for execution to complete)
java.lang.String	getDescription()
IcyIcon	getIcon()
javax.swing.KeyStroke	getKeyStroke() Returns the KeyStroke for this action (can be null).
javax.swing.JLabel	getLabelComponent() Returns a JLabel component representing the action.
javax.swing.JLabel	getLabelComponent(boolean wantIcon, boolean wantText) Returns a JLabel component representing the action.
java.lang.String	getLongDescription()
java.lang.String	getName()
java.lang.String	getProcessMessage()
org.pushingpixels.flamingo.api.common.RichTooltip	getRichToolTip()
boolean	isBgProcess()
boolean	isEnabled()
boolean	isProcessing()
boolean	isSelected() Returns the selected state (for toggle button type).
void	setAccelerator(int keyCode)
void	setAccelerator(int keyCode, int modifiers)
void	setBgProcess(boolean bgProcess) Set to true if you want to action to be processed in a background thread.
void	setDescription(java.lang.String value)
void	setEnabled(boolean value)
void	setIcon(IcyIcon value)
void	setLongDescription(java.lang.String value)
void	setName(java.lang.String value)
void	setProcessMessage(java.lang.String processMessage) Set the process message to display for background action process.
void	setSelected(boolean value) Sets the selected state (for toggle button type).
static void	setToolTipTextFromAction(javax.swing.JComponent c, javax.swing.Action a) Sets the tooltip text of a component from an Action.

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, getKeys, getPropertyChangeListeners, getValue, putValue, removePropertyChangeListener

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENABLED_KEY

public static final java.lang.String ENABLED_KEY

The "enabled" property key.

See Also:

Constant Field Values

Constructor Detail

IcyAbstractAction

public IcyAbstractAction(java.lang.String name,
                 IcyIcon icon,
                 java.lang.String description,
                 java.lang.String longDescription,
                 int keyCode,
                 int modifiers,
                 boolean bgProcess,
                 java.lang.String processMessage)

IcyAbstractAction

public IcyAbstractAction(java.lang.String name,
                 IcyIcon icon,
                 java.lang.String description,
                 java.lang.String longDescription,
                 int keyCode,
                 int modifiers)

IcyAbstractAction

public IcyAbstractAction(java.lang.String name,
                 IcyIcon icon,
                 java.lang.String description,
                 java.lang.String longDescription,
                 boolean bgProcess,
                 java.lang.String processMessage)

IcyAbstractAction

public IcyAbstractAction(java.lang.String name,
                 IcyIcon icon,
                 java.lang.String description,
                 boolean bgProcess,
                 java.lang.String processMessage)

IcyAbstractAction

public IcyAbstractAction(java.lang.String name,
                 IcyIcon icon,
                 java.lang.String description,
                 int keyCode,
                 int modifiers)

IcyAbstractAction

public IcyAbstractAction(java.lang.String name,
                 IcyIcon icon,
                 java.lang.String description,
                 int keyCode)

IcyAbstractAction

public IcyAbstractAction(java.lang.String name,
                 IcyIcon icon,
                 java.lang.String description,
                 java.lang.String longDescription)

IcyAbstractAction

public IcyAbstractAction(java.lang.String name,
                 IcyIcon icon,
                 java.lang.String description)

IcyAbstractAction

public IcyAbstractAction(java.lang.String name,
                 IcyIcon icon)

IcyAbstractAction

public IcyAbstractAction(java.lang.String name)

IcyAbstractAction

@Deprecated
public IcyAbstractAction(java.lang.String name,
                            java.lang.String iconName,
                            java.lang.String description,
                            int keyCode,
                            int modifiers)

Deprecated. Use IcyAbstractAction(String, IcyIcon, String, int, int) instead.

IcyAbstractAction

@Deprecated
public IcyAbstractAction(java.lang.String name,
                            java.lang.String iconName,
                            java.lang.String description,
                            int keyCode)

Deprecated. Use IcyAbstractAction(String, IcyIcon, String, int) instead.

IcyAbstractAction

@Deprecated
public IcyAbstractAction(java.lang.String name,
                            java.lang.String iconName,
                            java.lang.String description)

Deprecated. Use IcyAbstractAction(String, IcyIcon, String) instead.

IcyAbstractAction

@Deprecated
public IcyAbstractAction(java.lang.String name,
                            java.lang.String iconName)

Deprecated. Use IcyAbstractAction(String, IcyIcon) instead.

Method Detail

setToolTipTextFromAction

public static void setToolTipTextFromAction(javax.swing.JComponent c,
                            javax.swing.Action a)

Sets the tooltip text of a component from an Action.

Parameters:

c - the Component to set the tooltip text on

a - the Action to set the tooltip text from, may be null

isBgProcess

public boolean isBgProcess()

Returns:

true if this action process is done in a background thread.

setBgProcess

public void setBgProcess(boolean bgProcess)

Set to true if you want to action to be processed in a background thread.

See Also:

isBgProcess(), setProcessMessage(String)

getProcessMessage

public java.lang.String getProcessMessage()

Returns:

the process message to display for background action process.

See Also:

setProcessMessage(String), isBgProcess()

getRichToolTip

public org.pushingpixels.flamingo.api.common.RichTooltip getRichToolTip()

setProcessMessage

public void setProcessMessage(java.lang.String processMessage)

Set the process message to display for background action process.
If set to null then no message is displayed (default).

See Also:

setBgProcess(boolean)

setName

public void setName(java.lang.String value)

getName

public java.lang.String getName()

setIcon

public void setIcon(IcyIcon value)

getIcon

public IcyIcon getIcon()

setDescription

public void setDescription(java.lang.String value)

getDescription

public java.lang.String getDescription()

setLongDescription

public void setLongDescription(java.lang.String value)

getLongDescription

public java.lang.String getLongDescription()

setAccelerator

public void setAccelerator(int keyCode,
                  int modifiers)

setAccelerator

public void setAccelerator(int keyCode)

isSelected

public boolean isSelected()

Returns the selected state (for toggle button type).

setSelected

public void setSelected(boolean value)

Sets the selected state (for toggle button type).

getKeyStroke

public javax.swing.KeyStroke getKeyStroke()

Returns the KeyStroke for this action (can be null).

isProcessing

public boolean isProcessing()

Returns:

true if action is currently processing.
Meaningful only when setBgProcess(boolean) is set to true)

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface javax.swing.Action

Overrides:

isEnabled in class javax.swing.AbstractAction

setEnabled

public void setEnabled(boolean value)

Specified by:

setEnabled in interface javax.swing.Action

Overrides:

setEnabled in class javax.swing.AbstractAction

enabledChanged

public void enabledChanged()

Helper method to fire enabled changed event (this force component refresh)

getLabelComponent

public javax.swing.JLabel getLabelComponent(boolean wantIcon,
                                   boolean wantText)

Returns a JLabel component representing the action.

getLabelComponent

public javax.swing.JLabel getLabelComponent()

Returns a JLabel component representing the action.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

execute

public void execute()

Execute action (delayed execution if action requires it)

doAction

@Deprecated
public boolean doAction()

Deprecated. Use executeNow() instead

executeNow

public boolean executeNow()

Execute action now (wait for execution to complete)