Package org.opencms.workplace.tools

Class CmsToolRootHandler

java.lang.Object

org.opencms.workplace.tools.A_CmsToolHandler

org.opencms.workplace.tools.CmsToolRootHandler

All Implemented Interfaces:

I_CmsToolHandler

public class CmsToolRootHandler
extends A_CmsToolHandler

Admin tool handler for tool roots.

Since:

6.0.0

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

Constructors

Constructor	Description
CmsToolRootHandler()

Method Summary

Modifier and Type	Method	Description
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, isEnabled, isVisible, 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

CmsToolRootHandler

public CmsToolRootHandler()

Method Detail

getKey

public java.lang.String getKey()

Returns the key.

Returns:

the key

getUri

public java.lang.String getUri()

Returns the uri.

Returns:

the uri

isEnabled

public boolean isEnabled(CmsObject cms)

Description copied from interface: I_CmsToolHandler

Returns the state of the admin tool for a given cms context.

Parameters:

cms - the cms context

Returns:

true if enabled

See Also:

I_CmsToolHandler.isEnabled(org.opencms.file.CmsObject)

isVisible

public boolean isVisible(CmsObject cms)

Description copied from interface: I_CmsToolHandler

Returns the visibility flag for a given cms context.

Parameters:

cms - the cms context

Returns:

true if visible

See Also:

I_CmsToolHandler.isVisible(org.opencms.file.CmsObject)

setKey

public void setKey(java.lang.String key)

Sets the key.

Parameters:

key - the key to set

setup

public boolean setup(CmsObject cms,
                     CmsToolRootHandler root,
                     java.lang.String resourcePath)

Description copied from class: A_CmsToolHandler

Default implementation.

It takes the icon path from 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 CmsPropertyDefinition.PROPERTY_NAVINFO property, the position from the 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

Specified by:

setup in interface I_CmsToolHandler

Overrides:

setup in class A_CmsToolHandler

Parameters:

cms - the admin context (at opencms-workplace (re-)initialization time)

root - the root context

resourcePath - the resource path of the file/folder to use as admin tool

Returns:

false if something goes wrong

See Also:

A_CmsToolHandler.setup(org.opencms.file.CmsObject, org.opencms.workplace.tools.CmsToolRootHandler, java.lang.String)

setUri

public void setUri(java.lang.String uri)

Sets the uri.

Parameters:

uri - the uri to set