com.sap.portal.admin.studio

Class Action

java.lang.Object

com.sap.portal.admin.studio.Action

public class Action
extends Object

The class that represents an action in the admin studio environment. An action can be rendered in a number of ways, for example, a toolbar button. The action can also be retrieved on the client side, using actionManager.js in the editor framework.

Constructor Summary

Constructors

Constructor and Description
Action(String id) A constructor that sets an ID.
Action(String id, String title) A constructor that sets an ID and title.
Action(String id, String title, String description) A constructor that sets an ID, title and description.

Method Summary

Modifier and Type	Method and Description
void	addComponentId(String compId) For internal use.
List	getComponents() For internal use.
String	getDescription() Gets the action description (the tooltip).
String	getId() Gets the action ID.
String	getTitle() Gets the action title.
boolean	isClientAction() Indicates whether action handling is performed on the client side.
boolean	isEnabled() Indicates whether the action is enabled.
void	setClientAction() Sets this action to be a client action.
void	setDescription(String description) Sets a description for the action.
void	setEnabled(boolean isEnabled) Enables or disables the action.
void	setTitle(String title) Sets the action title.

Methods inherited from class java.lang.Object

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

Constructor Detail

Action

public Action(String id,
              String title,
              String description)

A constructor that sets an ID, title and description. The description is displayed in a tooltip.

Parameters:

id - action ID

title - a title for components related to the action

description - the tooltip for the action

Action

public Action(String id,
              String title)

A constructor that sets an ID and title.

Parameters:

id - action ID

title - a title for components related to the action

Action

public Action(String id)

A constructor that sets an ID.

Parameters:

id - an action ID

Method Detail

setClientAction

public void setClientAction()

Sets this action to be a client action. When this action is executed, it runs the client handler with the following signature: doMyAction, where myAction is the action ID.

isClientAction

public boolean isClientAction()

Indicates whether action handling is performed on the client side.

Returns:

true if this is a client action, false if not

setDescription

public void setDescription(String description)

Sets a description for the action. The description is displayed as a tooltip.

Parameters:

description - a tooltip for the action

getDescription

public String getDescription()

Gets the action description (the tooltip).

Returns:

the action description

setEnabled

public void setEnabled(boolean isEnabled)

Enables or disables the action.

Parameters:

isEnabled - true to enable the action, false to disable it

isEnabled

public boolean isEnabled()

Indicates whether the action is enabled.

Returns:

true if this action is enabled, false if it is disabled

getId

public String getId()

Gets the action ID.

Returns:

the action ID

getTitle

public String getTitle()

Gets the action title.

Returns:

the action title

getComponents

public List getComponents()

For internal use.
Gets the list of component IDs for the action.

Returns:

the list of components

addComponentId

public void addComponentId(String compId)

For internal use.
Adds a component ID that is related to the action.

Parameters:

compId - the component ID

setTitle

public void setTitle(String title)

Sets the action title.

Parameters:

title - the action title