|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.help.ServletHelpBroker
An implmentation of the HelpBroker interface for Servlets
| Constructor Summary | |
ServletHelpBroker()
Zero-argument constructor. |
|
| Method Summary | |
void |
enableHelp(java.awt.Component comp,
java.lang.String id,
HelpSet hs)
Enables help for a Component. |
void |
enableHelp(java.awt.MenuItem comp,
java.lang.String id,
HelpSet hs)
Enables help for a MenuItem. |
void |
enableHelpKey(java.awt.Component comp,
java.lang.String id,
HelpSet hs)
Enables the Help key on a Component. |
void |
enableHelpKey(java.awt.Component comp,
java.lang.String id,
HelpSet hs,
java.lang.String presentation,
java.lang.String presentationName)
Enables the Help key on a component. |
void |
enableHelpOnButton(java.awt.Component comp,
java.lang.String id,
HelpSet hs)
Enables help for a Component. |
void |
enableHelpOnButton(java.awt.MenuItem comp,
java.lang.String id,
HelpSet hs)
Enables help for a MenuItem. |
void |
enableHelpOnButton(java.lang.Object obj,
java.lang.String id,
HelpSet hs,
java.lang.String presentation,
java.lang.String presentationName)
Enables help for an object. |
Map.ID |
getCurrentID()
Determines which ID is displayed (if any). |
NavigatorView |
getCurrentNavigatorView()
Returns the current navigator as a NavigatorView. |
java.net.URL |
getCurrentURL()
Determines which URL is displayed. |
java.lang.String |
getCurrentView()
Determines the current navigator. |
java.awt.Font |
getFont()
Gets the font for this HelpBroker. |
HelpSet |
getHelpSet()
Returns the default HelpSet |
java.util.Locale |
getLocale()
Gets the locale of this component. |
java.awt.Point |
getLocation()
Requests the location of the presentation. |
int |
getScreen()
Requests the screen of the presentation. |
java.awt.Dimension |
getSize()
Requests the size of the presentation. |
void |
initPresentation()
Initializes the presentation. |
boolean |
isDisplayed()
Determines if the presentation is displayed. |
boolean |
isViewDisplayed()
Determines if the current view is visible. |
void |
setCurrentID(Map.ID id)
Displays this ID--HelpVisitListeners are notified. |
void |
setCurrentID(java.lang.String id)
Shows this ID as content relative to the (top) HelpSet for the HelpBroker instance--HelpVisitListeners are notified. |
void |
setCurrentURL(java.net.URL url)
Displays this URL. |
void |
setCurrentView(java.lang.String name)
Set the currentView to the navigator with the same name as the name parameter. |
void |
setDisplayed(boolean b)
Displays the presentation to the user. |
void |
setFont(java.awt.Font f)
Sets the font for this this HelpBroker. |
void |
setHelpSet(HelpSet hs)
Changes the HelpSet for this broker. |
void |
setHelpSetPresentation(HelpSet.Presentation pres)
Sets the presentation attributes from a HelpSet.Presentation. |
void |
setLocale(java.util.Locale l)
Sets the locale of this HelpBroker. |
void |
setLocation(java.awt.Point p)
Requests the presentation be located at a given position. |
void |
setScreen(int screen)
Requests the presentation be set to a given screen. |
void |
setSize(java.awt.Dimension d)
Requests the presentation be set to a given size. |
void |
setViewDisplayed(boolean displayed)
Hides/Shows view. |
void |
showID(Map.ID id,
java.lang.String presentation,
java.lang.String presentationName)
Displays this ID in a given presentation |
void |
showID(java.lang.String id,
java.lang.String presentation,
java.lang.String presentationName)
Displays this ID in a particular presentation |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public ServletHelpBroker()
| Method Detail |
public HelpSet getHelpSet()
getHelpSet in interface HelpBrokerpublic void setHelpSet(HelpSet hs)
setHelpSet in interface HelpBrokerhs - The HelpSet to set for this broker.
A null hs is valid parameter.public java.util.Locale getLocale()
getLocale in interface HelpBrokersetLocale(java.util.Locale)public void setLocale(java.util.Locale l)
setLocale in interface HelpBrokerl - The locale to become this component's locale. A null locale
is the same as the defaultLocale.getLocale()public java.awt.Font getFont()
getFont in interface HelpBrokerpublic void setFont(java.awt.Font f)
setFont in interface HelpBrokerf - The font.public void setCurrentView(java.lang.String name)
setCurrentView in interface HelpBrokername - The name of the navigator to set as the
current view. If nav is null or not a valid Navigator
in this HelpBroker then an
IllegalArgumentException is thrown.
java.lang.IllegalArgumentException - if nav is null or not a valid Navigator.public java.lang.String getCurrentView()
getCurrentView in interface HelpBrokerpublic NavigatorView getCurrentNavigatorView()
public void initPresentation()
initPresentation in interface HelpBrokerpublic void setDisplayed(boolean b)
setDisplayed in interface HelpBrokerb - Makes the presentation visible or not.public boolean isDisplayed()
isDisplayed in interface HelpBroker
public void setLocation(java.awt.Point p)
throws UnsupportedOperationException
setLocation in interface HelpBrokerUnsupportedOperationException
public java.awt.Point getLocation()
throws UnsupportedOperationException
getLocation in interface HelpBrokerUnsupportedOperationException
public void setSize(java.awt.Dimension d)
throws UnsupportedOperationException
setSize in interface HelpBrokerUnsupportedOperationException
public java.awt.Dimension getSize()
throws UnsupportedOperationException
getSize in interface HelpBrokerUnsupportedOperationException
public void setScreen(int screen)
throws UnsupportedOperationException
setScreen in interface HelpBrokerUnsupportedOperationException
public int getScreen()
throws UnsupportedOperationException
getScreen in interface HelpBrokerUnsupportedOperationExceptionpublic void setViewDisplayed(boolean displayed)
setViewDisplayed in interface HelpBrokerdisplayed - Make the navigational views visible or not.public boolean isViewDisplayed()
isViewDisplayed in interface HelpBroker
public void setCurrentID(java.lang.String id)
throws BadIDException
setCurrentID in interface HelpBrokerid - A string that identifies the topic to show for the loaded (top) HelpSet
BadIDException - The ID is not valid for the HelpSet
public void setCurrentID(Map.ID id)
throws InvalidHelpSetContextException
setCurrentID in interface HelpBrokerid - a Map.ID indicating the URL to display
InvalidHelpSetContextException - if the current helpset does not contain
id.helpsetHelpModel.setCurrentID(javax.help.Map.ID)public Map.ID getCurrentID()
getCurrentID in interface HelpBrokerpublic void setCurrentURL(java.net.URL url)
setCurrentURL in interface HelpBrokerurl - The url to display. A null URL is a valid url.public java.net.URL getCurrentURL()
getCurrentURL in interface HelpBroker
public void enableHelpKey(java.awt.Component comp,
java.lang.String id,
HelpSet hs)
enableHelpKey in interface HelpBrokercomp - The component to enable the keyboard actions on.id - The default HelpID to be displayed.hs - The default HelpSet to be displayed.
public void enableHelp(java.awt.Component comp,
java.lang.String id,
HelpSet hs)
enableHelp in interface HelpBrokerCSH.setHelpID,
CSH.setHelpSet
public void enableHelp(java.awt.MenuItem comp,
java.lang.String id,
HelpSet hs)
enableHelp in interface HelpBrokerCSH.setHelpID,
CSH.setHelpSet
public void enableHelpOnButton(java.awt.Component comp,
java.lang.String id,
HelpSet hs)
enableHelpOnButton in interface HelpBrokerCSH.setHelpID,
CSH.setHelpSet,
AbstractButton,
Button
public void enableHelpOnButton(java.awt.MenuItem comp,
java.lang.String id,
HelpSet hs)
enableHelpOnButton in interface HelpBrokerCSH.setHelpID,
CSH.setHelpSet,
MenuItempublic void setHelpSetPresentation(HelpSet.Presentation pres)
HelpBroker
setHelpSetPresentation in interface HelpBrokerpres - The HelpSet.Presentation
public void showID(java.lang.String id,
java.lang.String presentation,
java.lang.String presentationName)
throws BadIDException
HelpBroker
showID in interface HelpBrokerid - A String identifying the topic to show relative to getHelpSet()presentation - The Presentation class to display the Help in.presentationName - The name of a Presentation section from a
HelpSet to use. For some Presentations this will also be
the name to apply to the Presentation.
BadIDException - if the ID is not valid in the map.Presentation
public void showID(Map.ID id,
java.lang.String presentation,
java.lang.String presentationName)
throws InvalidHelpSetContextException
HelpBroker
showID in interface HelpBrokerid - An ID that identifies the topic to display.presentation - The Presentation class to display the Help in.presentationName - The name of a Presentation section from a
HelpSet to use. For some Presentations this will also be
the name to apply to the Presentation.
InvalidHelpSetContextException - If id.hs is not contanied in the current
HelpSet of this broker.Presentation
public void enableHelpKey(java.awt.Component comp,
java.lang.String id,
HelpSet hs,
java.lang.String presentation,
java.lang.String presentationName)
HelpBroker
enableHelpKey in interface HelpBrokercomp - The component to enable the keyboard actions on.id - The default HelpID to be displayed.hs - The default HelpSet to be displayed.presentation - The Presentation class to display the Help in.presentationName - The name of a Presentation section from a
HelpSet to use. For some Presentations this will also be
the name to apply to the Presentation.Presentation
public void enableHelpOnButton(java.lang.Object obj,
java.lang.String id,
HelpSet hs,
java.lang.String presentation,
java.lang.String presentationName)
HelpBroker
enableHelpOnButton in interface HelpBrokerid - The default HelpID to be displayed.hs - The default HelpSet to be displayed.presentation - The Presentation class to display the Help in.presentationName - The name of a Presentation section from a
HelpSet to use. For some Presentations this will also be
the name to apply to the Presentation.Presentation,
CSH.setHelpID,
CSH.setHelpSet,
AbstractButton,
Button
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||