ActionInfo (org.gvsig.andami 2.0.462 API)

All Superinterfaces:

javax.swing.Action, java.awt.event.ActionListener, java.lang.Cloneable, java.util.EventListener

All Known Implementing Classes:

DefaultActionInfo, TranslatedActionInfo
```
public interface ActionInfo
extends javax.swing.Action, java.awt.event.ActionListener, org.gvsig.tools.lang.Cloneable
```
Esta entidad representa a una accion dentro de gvSIG, que podra ser usada por menus, botones de la toolbar, menus contextuales, o desde cualquier otro elemento de gvSIG que precise invocar a una accion. La accion esta compuesta por una definicion de cual es su etiqueta, su icono, teclas aceleradoras, su tip, o su posicion respecto a otras acciones, junto con una extension (IExtension) que aporta el codigo de la accion. Una accion responde principalmente a cuatro operaciones: - isActive, que nos indica si la accion esta activa, es decir, si debera presentarse al usuario o no. Si una extension no esta activa, los metodos isVisible y isEnabled retornaran siempre false, sin invocar al codigo de la extension asociada a la accion. - isVisible, que nos indica si la accion debera presentarse o no en el interface de usuario. De forma general podemos asumir que cuando se invoque a este metodo se delegara en el metodo isVisible de la extension asociada a la accion. - isEnabled, que nos indica si la accion debera estar habilitada o no en el interface de usuario. De forma general podemos asumir que cuando se invoque a este metodo se delegara en el metodo isEnabled de la extension asociada a la accion. - execute, que provocara que se ejecute el codigo asociado a la accion. De forma general podemos asumir que cuando se invoque a estos metodo se delegara en el metodo execute de la extension asociada a esta accion, pasandole el "command" de la accion como parametro. Ademas de la definicion de la accion, esta tambien puede disponer de una coleccion de acciones hacia las que puede ser redirigida. Esto es, en un momento dado nos puede interesar que cuando sea invocada la accion "A", en lugar de ejecutarse las operaciones de esta, se ejecuten las operaciones de otra accion "B". Esto nos permite atrapar la ejecucion de una accion independientemente de desde donde se este invocando. Cuando una accion tenga asignadas otras acciones a las que redirigir su ejecucion, solo se redigira a una de ellas, la primera en la coleccion de acciones a redirigir que responda "true" a su metodo isEnabled, y en caso de que no responda true ninguna se ejecutara el codigo de la accion original. El orden de la coleccion de acciones a las que redirigir de una accion sera el orden inverso en el que se han ido registrandose las redirecciones. Asi primero se intentara con la ultima redireccion asignada, luego con la anterior, y asi sucesivamente se recorreran todas las redireccion hasta que una responda "true" a su isEnabled, ejecutandose entonces el codigo de esta.

Author:

jjdelcerro

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACCELERATOR`
`static java.lang.String`	`ACTIVE`
`static java.lang.String`	`EXTENSION`
`static java.lang.String`	`EXTENSION_NAME`
`static java.lang.String`	`ICON_NAME`
`static java.lang.String`	`PLUGIN`
`static java.lang.String`	`PLUGIN_NAME`
`static java.lang.String`	`POSITION`
`static java.lang.String`	`REDIRECTION`
`static java.lang.String`	`REDIRECTIONS`
`static java.lang.String`	`TOOLTIP`
`static java.lang.String`	`VISIBLE`

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`execute()` Execute the code asociated to the action.
`void`	`execute(java.util.Map args)`
`void`	`execute(java.lang.Object arg)` Execute the code asociated to the action.
`void`	`execute(java.lang.Object[] args)` Execute the code asociated to the action.
`java.lang.String`	`getAccelerator()` returns a representation human readable of the accelerator to be used associated to the action.
`java.lang.String`	`getCommand()` Returns the command used for invoking the execute method of the extension asociated to this action.
`IExtension`	`getExtension()` returns the extension asociated to the action.
`java.lang.String`	`getExtensionName()` Returns the extension name of the extension asociated to this action.
`javax.swing.ImageIcon`	`getIcon()` Return an icon asociated to the action.
`java.lang.String`	`getIconName()` Returns the name of icon asociated to the action.
`javax.swing.KeyStroke`	`getKeyStroke()` returns the KeyStroke which represents the accelerator of this action.
`java.lang.String`	`getLabel()` Return a label asociated to the action.
`java.lang.String`	`getName()` Returns the name of the action.
`PluginServices`	`getPlugin()` returns the plugin of the extension asociated to the action.
`java.lang.String`	`getPluginName()` Return the plugin name of the plugin asociated to the action.
`long`	`getPosition()` Return the position absolute of the action referred to all actions.
`java.util.Collection<ActionInfo>`	`getRedirections()` An action can redirect the execution of the execute, isVisible and isEnabled methods to other action.
`java.lang.String`	`getTooltip()` Return a string that represents a tip asociated whit the action, usually used as tooltip in buttons or menus.
`boolean`	`isActive()` Return true is the action is active.
`boolean`	`isEnabled()` retrurn if the action is enables.
`boolean`	`isVisible()` retrurn if the action can be visible in the user interface or not.
`void`	`setActive(boolean active)` Set the active state of an ActionInfo.

Methods inherited from interface javax.swing.Action
addPropertyChangeListener, getValue, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener
actionPerformed

Methods inherited from interface org.gvsig.tools.lang.Cloneable
clone, cloneQuietly, cloneQuietly

- Field Detail
  - ACCELERATOR
```
static final java.lang.String ACCELERATOR
```
    See Also:
    
    Constant Field Values
  - ACTIVE
```
static final java.lang.String ACTIVE
```
    See Also:
    
    Constant Field Values
  - EXTENSION
```
static final java.lang.String EXTENSION
```
    See Also:
    
    Constant Field Values
  - EXTENSION_NAME
```
static final java.lang.String EXTENSION_NAME
```
    See Also:
    
    Constant Field Values
  - ICON_NAME
```
static final java.lang.String ICON_NAME
```
    See Also:
    
    Constant Field Values
  - PLUGIN
```
static final java.lang.String PLUGIN
```
    See Also:
    
    Constant Field Values
  - PLUGIN_NAME
```
static final java.lang.String PLUGIN_NAME
```
    See Also:
    
    Constant Field Values
  - POSITION
```
static final java.lang.String POSITION
```
    See Also:
    
    Constant Field Values
  - REDIRECTION
```
static final java.lang.String REDIRECTION
```
    See Also:
    
    Constant Field Values
  - REDIRECTIONS
```
static final java.lang.String REDIRECTIONS
```
    See Also:
    
    Constant Field Values
  - TOOLTIP
```
static final java.lang.String TOOLTIP
```
    See Also:
    
    Constant Field Values
  - VISIBLE
```
static final java.lang.String VISIBLE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - execute
```
void execute()
```
    Execute the code asociated to the action. This method call the execute method of the asociated exetnsion using the command of action as argument. If the action is redirected try to call to the redirected actions.
  - execute
```
void execute(java.util.Map args)
```
  - execute
```
void execute(java.lang.Object arg)
```
    Execute the code asociated to the action. Pass the args to the execute of the asociated extension.
    
    See Also:
    
    execute()
  - execute
```
void execute(java.lang.Object[] args)
```
    Execute the code asociated to the action. Pass the args to the execute of the asociated extension.
    
    See Also:
    
    execute()
  - getAccelerator
```
java.lang.String getAccelerator()
```
    returns a representation human readable of the accelerator to be used associated to the action.
    
    Returns:
    
    String representing the accelerator
  - getCommand
```
java.lang.String getCommand()
```
    Returns the command used for invoking the execute method of the extension asociated to this action.
    
    Returns:
    
    command of action
  - getExtension
```
IExtension getExtension()
```
    returns the extension asociated to the action. The action delegates the methods isEnabled, isVisible and execute in this extension when these are invoked.
    
    Returns:
    
    IExtension asociated to the action
  - getExtensionName
```
java.lang.String getExtensionName()
```
    Returns the extension name of the extension asociated to this action. This a utility method that check null values. Is equivalent to: action.getExtension().getClass().getName()
    
    Returns:
    
    extension name.
    
    See Also:
    
    getExtension()
  - getIcon
```
javax.swing.ImageIcon getIcon()
```
    Return an icon asociated to the action. This icon can be used in buttons, o menus.
    
    Returns:
    
    ImageIcon asociated tho the action
  - getIconName
```
java.lang.String getIconName()
```
    Returns the name of icon asociated to the action. This name is used to retrive the icon from the current icon theme of the application.
    
    Returns:
    
    icon name.
  - getKeyStroke
```
javax.swing.KeyStroke getKeyStroke()
```
    returns the KeyStroke which represents the accelerator of this action.
    
    Returns:
    
    keystroke asociated to this action
    
    See Also:
    
    getAccelerator()
  - getLabel
```
java.lang.String getLabel()
```
    Return a label asociated to the action. This label can be used in buttons, o menus.
    
    Returns:
    
    label of action
  - getName
```
java.lang.String getName()
```
    Returns the name of the action. This name is usaed to retrieve the action thwros the manager.
    
    Returns:
    
    action name
  - getPlugin
```
PluginServices getPlugin()
```
    returns the plugin of the extension asociated to the action.
    
    Returns:
    
    pluginServices asiciated to the action.
  - getPluginName
```
java.lang.String getPluginName()
```
    Return the plugin name of the plugin asociated to the action. This is a utility method checkins null values. is equivalent to: action.getPlugin().getPluginName()
    
    Returns:
    
    plugin name
    
    See Also:
    
    getPlugin()
  - getPosition
```
long getPosition()
```
    Return the position absolute of the action referred to all actions.
    
    Returns:
    
    the position of the action
  - getRedirections
```
java.util.Collection<ActionInfo> getRedirections()
```
    An action can redirect the execution of the execute, isVisible and isEnabled methods to other action. Using this method is can be query and set this redirections. The redirect will be established only if the method isEnabled of target action returns true. Otherwise execute methods of initial action.
    
    Returns:
    
    the redirections established for this action
  - getTooltip
```
java.lang.String getTooltip()
```
    Return a string that represents a tip asociated whit the action, usually used as tooltip in buttons or menus.
    
    Returns:
    
    the tip of the action
  - isActive
```
boolean isActive()
```
    Return true is the action is active. When an action is active the methods isEnable and isVisible call the methods of the extension asociated to this. When is inactive always return false.
    
    Returns:
    
    if the action is active
  - isEnabled
```
boolean isEnabled()
```
    retrurn if the action is enables. This method call the isEnabled of the extension asociated to the action, unless the action is inactive. This method is used to determine whether it is possible to redirect to this action or not. If has a ExclusiveUIExtension set, then this is invoqued instead of the the isEnabled of the extension.
    
    Specified by:
    
    isEnabled in interface javax.swing.Action
    
    Returns:
    
    if the action if visible for the user.
  - isVisible
```
boolean isVisible()
```
    retrurn if the action can be visible in the user interface or not. This method call the isVisible of the extension asociated to the action, unless the action is inactive. If has a ExclusiveUIExtension set, then this is invoqued instead of the the isVisible of the extension.
    
    Returns:
    
    if the action if visible for the user.
  - setActive
```
void setActive(boolean active)
```
    Set the active state of an ActionInfo. When the active state is set to false, isEnabled, and isVisible returns false.
    
    Parameters:
    
    active -

Interface ActionInfo

Field Summary

Fields inherited from interface javax.swing.Action

Method Summary

Methods inherited from interface javax.swing.Action

Methods inherited from interface java.awt.event.ActionListener

Methods inherited from interface org.gvsig.tools.lang.Cloneable

Field Detail

ACCELERATOR

ACTIVE

EXTENSION

EXTENSION_NAME

ICON_NAME

PLUGIN

PLUGIN_NAME

POSITION

REDIRECTION

REDIRECTIONS

TOOLTIP

VISIBLE

Method Detail

execute

execute

execute

execute

getAccelerator

getCommand

getExtension

getExtensionName

getIcon

getIconName

getKeyStroke

getLabel

getName

getPlugin

getPluginName

getPosition

getRedirections

getTooltip

isActive

isEnabled

isVisible

setActive