org.opa.core
Class OPAPanelAction

java.lang.Object
  extended byjavax.swing.AbstractAction
      extended byorg.opa.core.OPAAction
          extended byorg.opa.core.OPAPanelAction
All Implemented Interfaces:
javax.swing.Action, java.awt.event.ActionListener, java.lang.Cloneable, java.util.EventListener, java.io.Serializable

public abstract class OPAPanelAction
extends OPAAction

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled
 
Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON
 
Constructor Summary
OPAPanelAction()
          Creates a new instance of OPAPanelAction
 
Method Summary
 java.lang.Class getCookieInterface()
          Returns the OPACookie to be associated with this OPAAction.
 java.lang.String getMenuPath()
          Returns a the preferred menu path for this events 'menu' agent.
 java.lang.String getPosition()
          This is the priority level used by OPA when building the system menu.
 boolean onMenubar()
          Add to application menubar?
 boolean onPopup()
          Add to application popup menu?
 boolean onToolbar()
          Add to application toolbar?
 void setCookie(OPACookie cookieInstance)
          Adds an OPACookie instance to this action.
 void setHelp(java.awt.Component c)
           
 
Methods inherited from class org.opa.core.OPAAction
setIcon, setName, setToolTip
 
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
 
Methods inherited from interface java.awt.event.ActionListener
actionPerformed
 

Constructor Detail

OPAPanelAction

public OPAPanelAction()
Creates a new instance of OPAPanelAction

Method Detail

getCookieInterface

public final java.lang.Class getCookieInterface()
Description copied from class: OPAAction
Returns the OPACookie to be associated with this OPAAction. The OPACookie will be used by OPAActionManager to decide when to enable or disable this OPAAction. If this method returns null then this OPAAction will be enabled permanently.

Specified by:
getCookieInterface in class OPAAction

getMenuPath

public final java.lang.String getMenuPath()
Description copied from class: OPAAction
Returns a the preferred menu path for this events 'menu' agent. This String is used by OPA to create the frame menus.

Specified by:
getMenuPath in class OPAAction

getPosition

public final java.lang.String getPosition()
Description copied from class: OPAAction
This is the priority level used by OPA when building the system menu. This determines the final order of menubar items.

Specified by:
getPosition in class OPAAction

onMenubar

public final boolean onMenubar()
Description copied from class: OPAAction
Add to application menubar?

Specified by:
onMenubar in class OPAAction

onPopup

public final boolean onPopup()
Description copied from class: OPAAction
Add to application popup menu?

Specified by:
onPopup in class OPAAction

onToolbar

public final boolean onToolbar()
Description copied from class: OPAAction
Add to application toolbar?

Specified by:
onToolbar in class OPAAction

setCookie

public final void setCookie(OPACookie cookieInstance)
Description copied from class: OPAAction
Adds an OPACookie instance to this action. This is used by OPAActionManager instances ONLY when an OPAAction returns a Cookie Interface (when it is context sensitive). This OPACookie instance should be CHECKED by OPAAction implementations that it is the correct OPACookie type (eg OPADeleteCookie etc). OPAAction implementations can then use this instance to invoke actions on the GUI component with focus.

Specified by:
setCookie in class OPAAction

setHelp

public final void setHelp(java.awt.Component c)
Specified by:
setHelp in class OPAAction