org.carewebframework.shell.plugins

Class PluginResourceMenu

java.lang.Object

org.carewebframework.shell.plugins.PluginResourceMenu

All Implemented Interfaces:

IPluginResource

public class PluginResourceMenu
extends Object
implements IPluginResource

Resource for declaring items to appear on the common menu.

Constructor Summary

Constructors

Constructor and Description
PluginResourceMenu()

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the action that will be invoked when the menu item is clicked.
String	getId() Returns the id to be assigned to the newly created component.
String	getPath() Returns the path that determines where the associated menu item will appear under the common menu.
void	register(CareWebShell shell, ElementBase owner, boolean register) Registers/unregisters a plugin resource.
void	setAction(String action) Sets the action that will be invoked when the menu item is clicked.
void	setId(String id) Sets the id to be assigned to the newly created component.
void	setPath(String path) Sets the path that determines where the associated menu item will appear under the common menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginResourceMenu

public PluginResourceMenu()

Method Detail

getPath

public String getPath()

Returns the path that determines where the associated menu item will appear under the common menu.

Returns:

The path that determines where the associated menu item will appear under the common menu. A menu hierarchy can be specified by separating levels with backslash characters.

setPath

public void setPath(String path)

Sets the path that determines where the associated menu item will appear under the common menu.

Parameters:

path - The path that determines where the associated menu item will appear under the common menu. A menu hierarchy can be specified by separating levels with backslash characters.

getAction

public String getAction()

Returns the action that will be invoked when the menu item 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 menu item is clicked.

Parameters:

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

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 plugin 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.