Package org.opencms.gwt.shared

Class CmsContextMenuEntryBean

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

  • Constructor Details

    • CmsContextMenuEntryBean

      public CmsContextMenuEntryBean()
      Default Constructor.

    • CmsContextMenuEntryBean

      public CmsContextMenuEntryBean(boolean active, boolean visible, String jspPath, String label, String name, String reason, boolean separator, 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 Details

    • getIconClass

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

      Returns:
      the CSS class for the icon

    • getJspPath

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

      Returns:
      the jsp path

    • getLabel

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

      Returns:
      the label

    • getName

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

      Returns:
      the name of the entry

    • getParams

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

      Returns:
      the parameters

    • getReason

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

      Returns:
      the reason

    • getSubMenu

      public List<CmsContextMenuEntryBean> getSubMenu()
      Returns the sub menu entries.

      Returns:
      the entries of the sub menu

    • 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(String iconClass)
      Sets CSS class to display an icon.

      Parameters:
      iconClass - the CSS class for the icon

    • setJspPath

      public void setJspPath(String jspPath)
      Sets the jspPath.

      Parameters:
      jspPath - the jspPath to set

    • setLabel

      public void setLabel(String label)
      Sets the label.

      Parameters:
      label - the label to set

    • setName

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

      Parameters:
      name - the name to set

    • setParams

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

      Parameters:
      params - the parameters for the context menu command

    • setReason

      public void setReason(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

    • setSubMenu

      public void setSubMenu(List<CmsContextMenuEntryBean> subMenu)
      Sets the subMenu.

      Parameters:
      subMenu - the subMenu to set

    • setVisible

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

      Parameters:
      visible - the enabled to set