Constructor Detail

• WindowPresentation

  public WindowPresentation​(HelpSet hs)

Method Detail

• setHelpSetPresentation

  public void setHelpSetPresentation​(HelpSet.Presentation hsPres)

  Set the Presentation attributes specific to WindowPresentations from a named presentation in a HelpSet.

  Overrides:

  setHelpSetPresentation in class Presentation

  See Also:

  HelpSet.Presentation

• getHelpSetPresentation

  public HelpSet.Presentation getHelpSetPresentation()

  Return the HelpSet.Presentation if one was set

  See Also:

  HelpSet.Presentation

• getActivationWindow

  public java.awt.Window getActivationWindow()

  Get the activation window.

• setActivationWindow

  public void setActivationWindow​(java.awt.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.

  Parameters:

  window - the activating window

• setActivationObject

  public void setActivationObject​(java.lang.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

  .

  Since:

  2.0

  See Also:

  setActivationWindow(java.awt.Window)

• getCurrentView

  public java.lang.String getCurrentView()

  Determines the current navigator.

• setCurrentView

  public void setCurrentView​(java.lang.String name)

  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:

  java.lang.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

  public void setHelpSet​(HelpSet hs)

  Changes the HelpSet for this presentation.

  Overrides:

  setHelpSet in class Presentation

  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:

  setDisplayed in class Presentation

• isDisplayed

  public boolean isDisplayed()

  Determines if the presentation is displayed.

  Specified by:

  isDisplayed in class Presentation

• setFont

  public void setFont​(java.awt.Font f)

  Sets the font for this this WindowPresentation.

  Overrides:

  setFont in class Presentation

  Parameters:

  f - The font.

• getFont

  public java.awt.Font getFont()

  Gets the font for this WindowPresentation

  Overrides:

  getFont in class Presentation

• setLocale

  public void setLocale​(java.util.Locale l)

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

  Overrides:

  setLocale in class Presentation

  Parameters:

  l - The locale to become this component's locale. A null locale is the same as the defaultLocale.

  See Also:

  Presentation.getLocale()

• getLocation

  public java.awt.Point getLocation()

  Requests the location of the presentation.

• setLocation

  public void setLocation​(java.awt.Point p)

  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:

  java.lang.IllegalArgumentException - if the screen is invalid

• getSize

  public java.awt.Dimension getSize()

  Requests the size of the presentation.

  Overrides:

  getSize in class Presentation

• setSize

  public void setSize​(java.awt.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.

  Overrides:

  setSize in class Presentation

  Parameters:

  d - - a Dimension to set the size to.

• getTitle

  public java.lang.String getTitle()

• setTitle

  public void setTitle​(java.lang.String title)

• 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

  public java.awt.Window getHelpWindow()

  Get the current window that help is displayed in