Package org.opencms.workplace.tools

Class CmsInvisibleToolHandler

java.lang.Object

org.opencms.workplace.tools.A_CmsToolHandler

org.opencms.workplace.tools.CmsInvisibleToolHandler

All Implemented Interfaces:

I_CmsToolHandler

public class CmsInvisibleToolHandler
extends A_CmsToolHandler

This tool handler just hides the tool for the user, but the tool can still be invoked explicitly, usefull for tool that requires an argument, like edit tools.

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
CmsInvisibleToolHandler()

Method Summary

Modifier and Type	Method	Description
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.

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, setup, toString

Methods inherited from class java.lang.Object

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

Constructor Details

CmsInvisibleToolHandler

public CmsInvisibleToolHandler()

Method Details

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)