Class MenuItem

java.lang.Object
org.apache.maven.doxia.site.LinkItem
org.apache.maven.doxia.site.MenuItem
All Implemented Interfaces:
Serializable, Cloneable
public class MenuItem extends LinkItem implements Serializable, Cloneable
A menu item.
Version:
$Revision$ $Date$
See Also:

  • Field Details

    • collapse

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

    • ref

      private 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 List<MenuItem> items
      Field items.

  • Constructor Details

    • MenuItem

      public MenuItem()

  • Method Details

    • addItem

      public void addItem(MenuItem menuItem)
      Method addItem.
      Parameters:
      menuItem - a menuItem object.

    • clone

      public MenuItem clone()
      Method clone.
      Overrides:
      clone in class LinkItem
      Returns:
      MenuItem

    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class LinkItem
      Parameters:
      other - a other object.
      Returns:
      boolean

    • getItems

      public List<MenuItem> getItems()
      Method getItems.
      Returns:
      List

    • getRef

      public 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 - a menuItem object.

    • setCollapse

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

    • setItems

      public void setItems(List<MenuItem> items)
      Set a list of menu item.
      Parameters:
      items - a items object.

    • setRef

      public void setRef(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 - a ref object.

    • toString

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