Class MenuItem

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class MenuItem
    extends LinkItem
    implements java.io.Serializable, java.lang.Cloneable
    A menu item.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Field Detail

      • description

        private java.lang.String description
        A description of the menu item. This is used on any summary pages for a menu.
      • collapse

        private boolean collapse
        Whether to collapse children elements of an item menu (by default).
      • ref

        private java.lang.String ref
        A reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.
      • items

        private java.util.List<MenuItem> items
        Field items.
    • Constructor Detail

      • MenuItem

        public MenuItem()
    • Method Detail

      • addItem

        public void addItem​(MenuItem menuItem)
        Method addItem.
        Parameters:
        menuItem -
      • equals

        public boolean equals​(java.lang.Object other)
        Method equals.
        Overrides:
        equals in class LinkItem
        Parameters:
        other -
        Returns:
        boolean
      • getDescription

        public java.lang.String getDescription()
        Get a description of the menu item. This is used on any summary pages for a menu.
        Returns:
        String
      • getItems

        public java.util.List<MenuItem> getItems()
        Method getItems.
        Returns:
        List
      • getRef

        public java.lang.String getRef()
        Get a reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.
        Returns:
        String
      • hashCode

        public int hashCode()
        Method hashCode.
        Overrides:
        hashCode in class LinkItem
        Returns:
        int
      • isCollapse

        public boolean isCollapse()
        Get whether to collapse children elements of an item menu (by default).
        Returns:
        boolean
      • removeItem

        public void removeItem​(MenuItem menuItem)
        Method removeItem.
        Parameters:
        menuItem -
      • setCollapse

        public void setCollapse​(boolean collapse)
        Set whether to collapse children elements of an item menu (by default).
        Parameters:
        collapse -
      • setDescription

        public void setDescription​(java.lang.String description)
        Set a description of the menu item. This is used on any summary pages for a menu.
        Parameters:
        description -
      • setItems

        public void setItems​(java.util.List<MenuItem> items)
        Set a list of menu item.
        Parameters:
        items -
      • setRef

        public void setRef​(java.lang.String ref)
        Set a reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.
        Parameters:
        ref -
      • toString

        public java.lang.String toString()
        Method toString.
        Overrides:
        toString in class LinkItem
        Returns:
        String