Package javax.help
Class WindowPresentation
java.lang.Object
javax.help.Presentation
javax.help.WindowPresentation
- Direct Known Subclasses:
MainWindow,SecondaryWindow
Window Presentation is an abstract class providing a generic interface for
the development of Window Presentations. Each implementation of
Presentation will need to override the static method getPresentation
according to it's own needs.
WindowPresentation implements several generic methods required in all
window presentations. Includes the ability to handle modal and non-modal
activation of the help window.
- Since:
- 2.0
- See Also:
-
HelpSetJHelpNavigatorjavax.help.HelpVisitListener
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoiddestroy()Destroy this object.Get the activation window.Determines the current navigator.getFont()Gets the font for this WindowPresentationReturn the HelpSet.Presentation if one was setGet the current window that help is displayed inRequests the location of the presentation.intRequests the screen of the presentationgetSize()Requests the size of the presentation.getTitle()booleanDetermines if the presentation should be distroyed on exitbooleanDetermines if the presentation is displayed.booleanIs the title set from the Document.booleanDetermines if the toolbar is visible.booleanDetermines if the current view is visible.voidsetActivationObject(Object comp) Set the activation window from given Component or MenuItem.voidsetActivationWindow(Window window) Set the activation window.voidsetCurrentView(String name) Set the currentView to the navigator with the same name as the name parameter.voidsetDestroyOnExit(boolean destroy) Destory the window on exitvoidsetDisplayed(boolean b) Displays the presentation to the user.voidSets the font for this this WindowPresentation.voidsetHelpSet(HelpSet hs) Changes the HelpSet for this presentation.voidSet the Presentation attributes specific to WindowPresentations from a named presentation in a HelpSet.voidSets the locale of this Presentation.voidsetLocation(Point p) Requests the presentation be located at a given position.voidsetScreen(int screen) Sets the screen of the presentationvoidRequests the presentation be set to a given size.voidvoidsetTitleFromDocument(boolean b) Set the title from the Document.voidsetToolbarDisplayed(boolean displayed) Hides/Shows ToolbarvoidsetViewDisplayed(boolean displayed) Hides/Shows view.Methods inherited from class javax.help.Presentation
getCurrentID, getCurrentURL, getHelpModel, getHelpSet, getLocale, getPresentation, setCurrentID, setCurrentID, setCurrentURL
-
Constructor Details
-
WindowPresentation
-
-
Method Details
-
setHelpSetPresentation
Set the Presentation attributes specific to WindowPresentations from a named presentation in a HelpSet.- Overrides:
setHelpSetPresentationin classPresentation- See Also:
-
getHelpSetPresentation
Return the HelpSet.Presentation if one was set- See Also:
-
getActivationWindow
Get the activation window. -
setActivationWindow
Set the activation window. If the window is an instance of a Dialog and the is modal, modallyActivated help is set to true and ownerDialog is set to the window. In all other instances modallyActivated is set to false and ownerDialog is set to null.- Parameters:
window- the activating window
-
setActivationObject
Set the activation window from given Component or MenuItem. It find Window component in the component tree from given Component or MenuItem end callsetActivationWindow
.- Since:
- 2.0
- See Also:
-
getCurrentView
Determines the current navigator. -
setCurrentView
Set the currentView to the navigator with the same name as the name parameter.- Parameters:
name- The name of the navigator to set as the current view. If nav is null or not a valid Navigator in this WindowPresentation then an IllegalArgumentException is thrown.- Throws:
IllegalArgumentException- if nav is null or not a valid Navigator.
-
isDestroyedOnExit
public boolean isDestroyedOnExit()Determines if the presentation should be distroyed on exit -
setDestroyOnExit
public void setDestroyOnExit(boolean destroy) Destory the window on exit -
destroy
public void destroy()Destroy this object. Implementation of WindowPresentation that maintian a list of objects should override this method and call super.destroy to clear up the WindowPresentation internal fields. -
setHelpSet
Changes the HelpSet for this presentation.- Overrides:
setHelpSetin classPresentation- Parameters:
hs- The HelpSet to set for this presentation. A null hs is valid parameter.
-
setDisplayed
public void setDisplayed(boolean b) Displays the presentation to the user.- Specified by:
setDisplayedin classPresentation
-
isDisplayed
public boolean isDisplayed()Determines if the presentation is displayed.- Specified by:
isDisplayedin classPresentation
-
setFont
Sets the font for this this WindowPresentation.- Overrides:
setFontin classPresentation- Parameters:
f- The font.
-
getFont
Gets the font for this WindowPresentation- Overrides:
getFontin classPresentation
-
setLocale
Sets the locale of this Presentation. The locale is propagated to the presentation.- Overrides:
setLocalein classPresentation- Parameters:
l- The locale to become this component's locale. A null locale is the same as the defaultLocale.- See Also:
-
getLocation
Requests the location of the presentation. -
setLocation
Requests the presentation be located at a given position. -
getScreen
public int getScreen()Requests the screen of the presentation -
setScreen
public void setScreen(int screen) Sets the screen of the presentation- Parameters:
screen- the screen number- Throws:
IllegalArgumentException- if the screen is invalid
-
getSize
Requests the size of the presentation.- Overrides:
getSizein classPresentation
-
setSize
Requests the presentation be set to a given size. Updates the the presentation on the fly. This is an override of Presentation.SetSize.- Overrides:
setSizein classPresentation- Parameters:
d- - a Dimension to set the size to.
-
getTitle
-
setTitle
-
isTitleSetFromDocument
public boolean isTitleSetFromDocument()Is the title set from the Document. This is generally useful in SecondaryWindows.- Returns:
- boolean True if title is set from the Document, false otherwise.
-
setTitleFromDocument
public void setTitleFromDocument(boolean b) Set the title from the Document.- Parameters:
b- if true will set the title form the document, otherwise will set the title from the HelpSet.
-
isViewDisplayed
public boolean isViewDisplayed()Determines if the current view is visible. -
setViewDisplayed
public void setViewDisplayed(boolean displayed) Hides/Shows view. -
isToolbarDisplayed
public boolean isToolbarDisplayed()Determines if the toolbar is visible. -
setToolbarDisplayed
public void setToolbarDisplayed(boolean displayed) Hides/Shows Toolbar -
createHelpWindow
public void createHelpWindow() -
getHelpWindow
Get the current window that help is displayed in
-