com.portal.bas

Class PBASToggleAction

java.lang.Object

javax.swing.AbstractAction

com.portal.bas.PBASAction

com.portal.bas.PBASToggleAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

PToggleAcctNavAction, PToggleShowAcctAction, PToggleShowToolsAction, PToggleToolTipAction

public abstract class PBASToggleAction
extends PBASAction

PBASToggleAction is a base for PBASAction actions that toggle, for example, checkboxes, which add state information to PBASAction and must be rendered differently.

Version:

%version: 9 % %date_modified: Wed Apr 11 10:54:12 2001 %

Author:

larrylf

See Also:

Serialized Form

Field Summary

Fields inherited from class com.portal.bas.PBASAction

ACCEL, ICON_DISABLED, ICON_DISABLED_SELECTED, ICON_PRESSED, ICON_ROLLOVER, ICON_ROLLOVER_SELECTED, ICON_SELECTED, MNEM, TOOL_TITLE, TOOLBAR_LABEL

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
PBASToggleAction(PClientComponent comp, String tag) Creates a new Action from a supplied component and resource tag.
PBASToggleAction(PClientComponent comp, String tag, String helpID) Creates a new Action from a supplied component, resource tag, and help ID.
PBASToggleAction(String tag) Creates a new Action from a supplied component and resource tag.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent evt) Default actionPerformed method that tracks state changes.
boolean	getState() Gets the state of the control created or to be created by this action.
void	setState(boolean state) Sets the state of the control created or to be created by this action.

Methods inherited from class com.portal.bas.PBASAction

equals, getComponent, getHelpID, getPreferredMenu, getTag, handleError, setActionHelpOn, setPreferredMenu

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PBASToggleAction

public PBASToggleAction(String tag)

Creates a new Action from a supplied component and resource tag.

Parameters:

comp - the component this action will act upon

tag - the resource tag used to look up info from.

The icon is expected at: <component resource base>.tag.icon

The name is expected at: <component resource base>.tag.name

The description is expected at: <component resource base>.tag.desc

PBASToggleAction

public PBASToggleAction(PClientComponent comp,
                        String tag)

Creates a new Action from a supplied component and resource tag.

Parameters:

comp - the target component of this action

tag - the resource tag used to look up information.

The icon is expected at: <component resource base>.tag.icon

The name is expected at: <component resource base>.tag.name

The description is expected at: <component resource base>.tag.desc

PBASToggleAction

public PBASToggleAction(PClientComponent comp,
                        String tag,
                        String helpID)

Creates a new Action from a supplied component, resource tag, and help ID.

Parameters:

comp - the target component of this action

tag - the resource tag used to look up information.

The icon is expected at: <component resource base>.tag.icon

The name is expected at: <component resource base>.tag.name

The description is expected at: <component resource base>.tag.desc

helpID - The help ID for this action.

Method Detail

setState

public void setState(boolean state)

Sets the state of the control created or to be created by this action.

Parameters:

state - the button's state

getState

public boolean getState()

Gets the state of the control created or to be created by this action.

Returns:

The button's state.

actionPerformed

public void actionPerformed(ActionEvent evt)

Default actionPerformed method that tracks state changes. Subclasses that override this method need to call super.actionPerformed().

Parameters:

evt - the action event