com.highqsoft.fwk.application.help

Class FwkHelpTOCView

java.lang.Object

javax.help.NavigatorView

javax.help.TOCView

com.highqsoft.fwk.application.help.FwkHelpTOCView

All Implemented Interfaces:

FwkInterface, java.io.Serializable

public class FwkHelpTOCView
extends javax.help.TOCView
implements FwkInterface

The FwkHelpTOCView.

Since:

$Date: 2017/04/06 13:29:03 $

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.help.TOCView

javax.help.TOCView.DefaultTOCFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version

Fields inherited from class javax.help.TOCView

publicIDString

Constructor Summary

Constructors

Constructor and Description
FwkHelpTOCView(javax.help.HelpSet hs, java.lang.String name, java.lang.String label, java.util.Hashtable params) Constructs a TOC VIew with some given data.
FwkHelpTOCView(javax.help.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.

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Component	createNavigator(javax.help.HelpModel model) Creates a navigator for a given model.
java.lang.String	getVersion() Return the version string of the FWK component.
void	release() Release the object.
java.lang.String	toString() Get the string representation of the object.

Methods inherited from class javax.help.TOCView

getDataAsTree, parse

Methods inherited from class javax.help.NavigatorView

create, getHelpSet, getImageID, getLabel, getLabel, getLocale, getName, getParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

FwkHelpTOCView

public FwkHelpTOCView(javax.help.HelpSet hs,
              java.lang.String name,
              java.lang.String label,
              java.util.Hashtable params)

Constructs a TOC VIew with some given data. Locale defaults to that of the HelpSet.

Parameters:

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.

FwkHelpTOCView

public FwkHelpTOCView(javax.help.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.

Parameters:

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.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

createNavigator

public java.awt.Component createNavigator(javax.help.HelpModel model)

Creates a navigator for a given model.

Overrides:

createNavigator in class javax.help.TOCView

Parameters:

model - The help model.

Returns:

The TOC navigator.

toString

public java.lang.String toString()

Get the string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of the object.