org.apache.clerezza.platform.globalmenu

Class GlobalMenuItem

java.lang.Object

org.apache.clerezza.platform.globalmenu.GlobalMenuItem

All Implemented Interfaces:

Comparable<GlobalMenuItem>

public class GlobalMenuItem
extends Object
implements Comparable<GlobalMenuItem>

This class keeps information about an item for the global menu.

Author:

mir

Constructor Summary

Constructors

Constructor and Description
GlobalMenuItem(String path, String identifier, String label, int priority, String groupIdentifier) Creates a new GlobalMenuItem.
GlobalMenuItem(String path, String identifier, String label, String description, int priority, String groupIdentifier) Creates a new GlobalMenuItem.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(GlobalMenuItem o)
boolean	equals(Object obj)
String	getDescription() Returns the description of the menu entry.
String	getGroupIdentifier() Returns the the identifier of the group of which this menu item is part, null if this is a top-level item.
String	getIdentifier() Return the identifier of the menu entry.
String	getLabel() Returns the label of the menu entry
String	getPath() Returns the path of the resource to be shown in the menu.
int	getPriority() Returns the the priority within the group, which is used for sorting the menu Items, higher numbers appear first in the menu
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalMenuItem

public GlobalMenuItem(String path,
              String identifier,
              String label,
              int priority,
              String groupIdentifier)

Creates a new GlobalMenuItem.

Parameters:

relativeUri - of the resource to be shown in the menu.

identifier - The identifier of the menu item.

label - Specifies the label of the menu entry.

priority - the priority, higher numbers appear first in the menu

groupIdentifier - Specifies the the identifier of the group of which the menu item is part.

GlobalMenuItem

public GlobalMenuItem(String path,
              String identifier,
              String label,
              String description,
              int priority,
              String groupIdentifier)

Creates a new GlobalMenuItem.

Parameters:

relativeUri - of the resource to be shown in the menu.

identifier - The identifier of the menu item.

label - Specifies the label of the menu entry.

description - The description of the menu item.

priority - the priority, higher numbers appear first in the menu

groupIdentifier - Specifies the the identifier of the group of which the menu item is part.

Method Detail

getPath

public String getPath()

Returns the path of the resource to be shown in the menu. The path is additional to the bundle prefix and if existing to the javax.ws.rs.Path annotation of the GlobalMenuItemsProvider that returned this GlobalMenuItem.

Returns:

the path

getLabel

public String getLabel()

Returns the label of the menu entry

Returns:

the label

getDescription

public String getDescription()

Returns the description of the menu entry.

Returns:

the groupIdentifier

getIdentifier

public String getIdentifier()

Return the identifier of the menu entry.

Returns:

getPriority

public int getPriority()

Returns the the priority within the group, which is used for sorting the menu Items, higher numbers appear first in the menu

Returns:

the priority

getGroupIdentifier

public String getGroupIdentifier()

Returns the the identifier of the group of which this menu item is part, null if this is a top-level item.

Returns:

the groupIdentifier

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(GlobalMenuItem o)

Specified by:

compareTo in interface Comparable<GlobalMenuItem>