javax.help

Class Popup

Implemented Interfaces:
ActionListener

public class Popup
extends Presentation
implements ActionListener

Popup is a Presentation class that will create a popup help window for an application. There is only one popup per application. A popup contains only a content viewer. It is intended to provide immediate help and then allow the user to continue working. Once a popup loses focus, it is destroyed.
Since:
2.0
See Also:
Presentation

Method Summary

void
actionPerformed(ActionEvent e)
Component
getInvoker()
Get the Component that invoked this popup
Rectangle
getInvokerInternalBounds()
Get the internal bounds for the invoker.
static Presentation
getPresentation(HelpSet hs, String name)
create a new Popup for a given HelpSet and HelpSet.Presentation "name".
boolean
isDisplayed()
void
setDisplayed(boolean b)
Displays the presentation to the user
void
setInvoker(Component invoker)
Set the invoking component for this popup.
void
setInvokerInternalBounds(Rectangle bounds)
Set the the internal bounds for an invoker.

Methods inherited from class javax.help.Presentation

getCurrentID, getCurrentURL, getFont, getHelpModel, getHelpSet, getLocale, getPresentation, getSize, isDisplayed, setCurrentID, setCurrentID, setCurrentURL, setDisplayed, setFont, setHelpSet, setHelpSetPresentation, setLocale, setSize

Method Details

actionPerformed

public void actionPerformed(ActionEvent e)

getInvoker

public Component getInvoker()
Get the Component that invoked this popup
Returns:
Component The invoking component

getInvokerInternalBounds

public Rectangle getInvokerInternalBounds()
Get the internal bounds for the invoker.

getPresentation

public static Presentation getPresentation(HelpSet hs,
                                           String name)
create a new Popup for a given HelpSet and HelpSet.Presentation "name". If the "name"d HelpSet.Presentation does not exist in the HelpSet then the defaultHelpSet.Presentation if used.
Overrides:
getPresentation in interface Presentation
Parameters:
hs - The HelpSEt used in this presentation
name - The name of the HelpSet.Presentation to use

isDisplayed

public boolean isDisplayed()
Overrides:
isDisplayed in interface Presentation

setDisplayed

public void setDisplayed(boolean b)
Displays the presentation to the user
Overrides:
setDisplayed in interface Presentation

setInvoker

public void setInvoker(Component invoker)
Set the invoking component for this popup. This must be called before setDisplayed(true) is called. If there is an invoker already set it will be used instead of the new invoker.
Parameters:
invoker - The component that invoked this popup

setInvokerInternalBounds

public void setInvokerInternalBounds(Rectangle bounds)
Set the the internal bounds for an invoker. For some invokers like JTrees and JTables it is necessary to set an internal bounds to further define the location of where to place the popup.
Parameters:
bounds - A Rectangle of the internal bounds