Package de.uplanet.lucy.server.menu.rt

Class AbstractMenuItem

java.lang.Object
de.uplanet.lucy.server.menu.rt.AbstractMenuItem
All Implemented Interfaces:
IMenuItem, Cloneable
Direct Known Subclasses:
AbstractContainerMenuItem, ApplicationMenuItem, LinkMenuItem, SeparatorMenuItem
public abstract class AbstractMenuItem extends Object implements IMenuItem

  • Constructor Details

    • AbstractMenuItem

      public AbstractMenuItem(String p_strId)

  • Method Details

    • clone

      public abstract AbstractMenuItem clone()

    • getGuid

      public String getGuid()
      Description copied from interface: IMenuItem
      Get the menu item's unique identifier.
      Specified by:
      getGuid in interface IMenuItem
      Returns:
      The menu item's unique identifier.

    • isRootMenuItem

      public boolean isRootMenuItem()
      Description copied from interface: IMenuItem
      Indicates if this is the root menu item.
      Specified by:
      isRootMenuItem in interface IMenuItem
      Returns:
      Always false.

    • isApplicationMenuItem

      public boolean isApplicationMenuItem()
      Description copied from interface: IMenuItem
      Indicates if this menu item is an application menu item.
      Specified by:
      isApplicationMenuItem in interface IMenuItem
      Returns:
      Always false.

    • isLinkMenuItem

      public boolean isLinkMenuItem()
      Description copied from interface: IMenuItem
      Indicates if this menu item is a link menu item.
      Specified by:
      isLinkMenuItem in interface IMenuItem
      Returns:
      Always false.

    • isCmsMenuItem

      public boolean isCmsMenuItem()
      Description copied from interface: IMenuItem
      Indicates if this menu item is a CMS menu item.
      Specified by:
      isCmsMenuItem in interface IMenuItem
      Returns:
      Always false.

    • isSeparatorMenuItem

      public boolean isSeparatorMenuItem()
      Description copied from interface: IMenuItem
      Indicates if this menu item is a separator.
      Specified by:
      isSeparatorMenuItem in interface IMenuItem
      Returns:
      Always false.

    • isContainerMenuItem

      public boolean isContainerMenuItem()
      Description copied from interface: IMenuItem
      Indicates if this menu item is a container.
      Specified by:
      isContainerMenuItem in interface IMenuItem
      Returns:
      Always false.

    • isTopLevelGroupMenuItem

      public boolean isTopLevelGroupMenuItem()
      Description copied from interface: IMenuItem
      Indicates if this menu item is a top-level group.
      Specified by:
      isTopLevelGroupMenuItem in interface IMenuItem
      Returns:
      Always false.

    • getLevel

      public int getLevel()
      Description copied from interface: IMenuItem
      Get the level of this menu item. 0 for menu items that do not have a parent.
      Specified by:
      getLevel in interface IMenuItem
      Returns:
      The level of this menu item.

    • getLevelRelative

      public int getLevelRelative(IMenuItem p_menuItem)
      Description copied from interface: IMenuItem
      Get the level of this menu item relative to the given menu item.
      Specified by:
      getLevelRelative in interface IMenuItem
      Returns:
      The relative level of this menu item.

    • hasParent

      public boolean hasParent()
      Description copied from interface: IMenuItem
      Indicates if this menu item has a parent.
      Specified by:
      hasParent in interface IMenuItem
      Returns:
      true if this menu item has a parent or false otherwise.

    • getParent

      public AbstractContainerMenuItem getParent()
      Description copied from interface: IMenuItem
      Get the parent of this menu item.
      Specified by:
      getParent in interface IMenuItem
      Returns:
      The parent of this menu item, or null if this menu item has no parent.

    • isFirstChild

      public boolean isFirstChild()
      Description copied from interface: IMenuItem
      Check if this menu item is the first child of it's parent.
      Specified by:
      isFirstChild in interface IMenuItem
      Returns:
      true if this menu item has a parent and is the first child of this parent, or false otherwise.

    • isLastChild

      public boolean isLastChild()
      Description copied from interface: IMenuItem
      Check if this menu item is the last child of it's parent.
      Specified by:
      isLastChild in interface IMenuItem
      Returns:
      true if this menu item has a parent and is the last child of this parent, or false otherwise.

    • getPreviousSibling

      public IMenuItem getPreviousSibling()
      Description copied from interface: IMenuItem
      Get the previous sibling of this menu item.
      Specified by:
      getPreviousSibling in interface IMenuItem
      Returns:
      If this menu item has a parent and this menu item is not the first child of this parent, the previous sibling of this menu item is returned. In all other cases the return value is null.

    • getNextSibling

      public IMenuItem getNextSibling()
      Description copied from interface: IMenuItem
      Get the next sibling of this menu item.
      Specified by:
      getNextSibling in interface IMenuItem
      Returns:
      If this menu item has a parent and this menu item is not the last child of this parent, the next sibling of this menu item is returned. In all other cases the return value is null.

    • hasProperty

      public boolean hasProperty(String p_strLang)
      Description copied from interface: IMenuItem
      Test if this menu item has the given property.
      Specified by:
      hasProperty in interface IMenuItem
      Parameters:
      p_strLang - The property name.
      Returns:
      true if this menu item has the property, or false otherwise.

    • getProperty

      public String getProperty(String p_strName)
      Description copied from interface: IMenuItem
      Get the value of the given property
      Specified by:
      getProperty in interface IMenuItem
      Parameters:
      p_strName - The property name.
      Returns:
      The value of the property.

    • getProperties

      public SortedMap<String,String> getProperties()
      Description copied from interface: IMenuItem
      Get the menu item's properties.
      Specified by:
      getProperties in interface IMenuItem
      Returns:
      An immutable map of the menu item's properties, never null.

    • hasName

      public boolean hasName(String p_strLang)
      Description copied from interface: IMenuItem
      Test if this menu item has a name in the specified language.
      Specified by:
      hasName in interface IMenuItem
      Parameters:
      p_strLang - The language.
      Returns:
      true if this menu item has a name in the given language, or false otherwise.

    • getName

      public String getName(String p_strLang)
      Description copied from interface: IMenuItem
      Get the name of this menu item in the specified language.
      Specified by:
      getName in interface IMenuItem
      Parameters:
      p_strLang - The language.
      Returns:
      The name of the menu item in the given language.

    • getNames

      public SortedMap<String,String> getNames()
      Description copied from interface: IMenuItem
      Get the menu item's language dependent names.
      Specified by:
      getNames in interface IMenuItem
      Returns:
      An immutable map of the menu item's names, never null.