Package org.opencms.workplace.tools
Class CmsOfflineToolHandler
- java.lang.Object
-
- org.opencms.workplace.tools.A_CmsToolHandler
-
- org.opencms.workplace.tools.CmsDefaultToolHandler
-
- org.opencms.workplace.tools.CmsOfflineToolHandler
-
- All Implemented Interfaces:
I_CmsToolHandler
public class CmsOfflineToolHandler extends CmsDefaultToolHandler
This tool handler disables the tool if in online project.- 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 CmsOfflineToolHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDisabledHelpText()
Returns the help text if disabled.boolean
isEnabled(CmsObject cms)
Returns the state of the admin tool for a given cms context.-
Methods inherited from class org.opencms.workplace.tools.CmsDefaultToolHandler
isVisible
-
Methods inherited from class org.opencms.workplace.tools.A_CmsToolHandler
getConfirmationMessage, 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
-
-
-
-
Constructor Detail
-
CmsOfflineToolHandler
public CmsOfflineToolHandler()
-
-
Method Detail
-
getDisabledHelpText
public java.lang.String getDisabledHelpText()
Description copied from interface:I_CmsToolHandler
Returns the help text if disabled.- Specified by:
getDisabledHelpText
in interfaceI_CmsToolHandler
- Overrides:
getDisabledHelpText
in classA_CmsToolHandler
- Returns:
- the help text if disabled
- See Also:
A_CmsToolHandler.getDisabledHelpText()
-
isEnabled
public boolean isEnabled(CmsObject cms)
Description copied from interface:I_CmsToolHandler
Returns the state of the admin tool for a given cms context.- Specified by:
isEnabled
in interfaceI_CmsToolHandler
- Overrides:
isEnabled
in classCmsDefaultToolHandler
- Parameters:
cms
- the cms context- Returns:
true
if enabled- See Also:
I_CmsToolHandler.isEnabled(org.opencms.file.CmsObject)
-
-