org.glassfish.admingui.connector

Class TOCItem

java.lang.Object

org.glassfish.admingui.connector.TOCItem

public class TOCItem
extends Object

This class is configured via XML (i.e. a console-config.xml file). This is done via the HK2 ConfigParser.

Author:

Ken Paulsen ([email protected])

Constructor Summary

Constructors

Constructor and Description
TOCItem()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) This method provides the "equals" functionality for TOCItem.
String	getTarget()
String	getTargetPath() This method returns the path to the target HTML page, starting with the moduleId.
String	getText()
List<TOCItem>	getTOCItems() Accessor for child TOCItems.
int	hashCode() This method is overriden to help ensure consistency for equals() comparisons.
boolean	isExpand()
void	setTargetPath(String targetPath) Sets the target path.
void	setTOCItems(List<TOCItem> tocItems) IntegrationPoints setter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TOCItem

public TOCItem()

Method Detail

getTOCItems

public List<TOCItem> getTOCItems()

Accessor for child TOCItems.

setTOCItems

public void setTOCItems(List<TOCItem> tocItems)

IntegrationPoints setter.

isExpand

public boolean isExpand()

getTarget

public String getTarget()

getTargetPath

public String getTargetPath()

This method returns the path to the target HTML page, starting with the moduleId. It does not add anything before the module id, and does not have a leading '/' character. It does append ".html" to the end of the target.

setTargetPath

public void setTargetPath(String targetPath)

Sets the target path. If the "target" is foo, the target path should look something like: moduleId/en/help/foo.html

. This value is NOT automatically set, it must be calculated and set during initialization code.

getText

public String getText()

equals

public boolean equals(Object obj)

This method provides the "equals" functionality for TOCItem. The behavior of equals ONLY compares the target value. The text and expand values are not used to test for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

This method is overriden to help ensure consistency for equals() comparisons. As such it simply returns the hashCode of the String (target) that is used in the equals comparison.

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object