|
Oracle Help for Java API Reference Release 4.2.7.0.0 B12198-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Book interface defines a set of methods for accessing a set of Help data. Books contain the following elements:
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
,
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 |
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. |
Method Detail |
public java.lang.String getBookTitle()
public oracle.help.common.View[] getViewsByType(java.lang.String type)
type
- The type identifier of the
views to retrievepublic oracle.help.common.View[] getAllViews()
public oracle.help.common.WindowType[] getWindowTypes()
public oracle.help.common.AssociativeLink[] getAssociativeLinks()
public java.net.URL mapIDToURL(java.lang.String id)
id
- The topicID.public java.lang.String mapURLToWindowTypeName(java.net.URL url)
url
- The URL to map.
|
HELP ${project.version} | ||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |