de.uni_paderborn.fujaba.mpEdit
Interface MpAction

All Superinterfaces:
java.awt.event.ActionListener, java.util.EventListener
All Known Implementing Classes:
AbstractMpAction

interface MpAction
extends java.awt.event.ActionListener

MpEDIT own swing-like action implementation Can be later changed to swing one, or extended for free-builder

Version:
$Revision: 1.11 $ $Date: 2004/10/20 17:50:01 $
Author:
Artur Biesiadowski
See Also:
AbstractMpAction

Field Summary
static java.lang.String ENABLED
          Identifier passed to PropertyChangeListeners when enabled flag has changed
static java.lang.String ID_STRING
          mpEDIT addition: provide emacs-like action identifier
static java.lang.String LONG_DESCRIPTION
          Verbose description for help, or advanced info
static java.lang.String NAME
          Text to be displayed on text button or in menu
static java.lang.String SHORT_DESCRIPTION
          Short description to be displayed in tooltips etc
static java.lang.String SMALL_ICON
          Key string for returning small (16x16) icon to be displayd on button
static java.lang.String SMALL_ICON_DISABLED
          mpEDIT additon: Small Icon in disabled state
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Add object to be notified of change in any of the values (mainly enabled state)
 java.lang.String getIdString()
           
 java.lang.String getName()
          Get the name attribute of the MpAction object
 java.lang.String getShortDescription()
          Get the shortDescription attribute of the MpAction object
 java.lang.String getText(java.lang.String key)
          Returns text for action for specific key
 boolean isEnabled()
          Is action enabled for its component
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Add object to be notified of change in any of action's values
 void setEnabled(boolean b)
          Enable/disable action for given component
 void setName(java.lang.String txt)
          Sets the name attribute of the MpAction object
 void setShortDescription(java.lang.String txt)
          Sets the shortDescription attribute of the MpAction object
 void setText(java.lang.String key, java.lang.String text)
          Sets text for action for specific key
 
Methods inherited from interface java.awt.event.ActionListener
actionPerformed
 

Field Detail

NAME

public static final java.lang.String NAME
Text to be displayed on text button or in menu

See Also:
Constant Field Values

LONG_DESCRIPTION

public static final java.lang.String LONG_DESCRIPTION
Verbose description for help, or advanced info

See Also:
Constant Field Values

SHORT_DESCRIPTION

public static final java.lang.String SHORT_DESCRIPTION
Short description to be displayed in tooltips etc

See Also:
Constant Field Values

SMALL_ICON

public static final java.lang.String SMALL_ICON
Key string for returning small (16x16) icon to be displayd on button

See Also:
Constant Field Values

SMALL_ICON_DISABLED

public static final java.lang.String SMALL_ICON_DISABLED
mpEDIT additon: Small Icon in disabled state

See Also:
Constant Field Values

ID_STRING

public static final java.lang.String ID_STRING
mpEDIT addition: provide emacs-like action identifier

See Also:
Constant Field Values

ENABLED

public static final java.lang.String ENABLED
Identifier passed to PropertyChangeListeners when enabled flag has changed

See Also:
Constant Field Values
Method Detail

getText

public java.lang.String getText(java.lang.String key)
Returns text for action for specific key

Parameters:
key - No description provided
Returns:
The text value

setText

public void setText(java.lang.String key,
                    java.lang.String text)
Sets text for action for specific key

Parameters:
key - The new text value
text - The new text value

getIdString

public java.lang.String getIdString()
Returns:
emacs-like name identifier for action

getShortDescription

public java.lang.String getShortDescription()
Get the shortDescription attribute of the MpAction object

Returns:
The shortDescription value

setShortDescription

public void setShortDescription(java.lang.String txt)
Sets the shortDescription attribute of the MpAction object

Parameters:
txt - The new shortDescription value

getName

public java.lang.String getName()
Get the name attribute of the MpAction object

Returns:
The name value

setName

public void setName(java.lang.String txt)
Sets the name attribute of the MpAction object

Parameters:
txt - The new name value

isEnabled

public boolean isEnabled()
Is action enabled for its component

Returns:
The enabled value

setEnabled

public void setEnabled(boolean b)
Enable/disable action for given component

Parameters:
b - The new enabled value

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add object to be notified of change in any of the values (mainly enabled state)

Parameters:
listener - The object added.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Add object to be notified of change in any of action's values

Parameters:
listener - No description provided