Package javax.help
Class TreeItem
java.lang.Object
javax.help.TreeItem
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
FavoritesItem
,IndexItem
,TOCItem
The base items known to TOC, Index and Favorites Navigators.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Show the children of the node collapsed in the viewstatic final int
A state of expansion determined by the viewstatic final int
Show the children of the node expanded in the viewprotected Locale
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the exansion typeReturns the HelpSet scoping this IndexItem.getID()
Returns the ID for the item.Returns the locale for the item.Returns the merge type for the itemgetName()
Returns the name of the item.Returns the presentationReturns the presentation namegetURL()
Returns the URL for the item.void
setExpansionType
(int type) Sets the expansion typevoid
setHelpSet
(HelpSet hs) Set the HelpSet for this TreeItem.void
Set the ID for the item.void
setMergeType
(String mergeType) Sets the merge typevoid
Sets the name of the item.void
setPresentation
(String presentation) Sets the presentationvoid
setPresentationName
(String presentationName) Sets the presentation nametoString()
Returns a String used when displaying the object.
-
Field Details
-
DEFAULT_EXPANSION
public static final int DEFAULT_EXPANSIONA state of expansion determined by the view- See Also:
-
COLLAPSE
public static final int COLLAPSEShow the children of the node collapsed in the view- See Also:
-
EXPAND
public static final int EXPANDShow the children of the node expanded in the view- See Also:
-
locale
-
-
Constructor Details
-
TreeItem
Create an TreeItem.- Parameters:
id
- ID for the item. The ID can be null.hs
- A HelpSet scoping this item.locale
- The locale for this item
-
TreeItem
Creates a TreeItem.- Parameters:
id
- ID for the item. Null is a valid ID.The
- lang for this item. A null is valid and indicates the default locale.
-
TreeItem
Creates a TreeItem.- Parameters:
name
- The name for the item.
-
TreeItem
public TreeItem()Creates an empty TreeItem.
-
-
Method Details
-
setName
Sets the name of the item. -
getName
Returns the name of the item. -
setID
Set the ID for the item. -
getID
Returns the ID for the item. -
getURL
Returns the URL for the item. -
setHelpSet
Set the HelpSet for this TreeItem. -
getHelpSet
Returns the HelpSet scoping this IndexItem. Will return the ID HelpSet if one exists. Null otherwise -
getLocale
Returns the locale for the item. -
setMergeType
Sets the merge type -
getMergeType
Returns the merge type for the item -
setExpansionType
public void setExpansionType(int type) Sets the expansion type- Throws:
IllegalArgumentException
- if not a valid type
-
getExpansionType
public int getExpansionType()Returns the exansion type -
setPresentation
Sets the presentation- See Also:
-
getPresentation
Returns the presentation- See Also:
-
setPresentationName
Sets the presentation name- See Also:
-
getPresentationName
Returns the presentation name- See Also:
-
toString
Returns a String used when displaying the object. Used by CellRenderers.
-