org.xngr
Interface Action


public interface Action

The representation of an action in the system. An action stores the parameters used to execute the service. Actions can be provided by the service provider but other tools should also be able to provide actions for different services. Action implementations should extend this class and implement the relevant methods for this class.

Version:
$Revision: 43 $, $Date: 2009-03-19 21:42:46 +0000 (Thu, 19 Mar 2009) $
Author:
Edwin Dankert

Method Summary
 java.util.Map<java.lang.String,java.lang.String> getArguments()
           
 java.lang.String getDescription()
          The description is normally used to provide more information for the action or the nature of the action, this information is generally not readily available but will appear after a user-action, like moving the mouse over a representation of the document, for instance as a tool-tip
 javax.swing.Icon getIcon()
          The icon is used to visually identify the action.
 java.lang.String getIdentifier()
           
 java.lang.String getName()
          The name is normally used to identify the action.
 java.util.Map<java.lang.String,java.lang.Object> getProperties()
          Specify properties to associate the action with application specific functionality.
 Service getService()
           
 

Method Detail

getIdentifier

java.lang.String getIdentifier()
Returns:
a unique identifier for the action.

getIcon

javax.swing.Icon getIcon()
The icon is used to visually identify the action.

Returns:
the icon for the action.

getName

java.lang.String getName()
The name is normally used to identify the action.

Returns:
a name for the action.

getDescription

java.lang.String getDescription()
The description is normally used to provide more information for the action or the nature of the action, this information is generally not readily available but will appear after a user-action, like moving the mouse over a representation of the document, for instance as a tool-tip

Returns:
the description for the action.

getService

Service getService()
Returns:
the service this action is supposed to invoke.

getArguments

java.util.Map<java.lang.String,java.lang.String> getArguments()
Returns:
the arguments to invoke the service with.

getProperties

java.util.Map<java.lang.String,java.lang.Object> getProperties()
Specify properties to associate the action with application specific functionality. For instance an application could provide a property to place the action at a certain place in a menu, or to provide key-shortcuts, etc.

Returns:
the properties to associate the action with application specific functionality.


Copyright © 2002-2009 Edwin Dankert. All Rights Reserved.