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 Details

    • getDisabledHelpText

      String getDisabledHelpText()
      Returns the help text if disabled.

      Returns:
      the help text if disabled

    • getGroup

      String getGroup()
      Returns the group.

      Returns:
      the group

    • getHelpText

      String getHelpText()
      Returns the help text.

      Returns:
      the help text

    • getIconPath

      String getIconPath()
      Returns the path to the icon.

      Returns:
      the path to the icon

    • getLink

      String getLink()
      Returns the link to the tool.

      Returns:
      the link

    • getName

      String getName()
      Returns the displayed name.

      Returns:
      the name

    • getParameters

      Map<String,String[]> getParameters(CmsWorkplace wp)
      Returns the evaluated map of parameters.

      Parameters:
      wp - the workplace context
      Returns:
      the parameters map

    • getPath

      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

      String getShortName()
      Returns the name for the menu or navbar.

      Returns:
      the short name

    • getConfirmationMessage

      String getConfirmationMessage()
      Returns an optional confirmation message, displayed in a js confirm dialog.

      Returns:
      the confirmation message

    • getSmallIconPath

      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, 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 context
      resourcePath - the resource path of the file/folder to use as admin tool
      Returns:
      false if something goes wrong