org.millstone.base.event
Class Action

java.lang.Object
  |
  +--org.millstone.base.event.Action

public class Action

extends java.lang.Object

Implements the MillStone action framework. This class contains subinterfaces for action handling and listing, and for action handler registrations and unregistration.

Since:

3.0

Version:

3.0.3

Author:

IT Mill Ltd.

Nested Class Summary

static interface	Action.Container Interface implemented by all components where actions can be registered.
static interface	Action.Handler Interface implemented by classes who wish to handle actions.

Constructor Summary

Action(java.lang.String caption)
Constructs a new action with the given caption.

Action(java.lang.String caption, Resource icon)
Constructs a new action with the given caption string and icon.

Method Summary

java.lang.String	getCaption() Returns the action's caption.
Resource	getIcon() Returns the action's icon.
void	setCaption(java.lang.String caption) Sets the caption.
void	setIcon(Resource icon) Sets the icon.

Methods inherited from class java.lang.Object

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

Constructor Detail

Action

public Action(java.lang.String caption)

Constructs a new action with the given caption.

Parameters:

caption - caption for the new action.

Action

public Action(java.lang.String caption,
              Resource icon)

Constructs a new action with the given caption string and icon.

Parameters:

caption - caption for the new action.

icon - icon for the new action

Method Detail

getCaption

public java.lang.String getCaption()

Returns the action's caption.

Returns:

the action's caption as a String

getIcon

public Resource getIcon()

Returns the action's icon.

Returns:

Icon

setCaption

public void setCaption(java.lang.String caption)

Sets the caption.

Parameters:

caption - The caption to set

setIcon

public void setIcon(Resource icon)

Sets the icon.

Parameters:

icon - The icon to set