public interface Book
OHJ currently supports two implementations of the Book interface (HelpBook and HelpSet). Clients could create their own implementation of the Book interface for custom help data formats. The HelpSet implementation, however, should be sufficient for most clients.
HelpSet
,
oracle.help.library.helpbook.HelpBook;
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 |
getBookTitle()
Get the title of the Book
|
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.
|
java.lang.String getBookTitle()
oracle.help.common.View[] getViewsByType(java.lang.String type)
type
- The type identifier of the
views to retrieveoracle.help.common.View[] getAllViews()
oracle.help.common.WindowType[] getWindowTypes()
oracle.help.common.AssociativeLink[] getAssociativeLinks()
java.net.URL mapIDToURL(java.lang.String id)
id
- The topicID.java.lang.String mapURLToWindowTypeName(java.net.URL url)
url
- The URL to map.