com.ehsbe.commons.gui
Class JxHelpFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.jdesktop.swingx.JXFrame
                          com.ehsbe.commons.gui.JxHelpFrame

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class JxHelpFrame
extends org.jdesktop.swingx.JXFrame

A wrapper around a JHelp helpset

Version:

$Revision: 432 $

Author:

Jens Elkner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jdesktop.swingx.JXFrame

org.jdesktop.swingx.JXFrame.StartPosition

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static String	HELP_ACTION_CMD the action command of the help action
static String	PREF_KEY_PREFIX key prefix used to [re]store help settings

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

JxHelpFrame(javax.help.HelpSet helpSet)
Create a new frame for the given helpset

JxHelpFrame(javax.help.HelpSet helpSet, String presentationName)
Create a new frame for the given helpset

Method Summary

void	close() Convinience method for calling the frames close action command's actionPerformed method.
void	dispose()
javax.help.HelpSet	getHelpSet() Get the currently active helpset of this frame.
Class<?>	getPreferencePackageClass() Get the clazz for obtaining/setting user preferences wrt. the help window state (e.g. size, location, font).
void	setHelpset(javax.help.HelpSet helpSet, String presentationName) Set the helpset to display.
void	setPreferencePackageClass(Class<?> clazz) Set the clazz for obtaining/setting user preferences wrt. the help window state (e.g. size, location, font).
void	setVisible(boolean b)
void	showID(String id) Show help for the given id.

Methods inherited from class org.jdesktop.swingx.JXFrame

createRootPane, getCancelButton, getDefaultButton, getIdleThreshold, getKeyPreview, getRootPaneExt, getStartPosition, getStatusBar, getToolBar, getWaitPane, isIdle, isWaitCursorVisible, isWaiting, isWaitPaneVisible, setCancelButton, setCursor, setDefaultButton, setIdle, setIdleThreshold, setKeyPreview, setRootPane, setStartPosition, setStatusBar, setToolBar, setWaitCursorVisible, setWaiting, setWaitPane, setWaitPaneVisible

Methods inherited from class javax.swing.JFrame

addImpl, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

HELP_ACTION_CMD

public static final String HELP_ACTION_CMD

the action command of the help action

See Also:

Constant Field Values

PREF_KEY_PREFIX

public static final String PREF_KEY_PREFIX

key prefix used to [re]store help settings

See Also:

Constant Field Values

Constructor Detail

JxHelpFrame

public JxHelpFrame(javax.help.HelpSet helpSet)

Create a new frame for the given helpset

Parameters:

helpSet - helpset to show

JxHelpFrame

public JxHelpFrame(javax.help.HelpSet helpSet,
                   String presentationName)

Create a new frame for the given helpset

Parameters:

helpSet - helpset to display. If null, this method does nothing.

presentationName - the name of the preferred presentation layout definition in the helpset file. If null, the default presentation definitions are used.

Method Detail

close

public final void close()

Convinience method for calling the frames close action command's actionPerformed method.

setHelpset

public void setHelpset(javax.help.HelpSet helpSet,
                       String presentationName)

Set the helpset to display.

Parameters:

helpSet - helpset to display. If null, this method does nothing.

presentationName - the name of the preferred presentation layout definition in the helpset file. If null, the default presentation definitions are used.

getHelpSet

public javax.help.HelpSet getHelpSet()

Get the currently active helpset of this frame.

Returns:

null if not set, the helpset otherwise.

setPreferencePackageClass

public void setPreferencePackageClass(Class<?> clazz)

Set the clazz for obtaining/setting user preferences wrt. the help window state (e.g. size, location, font).

Parameters:

clazz - class for obtaining the right preference node.

getPreferencePackageClass

public Class<?> getPreferencePackageClass()

Get the clazz for obtaining/setting user preferences wrt. the help window state (e.g. size, location, font).

Returns:

class to use for obtaining the right preference node.

setVisible

public void setVisible(boolean b)

Overrides:

setVisible in class org.jdesktop.swingx.JXFrame

dispose

public void dispose()

Overrides:

dispose in class Window

showID

public void showID(String id)

Show help for the given id.

Does nothing, if no helpset is currently set or id is null.

Parameters:

id - ID of the page to show