com.sap.portal.admin.studio

Class Action

java.lang.Object
  com.sap.portal.admin.studio.Action

public class Action

extends Object

Action Virtual representive of an action in the admin studio environment. Action can be rendered in many ways (tool bar button for example) according to the context it was added. The action can be retrieved also in the client side, using the acionManager global object.

Constructor Summary

Action(String id)
Constructor - construct an empty action with id, The title and description will be the id.

Action(String id, String title)
Constructor - construct a new action with id and title.

Action(String id, String title, String description)
Constructor - construct a new action with id title and description

Method Summary

void	addComponentId(String compId) Internal: Add a component id that this action is related to.
List	getComponents() Internal:
String	getDescription() Gets this action description.
String	getId() Gets the id of this action
String	getTitle() Gets the title of this action
boolean	isClientAction() Indicates whether this action handling will be performed in the client side.
boolean	isEnabled() Indicates if this action is enable (the components related to this action)
void	setClientAction() Set this action to be a client action.
void	setDescription(String description) Set a description for this action.
void	setEnabled(boolean isEnabled) Set this action to be anabled or diabled
void	setTitle(String 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)

Constructor - construct a new action with id title and description

Parameters:

id - unique id for this action

title - the title that will be rendered for components related to that action

description - description for this action, will extend the title (in a tool tip for example).

Action

public Action(String id,
              String title)

Constructor - construct a new action with id and title. The description will be the title.

Parameters:

id - unique id for this action

title - the title that will be rendered for components related to that action

Action

public Action(String id)

Constructor - construct an empty action with id, The title and description will be the id.

Parameters:

id - unique id for this action

Method Detail

setClientAction

public void setClientAction()

Set this action to be a client action. When this action will be executed, it will run the client handler With the following signature: doMyAction() Where myAction is the action id

isClientAction

public boolean isClientAction()

Indicates whether this action handling will be performed in the client side.

Returns:

true if this is a client action.

setDescription

public void setDescription(String description)

Set a description for this action. The description usually will be presented as tool tip.

Parameters:

description - the description string for this action

getDescription

public String getDescription()

Gets this action description.

Returns:

this action description

setEnabled

public void setEnabled(boolean isEnabled)

Set this action to be anabled or diabled

isEnabled

public boolean isEnabled()

Indicates if this action is enable (the components related to this action)

Returns:

true if this action is enabled, false if it is diabled.

getId

public String getId()

Gets the id of this action

Returns:

the id of this action

getTitle

public String getTitle()

Gets the title of this action

Returns:

title of this action

getComponents

public List getComponents()

Internal:

Returns:

the list of the components ids that this Action refers to.

addComponentId

public void addComponentId(String compId)

Internal: Add a component id that this action is related to.

Parameters:

compId -

setTitle

public void setTitle(String title)

Parameters:

title - the title of this action