java.io.Serializable
public class TOCView extends NavigatorView
Modifier and Type | Class | Description |
---|---|---|
static class |
TOCView.DefaultTOCFactory |
A default TreeItemFactory that can be used to parse TOC items as used
by this navigator.
|
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
publicIDString |
PublicID (known to this XML processor) to the DTD for version 1.0 of the TOC.
|
static java.lang.String |
publicIDString_V2 |
PublicID (known to this XML processor) to the DTD for version 2.0 of the TOC.
|
Constructor | Description |
---|---|
TOCView(HelpSet hs,
java.lang.String name,
java.lang.String label,
java.util.Hashtable params) |
Constructs a TOC VIew with some given data.
|
TOCView(HelpSet hs,
java.lang.String name,
java.lang.String label,
java.util.Locale locale,
java.util.Hashtable params) |
Constructs a TOC VIew with some given data.
|
Modifier and Type | Method | Description |
---|---|---|
java.awt.Component |
createNavigator(HelpModel model) |
Creates a navigator for a given model.
|
Map.ID |
getCategoryClosedImageID() |
Returns the default category closed image ID.
|
Map.ID |
getCategoryOpenImageID() |
Returns the default category open image ID.
|
javax.swing.tree.DefaultMutableTreeNode |
getDataAsTree() |
Public method that gets a DefaultMutableTreeNode representing the information in this
view instance.
|
java.lang.String |
getMergeType() |
Get the TOC navigators mergeType.
|
Map.ID |
getTopicImageID() |
Returns the topic image ID.
|
static javax.swing.tree.DefaultMutableTreeNode |
parse(java.net.URL url,
HelpSet hs,
java.util.Locale locale,
TreeItemFactory factory) |
Public method for parsing a TOC in a URL.
|
static javax.swing.tree.DefaultMutableTreeNode |
parse(java.net.URL url,
HelpSet hs,
java.util.Locale locale,
TreeItemFactory factory,
TOCView view) |
Public method for parsing a TOC in a URL.
|
void |
setCategoryClosedImageID(java.lang.String imageID) |
Set the default category closed image ID.
|
void |
setCategoryOpenImageID(java.lang.String imageID) |
Set the default category open image ID.
|
void |
setTopicImageID(java.lang.String imageID) |
Set the topic image ID
param String ID for the topic image
|
create, getHelpSet, getImageID, getLabel, getLabel, getLocale, getName, getParameters
public static final java.lang.String publicIDString
public static final java.lang.String publicIDString_V2
public TOCView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Hashtable params)
hs
- The HelpSet that provides context information.name
- The name of the View.label
- The label (to show the user) of the View.params
- A hashtable that provides different key/values for this type.public TOCView(HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.util.Hashtable params)
hs
- The HelpSet that provides context information.name
- The name of the View.label
- The label (to show the user) of the View.locale
- The default locale to interpret the data in this TOC.params
- A hashtable that provides different key/values for this type.public java.awt.Component createNavigator(HelpModel model)
createNavigator
in class NavigatorView
model
- The model for the Navigator.public java.lang.String getMergeType()
getMergeType
in class NavigatorView
public javax.swing.tree.DefaultMutableTreeNode getDataAsTree()
public static javax.swing.tree.DefaultMutableTreeNode parse(java.net.URL url, HelpSet hs, java.util.Locale locale, TreeItemFactory factory)
url
- Where the TOC lives. If null, returns a null value.hs
- The HelpSet context for this TOC. Null hs is ignored.locale
- The default locale to interpret the data in this TOC. Null locale
is treated as the default locale.factory
- A factory instance used to create the TOCItems.public static javax.swing.tree.DefaultMutableTreeNode parse(java.net.URL url, HelpSet hs, java.util.Locale locale, TreeItemFactory factory, TOCView view)
url
- Where the TOC lives. If null, returns a null value.hs
- The HelpSet context for this TOC. Null hs is ignored.locale
- The default locale to interpret the data in this TOC. Null locale
is treated as the default locale.factory
- A factory instance used to create the TOCItems.view
- The TOCView instance. May be nullpublic void setCategoryOpenImageID(java.lang.String imageID)
public Map.ID getCategoryOpenImageID()
public void setCategoryClosedImageID(java.lang.String imageID)
public Map.ID getCategoryClosedImageID()
public void setTopicImageID(java.lang.String imageID)
public Map.ID getTopicImageID()