oracle.help.library.helpset
Class HelpSet

java.lang.Object
  |
  +--oracle.help.library.helpset.HelpSet

All Implemented Interfaces:

Book

public class HelpSet

extends java.lang.Object

implements Book

A robust implementation of the Book interface that supports the Oracle Help for Java extensions of the JavaHelp standard file format. This file format is described in detail in the OHJ 3.2 File Formats Document.

See Also:

Field Summary

static java.lang.String	PARAM_CLASS
static java.lang.String	PARAM_DEFAULT
static java.lang.String	PARAM_ENGINE
static java.lang.String	PARAM_ENGINEPARAMS
static java.lang.String	PARAM_ID
static java.lang.String	PARAM_IMAGE
static java.lang.String	PARAM_LOCATION
static java.lang.String	PARAM_TYPE
static java.lang.String	PARAM_URL
static java.lang.String	TAG_BG
static java.lang.String	TAG_DATA
static java.lang.String	TAG_HEIGHT
static java.lang.String	TAG_HELPSET
static java.lang.String	TAG_HOMEID
static java.lang.String	TAG_KEY
static java.lang.String	TAG_LABEL
static java.lang.String	TAG_LINKFG
static java.lang.String	TAG_LINKREF
static java.lang.String	TAG_LINKS
static java.lang.String	TAG_MAP
static java.lang.String	TAG_MAPREF
static java.lang.String	TAG_MERGETYPE
static java.lang.String	TAG_NAME
static java.lang.String	TAG_SUBHELPSET
static java.lang.String	TAG_TEXTFG
static java.lang.String	TAG_TITLE
static java.lang.String	TAG_TOOLBAR
static java.lang.String	TAG_TYPE
static java.lang.String	TAG_VIEW
static java.lang.String	TAG_WIDTH
static java.lang.String	TAG_WINTYPE
static java.lang.String	TAG_X
static java.lang.String	TAG_Y

Constructor Summary

HelpSet()
Create an empty HelpSet Note: Most clients will use the HelpSet() constructors that load help content from an existing helpset file.

HelpSet(java.lang.Class pathClass, java.lang.String pathExtension)
Create a HelpSet from the helpset file at the specified location.

HelpSet(java.lang.Class pathClass, java.lang.String pathExtension, java.lang.String helpDefaultEncoding)
Create a HelpSet from the helpset file at the specified location using the specified encoding.

HelpSet(java.net.URL fileURL)
Create a HelpSet from the helpset file at the specified location.

HelpSet(java.net.URL fileURL, java.lang.String helpDefaultEncoding)
Create a HelpSet from the helpset file at the specified location using the specified encoding.

Method Summary

oracle.help.common.View[]	getAllViews() Get all of the View objects defined in this book (views of all types).
oracle.help.common.AssociativeLink[]	getAssociativeLinks() Get the AssociativeLink objects defined in this book.
java.lang.String	getBookTitle() Get the title of the Book
java.lang.String	getHelpSetEncoding() Gets the encoding of the HelpSet, null if using the LocaleUtils default encoding
oracle.help.library.helpset.HelpSetSection[]	getHelpSetSections()
java.lang.String	getHomeID() Gets the HomeID for the HelpSet.
oracle.help.common.View[]	getViewsByType(java.lang.String type) Get the View objects defined in this book of the specified type.
oracle.help.common.WindowType[]	getWindowTypes() Get the WindowType objects defined in this book.
java.net.URL	mapIDToURL(java.lang.String id) Get the URL the Book mapped to the given ID.
java.lang.String	mapURLToWindowTypeName(java.net.URL url) Get the name of the WindowType this Book has mapped to the given URL.
void	setHomeID(java.lang.String homeID) Sets the HomeID for the HelpSet.

Methods inherited from class java.lang.Object

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

Field Detail

TAG_HELPSET

public static final java.lang.String TAG_HELPSET

TAG_TITLE

public static final java.lang.String TAG_TITLE

TAG_HOMEID

public static final java.lang.String TAG_HOMEID

TAG_SUBHELPSET

public static final java.lang.String TAG_SUBHELPSET

TAG_WINTYPE

public static final java.lang.String TAG_WINTYPE

TAG_HEIGHT

public static final java.lang.String TAG_HEIGHT

TAG_WIDTH

public static final java.lang.String TAG_WIDTH

TAG_X

public static final java.lang.String TAG_X

TAG_Y

public static final java.lang.String TAG_Y

TAG_TEXTFG

public static final java.lang.String TAG_TEXTFG

TAG_LINKFG

public static final java.lang.String TAG_LINKFG

TAG_BG

public static final java.lang.String TAG_BG

TAG_TOOLBAR

public static final java.lang.String TAG_TOOLBAR

TAG_LINKS

public static final java.lang.String TAG_LINKS

TAG_MAP

public static final java.lang.String TAG_MAP

TAG_VIEW

public static final java.lang.String TAG_VIEW

TAG_DATA

public static final java.lang.String TAG_DATA

TAG_KEY

public static final java.lang.String TAG_KEY

TAG_NAME

public static final java.lang.String TAG_NAME

TAG_TYPE

public static final java.lang.String TAG_TYPE

TAG_MERGETYPE

public static final java.lang.String TAG_MERGETYPE

TAG_LABEL

public static final java.lang.String TAG_LABEL

TAG_MAPREF

public static final java.lang.String TAG_MAPREF

TAG_LINKREF

public static final java.lang.String TAG_LINKREF

PARAM_ID

public static final java.lang.String PARAM_ID

PARAM_URL

public static final java.lang.String PARAM_URL

PARAM_CLASS

public static final java.lang.String PARAM_CLASS

PARAM_TYPE

public static final java.lang.String PARAM_TYPE

PARAM_DEFAULT

public static final java.lang.String PARAM_DEFAULT

PARAM_ENGINE

public static final java.lang.String PARAM_ENGINE

PARAM_ENGINEPARAMS

public static final java.lang.String PARAM_ENGINEPARAMS

PARAM_LOCATION

public static final java.lang.String PARAM_LOCATION

PARAM_IMAGE

public static final java.lang.String PARAM_IMAGE

Constructor Detail

HelpSet

public HelpSet()

Create an empty HelpSet Note: Most clients will use the HelpSet() constructors that load help content from an existing helpset file.

HelpSet

public HelpSet(java.lang.Class pathClass,
               java.lang.String pathExtension)
        throws HelpSetParseException

Create a HelpSet from the helpset file at the specified location.

Parameters:

baseClass - A Java class. The HelpSet uses the location of this class to determine the location of your helpset file. The dirPathExt is appended to the absolute path to the directory containing the Java class. The resulting path should be the path to your helpset file.

dirpathExt - The dirPathExt is a path appended to the absolute path to the directory containing the baseClass. The resulting path should be the path to your helpset file.

Throws:

HelpSetParseException - if the helpset cannot be parsed

HelpSet

public HelpSet(java.lang.Class pathClass,
               java.lang.String pathExtension,
               java.lang.String helpDefaultEncoding)
        throws HelpSetParseException

Create a HelpSet from the helpset file at the specified location using the specified encoding.

Parameters:

baseClass - A Java class. The HelpSet uses the location of this class to determine the location of your helpset file. The dirPathExt is appended to the absolute path to the directory containing the Java class. The resulting path should be the path to your helpset file.

dirpathExt - The dirPathExt is a path appended to the absolute path to the directory containing the baseClass. The resulting path should be the path to your helpset file.

helpDefaultEncoding -

Throws:

HelpSetParseException - if the helpset cannot be parsed

HelpSet

public HelpSet(java.net.URL fileURL)
        throws HelpSetParseException

Create a HelpSet from the helpset file at the specified location.

Parameters:

fileURL - A URL to the OHJ helpset file.

Throws:

HelpSetParseException - if the helpset cannot be parsed

HelpSet

public HelpSet(java.net.URL fileURL,
               java.lang.String helpDefaultEncoding)
        throws HelpSetParseException

Create a HelpSet from the helpset file at the specified location using the specified encoding.

Parameters:

fileURL - A URL to the OHJ helpset file.

helpDefaultEncoding -

Throws:

HelpSetParseException - if the helpset cannot be parsed

Method Detail

mapIDToURL

public java.net.URL mapIDToURL(java.lang.String id)

Description copied from interface: Book

Get the URL the Book mapped to the given ID. If the Book cannot map the topicID (i.e. the topicID is not in the book's map file) null will be returned.

Specified by:

mapIDToURL in interface Book

Following copied from interface: oracle.help.library.Book

Parameters:

id - The topicID.

mapURLToWindowTypeName

public java.lang.String mapURLToWindowTypeName(java.net.URL url)

Get the name of the WindowType this Book has mapped to the given URL. If the Book cannot map the URL to a WindowType null will be returned.

Specified by:

mapURLToWindowTypeName in interface Book

Parameters:

url - The URL to map.

getBookTitle

public java.lang.String getBookTitle()

Description copied from interface: Book

Get the title of the Book

Specified by:

getBookTitle in interface Book

getViewsByType

public oracle.help.common.View[] getViewsByType(java.lang.String type)

Description copied from interface: Book

Get the View objects defined in this book of the specified type.

Specified by:

getViewsByType in interface Book

Following copied from interface: oracle.help.library.Book

Parameters:

type - The type identifier of the views to retrieve

getAllViews

public oracle.help.common.View[] getAllViews()

Description copied from interface: Book

Get all of the View objects defined in this book (views of all types).

Specified by:

getAllViews in interface Book

getWindowTypes

public oracle.help.common.WindowType[] getWindowTypes()

Description copied from interface: Book

Get the WindowType objects defined in this book.

Specified by:

getWindowTypes in interface Book

getAssociativeLinks

public oracle.help.common.AssociativeLink[] getAssociativeLinks()

Description copied from interface: Book

Get the AssociativeLink objects defined in this book.

Specified by:

getAssociativeLinks in interface Book

getHelpSetSections

public oracle.help.library.helpset.HelpSetSection[] getHelpSetSections()

setHomeID

public void setHomeID(java.lang.String homeID)

Sets the HomeID for the HelpSet.

Parameters:

homeID - The HomeID to set

getHomeID

public java.lang.String getHomeID()

Gets the HomeID for the HelpSet.

Parameters:

homeID - The HomeID to set

getHelpSetEncoding

public java.lang.String getHelpSetEncoding()

Gets the encoding of the HelpSet, null if using the LocaleUtils default encoding

Parameters:

homeID - The HomeID to set