SharedAction (Commons)

java.lang.Object
- com.lf.commons.gui.SharedAction

```
public class SharedAction
extends java.lang.Object
```
Simple data holding class for high-level shared GUI actions.

Since:

1.6

Version:

$Revision: 1.19 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTION_CLOSE_TAB` Default action name.
`static java.lang.String`	`ACTION_CONNECT` Default action name.
`static java.lang.String`	`ACTION_COPY` Default action name.
`static java.lang.String`	`ACTION_CUT` Default action name.
`static java.lang.String`	`ACTION_DELETE` Default action name.
`static java.lang.String`	`ACTION_DISCONNECT` Default action name.
`static java.lang.String`	`ACTION_EXPORT_DATA` Default action name.
`static java.lang.String`	`ACTION_FIND` Default action name.
`static java.lang.String`	`ACTION_HELP` Default action name.
`static java.lang.String`	`ACTION_HIDE_WINDOW` Default action name.
`static java.lang.String`	`ACTION_IMPORT_DATA` Default action name.
`static java.lang.String`	`ACTION_PASTE` Default action name.
`static java.lang.String`	`ACTION_PRINT` Default action name.
`static java.lang.String`	`ACTION_RECONNECT` Default action name.
`static java.lang.String`	`ACTION_REFRESH` Default action name.
`static java.lang.String`	`ACTION_RENAME` Default action name.
`static java.lang.String`	`ACTION_SAVE` Default action name.
`static java.lang.String`	`ACTION_SAVE_AS` Default action name.
`static java.lang.String`	`ACTION_SAVE_AS_URL` Default action name.

Constructor Summary

Constructors
Constructor and Description
`SharedAction()` Constructor method for i18n purposes only.
`SharedAction(java.lang.String name, javax.swing.AbstractButton[] components)` Constructor settings the initial values.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addActionListener(java.awt.event.ActionListener listener)` Adds an action listener to this shared action.
`static java.lang.String[]`	`combineActions(java.lang.String[]... actions)` Assembles overall shared actions.
`static SharedAction`	`createCloseTabAction(javax.swing.AbstractButton[] components)` Convenience method to get a close tab action.
`static SharedAction`	`createConnectAction(javax.swing.AbstractButton[] components)` Convenience method to get a database connect action.
`static SharedAction`	`createCopyAction(javax.swing.AbstractButton[] components)` Convenience method to get a copy action.
`static SharedAction`	`createCutAction(javax.swing.AbstractButton[] components)` Convenience method to get a cut action.
`static SharedAction`	`createDeleteAction(javax.swing.AbstractButton[] components)` Convenience method to get a delete action.
`static SharedAction`	`createDisconnectAction(javax.swing.AbstractButton[] components)` Convenience method to get a database disconnect action.
`static SharedAction`	`createExportDataAction(javax.swing.AbstractButton[] components)` Convenience method to get a database export data action.
`static SharedAction`	`createFindAction(javax.swing.AbstractButton[] components)` Convenience method to get a find action.
`static SharedAction`	`createHelpAction(javax.swing.AbstractButton[] components)` Convenience method to get a help action.
`static SharedAction`	`createHideWindowAction(javax.swing.AbstractButton[] components)` Convenience method to get a hide window action.
`static SharedAction`	`createImportDataAction(javax.swing.AbstractButton[] components)` Convenience method to get a database import data action.
`static SharedAction`	`createPasteAction(javax.swing.AbstractButton[] components)` Convenience method to get a paste action.
`static SharedAction`	`createPrintAction(javax.swing.AbstractButton[] components)` Convenience method to get a print action.
`static SharedAction`	`createReconnectAction(javax.swing.AbstractButton[] components)` Convenience method to get a database reconnect action.
`static SharedAction`	`createRefreshAction(javax.swing.AbstractButton[] components)` Convenience method to get a refresh action.
`static SharedAction`	`createRenameAction(javax.swing.AbstractButton[] components)` Convenience method to get a rename action.
`static SharedAction`	`createSaveAction(javax.swing.AbstractButton[] components)` Convenience method to get a save action.
`static SharedAction`	`createSaveAsAction(javax.swing.AbstractButton[] components)` Convenience method to get a "Save As" action (file).
`static SharedAction`	`createSaveAsURLAction(javax.swing.AbstractButton[] components)` Convenience method to get a "Save As" action (URL).
`boolean`	`equals(SharedAction tocheck)` Checks wether a given `SharedAction` instance is equal to this.
`static SharedAction`	`findAction(SharedAction[] actions, java.lang.String name)` Determines the desired shared action type from the given list.
`static javax.swing.AbstractButton[]`	`findComponents(SharedAction[] actions, java.lang.String name)` Determines the desired shared action components from the given list.
`javax.swing.AbstractButton[]`	`getComponents()` Getter for components.
`java.lang.String`	`getName()` Getter for name.
`void`	`removeActionListener(java.awt.event.ActionListener listener)` Removes an action listener from this shared action.
`void`	`setEnabled(boolean enabled)` Enables/disables the action components.
`java.lang.String`	`toString()` Overrides method `java.lang.Object.toString`.

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

- Field Detail
  - ACTION_SAVE
```
public static final java.lang.String ACTION_SAVE
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_SAVE_AS
```
public static final java.lang.String ACTION_SAVE_AS
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_SAVE_AS_URL
```
public static final java.lang.String ACTION_SAVE_AS_URL
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_PRINT
```
public static final java.lang.String ACTION_PRINT
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_REFRESH
```
public static final java.lang.String ACTION_REFRESH
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_FIND
```
public static final java.lang.String ACTION_FIND
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_HELP
```
public static final java.lang.String ACTION_HELP
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_CLOSE_TAB
```
public static final java.lang.String ACTION_CLOSE_TAB
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_DELETE
```
public static final java.lang.String ACTION_DELETE
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_RENAME
```
public static final java.lang.String ACTION_RENAME
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_CUT
```
public static final java.lang.String ACTION_CUT
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_COPY
```
public static final java.lang.String ACTION_COPY
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_PASTE
```
public static final java.lang.String ACTION_PASTE
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_HIDE_WINDOW
```
public static final java.lang.String ACTION_HIDE_WINDOW
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_CONNECT
```
public static final java.lang.String ACTION_CONNECT
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_DISCONNECT
```
public static final java.lang.String ACTION_DISCONNECT
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_RECONNECT
```
public static final java.lang.String ACTION_RECONNECT
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_IMPORT_DATA
```
public static final java.lang.String ACTION_IMPORT_DATA
```
    Default action name.
    
    See Also:
    Constant Field Values
  - ACTION_EXPORT_DATA
```
public static final java.lang.String ACTION_EXPORT_DATA
```
    Default action name.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SharedAction
```
public SharedAction()
             throws java.lang.InstantiationException
```
    Constructor method for i18n purposes only.
    Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).
    
    Throws:
    
    java.lang.InstantiationException - Error indication
    Since:
    
    1.6
  - SharedAction
```
public SharedAction(java.lang.String name,
            javax.swing.AbstractButton[] components)
```
    Constructor settings the initial values.
    
    Parameters:
    name - The name of the action (required)
    components - The associated clickable components (required)
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
    Since:
    
    1.6
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides method java.lang.Object.toString.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The identifer for the represented object or empty string
    Since:
    
    1.6
  - equals
```
public boolean equals(SharedAction tocheck)
```
    Checks wether a given SharedAction instance is equal to this.
    
    Parameters:
    tocheck - The instance to be compared
    
    Returns:
    The SharedAction instance to check for equality
    Since:
    
    1.6
  - getName
```
public java.lang.String getName()
```
    Getter for name.
    
    Returns:
    The name
    Since:
    
    1.6
  - getComponents
```
public javax.swing.AbstractButton[] getComponents()
```
    Getter for components.
    
    Returns:
    The components
    Since:
    
    1.6
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Enables/disables the action components.
    
    Parameters:
    enabled - Enable the components?
    Since:
    
    1.6
  - addActionListener
```
public void addActionListener(java.awt.event.ActionListener listener)
```
    Adds an action listener to this shared action.
    
    Parameters:
    listener - The action listener to be added
    
    Throws:
    
    java.lang.NullPointerException - If parameter is null
    Since:
    
    1.6
  - removeActionListener
```
public void removeActionListener(java.awt.event.ActionListener listener)
```
    Removes an action listener from this shared action.
    
    Parameters:
    listener - The action listener to be removed
    
    Throws:
    
    java.lang.NullPointerException - If parameter is null
    Since:
    
    1.6
  - findAction
```
public static SharedAction findAction(SharedAction[] actions,
                      java.lang.String name)
```
    Determines the desired shared action type from the given list.
    
    Parameters:
    actions - The actions to be searched
    name - The desired action type
    
    Returns:
    The desired action, null if not available
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    Since:
    
    1.6
  - findComponents
```
public static javax.swing.AbstractButton[] findComponents(SharedAction[] actions,
                                          java.lang.String name)
```
    Determines the desired shared action components from the given list.
    
    Parameters:
    actions - The actions to be searched
    name - The desired action type
    
    Returns:
    The desired action components, null if not available
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    Since:
    
    1.6
  - combineActions
```
public static java.lang.String[] combineActions(java.lang.String[]... actions)
```
    Assembles overall shared actions.
    
    Parameters:
    actions - The actions
    
    Returns:
    The combined actions, may have zero-length
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    Since:
    
    1.6
  - createSaveAction
```
public static SharedAction createSaveAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a save action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createSaveAsAction
```
public static SharedAction createSaveAsAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a "Save As" action (file).
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createSaveAsURLAction
```
public static SharedAction createSaveAsURLAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a "Save As" action (URL).
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createPrintAction
```
public static SharedAction createPrintAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a print action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createRefreshAction
```
public static SharedAction createRefreshAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a refresh action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createFindAction
```
public static SharedAction createFindAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a find action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createHelpAction
```
public static SharedAction createHelpAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a help action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createCloseTabAction
```
public static SharedAction createCloseTabAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a close tab action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createDeleteAction
```
public static SharedAction createDeleteAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a delete action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createRenameAction
```
public static SharedAction createRenameAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a rename action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createCutAction
```
public static SharedAction createCutAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a cut action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createCopyAction
```
public static SharedAction createCopyAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a copy action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createPasteAction
```
public static SharedAction createPasteAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a paste action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createHideWindowAction
```
public static SharedAction createHideWindowAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a hide window action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createConnectAction
```
public static SharedAction createConnectAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a database connect action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createDisconnectAction
```
public static SharedAction createDisconnectAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a database disconnect action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createReconnectAction
```
public static SharedAction createReconnectAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a database reconnect action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createImportDataAction
```
public static SharedAction createImportDataAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a database import data action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid
  - createExportDataAction
```
public static SharedAction createExportDataAction(javax.swing.AbstractButton[] components)
```
    Convenience method to get a database export data action.
    
    Parameters:
    components - The associated clickable components (required)
    
    Returns:
    Pre-defined action
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If at least one of the parameters is invalid

Class SharedAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION_SAVE

ACTION_SAVE_AS

ACTION_SAVE_AS_URL

ACTION_PRINT

ACTION_REFRESH

ACTION_FIND

ACTION_HELP

ACTION_CLOSE_TAB

ACTION_DELETE

ACTION_RENAME

ACTION_CUT

ACTION_COPY

ACTION_PASTE

ACTION_HIDE_WINDOW

ACTION_CONNECT

ACTION_DISCONNECT

ACTION_RECONNECT

ACTION_IMPORT_DATA

ACTION_EXPORT_DATA

Constructor Detail

SharedAction

SharedAction

Method Detail

toString

equals

getName

getComponents

setEnabled

addActionListener

removeActionListener

findAction

findComponents

combineActions

createSaveAction

createSaveAsAction

createSaveAsURLAction

createPrintAction

createRefreshAction

createFindAction

createHelpAction

createCloseTabAction

createDeleteAction

createRenameAction

createCutAction

createCopyAction

createPasteAction

createHideWindowAction

createConnectAction

createDisconnectAction

createReconnectAction

createImportDataAction

createExportDataAction