PFCAction (Oracle Communications Billing and Revenue Management Customer Center SDK Java API Reference)

java.lang.Object
- javax.swing.AbstractAction
- - com.portal.pfc.ui.PFCAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action
```
public abstract class PFCAction
extends AbstractAction
```
Subclass PFCAction to implement functionality that is triggered by a menu entry or a toolbar button.
PFCAction is configured by a set of properties. See section PJF AppCenter FnS section 4.7.1 for the properties definitions. (We'll move it here later.)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEL` Constant used to store accelerator property information in the action class.
`static String`	`ICON_DISABLED` Constant used to store icon disabled information in action class
`static String`	`ICON_PRESSED` Constant used to store icon property information in the action class.
`static String`	`MNEM` Constant used to store mnemonic property information in the action class.
`static String`	`RES_ACCEL` Suffix of the token that defines the action accelerator in the resource file.
`static String`	`RES_DESCRIPTION` Suffix of the token that defines the action description in the resource file.
`static String`	`RES_ICON` Suffix of the token that defines the action icon in the resource file.
`static String`	`RES_ICON_DISABLED` Suffix of the token that defines the action disabled icon in the resource file.
`static String`	`RES_ICON_PRESSED` Suffix of the token that defines the action pressed icon in the resource file.
`static String`	`RES_MNEM` Suffix of the token that defines the action mnemonic in the resource file.
`static String`	`RES_NAME` Suffix of the token that defines the name in the resource file.
`static String`	`RES_TOOLBAR_LABEL` Suffix of the token that defines the action toolbar label in the resource file.
`static String`	`RES_TOOLTIP` Suffix of the token that defines the action tooltip in the resource file.
`static String`	`RES_TYPE` Suffix of the token that defines the action type in the resource file.
`static String`	`TOOLBAR_LABEL` Constant used to indicate the label that should appear for a toolbar button.
`static String`	`TYPE` Constant used to store type information in action class

Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled

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

Constructor Summary

Constructors
Constructor and Description
`PFCAction()` Zero-arg constructor that does no initialization.
`PFCAction(String token, Properties props, ResourceBundle resbndl)` Creates a PFCAction.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`actionPerformed(ActionEvent ae)` Override this method to implement the functionality that this action provides.
`Component`	`getCustomToolbarComponent()` Override this method to return a custom control when this action is used in a toolbar.
`String`	`getToken()`
`boolean`	`isConfigured()` Check if this action is configured.
`void`	`setConfigured(boolean configured)` Sets the configured property for the action.

Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

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

- Field Detail
  - ACCEL
```
public static final String ACCEL
```
    Constant used to store accelerator property information in the action class.
    
    See Also:
    
    Constant Field Values
  - RES_ACCEL
```
public static final String RES_ACCEL
```
    Suffix of the token that defines the action accelerator in the resource file.
    
    See Also:
    
    Constant Field Values
  - MNEM
```
public static final String MNEM
```
    Constant used to store mnemonic property information in the action class.
    
    See Also:
    
    Constant Field Values
  - RES_MNEM
```
public static final String RES_MNEM
```
    Suffix of the token that defines the action mnemonic in the resource file.
    
    See Also:
    
    Constant Field Values
  - ICON_DISABLED
```
public static final String ICON_DISABLED
```
    Constant used to store icon disabled information in action class
    
    See Also:
    
    Constant Field Values
  - RES_ICON_DISABLED
```
public static final String RES_ICON_DISABLED
```
    Suffix of the token that defines the action disabled icon in the resource file.
    
    See Also:
    
    Constant Field Values
  - ICON_PRESSED
```
public static final String ICON_PRESSED
```
    Constant used to store icon property information in the action class.
    
    See Also:
    
    Constant Field Values
  - RES_ICON_PRESSED
```
public static final String RES_ICON_PRESSED
```
    Suffix of the token that defines the action pressed icon in the resource file.
    
    See Also:
    
    Constant Field Values
  - TOOLBAR_LABEL
```
public static final String TOOLBAR_LABEL
```
    Constant used to indicate the label that should appear for a toolbar button. When using ACToolBar, PFCAction.TOOLBAR_LABEL will be used first. If it's not set, Action.NAME will be used. Menu items will still refer to Action.NAME - this allows you to use one action in both widgets and not have a label appear in the toolbar unless you explicitely want it to.
    
    See Also:
    
    Constant Field Values
  - RES_TOOLBAR_LABEL
```
public static final String RES_TOOLBAR_LABEL
```
    Suffix of the token that defines the action toolbar label in the resource file.
    
    See Also:
    
    Constant Field Values
  - RES_NAME
```
public static final String RES_NAME
```
    Suffix of the token that defines the name in the resource file.
    
    See Also:
    
    Constant Field Values
  - RES_TOOLTIP
```
public static final String RES_TOOLTIP
```
    Suffix of the token that defines the action tooltip in the resource file.
    
    See Also:
    
    Constant Field Values
  - RES_DESCRIPTION
```
public static final String RES_DESCRIPTION
```
    Suffix of the token that defines the action description in the resource file.
    
    See Also:
    
    Constant Field Values
  - RES_ICON
```
public static final String RES_ICON
```
    Suffix of the token that defines the action icon in the resource file.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final String TYPE
```
    Constant used to store type information in action class
    
    See Also:
    
    Constant Field Values
  - RES_TYPE
```
public static final String RES_TYPE
```
    Suffix of the token that defines the action type in the resource file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PFCAction
```
public PFCAction()
```
    Zero-arg constructor that does no initialization. Typically used when an action is utilized outside the context of a menubar or toolbar (i.e. reuse of code that is available in a tool/menubar and elsewhere).
  - PFCAction
```
public PFCAction(String token,
                 Properties props,
                 ResourceBundle resbndl)
```
    Creates a PFCAction.
    
    Parameters:
    
    token - Action token of the form <appname>.action.<actiontoken>. Must not be null.
    
    props - Properties object that contains action definitions. Must not be null.
    
    resbndl - Contains action resources for name, icon, accelerator, etc. Must not be null.
- Method Detail
  - getToken
```
public String getToken()
```
  - setConfigured
```
public void setConfigured(boolean configured)
```
    Sets the configured property for the action. Actions that are not configured (configured == false) are not added to the menubar and toolbar.
    An action should check in its constructor whether it should be available to the user and set this value as appropriate. An action should not be available (configured == false) if some dependency required by the action is not present.
    'Un/Configured' should not be confused with 'En/Disabled'. Disabled actions are visible on the toolbar/menubar but are inactive. Unconfigured actions do not even show up.
    
    Parameters:
    
    configured - Specifies whether the action should be available to the user on the menubar and toolbar. Should be set in the action constructor. Defaults to 'true'.
  - isConfigured
```
public boolean isConfigured()
```
    Check if this action is configured.
    
    Returns:
    
    true if configured, false otherwise
  - getCustomToolbarComponent
```
public Component getCustomToolbarComponent()
```
    Override this method to return a custom control when this action is used in a toolbar. If this returns null, a regular toolbar button will be used. Note that the action will be responsible for the labels, icons, etc. associated with this custom control. None of the normal action attributes will be applied.
    
    Returns:
    
    The control to place in the toolbar
  - actionPerformed
```
public abstract void actionPerformed(ActionEvent ae)
```
    Override this method to implement the functionality that this action provides.

Class PFCAction

Field Summary

Fields inherited from class javax.swing.AbstractAction

Fields inherited from interface javax.swing.Action

Constructor Summary

Method Summary

Methods inherited from class javax.swing.AbstractAction

Methods inherited from class java.lang.Object

Field Detail

ACCEL

RES_ACCEL

MNEM

RES_MNEM

ICON_DISABLED

RES_ICON_DISABLED

ICON_PRESSED

RES_ICON_PRESSED

TOOLBAR_LABEL

RES_TOOLBAR_LABEL

RES_NAME

RES_TOOLTIP

RES_DESCRIPTION

RES_ICON

TYPE

RES_TYPE

Constructor Detail

PFCAction

PFCAction

Method Detail

getToken

setConfigured

isConfigured

getCustomToolbarComponent

actionPerformed