org.carewebframework.shell.plugins

Class PluginResourceHelp

java.lang.Object

org.carewebframework.shell.plugins.PluginResourceHelp

All Implemented Interfaces:

IPluginResource

public class PluginResourceHelp
extends Object
implements IPluginResource

Resource for declaring items to appear under the help menu.

There are essentially two ways to declare a help resource, one for internal help resources and one for external help resources:

• If the help resource uses the framework's embedded help system, you only need to set the module name (and optionally the topic). Default values for all other properties can be derived from the associated help definition, though you can set them explicitly if you need to override the defaults.
• If the help resource refers to externally derived help content (e.g., another web page), you will instead need to set the path and associated action. In this case, the module name should remain empty.

Constructor Summary

Constructors

Constructor and Description
PluginResourceHelp()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAction() Returns the action that will be invoked when the associated menu item is clicked.
String	getModule() Returns the id of the associated help module.
String	getPath() Returns the path that determines where the associated menu item will appear under the help submenu.
String	getTopic() Returns the topic id associated with this help resource.
void	process(PluginContainer container) Registers the help resource with the container.
void	setAction(String action) Sets the action that will be invoked when the associated menu item is clicked.
void	setModule(String module) Sets the id of the associated help module.
void	setPath(String path) Sets the path that determines where the associated menu item will appear under the help submenu.
void	setTopic(String topic) Sets the topic id associated with this help resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginResourceHelp

public PluginResourceHelp()

Method Detail

getPath

public String getPath()

Returns the path that determines where the associated menu item will appear under the help submenu. If this value has not been explicitly set, and a help module has been specified, its value will be determined from the help module.

Returns:

The path that determines where the associated menu item will appear under the help submenu. 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 help submenu. This is typically only specified for external help resources.

Parameters:

path - The path that determines where the associated menu item will appear under the help submenu. 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 associated menu item is clicked. For externally derived help content, this value must be explicitly set. Otherwise, it will be determined automatically from the specified help module.

Returns:

The action to be invoked to display the help content. This may be a url or a zscript action.

setAction

public void setAction(String action)

Sets the action that will be invoked when the associated menu item is clicked. For externally derived help content, this value must be explicitly set. For internally derived content, do not set this value. It will be derived automatically from the specified help module.

Parameters:

action - The action to be invoked to display the help content. This may be a url or a zscript action.

getTopic

public String getTopic()

Returns the topic id associated with this help resource. Specifying a topic id is optional and only applicable to internally derived help content. If a topic id is specified, information related to that topic will be displayed. Otherwise, the default topic will be displayed.

Returns:

The id of the topic to be displayed, or empty to display the default topic.

setTopic

public void setTopic(String topic)

Sets the topic id associated with this help resource. Specifying a topic id is optional and only applicable to internally derived help content. If a topic id is specified, information related to that topic will be displayed. Otherwise, the default topic will be displayed.

Parameters:

topic - The id of the topic to be displayed, or empty to display the default topic.

getModule

public String getModule()

Returns the id of the associated help module. This is only applicable for internally derived help content.

Returns:

The id of the associated help module.

setModule

public void setModule(String module)

Sets the id of the associated help module. This is only applicable for internally derived help content.

Parameters:

module - The id of the associated help module.

process

public void process(PluginContainer container)

Registers the help resource with the container.

Specified by:

process in interface IPluginResource

Parameters:

container - A plugin container.