com.portal.bas.comp

Class PDefaultHelpIDAction

java.lang.Object

javax.swing.AbstractAction

com.portal.bas.PBASAction

com.portal.bas.comp.PDefaultHelpIDAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public class PDefaultHelpIDAction
extends PBASAction

PDefaultHelpIDAction is the PBASAction command object used to deliver help for a component, given an ID. This is the default provided by PViewComponent.

Version:

%version: 10 % %date_modified: Tue Dec 18 19:17:46 2001 %

Author:

larrylf

See Also:

Serialized Form

Field Summary

Fields inherited from class com.portal.bas.PBASAction

ACCEL, ICON_DISABLED, ICON_DISABLED_SELECTED, ICON_PRESSED, ICON_ROLLOVER, ICON_ROLLOVER_SELECTED, ICON_SELECTED, MNEM, TOOL_TITLE, TOOLBAR_LABEL

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
PDefaultHelpIDAction(PClientComponent comp, String helpID) Creates a new instance of PDefaultHelpAction.
PDefaultHelpIDAction(String helpID) Creates a new instance of PDefaultHelpAction.
PDefaultHelpIDAction(String helpID, oracle.help.CSHManager cshManager) Creates a new instance of PDefaultHelpAction.
PDefaultHelpIDAction(String helpID, Window helpUIOwner) Create a new instance of the DefaultHelpAction

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) An actionPerformed handler that displays help.
void	setHelpID(String helpID) set the help ID for this instance of the DefaultHelpAction

Methods inherited from class com.portal.bas.PBASAction

equals, getComponent, getHelpID, getPreferredMenu, getTag, handleError, setActionHelpOn, setPreferredMenu

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDefaultHelpIDAction

public PDefaultHelpIDAction(PClientComponent comp,
                            String helpID)

Creates a new instance of PDefaultHelpAction.

Parameters:

comp - the component to deliver help for

helpID - the help ID to be displayed by this action

PDefaultHelpIDAction

public PDefaultHelpIDAction(String helpID)

Creates a new instance of PDefaultHelpAction.

Parameters:

helpID - the help ID to be displayed by this action

PDefaultHelpIDAction

public PDefaultHelpIDAction(String helpID,
                            oracle.help.CSHManager cshManager)

Creates a new instance of PDefaultHelpAction.

Parameters:

helpID - the help ID to be displayed by this action

cshManager - the help broker to display context senstive help

PDefaultHelpIDAction

public PDefaultHelpIDAction(String helpID,
                            Window helpUIOwner)

Create a new instance of the DefaultHelpAction

Parameters:

helpID - The help ID to be displayed by this Action

helpUIOwner - Window that will "own" the help UI

Method Detail

setHelpID

public void setHelpID(String helpID)

set the help ID for this instance of the DefaultHelpAction

Parameters:

helpID - THe help ID to be displayed by this Action

actionPerformed

public void actionPerformed(ActionEvent e)

An actionPerformed handler that displays help.

Parameters:

e - the event to display help for