|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.tools.A_CmsToolHandler
org.opencms.workplace.tools.CmsToolRootHandler
Admin tool handler for tool roots.
Field Summary |
Fields inherited from class org.opencms.workplace.tools.A_CmsToolHandler |
ARG_PARAM_NAME, ARG_PATH_NAME, ARGS_PROPERTY_DEFINITION, ARGUMENT_SEPARATOR, DEFAULT_DISABLED_HELPTEXT, VALUE_SEPARATOR |
Constructor Summary | |
CmsToolRootHandler()
|
Method Summary | |
java.lang.String |
getKey()
Returns the key. |
java.lang.String |
getUri()
Returns the uri. |
boolean |
isEnabled(CmsObject cms)
Returns the state of the admin tool for a given cms context. |
boolean |
isVisible(CmsObject cms)
Returns the visibility flag for a given cms context. |
void |
setKey(java.lang.String key)
Sets the key. |
boolean |
setup(CmsObject cms,
CmsToolRootHandler root,
java.lang.String resourcePath)
Default implementation. |
void |
setUri(java.lang.String uri)
Sets the uri. |
Methods inherited from class org.opencms.workplace.tools.A_CmsToolHandler |
getConfirmationMessage, getDisabledHelpText, getGroup, getHelpText, getIconPath, getLink, getName, getParameters, getPath, getPosition, getShortName, getSmallIconPath, setConfirmationMessage, setDisabledHelpText, setGroup, setHelpText, setIconPath, setLink, setLink, setName, setParameters, setParameterString, setPath, setPosition, setShortName, setSmallIconPath, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public CmsToolRootHandler()
Method Detail |
public java.lang.String getKey()
public java.lang.String getUri()
public boolean isEnabled(CmsObject cms)
I_CmsToolHandler
cms
- the cms context
true
if enabledI_CmsToolHandler.isEnabled(org.opencms.file.CmsObject)
public boolean isVisible(CmsObject cms)
I_CmsToolHandler
cms
- the cms context
true
if visibleI_CmsToolHandler.isVisible(org.opencms.file.CmsObject)
public void setKey(java.lang.String key)
key
- the key to setpublic boolean setup(CmsObject cms, CmsToolRootHandler root, java.lang.String resourcePath)
A_CmsToolHandler
CmsPropertyDefinition.PROPERTY_NAVIMAGE
property,
or uses a default icon if undefined, the name is taken from the
CmsPropertyDefinition.PROPERTY_NAVTEXT
property,
or uses the 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
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
property,
the position from the CmsPropertyDefinition.PROPERTY_NAVINFO
and the install path is given by the folder structure if the CmsPropertyDefinition.PROPERTY_NAVPOS
property does not include path information.A_CmsToolHandler.ARGS_PROPERTY_DEFINITION
For the icon path you can specify 2 paths separated by a
,
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}A_CmsToolHandler.VALUE_SEPARATOR
The confirmation message is taken from the
with key
A_CmsToolHandler.ARGS_PROPERTY_DEFINITION
#ARG_CONFIRMATION_NAME
setup
in interface I_CmsToolHandler
setup
in class A_CmsToolHandler
A_CmsToolHandler.setup(org.opencms.file.CmsObject, org.opencms.workplace.tools.CmsToolRootHandler, java.lang.String)
public void setUri(java.lang.String uri)
uri
- the uri to set
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |