VLab Common 1.2

pl.psnc.vlab.util.gui.action
Interface ActionDecorator

All Known Implementing Classes:
AbstractActionDefault, LocalizedAbstractAction, LocalizedObservableAbstractAction

public interface ActionDecorator

ActionDecorator Interface. Defines a set of methods which can be called to decorate AbstractAction

Author:
Dominik Stoklosa (~osa~)
Email address
osa@man.poznan.pl

Field Summary
static java.lang.String DISABLED_ICON
          Holds key of disabledIcon property
static java.lang.String PARENT_OBJECT
          The parent object of this action
 
Method Summary
 void addSource(java.awt.Component component)
          Add source component of this action - the component associated with this action.
 javax.swing.ImageIcon getDisabledActionIcon()
          Get disabled icon for this ActionDecorator
 java.lang.String getName()
          Get action name
 java.lang.String getShortDescription()
          Get short description for this ActionDecorator
 java.util.List<java.awt.Component> getSources()
          Get source components which were associated with this action
 void setAcceleratorKey(java.lang.String accelerator)
          Set Accelerator key.
 void setDisabledActionIcon(javax.swing.ImageIcon icon)
          Set disabled icon for this ActionDecorator
 void setMnemonic(char mnemonic)
          Set Mnemonic key.
 void setName(java.lang.String name)
          Set action name
 void setShortDescription(java.lang.String description)
          Set short description for this ActionDecorator
 

Field Detail

PARENT_OBJECT

static final java.lang.String PARENT_OBJECT
The parent object of this action

See Also:
Constant Field Values

DISABLED_ICON

static final java.lang.String DISABLED_ICON
Holds key of disabledIcon property

See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Get action name

Returns:
action name

setName

void setName(java.lang.String name)
Set action name


setShortDescription

void setShortDescription(java.lang.String description)
Set short description for this ActionDecorator

Parameters:
description - short description

getShortDescription

java.lang.String getShortDescription()
Get short description for this ActionDecorator

Returns:
short description for this ActionDecorator

setDisabledActionIcon

void setDisabledActionIcon(javax.swing.ImageIcon icon)
Set disabled icon for this ActionDecorator

Parameters:
icon - disabled action

getDisabledActionIcon

javax.swing.ImageIcon getDisabledActionIcon()
Get disabled icon for this ActionDecorator

Returns:
disabled icon for this ActionDecorator

setMnemonic

void setMnemonic(char mnemonic)
Set Mnemonic key. The key used for storing an int key code to be used as the mnemonic for the action.

Parameters:
mnemonic - mnemonic

setAcceleratorKey

void setAcceleratorKey(java.lang.String accelerator)
Set Accelerator key. The key used for storing a KeyStroke to be used as the accelerator for the action.

Parameters:
accelerator - accelerator

addSource

void addSource(java.awt.Component component)
Add source component of this action - the component associated with this action.


getSources

java.util.List<java.awt.Component> getSources()
Get source components which were associated with this action

Returns:
source components which were associated with this action. Instance of Component

VLab Common 1.2

Copyright 2004 by VLAB Dominik Stoklosa.