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.
createHelpWindow
public void createHelpWindow()
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.
getActivationWindow
public Window getActivationWindow()
Get the activation window.
getCurrentView
public String getCurrentView()
Determines the current navigator.
getFont
public Font getFont()
Gets the font for this WindowPresentation
- getFont in interface Presentation
getHelpSetPresentation
public HelpSet.Presentation getHelpSetPresentation()
Return the HelpSet.Presentation if one was set
getHelpWindow
public Window getHelpWindow()
Get the current window that help is displayed in
getLocation
public Point getLocation()
Requests the location of the presentation.
getScreen
public int getScreen()
Requests the screen of the presentation
getSize
public Dimension getSize()
Requests the size of the presentation.
- getSize in interface Presentation
getTitle
public String getTitle()
isDestroyedOnExit
public boolean isDestroyedOnExit()
Determines if the presentation should be distroyed on exit
isDisplayed
public boolean isDisplayed()
Determines if the presentation is displayed.
- isDisplayed in interface Presentation
isTitleSetFromDocument
public boolean isTitleSetFromDocument()
Is the title set from the Document. This is generally useful
in SecondaryWindows.
- boolean True if title is set from the Document, false otherwise.
isToolbarDisplayed
public boolean isToolbarDisplayed()
Determines if the toolbar is visible.
isViewDisplayed
public boolean isViewDisplayed()
Determines if the current view is visible.
setActivationObject
public void setActivationObject(Object comp)
Set the activation window from given Component or MenuItem. It find Window component
in the component tree from given Component or MenuItem end call
setActivationWindow
.
setActivationWindow
public void setActivationWindow(Window window)
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.
window
- the activating window
setCurrentView
public void setCurrentView(String name)
Set the currentView to the navigator with the same
name as the name parameter.
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.
setDestroyOnExit
public void setDestroyOnExit(boolean destroy)
Destory the window on exit
setDisplayed
public void setDisplayed(boolean b)
Displays the presentation to the user.
- setDisplayed in interface Presentation
setFont
public void setFont(Font f)
Sets the font for this this WindowPresentation.
- setFont in interface Presentation
setHelpSet
public void setHelpSet(HelpSet hs)
Changes the HelpSet for this presentation.
- setHelpSet in interface Presentation
hs
- The HelpSet to set for this presentation.
A null hs is valid parameter.
setLocale
public void setLocale(Locale l)
Sets the locale of this Presentation. The locale is propagated to
the presentation.
- setLocale in interface Presentation
l
- The locale to become this component's locale. A null locale
is the same as the defaultLocale.
setLocation
public void setLocation(Point p)
Requests the presentation be located at a given position.
setScreen
public void setScreen(int screen)
Sets the screen of the presentation
screen
- the screen number
setSize
public void setSize(Dimension d)
Requests the presentation be set to a given size. Updates the
the presentation on the fly. This is an override of
Presentation.SetSize.
- setSize in interface Presentation
setTitle
public void setTitle(String title)
setTitleFromDocument
public void setTitleFromDocument(boolean b)
Set the title from the Document.
b
- if true will set the title form the document, otherwise will
set the title from the HelpSet.
setToolbarDisplayed
public void setToolbarDisplayed(boolean displayed)
Hides/Shows Toolbar
setViewDisplayed
public void setViewDisplayed(boolean displayed)
Hides/Shows view.