org.carewebframework.shell.plugins

Class PluginResourceButton

java.lang.Object

org.carewebframework.shell.plugins.PluginResourceButton

All Implemented Interfaces:

IPluginResource

public class PluginResourceButton
extends Object
implements IPluginResource

Resource for declaring buttons to appear on common toolbar.

Constructor Summary

Constructors

Constructor and Description
PluginResourceButton()

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the action that will be invoked when the button is clicked.
String	getCaption() Returns the value of the button's caption text.
String	getHint() Returns the text to appear when the mouse cursor hovers over the button.
String	getIcon() Returns the url of an image to display on the button.
String	getId() Returns the id to be assigned to the newly created component.
void	register(CareWebShell shell, ElementBase owner, boolean register) Registers/unregisters a button resource.
void	setAction(String action) Sets the action that will be invoked when the button is clicked.
void	setCaption(String caption) Sets the value of the button's caption text.
void	setHint(String hint) Sets the text to appear when the mouse cursor hovers over the button.
void	setIcon(String icon) Sets the url of an image to display on the button.
void	setId(String id) Sets the id to be assigned to the newly created component.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginResourceButton

public PluginResourceButton()

Method Detail

getCaption

public String getCaption()

Returns the value of the button's caption text.

Returns:

The button's caption text.

setCaption

public void setCaption(String caption)

Sets the value of the button's caption text.

Parameters:

caption - The button's caption text.

getAction

public String getAction()

Returns the action that will be invoked when the button is clicked.

Returns:

The action to be invoked. This may be a url or a groovy script action.

setAction

public void setAction(String action)

Sets the action that will be invoked when the button is clicked.

Parameters:

action - The action to be invoked. This may be a url or a groovy script action.

getHint

public String getHint()

Returns the text to appear when the mouse cursor hovers over the button.

Returns:

The tool tip text.

setHint

public void setHint(String hint)

Sets the text to appear when the mouse cursor hovers over the button.

Parameters:

hint - The tool tip text.

getIcon

public String getIcon()

Returns the url of an image to display on the button.

Returns:

Url of the image.

setIcon

public void setIcon(String icon)

Sets the url of an image to display on the button.

Parameters:

icon - Url of the image.

getId

public String getId()

Returns the id to be assigned to the newly created component.

Returns:

Component id (may be null).

setId

public void setId(String id)

Sets the id to be assigned to the newly created component.

Parameters:

id - Component id (may be null).

register

public void register(CareWebShell shell,
                     ElementBase owner,
                     boolean register)

Registers/unregisters a button resource.

Specified by:

register in interface IPluginResource

Parameters:

shell - The running shell.

owner - Owner of the resource.

register - If true, register the resource. If false, unregister it.