DefaultActionInfo

java.lang.Object
- javax.swing.AbstractAction
- - org.gvsig.andami.actioninfo.impl.DefaultActionInfo

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, ActionInfo
```
public class DefaultActionInfo
extends javax.swing.AbstractAction
implements ActionInfo
```
See Also:

Serialized Form

Field Summary
- Fields inherited from class javax.swing.AbstractAction
  changeSupport, enabled
- Fields inherited from interface org.gvsig.andami.actioninfo.ActionInfo
  ACCELERATOR, ACTIVE, EXTENSION, EXTENSION_NAME, ICON_NAME, PLUGIN, PLUGIN_NAME, POSITION, REDIRECTION, REDIRECTIONS, TOOLTIP, 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 Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(java.awt.event.ActionEvent arg0)`
`java.lang.Object`	`clone()` Creates a copy of the object.
`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.
`java.lang.Object`	`getValue(java.lang.String key)`
`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`	`merge(ActionInfo other)`
`void`	`putValue(java.lang.String key, java.lang.Object newValue)`
`void`	`setActive(boolean active)` Set the active state of an ActionInfo.
`java.lang.String`	`toString()`

Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, firePropertyChange, getKeys, getPropertyChangeListeners, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

- Method Detail
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Description copied from interface: Cloneable
    
    Creates a copy of the object.
    
    Overrides:
    
    clone in class javax.swing.AbstractAction
    
    Returns:
    
    a copy of the object
    
    Throws:
    
    java.lang.CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.
    
    See Also:
    
    Object#clone()}.
  - getRedirections
```
public java.util.Collection<ActionInfo> getRedirections()
```
    Description copied from interface: ActionInfo
    
    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.
    
    Specified by:
    
    getRedirections in interface ActionInfo
    
    Returns:
    
    the redirections established for this action
  - merge
```
public void merge(ActionInfo other)
```
  - getPlugin
```
public PluginServices getPlugin()
```
    Description copied from interface: ActionInfo
    
    returns the plugin of the extension asociated to the action.
    
    Specified by:
    
    getPlugin in interface ActionInfo
    
    Returns:
    
    pluginServices asiciated to the action.
  - getPluginName
```
public java.lang.String getPluginName()
```
    Description copied from interface: ActionInfo
    
    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()
    
    Specified by:
    
    getPluginName in interface ActionInfo
    
    Returns:
    
    plugin name
    
    See Also:
    
    ActionInfo.getPlugin()
  - getExtension
```
public IExtension getExtension()
```
    Description copied from interface: ActionInfo
    
    returns the extension asociated to the action. The action delegates the methods isEnabled, isVisible and execute in this extension when these are invoked.
    
    Specified by:
    
    getExtension in interface ActionInfo
    
    Returns:
    
    IExtension asociated to the action
  - getExtensionName
```
public java.lang.String getExtensionName()
```
    Description copied from interface: ActionInfo
    
    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()
    
    Specified by:
    
    getExtensionName in interface ActionInfo
    
    Returns:
    
    extension name.
    
    See Also:
    
    ActionInfo.getExtension()
  - isVisible
```
public boolean isVisible()
```
    Description copied from interface: ActionInfo
    
    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.
    
    Specified by:
    
    isVisible in interface ActionInfo
    
    Returns:
    
    if the action if visible for the user.
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: ActionInfo
    
    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
    
    Specified by:
    
    isEnabled in interface ActionInfo
    
    Overrides:
    
    isEnabled in class javax.swing.AbstractAction
    
    Returns:
    
    if the action if visible for the user.
  - execute
```
public void execute()
```
    Description copied from interface: ActionInfo
    
    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.
    
    Specified by:
    
    execute in interface ActionInfo
  - execute
```
public void execute(java.lang.Object[] args)
```
    Description copied from interface: ActionInfo
    
    Execute the code asociated to the action. Pass the args to the execute of the asociated extension.
    
    Specified by:
    
    execute in interface ActionInfo
    
    See Also:
    
    ActionInfo.execute()
  - execute
```
public void execute(java.lang.Object arg)
```
    Description copied from interface: ActionInfo
    
    Execute the code asociated to the action. Pass the args to the execute of the asociated extension.
    
    Specified by:
    
    execute in interface ActionInfo
    
    See Also:
    
    ActionInfo.execute()
  - execute
```
public void execute(java.util.Map args)
```
    Specified by:
    
    execute in interface ActionInfo
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent arg0)
```
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: ActionInfo
    
    Returns the name of the action. This name is usaed to retrieve the action thwros the manager.
    
    Specified by:
    
    getName in interface ActionInfo
    
    Returns:
    
    action name
  - getLabel
```
public java.lang.String getLabel()
```
    Description copied from interface: ActionInfo
    
    Return a label asociated to the action. This label can be used in buttons, o menus.
    
    Specified by:
    
    getLabel in interface ActionInfo
    
    Returns:
    
    label of action
  - getCommand
```
public java.lang.String getCommand()
```
    Description copied from interface: ActionInfo
    
    Returns the command used for invoking the execute method of the extension asociated to this action.
    
    Specified by:
    
    getCommand in interface ActionInfo
    
    Returns:
    
    command of action
  - getIconName
```
public java.lang.String getIconName()
```
    Description copied from interface: ActionInfo
    
    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.
    
    Specified by:
    
    getIconName in interface ActionInfo
    
    Returns:
    
    icon name.
  - getIcon
```
public javax.swing.ImageIcon getIcon()
```
    Description copied from interface: ActionInfo
    
    Return an icon asociated to the action. This icon can be used in buttons, o menus.
    
    Specified by:
    
    getIcon in interface ActionInfo
    
    Returns:
    
    ImageIcon asociated tho the action
  - getAccelerator
```
public java.lang.String getAccelerator()
```
    Description copied from interface: ActionInfo
    
    returns a representation human readable of the accelerator to be used associated to the action.
    
    Specified by:
    
    getAccelerator in interface ActionInfo
    
    Returns:
    
    String representing the accelerator
  - getKeyStroke
```
public javax.swing.KeyStroke getKeyStroke()
```
    Description copied from interface: ActionInfo
    
    returns the KeyStroke which represents the accelerator of this action.
    
    Specified by:
    
    getKeyStroke in interface ActionInfo
    
    Returns:
    
    keystroke asociated to this action
    
    See Also:
    
    ActionInfo.getAccelerator()
  - getPosition
```
public long getPosition()
```
    Description copied from interface: ActionInfo
    
    Return the position absolute of the action referred to all actions.
    
    Specified by:
    
    getPosition in interface ActionInfo
    
    Returns:
    
    the position of the action
  - getTooltip
```
public java.lang.String getTooltip()
```
    Description copied from interface: ActionInfo
    
    Return a string that represents a tip asociated whit the action, usually used as tooltip in buttons or menus.
    
    Specified by:
    
    getTooltip in interface ActionInfo
    
    Returns:
    
    the tip of the action
  - getValue
```
public java.lang.Object getValue(java.lang.String key)
```
    Specified by:
    
    getValue in interface javax.swing.Action
    
    Overrides:
    
    getValue in class javax.swing.AbstractAction
  - putValue
```
public void putValue(java.lang.String key,
                     java.lang.Object newValue)
```
    Specified by:
    
    putValue in interface javax.swing.Action
    
    Overrides:
    
    putValue in class javax.swing.AbstractAction
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isActive
```
public boolean isActive()
```
    Description copied from interface: ActionInfo
    
    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.
    
    Specified by:
    
    isActive in interface ActionInfo
    
    Returns:
    
    if the action is active
  - setActive
```
public void setActive(boolean active)
```
    Description copied from interface: ActionInfo
    
    Set the active state of an ActionInfo. When the active state is set to false, isEnabled, and isVisible returns false.
    
    Specified by:
    
    setActive in interface ActionInfo

Class DefaultActionInfo

Field Summary

Fields inherited from class javax.swing.AbstractAction

Fields inherited from interface org.gvsig.andami.actioninfo.ActionInfo

Fields inherited from interface javax.swing.Action

Method Summary

Methods inherited from class javax.swing.AbstractAction

Methods inherited from class java.lang.Object

Methods inherited from interface javax.swing.Action

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

Method Detail

clone

getRedirections

merge

getPlugin

getPluginName

getExtension

getExtensionName

isVisible

isEnabled

execute

execute

execute

execute

actionPerformed

getName

getLabel

getCommand

getIconName

getIcon

getAccelerator

getKeyStroke

getPosition

getTooltip

getValue

putValue

toString

isActive

setActive