Package javax.help

Class TOCItem

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
SearchTOCItem

public class TOCItem extends TreeItem
A class for individual TOC items
See Also:
  • Constructor Details

    • 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.
      image - The ID for image to be displayed for this item. A null image is valid.
      lang - The locale for this item. A null locale indicates the default locale.
    • 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.
      image - The image to be displayed for this item.
      lang - The locale for this item
    • TOCItem

      public TOCItem()
      Creates a default TOCItem.
  • Method Details

    • getImageID

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