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 Description TOCItem()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 childTOCItem
s.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)
IntegrationPoint
s setter.String
toString()
-
-
-
Method Detail
-
setTOCItems
public void setTOCItems(List<TOCItem> tocItems)
IntegrationPoint
s 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
. This value is NOT automatically set, it must be calculated and set during initialization code.foo
, the target path should look something like:moduleId/en/help/foo.html
-
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. Thetext
andexpand
values are not used to test for equality.
-
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.
-
-