Package org.opencms.workplace.tools

Interface I_CmsHtmlIconButton

All Known Implementing Classes:
A_CmsHtmlIconButton
public interface I_CmsHtmlIconButton
Interface for html buttons with icon.

Since:
6.0.0

  • Method Details

    • buttonHtml

      String buttonHtml(CmsWorkplace wp)
      Returns the necessary html code.

      Parameters:
      wp - the jsp page to write the code to
      Returns:
      html code

    • getHelpText

      CmsMessageContainer getHelpText()
      Returns the help text.

      Returns:
      the help text

    • getIconPath

      String getIconPath()
      Returns the path to the icon.

      Returns:
      the path to the icon

    • getId

      String getId()
      Returns the id of the html component.

      Returns:
      the id

    • getName

      CmsMessageContainer getName()
      Returns the display name.

      Returns:
      the display name

    • isEnabled

      boolean isEnabled()
      Returns if enabled or disabled.

      Returns:
      if enabled or disabled

    • isVisible

      boolean isVisible()
      Returns if visible or not.

      Returns:
      if visible or not

    • setEnabled

      void setEnabled(boolean enabled)
      Sets if enabled or disabled.

      Parameters:
      enabled - if enabled or disabled

    • setHelpText

      void setHelpText(CmsMessageContainer helpText)
      Sets the help Text.

      Parameters:
      helpText - the help Text to set

    • setIconPath

      void setIconPath(String iconPath)
      Sets the icon Path.

      Parameters:
      iconPath - the icon Path to set

    • setName

      void setName(CmsMessageContainer name)
      Sets the name.

      Parameters:
      name - the name to set

    • setVisible

      void setVisible(boolean visible)
      Sets if visible or not.

      Parameters:
      visible - if visible or not