Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.help

Class TOCItem

Implemented Interfaces:
Serializable
Known Direct Subclasses:
SearchTOCItem
public class TOCItem
extends TreeItem
A class for individual TOC items

Field Summary

Fields inherited from class javax.help.TreeItem

COLLAPSE, DEFAULT_EXPANSION, EXPAND, locale

Constructor Summary

TOCItem()
Creates a default TOCItem.
TOCItem(Map.ID id, Map.ID imageID, Locale locale)
Creates a TOCItem with a default HelpSet based on its ID.
TOCItem(Map.ID id, Map.ID imageID, HelpSet hs, Locale locale)
Creates a TOCItem.

Method Summary

Map.ID
getImageID()
Returns the image for this TOCItem.

Methods inherited from class javax.help.TreeItem

getExpansionType, getHelpSet, getID, getLocale, getMergeType, getName, getPresentation, getPresentationName, getURL, setExpansionType, setHelpSet, setID, setMergeType, setName, setPresentation, setPresentationName, toString

Constructor Details

TOCItem

public TOCItem()
Creates a default TOCItem.

TOCItem

public TOCItem(Map.ID id,
               Map.ID imageID,
               Locale locale)
Creates a TOCItem with a default HelpSet based on its ID.
Parameters:
id - ID for the item. The ID can be null.

TOCItem

public TOCItem(Map.ID id,
               Map.ID imageID,
               HelpSet hs,
               Locale locale)
Creates a TOCItem.
Parameters:
id - ID for the item. A null ID is valid.
hs - The HelpSet scoping this item. In almost all cases this is the same as the HelpSet of the id field. A null ID is valid.

Method Details

getImageID

public Map.ID getImageID()
Returns the image for this TOCItem.

Overview Package Class Use Tree Index Deprecated About