JHelp
Class JHelpFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--JHelp.JHelpFrame
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class JHelpFrame
extends javax.swing.JFrame

This class is the Frame that displays help content for JHelp.

Example:

 // 'this' is a Frame parent object
 JHelpFrame jHelpFrame = new JHelpFrame(new File("help.dat"), this);
 jHelpFrame.setTitle("JHelp Title");
 jHelpFrame.centerFrame();
 jHelpFrame.setVisible(true);
 

Copyright (c) 2003

Document Date: 7/03

Company: Vermalt LLC

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
 
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
JHelpFrame(java.io.File helpHeaderFile, java.awt.Frame owner)
          Construct a JHelpFrame.
 
Method Summary
 void addJHelpListener(JHelpListener jHelpListener)
          Add a JHelpListener for frame close events.
 void centerFrame()
          Center this frame on the screen.
 boolean displayContentUID(java.lang.String uid)
          Display a help content page specified by its uid.
 javax.swing.JButton getBackButton()
          Get the JButton used for the back button.
 int getDividerLocation()
          Get the divider location between the help content and the Contents/Search area.
 javax.swing.JLabel getEnterKeywordLabel()
          Get the JLabel used for displaying the text "Enter Keyword:"
 javax.swing.JButton getForwardButton()
          Get the JButton used for the forward button.
 javax.swing.JEditorPane getJEditorPane()
          Get the JEditorPane for displaying the content help pages.
 javax.swing.JTree getJTree()
          Get the JTree used for displaying the help hierarchy.
 javax.swing.JButton getSearchButton()
          Get the JButton used for the search button.
 javax.swing.JList getSearchList()
          Get the JList used for displaying search results.
 javax.swing.JLabel getSelectTopicLabel()
          Get the JLabel used for displaying the text "Select Topic:"
 void hide()
           Hide the JHelpFrame window.
 void hideSearchTab()
          Does not display the search tab.
 boolean isBlank()
          Is there no help content being displayed?
 void removeJHelpListener(JHelpListener jHelpListener)
          Remove a JHelpListener for frame close events.
 void setBackIcon(javax.swing.Icon icon)
          Set the icon to display in the Back button.
 void setCharset(java.lang.String charset)
          Set the character set used to read the html help content files.
 void setDividerLocation(int location)
          Set the divider location between the help content and the Contents/Search area.
 void setForwardIcon(javax.swing.Icon icon)
          Set the icon to display in the Forward button.
 void setMinimumFrameSize(java.awt.Dimension dimension)
          Sets the minimum size of this frame.
 void setTabTitleContents(java.lang.String title)
          Set the text to display on the Contents tab.
 void setTabTitleSearch(java.lang.String title)
          Set the text to display on the Search tab.
 void setVisible(boolean b)
           Display or hide the JHelpFrame window.
 void show()
           Display the JHelpFrame window.
 
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, update
 
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Constructor Detail

JHelpFrame

public JHelpFrame(java.io.File helpHeaderFile,
                  java.awt.Frame owner)

Construct a JHelpFrame.

Parameters:
helpHeaderFile - The header file defining the hierarchy of the help data
owner - The parent owner Frame
Method Detail

addJHelpListener

public void addJHelpListener(JHelpListener jHelpListener)

Add a JHelpListener for frame close events.


centerFrame

public void centerFrame()

Center this frame on the screen.


displayContentUID

public boolean displayContentUID(java.lang.String uid)

Display a help content page specified by its uid.

The uid needs to be specified in the hierarchy file and must be unique.

Example hierarchy file line:
Help Content Title ?=help/help.html uid=help

Parameters:
uid - The unique ID of the help content page
Returns:
true if displayed, false otherwise

getBackButton

public javax.swing.JButton getBackButton()

Get the JButton used for the back button.


getDividerLocation

public int getDividerLocation()

Get the divider location between the help content and the Contents/Search area.

Returns:
The location of the divider.

getEnterKeywordLabel

public javax.swing.JLabel getEnterKeywordLabel()

Get the JLabel used for displaying the text "Enter Keyword:"


getForwardButton

public javax.swing.JButton getForwardButton()

Get the JButton used for the forward button.


getJEditorPane

public javax.swing.JEditorPane getJEditorPane()

Get the JEditorPane for displaying the content help pages.


getJTree

public javax.swing.JTree getJTree()

Get the JTree used for displaying the help hierarchy.


getSearchButton

public javax.swing.JButton getSearchButton()

Get the JButton used for the search button.


getSearchList

public javax.swing.JList getSearchList()

Get the JList used for displaying search results.


getSelectTopicLabel

public javax.swing.JLabel getSelectTopicLabel()

Get the JLabel used for displaying the text "Select Topic:"


hide

public void hide()

Hide the JHelpFrame window.

Overrides:
hide in class java.awt.Window

hideSearchTab

public void hideSearchTab()

Does not display the search tab.


isBlank

public boolean isBlank()

Is there no help content being displayed?

Returns:
true if no help content page is selected, false otherwise

removeJHelpListener

public void removeJHelpListener(JHelpListener jHelpListener)

Remove a JHelpListener for frame close events.


setBackIcon

public void setBackIcon(javax.swing.Icon icon)

Set the icon to display in the Back button.

Parameters:
icon - The icon to display.

setCharset

public void setCharset(java.lang.String charset)

Set the character set used to read the html help content files.

Parameters:
charset - Character set such as "UTF-16" or "UTF-8"

setDividerLocation

public void setDividerLocation(int location)

Set the divider location between the help content and the Contents/Search area.

Parameters:
location - The location to put the divider.

setForwardIcon

public void setForwardIcon(javax.swing.Icon icon)

Set the icon to display in the Forward button.

Parameters:
icon - The icon to display.

setMinimumFrameSize

public void setMinimumFrameSize(java.awt.Dimension dimension)

Sets the minimum size of this frame.

If user resizes below this size, the frame will resize to the minimum.

Parameters:
dimension - The minimum size.

setTabTitleContents

public void setTabTitleContents(java.lang.String title)

Set the text to display on the Contents tab.


setTabTitleSearch

public void setTabTitleSearch(java.lang.String title)

Set the text to display on the Search tab.


setVisible

public void setVisible(boolean b)

Display or hide the JHelpFrame window.

Overrides:
setVisible in class java.awt.Component
Parameters:
b - true to show, false to hide.

show

public void show()

Display the JHelpFrame window.

Overrides:
show in class java.awt.Window