com.neurosys.menu.model

Class MenuItem<M extends MenuItem>

java.lang.Object

com.neurosys.menu.model.MenuItem<M>

All Implemented Interfaces:

AbsrtactHierarchialItem<M>, Serializable, Comparable<M>

Direct Known Subclasses:

AuthorizableMenuItem, AutoGenMenuItem, CustomAutoNav.CustomMenuItem, RollOverMenuItem

public class MenuItem<M extends MenuItem>
extends Object
implements Serializable, AbsrtactHierarchialItem<M>, Comparable<M>

Represents a Generic Menu Item. If children is null then it is a node element
Note: Menu names are case insensitive while comparing.

Author:

Arjun Dhar

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MenuItem()

Method Summary

Modifier and Type	Method and Description
int	compareTo(MenuItem mi)
boolean	equals(Object o) Compares the refId as long as they are not null.
List<M>	getChildren() Represents the Children sub-menu items of this item
Integer	getLevel() Indicate how down in the hierarchy is this.
String	getName() Name / id
MenuItem	getParent() Deprecated. see children : Not sufficient use cases currently to support that this is required. It adds overhead to maintain this field that may not be required.
String	getRefId() A String that denotes where the item Points to.
int	hashCode()
boolean	isNavigable() true indicates that if refId is available then one can navigate using this item.
void	setChildren(List<M> children) Represents the Children sub-menu items of this item
void	setLevel(Integer level) Indicate how down in the hierarchy is this.
void	setName(String name) Name / id
void	setNavigable(boolean navigatable) true indicates that if refId is available then one can navigate using this item.
void	setParent(M parent) Deprecated. see children : Not sufficient use cases currently to support that this is required. It adds overhead to maintain this field that may not be required.
void	setRefId(String refId) A String that denotes where the item Points to.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuItem

public MenuItem()

Method Detail

getName

public String getName()

Name / id

setName

public void setName(String name)

Name / id

getRefId

public String getRefId()

A String that denotes where the item Points to. A URL, An id that the system can interpret it. The value depends on the context it is used in.

setRefId

public void setRefId(String refId)

A String that denotes where the item Points to. A URL, An id that the system can interpret it. The value depends on the context it is used in.

getChildren

public List<M> getChildren()

Represents the Children sub-menu items of this item

Specified by:

getChildren in interface AbsrtactHierarchialItem<M extends MenuItem>

Returns:

List of same type

Can be null:

true

setChildren

public void setChildren(List<M> children)

Represents the Children sub-menu items of this item

Can be null:

true

isNavigable

public boolean isNavigable()

true indicates that if refId is available then one can navigate using this item. If false means that irrespective of refId provided in the DataModel, on rendering the navigation link will not appear / it will be muted / disabled.
One could remove a Non navigable node from the model however in SOME cases we want to show the TREE specially if it has children, we would want it to remain as part of the path and some complex scenarios.

setNavigable

public void setNavigable(boolean navigatable)

true indicates that if refId is available then one can navigate using this item. If false means that irrespective of refId provided in the DataModel, on rendering the navigation link will not appear / it will be muted / disabled.
One could remove a Non navigable node from the model however in SOME cases we want to show the TREE specially if it has children, we would want it to remain as part of the path and some complex scenarios.

getParent

@Deprecated
public MenuItem getParent()

Deprecated. see children : Not sufficient use cases currently to support that this is required. It adds overhead to maintain this field that may not be required.

Returns:

MenuItem

Can be null:

true

setParent

@Deprecated
public void setParent(M parent)

Deprecated. see children : Not sufficient use cases currently to support that this is required. It adds overhead to maintain this field that may not be required.

Parameters:

parent -

Can be null:

true

getLevel

public Integer getLevel()

Indicate how down in the hierarchy is this. 0 indicated Root level.
null means not defined for this Menu logic.

Specified by:

getLevel in interface AbsrtactHierarchialItem<M extends MenuItem>

Can be null:

true

Default value:

null

setLevel

public void setLevel(Integer level)

Indicate how down in the hierarchy is this. 0 indicated Root level.
null means not defined for this Menu logic.

Can be null:

true

Default value:

null

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Compares the refId as long as they are not null. By default compared the refid to ensure, the exact same Menu Item, since names *may* match/duplicate in a different part of the menu hierarchy. TODO: Add unit test case

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(MenuItem mi)

Specified by:

compareTo in interface Comparable<M extends MenuItem>