| java.lang.Object
 org.opencms.workplace.tools.A_CmsToolHandler
All known Subclasses: org.opencms.workplace.tools.searchindex.CmsSearchToolHandler, org.opencms.workplace.tools.scheduler.CmsSchedulerToolHandler, org.opencms.workplace.tools.CmsOnlyAdminToolHandler, org.opencms.workplace.tools.accounts.CmsOrgUnitsToolHandler, org.opencms.workplace.tools.database.CmsDatabaseToolHandler, org.opencms.workplace.tools.projects.CmsProjectsToolHandler, org.opencms.workplace.tools.workplace.CmsWorkplaceToolHandler, org.opencms.workplace.tools.CmsDefaultToolHandler, org.opencms.workplace.tools.cache.CmsCacheAdminToolHandler, org.opencms.workplace.tools.history.CmsFileHistoryToolHandler, org.opencms.workplace.tools.CmsInvisibleToolHandler, org.opencms.workplace.tools.CmsToolRootHandler, org.opencms.workplace.tools.galleryoverview.CmsGalleriesToolHandler, org.opencms.workplace.tools.link.CmsLinkValidationToolHandler, org.opencms.workplace.tools.modules.CmsModulesToolHandler,
| A_CmsToolHandler | | abstract public class A_CmsToolHandler implements I_CmsToolHandler(Code) | | Helper class to build easily other admin tool handlers.
author:
Michael Moossen
version:
$Revision: 1.28 $
since:
6.0.0 |
| ARGS_PROPERTY_DEFINITION | | final public static String ARGS_PROPERTY_DEFINITION(Code) | | Property definition for the arguments.
|
| ARGUMENT_SEPARATOR | | final public static String ARGUMENT_SEPARATOR(Code) | | Argument separator.
|
| ARG_PARAM_NAME | | final public static String ARG_PARAM_NAME(Code) | | Property for the parameters argument.
|
| ARG_PATH_NAME | | final public static String ARG_PATH_NAME(Code) | | Property for the path argument.
|
| DEFAULT_DISABLED_HELPTEXT | | final public static String DEFAULT_DISABLED_HELPTEXT(Code) | | Default disabled help text constant.
|
| VALUE_SEPARATOR | | final public static String VALUE_SEPARATOR(Code) | | Argument name and value separator.
|
| getConfirmationMessage | | public String getConfirmationMessage()(Code) | | Returns the confirmation Message.
the confirmation Message |
| setConfirmationMessage | | public void setConfirmationMessage(String confirmationMessage)(Code) | | Sets the confirmation Message.
Parameters:
confirmationMessage - the confirmation Message to set |
| setDisabledHelpText | | public void setDisabledHelpText(String disabledHelpText)(Code) | | Sets the help text if disabled.
Parameters:
disabledHelpText - the help text to set |
| setGroup | | public void setGroup(String group)(Code) | | Sets the group.
Parameters:
group - the group to set |
| setHelpText | | public void setHelpText(String helpText)(Code) | | Sets the help text.
Parameters:
helpText - the help text to set |
| setIconPath | | public void setIconPath(String iconPath)(Code) | | Sets the icon path.
Parameters:
iconPath - the icon path to set |
| setLink | | public void setLink(String link)(Code) | | Sets the link.
Parameters:
link - the link to set |
| setLink | | protected void setLink(CmsObject cms, String resourcePath)(Code) | | Sets the link for the given resource.
Use the resourcePath as link if it is not a folder.
If it is a folder, try to use the folder default file property value as link.
if not use the
CmsToolManager.VIEW_JSPPAGE_LOCATION .
Parameters:
cms - the cms context
Parameters:
resourcePath - the path to the resource to set the link for |
| setName | | public void setName(String name)(Code) | | Sets the name.
Parameters:
name - the name to set |
| setParameterString | | public void setParameterString(String paramString)(Code) | | Sets the parameter string.
Parameters:
paramString - the parameter string to set |
| setPath | | public void setPath(String path)(Code) | | Sets the path.
Parameters:
path - the path to set |
| setPosition | | public void setPosition(float position)(Code) | | Sets the position.
Parameters:
position - the position to set |
| setShortName | | public void setShortName(String shortName)(Code) | | Sets the short name.
Parameters:
shortName - the short name to set |
| setSmallIconPath | | public void setSmallIconPath(String smallIconPath)(Code) | | Sets the small icon path.
Parameters:
smallIconPath - the samll icon path to set |
| setup | | public boolean setup(CmsObject cms, CmsToolRootHandler root, String resourcePath)(Code) | | Default implementation.
It takes the icon path from
org.opencms.file.CmsPropertyDefinition.PROPERTY_NAVIMAGE property,
or uses a default icon if undefined, the name is taken from the
org.opencms.file.CmsPropertyDefinition.PROPERTY_NAVTEXT property,
or uses the
org.opencms.file.CmsPropertyDefinition.PROPERTY_TITLE property if undefined,
or an default text, if still undefined. if you want 2 different names, one for the big icon tools and one for
the menu/navbar entries, use a
A_CmsToolHandler.VALUE_SEPARATOR to separate them in the property.
(if you do so, the first one is for big icons and the second one for menu/navbar entries). the help text is taken from the
org.opencms.file.CmsPropertyDefinition.PROPERTY_DESCRIPTION property or a
default text if undefined, if you want to customize a help text while disabled, use a
A_CmsToolHandler.VALUE_SEPARATOR as a separator in the same property.
The group is taken from the
org.opencms.file.CmsPropertyDefinition.PROPERTY_NAVINFO property,
the position from the
org.opencms.file.CmsPropertyDefinition.PROPERTY_NAVPOS
and the install path is given by the folder structure if the
A_CmsToolHandler.ARGS_PROPERTY_DEFINITION
property does not include path information.
For the icon path you can specify 2 paths separated by a
A_CmsToolHandler.VALUE_SEPARATOR ,
the first one will be used as a group icon (32x32), and the second as an menu icon (16x16). The paths are relative
to the /system/workplace/resources/ folder. If the tool is disabled, the names of the icons are composed as
${name}_disabled.${ext}
The confirmation message is taken from the
A_CmsToolHandler.ARGS_PROPERTY_DEFINITION with key
#ARG_CONFIRMATION_NAME
See Also: org.opencms.workplace.tools.I_CmsToolHandler.setup(org.opencms.file.CmsObjectCmsToolRootHandlerjava.lang.String) |
|
|