ServletHelpBroker

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.help
Class ServletHelpBroker

java.lang.Object
  |
  +--javax.help.ServletHelpBroker

All Implemented Interfaces:: HelpBroker

public class ServletHelpBroker
extends java.lang.Object
implements HelpBroker

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

ServletHelpBroker

public ServletHelpBroker()

Zero-argument constructor. It should be followed by a setHelpSet() invocation.

Method Detail

getHelpSet

public HelpSet getHelpSet()

Returns the default HelpSet

Specified by:: getHelpSet in interface HelpBroker

Returns:: The HelpSet this JavaHelp is presenting.

setHelpSet

public void setHelpSet(HelpSet hs)

Changes the HelpSet for this broker.

Specified by:: setHelpSet in interface HelpBroker

Parameters:: hs - The HelpSet to set for this broker. A null hs is valid parameter.

getLocale

public java.util.Locale getLocale()

Gets the locale of this component.

Specified by:: getLocale in interface HelpBroker

Returns:: This component's locale. If this component does not have a locale, the defaultLocale is returned.
See Also:: setLocale(java.util.Locale)

setLocale

public void setLocale(java.util.Locale l)

Sets the locale of this HelpBroker. The locale is propagated to the presentation.

Specified by:: setLocale in interface HelpBroker

Parameters:: l - The locale to become this component's locale. A null locale is the same as the defaultLocale.
See Also:: getLocale()

getFont

public java.awt.Font getFont()

Gets the font for this HelpBroker.

Specified by:: getFont in interface HelpBroker

setFont

public void setFont(java.awt.Font f)

Sets the font for this this HelpBroker.

Specified by:: setFont in interface HelpBroker

Parameters:: f - The font.

setCurrentView

public void setCurrentView(java.lang.String name)

Set the currentView to the navigator with the same name as the name parameter.

Specified by:: setCurrentView in interface HelpBroker

Parameters:: name - 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.
Throws:: java.lang.IllegalArgumentException - if nav is null or not a valid Navigator.

getCurrentView

public java.lang.String getCurrentView()

Determines the current navigator.

Specified by:: getCurrentView in interface HelpBroker

Returns:: The name of the current navigational view.

getCurrentNavigatorView

public NavigatorView getCurrentNavigatorView()

Returns the current navigator as a NavigatorView.

initPresentation

public void initPresentation()

Initializes the presentation. Not implemented in ServletHelpBroker.

Specified by:: initPresentation in interface HelpBroker

setDisplayed

public void setDisplayed(boolean b)

Displays the presentation to the user.

Specified by:: setDisplayed in interface HelpBroker

Parameters:: b - Makes the presentation visible or not.

isDisplayed

public boolean isDisplayed()

Determines if the presentation is displayed.

Specified by:: isDisplayed in interface HelpBroker

Returns:: Whether the presentation is currently visible.

setLocation

public void setLocation(java.awt.Point p)
                 throws UnsupportedOperationException

Requests the presentation be located at a given position. This operation throws an UnsupportedOperationException in ServletHelpBroker

Specified by:: setLocation in interface HelpBroker