Class CmsAdminMenuItem

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsAdminMenuItem​(java.lang.String id, java.lang.String name, java.lang.String iconPath, java.lang.String link, java.lang.String helpText, boolean enabled, java.lang.String target)
      Default Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getHelpText()
      Returns the help text.
      java.lang.String getIconPath()
      Returns the path to the icon.
      java.lang.String getId()
      Returns the dhtml unique id.
      java.lang.String getLink()
      Returns the link.
      java.lang.String getName()
      Returns the display name.
      java.lang.String getTarget()
      Returns the target.
      boolean isEnabled()
      Returns if enabled or disabled.
      java.lang.String itemHtml​(org.opencms.workplace.CmsWorkplace wp)
      Returns the necessary html code.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CmsAdminMenuItem

        public CmsAdminMenuItem​(java.lang.String id,
                                java.lang.String name,
                                java.lang.String iconPath,
                                java.lang.String link,
                                java.lang.String helpText,
                                boolean enabled,
                                java.lang.String target)
        Default Constructor.

        Parameters:
        id - a unique id
        name - the name of the item
        iconPath - the icon to display
        link - the link to open when selected
        helpText - the help text to display
        enabled - if enabled or not
        target - the target frame to open the link into
    • Method Detail

      • getHelpText

        public java.lang.String getHelpText()
        Returns the help text.

        Returns:
        the help text
      • getIconPath

        public java.lang.String getIconPath()
        Returns the path to the icon.

        Returns:
        the path to the icon
      • getId

        public java.lang.String getId()
        Returns the dhtml unique id.

        Returns:
        the dhtml unique id
      • getLink

        public java.lang.String getLink()
        Returns the link.

        Returns:
        the link
      • getName

        public java.lang.String getName()
        Returns the display name.

        Returns:
        the name
      • getTarget

        public java.lang.String getTarget()
        Returns the target.

        Returns:
        the target
      • isEnabled

        public boolean isEnabled()
        Returns if enabled or disabled.

        Returns:
        if enabled or disabled
      • itemHtml

        public java.lang.String itemHtml​(org.opencms.workplace.CmsWorkplace wp)
        Returns the necessary html code.

        Parameters:
        wp - the workplace
        Returns:
        html code