| org.opencms.workplace.tools.I_CmsToolHandler
All known Subclasses: org.opencms.workplace.tools.content.check.A_CmsContentCheck, org.opencms.workplace.tools.A_CmsToolHandler,
| I_CmsToolHandler | | public interface I_CmsToolHandler (Code) | | Interface for an admin tool handler.
These handlers are created and managed by the
org.opencms.workplace.tools.CmsToolManager .
author:
Michael Moossen
version:
$Revision: 1.21 $
since:
6.0.0 |
| getConfirmationMessage | | String getConfirmationMessage()(Code) | | Returns an optional confirmation message, displayed in a js confirm dialog.
the confirmation message |
| getDisabledHelpText | | String getDisabledHelpText()(Code) | | Returns the help text if disabled.
the help text if disabled |
| getGroup | | String getGroup()(Code) | | Returns the group.
the group |
| getHelpText | | String getHelpText()(Code) | | Returns the help text.
the help text |
| getIconPath | | String getIconPath()(Code) | | Returns the path to the icon.
the path to the icon |
| getLink | | String getLink()(Code) | | Returns the link to the tool.
the link |
| getName | | String getName()(Code) | | Returns the displayed name.
the name |
| getParameters | | Map getParameters(CmsWorkplace wp)(Code) | | Returns the evaluated map of parameters.
Parameters:
wp - the workplace context the parameters map |
| getPath | | String getPath()(Code) | | Returns the tool path to install the tool in.
the path |
| getPosition | | float getPosition()(Code) | | Returns the relative position in the group.
the position |
| getShortName | | String getShortName()(Code) | | Returns the name for the menu or navbar.
the short name |
| getSmallIconPath | | String getSmallIconPath()(Code) | | Returns the path to an optional small(16x16) icon.
the path to an optional small(16x16) icon |
| isEnabled | | boolean isEnabled(CmsObject cms)(Code) | | Returns the state of the admin tool for a given cms context.
Parameters:
cms - the cms context true if enabled |
| isEnabled | | boolean isEnabled(CmsWorkplace wp)(Code) | | Returns the state of the admin tool for a given workplace context.
Parameters:
wp - the workplace context true if enabled |
| isVisible | | boolean isVisible(CmsObject cms)(Code) | | Returns the visibility flag for a given cms context.
Parameters:
cms - the cms context true if visible |
| isVisible | | boolean isVisible(CmsWorkplace wp)(Code) | | Returns the visibility flag for a given workplace context.
Parameters:
wp - the workplace context true if visible |
| setup | | boolean setup(CmsObject cms, CmsToolRootHandler root, String resourcePath)(Code) | | Main method that somehow setups the admin tool handler.
Parameters:
cms - the admin context (at opencms-workplace (re-)initialization time)
Parameters:
root - the root context
Parameters:
resourcePath - the resource path of the file/folder to use as admin tool false if something goes wrong |
|
|