public class HelpBook extends java.lang.Object implements Book
oracle.help.library.Book;
Constructor and Description |
---|
HelpBook()
Create an empty HelpBook.
|
HelpBook(java.lang.Class baseClass,
java.lang.String dirPathExt,
java.lang.String baseName,
java.lang.String bookTitle)
Create a HelpBook with the specified title, loading
the data from the given location.
|
HelpBook(java.lang.Class baseClass,
java.lang.String dirPathExt,
java.lang.String baseName,
java.lang.String bookTitle,
java.lang.String helpDefaultEncoding)
Create a HelpBook with the specified title, loading
the data from the given location using the specified encoding.
|
HelpBook(java.lang.String baseURL,
java.lang.String baseName,
java.lang.String bookTitle)
Create a HelpBook with the specified title, loading
the data from the given location.
|
HelpBook(java.lang.String baseURL,
java.lang.String baseName,
java.lang.String bookTitle,
java.lang.String helpDefaultEncoding)
Create a HelpBook with the specified title, loading
the data from the given location using the specified encoding.
|
Modifier and Type | Method and Description |
---|---|
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 |
getBaseName()
Returns the baseName.
|
java.lang.String |
getBaseURL() |
java.lang.String |
getBookTitle()
Get the title of the Book
|
java.lang.String |
getTitle()
Returns the book title.
|
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.
|
public HelpBook()
public HelpBook(java.lang.Class baseClass, java.lang.String dirPathExt, java.lang.String baseName, java.lang.String bookTitle) throws oracle.help.library.helpbook.HelpBookException
baseClass
- A Java class. The HelpBook uses
the location of this class to determine the location
of your help data. The dirPathExt is appended to
the absolute path to the directory containing the
Java class. The HelpBook then looks for known control
files (TOC, TOK, HHC, HHK, OHT, and IDX) named
with the given basename.dirpathExt
- The dirPathExt is a path appended to
the absolute path to the directory containing the
baseClass. The resulting directory is then examined
for control files.baseName
- The baseName of the control files
in the specified directory (i.e. if your control
files are named discoverer.hhc, discoverer.hhk,
etc., the baseName would be "discoverer").bookTitle
- The title to use for this HelpBook.oracle.help.library.helpbook.HelpBookException
public HelpBook(java.lang.Class baseClass, java.lang.String dirPathExt, java.lang.String baseName, java.lang.String bookTitle, java.lang.String helpDefaultEncoding) throws oracle.help.library.helpbook.HelpBookException
baseClass
- A Java class. The HelpBook uses
the location of this class to determine the location
of your help data. The dirPathExt is appended to
the absolute path to the directory containing the
Java class. The HelpBook then looks for known control
files (TOC, TOK, HHC, HHK, OHT, and IDX) named
with the given basename.dirpathExt
- The dirPathExt is a path appended to
the absolute path to the directory containing the
baseClass. The resulting directory is then examined
for control files.baseName
- The baseName of the control files
in the specified directory (i.e. if your control
files are named discoverer.hhc, discoverer.hhk,
etc., the baseName would be "discoverer").helpDefaultEncoding
- bookTitle
- The title to use for this HelpBook.oracle.help.library.helpbook.HelpBookException
public HelpBook(java.lang.String baseURL, java.lang.String baseName, java.lang.String bookTitle) throws oracle.help.library.helpbook.HelpBookException
baseURL
- The string representation of the URL
to the base directory which contains your help control
files. This directory will be examined for control
files named with the baseName.baseName
- The baseName of the control files
in the specified directory (i.e. if your control
files are named discoverer.hhc, discoverer.hhk,
etc., the baseName would be "discoverer").bookTitle
- The title to use for this HelpBook.oracle.help.library.helpbook.HelpBookException
public HelpBook(java.lang.String baseURL, java.lang.String baseName, java.lang.String bookTitle, java.lang.String helpDefaultEncoding) throws oracle.help.library.helpbook.HelpBookException
baseURL
- The string representation of the URL
to the base directory which contains your help control
files. This directory will be examined for control
files named with the baseName.baseName
- The baseName of the control files
in the specified directory (i.e. if your control
files are named discoverer.hhc, discoverer.hhk,
etc., the baseName would be "discoverer").bookTitle
- The title to use for this HelpBook.helpDefaultEncoding
- oracle.help.library.helpbook.HelpBookException
public java.lang.String getBookTitle()
Book
getBookTitle
in interface Book
public oracle.help.common.View[] getViewsByType(java.lang.String type)
Book
getViewsByType
in interface Book
type
- The type identifier of the
views to retrievepublic oracle.help.common.View[] getAllViews()
Book
getAllViews
in interface Book
public oracle.help.common.WindowType[] getWindowTypes()
Book
getWindowTypes
in interface Book
public oracle.help.common.AssociativeLink[] getAssociativeLinks()
Book
getAssociativeLinks
in interface Book
public java.net.URL mapIDToURL(java.lang.String id)
Book
mapIDToURL
in interface Book
id
- The topicID.public java.lang.String mapURLToWindowTypeName(java.net.URL url)
Book
mapURLToWindowTypeName
in interface Book
url
- The URL to map.public java.lang.String getBaseURL()
public java.lang.String getBaseName()
public java.lang.String getTitle()