javax.help

Class SearchTOCItem

Implemented Interfaces:
Serializable

public class SearchTOCItem
extends TOCItem

Stores Search TOC items. This class extends TOCItems with additonal search hits. Can be used as part of the TOC tree or as an appendage to the tree for items not contained in the tree.

Field Summary

Fields inherited from class javax.help.TreeItem

COLLAPSE, DEFAULT_EXPANSION, EXPAND, locale

Constructor Summary

SearchTOCItem(Map.ID id, Map.ID imageID, HelpSet hs, Locale locale)
Creates a TOCItem.
SearchTOCItem(SearchItem item)

Method Summary

void
addSearchHit(SearchHit si)
Adds a SearchHit.
double
getConfidence()
Enumeration
getConfidences()
Enumeration
getSearchHits()
URL
getURL()
Returns the URL for the item.
int
hitCount()
boolean
inTOC()

Methods inherited from class javax.help.TOCItem

getImageID

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

SearchTOCItem

public SearchTOCItem(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.

SearchTOCItem

public SearchTOCItem(SearchItem item)

Method Details

addSearchHit

public void addSearchHit(SearchHit si)
Adds a SearchHit.

getConfidence

public double getConfidence()

getConfidences

public Enumeration getConfidences()

getSearchHits

public Enumeration getSearchHits()

getURL

public URL getURL()
Returns the URL for the item.
Overrides:
getURL in interface TreeItem

hitCount

public int hitCount()

inTOC

public boolean inTOC()