Package org.opencms.gwt.shared

Class CmsContextMenuEntryBean

  • All Implemented Interfaces:
    com.google.gwt.user.client.rpc.IsSerializable
    public class CmsContextMenuEntryBean
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable
    A context menu entry bean.

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsContextMenuEntryBean()
      Default Constructor.
      CmsContextMenuEntryBean​(boolean active, boolean visible, java.lang.String jspPath, java.lang.String label, java.lang.String name, java.lang.String reason, boolean separator, java.util.List<CmsContextMenuEntryBean> subMenu)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getIconClass()
      Gets the CSS class used to display an item.
      java.lang.String getJspPath()
      Returns the jsp path of the menu entry.
      java.lang.String getLabel()
      Returns the label of the menu entry.
      java.lang.String getName()
      Returns the name of the entry.
      java.util.Map<java.lang.String,​java.lang.String> getParams()
      Gets the parameters for the context menu command.
      java.lang.String getReason()
      Returns the reason for de-activation of the menu entry.
      java.util.List<CmsContextMenuEntryBean> getSubMenu()
      Returns the sub menu entries.
      boolean hasSubMenu()
      Returns true if this menu entry has a sub menu false otherwise.
      boolean isActive()
      Returns true if this menu entry is active, false otherwise.
      boolean isSeparator()
      Returns true if this menu entry is a separator, false otherwise.
      boolean isVisible()
      Returns true if this menu entry is visible, false otherwise.
      void setActive​(boolean active)
      Sets the active.
      void setIconClass​(java.lang.String iconClass)
      Sets CSS class to display an icon.
      void setJspPath​(java.lang.String jspPath)
      Sets the jspPath.
      void setLabel​(java.lang.String label)
      Sets the label.
      void setName​(java.lang.String name)
      Sets the name of the entry.
      void setParams​(java.util.Map<java.lang.String,​java.lang.String> params)
      Sets the parameters for the context menu command.
      void setReason​(java.lang.String reason)
      Sets the reason.
      void setSeparator​(boolean separator)
      Sets the separator.
      void setSubMenu​(java.util.List<CmsContextMenuEntryBean> subMenu)
      Sets the subMenu.
      void setVisible​(boolean visible)
      Sets the visible flag.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CmsContextMenuEntryBean

        public CmsContextMenuEntryBean​(boolean active,
                               boolean visible,
                               java.lang.String jspPath,
                               java.lang.String label,
                               java.lang.String name,
                               java.lang.String reason,
                               boolean separator,
                               java.util.List<CmsContextMenuEntryBean> subMenu)
        Constructor.

        Parameters:
        active - signals if this menu entry is active
        visible - signals if this menu entry is visible
        jspPath - the JSP path for the command
        label - the label for the menu entry
        name - the name for the menu entry
        reason - the reason why this item is deactivated
        separator - signals if this entry is a separator
        subMenu - contains the sub menu of the entry

    • Method Detail

      • getIconClass

        public java.lang.String getIconClass()
        Gets the CSS class used to display an item.

        Returns:
        the CSS class for the icon

      • getJspPath

        public java.lang.String getJspPath()
        Returns the jsp path of the menu entry.

        Returns:
        the jsp path

      • getLabel

        public java.lang.String getLabel()
        Returns the label of the menu entry.

        Returns:
        the label

      • getName

        public java.lang.String getName()
        Returns the name of the entry.

        Returns:
        the name of the entry

      • getParams

        public java.util.Map<java.lang.String,​java.lang.String> getParams()
        Gets the parameters for the context menu command.

        Returns:
        the parameters

      • getReason

        public java.lang.String getReason()
        Returns the reason for de-activation of the menu entry.

        Returns:
        the reason

      • hasSubMenu

        public boolean hasSubMenu()
        Returns true if this menu entry has a sub menu false otherwise.

        Returns:
        true if this menu entry has a sub menu false otherwise

      • isActive

        public boolean isActive()
        Returns true if this menu entry is active, false otherwise.

        Returns:
        true if this menu entry is active, false otherwise

      • isSeparator

        public boolean isSeparator()
        Returns true if this menu entry is a separator, false otherwise.

        Returns:
        true if this menu entry is a separator, false otherwise

      • isVisible

        public boolean isVisible()
        Returns true if this menu entry is visible, false otherwise.

        Returns:
        true if this menu entry is visible, false otherwise

      • setActive

        public void setActive​(boolean active)
        Sets the active.

        Parameters:
        active - the active to set

      • setIconClass

        public void setIconClass​(java.lang.String iconClass)
        Sets CSS class to display an icon.

        Parameters:
        iconClass - the CSS class for the icon

      • setJspPath

        public void setJspPath​(java.lang.String jspPath)
        Sets the jspPath.

        Parameters:
        jspPath - the jspPath to set

      • setLabel

        public void setLabel​(java.lang.String label)
        Sets the label.

        Parameters:
        label - the label to set

      • setName

        public void setName​(java.lang.String name)
        Sets the name of the entry.

        Parameters:
        name - the name to set

      • setParams

        public void setParams​(java.util.Map<java.lang.String,​java.lang.String> params)
        Sets the parameters for the context menu command.

        Parameters:
        params - the parameters for the context menu command

      • setReason

        public void setReason​(java.lang.String reason)
        Sets the reason.

        Parameters:
        reason - the reason to set

      • setSeparator

        public void setSeparator​(boolean separator)
        Sets the separator.

        Parameters:
        separator - the separator to set

      • setVisible

        public void setVisible​(boolean visible)
        Sets the visible flag.

        Parameters:
        visible - the enabled to set