Package | Description |
---|---|
javax.help |
Supports presentation of online documentation with both
content and contextual views of this information.
|
javax.help.event |
Supports event changes in JavaHelp classes.
|
javax.help.plaf.basic |
Modifier and Type | Method | Description |
---|---|---|
static Map.ID |
Map.ID.create(java.lang.String id,
HelpSet hs) |
A location within a HelpSet.
|
Map.ID |
TOCView.getCategoryClosedImageID() |
Returns the default category closed image ID.
|
Map.ID |
TOCView.getCategoryOpenImageID() |
Returns the default category open image ID.
|
Map.ID |
FlatMap.getClosestID(java.net.URL url) |
Determines the ID that is "closest" to this URL (with a given anchor).
|
Map.ID |
Map.getClosestID(java.net.URL url) |
Determines the ID that is "closest" to this URL (with a given anchor).
|
Map.ID |
TryMap.getClosestID(java.net.URL url) |
Determines the ID that is "closest" to this URL (with a given anchor).
|
Map.ID |
DefaultHelpBroker.getCurrentID() |
Determines which ID is displayed (if any).
|
Map.ID |
DefaultHelpModel.getCurrentID() |
Gets the current ID.
|
Map.ID |
HelpBroker.getCurrentID() |
Determines The currently displayed ID (if any).
|
Map.ID |
HelpModel.getCurrentID() |
Gets the current ID.
|
Map.ID |
Presentation.getCurrentID() |
Determines which ID is displayed (if any).
|
Map.ID |
ServletHelpBroker.getCurrentID() |
Determines which ID is displayed (if any).
|
Map.ID |
HelpSet.getHomeID() |
Returns
the ID to visit when the user makes a "go home" gesture.
|
Map.ID |
TreeItem.getID() |
Returns the ID for the item.
|
Map.ID |
FlatMap.getIDFromURL(java.net.URL url) |
Gets the ID for this URL.
|
Map.ID |
Map.getIDFromURL(java.net.URL url) |
Determines the ID for this URL.
|
Map.ID |
TryMap.getIDFromURL(java.net.URL url) |
Determines the ID for this URL.
|
Map.ID |
HelpSet.Presentation.getImageID() |
|
Map.ID |
NavigatorView.getImageID() |
Returns Map ID of icons passed to this View.
|
Map.ID |
TOCItem.getImageID() |
Returns the image for this TOCItem.
|
Map.ID |
TOCView.getTopicImageID() |
Returns the topic image ID.
|
Modifier and Type | Method | Description |
---|---|---|
protected void |
DefaultHelpModel.fireIDChanged(java.lang.Object source,
Map.ID id,
java.net.URL url) |
|
protected void |
DefaultHelpModel.fireIDChanged(java.lang.Object source,
Map.ID id,
java.net.URL url,
java.lang.String historyName,
JHelpNavigator navigator) |
|
java.net.URL |
FlatMap.getURLFromID(Map.ID iden) |
Gets the URL that corresponds to a given ID in the map.
|
java.net.URL |
Map.getURLFromID(Map.ID id) |
Gets the URL that corresponds to a given ID in the Map.
|
java.net.URL |
TryMap.getURLFromID(Map.ID id) |
Gets the URL that corresponds to a given ID in the Map.
|
void |
DefaultHelpBroker.setCurrentID(Map.ID id) |
Displays this ID--HelpVisitListeners are notified.
|
void |
DefaultHelpModel.setCurrentID(Map.ID ident) |
Sets the current ID.
|
void |
DefaultHelpModel.setCurrentID(Map.ID ident,
java.lang.String historyName,
JHelpNavigator navigator) |
Sets the current ID relative to some HelpSet
HelpModelListeners and HelpVisitListeners are notified
|
void |
HelpBroker.setCurrentID(Map.ID id) |
Displays this ID.
|
void |
HelpModel.setCurrentID(Map.ID id) |
Sets the current ID relative to some HelpSet
HelpModelListeners and HelpVisitListeners are notified
|
void |
HelpModel.setCurrentID(Map.ID id,
java.lang.String historyName,
JHelpNavigator navigator) |
Sets the current ID relative to some HelpSet
HelpModelListeners and HelpVisitListeners are notified
|
void |
JHelp.setCurrentID(Map.ID id) |
Visits a given ID.
|
void |
JHelp.setCurrentID(Map.ID id,
java.lang.String historyName,
JHelpNavigator navigator) |
Visits a given ID.
|
void |
JHelpContentViewer.setCurrentID(Map.ID id) |
Visits a given ID.
|
void |
Presentation.setCurrentID(Map.ID id) |
Displays this ID--HelpVisitListeners are notified.
|
void |
ServletHelpBroker.setCurrentID(Map.ID id) |
Displays this ID--HelpVisitListeners are notified.
|
void |
TreeItem.setID(Map.ID id) |
Set the ID for the item.
|
void |
DefaultHelpBroker.showID(Map.ID id,
java.lang.String presentation,
java.lang.String presentationName) |
Show this ID.
|
void |
HelpBroker.showID(Map.ID id,
java.lang.String presentation,
java.lang.String presentationName) |
Displays this ID in a given presentation
|
void |
ServletHelpBroker.showID(Map.ID id,
java.lang.String presentation,
java.lang.String presentationName) |
Constructor | Description |
---|---|
IndexItem(Map.ID id,
java.util.Locale locale) |
Create an IndexItem defaulting the HelpSet to that of its ID.
|
IndexItem(Map.ID id,
HelpSet hs,
java.util.Locale locale) |
Create an IndexItem.
|
Presentation(java.lang.String name,
boolean displayViews,
boolean displayViewImages,
java.awt.Dimension size,
java.awt.Point location,
java.lang.String title,
Map.ID imageID,
boolean toolbar,
java.util.Vector helpActions) |
|
SearchTOCItem(Map.ID id,
Map.ID imageID,
HelpSet hs,
java.util.Locale locale) |
|
TOCItem(Map.ID id,
Map.ID imageID,
java.util.Locale locale) |
Creates a TOCItem with a default HelpSet based on its ID.
|
TOCItem(Map.ID id,
Map.ID imageID,
HelpSet hs,
java.util.Locale locale) |
Creates a TOCItem.
|
TreeItem(Map.ID id,
java.util.Locale locale) |
Creates a TreeItem.
|
TreeItem(Map.ID id,
HelpSet hs,
java.util.Locale locale) |
Create an TreeItem.
|
Modifier and Type | Method | Description |
---|---|---|
Map.ID |
HelpModelEvent.getID() |
Returns the current ID in the HelpModel.
|
Constructor | Description |
---|---|
HelpModelEvent(java.lang.Object source,
Map.ID id,
java.net.URL url) |
Represents a change in the JavaHelp in the current ID or URL.
|
HelpModelEvent(java.lang.Object source,
Map.ID id,
java.net.URL url,
java.lang.String historyName,
JHelpNavigator navigator) |
Represents a change in the JavaHelp in the current ID or URL.
|
Modifier and Type | Field | Description |
---|---|---|
protected Map.ID |
BasicFavoritesNavigatorUI.FavoritesTree.selectedID |