Package org.opencms.workplace.tools
Interface I_CmsToolHandler
-
- All Known Implementing Classes:
A_CmsToolHandler
,CmsDefaultToolHandler
,CmsInvisibleToolHandler
,CmsOfflineToolHandler
,CmsOnlyAdminToolHandler
,CmsToolRootHandler
public interface I_CmsToolHandler
Interface for an admin tool handler.These handlers are created and managed by the
.CmsToolManager
- Since:
- 6.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getConfirmationMessage()
Returns an optional confirmation message, displayed in a js confirm dialog.java.lang.String
getDisabledHelpText()
Returns the help text if disabled.java.lang.String
getGroup()
Returns the group.java.lang.String
getHelpText()
Returns the help text.java.lang.String
getIconPath()
Returns the path to the icon.java.lang.String
getLink()
Returns the link to the tool.java.lang.String
getName()
Returns the displayed name.java.util.Map<java.lang.String,java.lang.String[]>
getParameters(CmsWorkplace wp)
Returns the evaluated map of parameters.java.lang.String
getPath()
Returns the tool path to install the tool in.float
getPosition()
Returns the relative position in the group.java.lang.String
getShortName()
Returns the name for the menu or navbar.java.lang.String
getSmallIconPath()
Returns the path to an optional small(16x16) icon.boolean
isEnabled(CmsObject cms)
Returns the state of the admin tool for a given cms context.boolean
isEnabled(CmsWorkplace wp)
Returns the state of the admin tool for a given workplace context.boolean
isVisible(CmsObject cms)
Returns the visibility flag for a given cms context.boolean
isVisible(CmsWorkplace wp)
Returns the visibility flag for a given workplace context.boolean
setup(CmsObject cms, CmsToolRootHandler root, java.lang.String resourcePath)
Main method that somehow setups the admin tool handler.
-
-
-
Method Detail
-
getDisabledHelpText
java.lang.String getDisabledHelpText()
Returns the help text if disabled.- Returns:
- the help text if disabled
-
getGroup
java.lang.String getGroup()
Returns the group.- Returns:
- the group
-
getHelpText
java.lang.String getHelpText()
Returns the help text.- Returns:
- the help text
-
getIconPath
java.lang.String getIconPath()
Returns the path to the icon.- Returns:
- the path to the icon
-
getLink
java.lang.String getLink()
Returns the link to the tool.- Returns:
- the link
-
getName
java.lang.String getName()
Returns the displayed name.- Returns:
- the name
-
getParameters
java.util.Map<java.lang.String,java.lang.String[]> getParameters(CmsWorkplace wp)
Returns the evaluated map of parameters.- Parameters:
wp
- the workplace context- Returns:
- the parameters map
-
getPath
java.lang.String getPath()
Returns the tool path to install the tool in.- Returns:
- the path
-
getPosition
float getPosition()
Returns the relative position in the group.- Returns:
- the position
-
getShortName
java.lang.String getShortName()
Returns the name for the menu or navbar.- Returns:
- the short name
-
getConfirmationMessage
java.lang.String getConfirmationMessage()
Returns an optional confirmation message, displayed in a js confirm dialog.- Returns:
- the confirmation message
-
getSmallIconPath
java.lang.String getSmallIconPath()
Returns the path to an optional small(16x16) icon.- Returns:
- the path to an optional small(16x16) icon
-
isEnabled
boolean isEnabled(CmsObject cms)
Returns the state of the admin tool for a given cms context.- Parameters:
cms
- the cms context- Returns:
true
if enabled
-
isVisible
boolean isVisible(CmsObject cms)
Returns the visibility flag for a given cms context.- Parameters:
cms
- the cms context- Returns:
true
if visible
-
isEnabled
boolean isEnabled(CmsWorkplace wp)
Returns the state of the admin tool for a given workplace context.- Parameters:
wp
- the workplace context- Returns:
true
if enabled
-
isVisible
boolean isVisible(CmsWorkplace wp)
Returns the visibility flag for a given workplace context.- Parameters:
wp
- the workplace context- Returns:
true
if visible
-
setup
boolean setup(CmsObject cms, CmsToolRootHandler root, java.lang.String resourcePath)
Main method that somehow setups the admin tool handler.- Parameters:
cms
- the admin context (at opencms-workplace (re-)initialization time)root
- the root contextresourcePath
- the resource path of the file/folder to use as admin tool- Returns:
false
if something goes wrong
-
-