javax.help
public abstract class WindowPresentation extends Presentation
HelpSet
,
JHelpNavigator
,
javax.help.HelpVisitListener
Constructor and Description |
---|
WindowPresentation(HelpSet hs) |
Modifier and Type | Method and Description |
---|---|
void |
createHelpWindow() |
void |
destroy()
Destroy this object.
|
java.awt.Window |
getActivationWindow()
Get the activation window.
|
java.lang.String |
getCurrentView()
Determines the current navigator.
|
java.awt.Font |
getFont()
Gets the font for this WindowPresentation
|
HelpSet.Presentation |
getHelpSetPresentation()
Return the HelpSet.Presentation if one was set
|
java.awt.Window |
getHelpWindow()
Get the current window that help is displayed in
|
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.
|
java.lang.String |
getTitle() |
boolean |
isDestroyedOnExit()
Determines if the presentation should be distroyed on exit
|
boolean |
isDisplayed()
Determines if the presentation is displayed.
|
boolean |
isTitleSetFromDocument()
Is the title set from the Document.
|
boolean |
isToolbarDisplayed()
Determines if the toolbar is visible.
|
boolean |
isViewDisplayed()
Determines if the current view is visible.
|
void |
setActivationObject(java.lang.Object comp)
Set the activation window from given Component or MenuItem.
|
void |
setActivationWindow(java.awt.Window window)
Set the activation window.
|
void |
setCurrentView(java.lang.String name)
Set the currentView to the navigator with the same
name as the name parameter.
|
void |
setDestroyOnExit(boolean destroy)
Destory the window on exit
|
void |
setDisplayed(boolean b)
Displays the presentation to the user.
|
void |
setFont(java.awt.Font f)
Sets the font for this this WindowPresentation.
|
void |
setHelpSet(HelpSet hs)
Changes the HelpSet for this presentation.
|
void |
setHelpSetPresentation(HelpSet.Presentation hsPres)
Set the Presentation attributes specific to WindowPresentations from a
named presentation in a HelpSet.
|
void |
setLocale(java.util.Locale l)
Sets the locale of this Presentation.
|
void |
setLocation(java.awt.Point p)
Requests the presentation be located at a given position.
|
void |
setScreen(int screen)
Sets the screen of the presentation
|
void |
setSize(java.awt.Dimension d)
Requests the presentation be set to a given size.
|
void |
setTitle(java.lang.String title) |
void |
setTitleFromDocument(boolean b)
Set the title from the Document.
|
void |
setToolbarDisplayed(boolean displayed)
Hides/Shows Toolbar
|
void |
setViewDisplayed(boolean displayed)
Hides/Shows view.
|
getCurrentID, getCurrentURL, getHelpModel, getHelpSet, getLocale, getPresentation, setCurrentID, setCurrentID, setCurrentURL
public WindowPresentation(HelpSet hs)
public void setHelpSetPresentation(HelpSet.Presentation hsPres)
setHelpSetPresentation
in class Presentation
HelpSet.Presentation
public HelpSet.Presentation getHelpSetPresentation()
HelpSet.Presentation
public java.awt.Window getActivationWindow()
public void setActivationWindow(java.awt.Window window)
window
- the activating windowpublic void setActivationObject(java.lang.Object comp)
setActivationWindow.
setActivationWindow
public java.lang.String getCurrentView()
public void setCurrentView(java.lang.String name)
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.java.lang.IllegalArgumentException
- if nav is null or not a valid Navigator.public boolean isDestroyedOnExit()
public void setDestroyOnExit(boolean destroy)
public void destroy()
public void setHelpSet(HelpSet hs)
setHelpSet
in class Presentation
hs
- The HelpSet to set for this presentation.
A null hs is valid parameter.public void setDisplayed(boolean b)
setDisplayed
in class Presentation
public boolean isDisplayed()
isDisplayed
in class Presentation
public void setFont(java.awt.Font f)
setFont
in class Presentation
f
- The font.public java.awt.Font getFont()
getFont
in class Presentation
public void setLocale(java.util.Locale l)
setLocale
in class Presentation
l
- The locale to become this component's locale. A null locale
is the same as the defaultLocale.Presentation.getLocale()
public java.awt.Point getLocation()
public void setLocation(java.awt.Point p)
public int getScreen()
public void setScreen(int screen)
screen
- the screen numberjava.lang.IllegalArgumentException
- if the screen is invalidpublic java.awt.Dimension getSize()
getSize
in class Presentation
public void setSize(java.awt.Dimension d)
setSize
in class Presentation
d
- - a Dimension to set the size to.public java.lang.String getTitle()
public void setTitle(java.lang.String title)
public boolean isTitleSetFromDocument()
public void setTitleFromDocument(boolean b)
b
- if true will set the title form the document, otherwise will
set the title from the HelpSet.public boolean isViewDisplayed()
public void setViewDisplayed(boolean displayed)
public boolean isToolbarDisplayed()
public void setToolbarDisplayed(boolean displayed)
public void createHelpWindow()
public java.awt.Window getHelpWindow()