com.klg.jclass.util.swing
Class JCHelpPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JSplitPane
                          |
                          +--com.klg.jclass.util.swing.JCHelpPane

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Serializable

public class JCHelpPane

extends JSplitPane

Class that contains two JCHTMLPanes. Clicks on links in the pane on the left will cause the clicked-on URL to be loaded in the pane on the right.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JSplitPane

JSplitPane.AccessibleJSplitPane

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected com.klg.jclass.util.swing.JCAction	backAction
protected JButton	backButton
protected com.klg.jclass.util.swing.JCHTMLPane	contentsPane
protected int	currentStackPosition
protected com.klg.jclass.util.swing.JCAction	forwardAction
protected JButton	forwardButton
protected JSplitPane	horizontalPane
protected int	movingThroughStack
protected com.klg.jclass.util.swing.JCHelpPane.PageListener	pageListener
protected com.klg.jclass.util.swing.JCHTMLPane	titlePane
protected JToolBar	toolBarButtonsAddedTo
protected JToolBar	toolBarCreated
protected JToolBar	toolBarListenersAddedTo
protected Stack	urlStack
protected boolean	useToolBar
protected JSplitPane	verticalPane
protected com.klg.jclass.util.swing.JCHTMLPane	viewPane

Fields inherited from class javax.swing.JSplitPane

BOTTOM, CONTINUOUS_LAYOUT_PROPERTY, continuousLayout, DIVIDER, DIVIDER_LOCATION_PROPERTY, DIVIDER_SIZE_PROPERTY, dividerSize, HORIZONTAL_SPLIT, LAST_DIVIDER_LOCATION_PROPERTY, lastDividerLocation, LEFT, leftComponent, ONE_TOUCH_EXPANDABLE_PROPERTY, oneTouchExpandable, orientation, ORIENTATION_PROPERTY, RESIZE_WEIGHT_PROPERTY, RIGHT, rightComponent, TOP, VERTICAL_SPLIT

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

JCHelpPane()

JCHelpPane(String contents, String view)

JCHelpPane(String contents, String view, String title)

JCHelpPane(URL contents, URL view)

JCHelpPane(URL contents, URL view, URL title)

Method Summary

void	addNotify() When this object is added to its parent.
protected void	back()
protected void	connectToToolBar() Implementation of toolbar activation behavior as described in setUseToolBar.
protected void	enableButtons()
protected void	forward()
String	getAbout() Returns vendor information.
URL	getContentsPage() Returns the URL displayed in the contents pane.
com.klg.jclass.util.swing.JCHTMLPane	getContentsPane() Returns the HTML pane on the left hand side.
JSplitPane	getHorizontalPane()
URL	getTitlePage() Returns the URL displayed in the title pane.
JSplitPane	getVerticalPane()
URL	getViewPage() Returns the URL displayed in the contents pane.
com.klg.jclass.util.swing.JCHTMLPane	getViewPane() Returns the HTML pane on the right hand side.
boolean	isUseToolBar()
void	resetHelpStack()
void	setAbout(String s) Provided for Beans property editors - has no effect.
void	setContentsPage(URL page) Sets the contents page.
void	setTitlePage(URL page) Sets the title page.
protected void	setupPanes()
void	setUseToolBar(boolean use) If this method returns true, the component traverses up the tree to find its root pane container and adds a tool bar to it if one does not exist.
void	setViewPage(URL page) Sets the view page.

Methods inherited from class javax.swing.JSplitPane

addImpl, getAccessibleContext, getBottomComponent, getDividerLocation, getDividerSize, getLastDividerLocation, getLeftComponent, getMaximumDividerLocation, getMinimumDividerLocation, getOrientation, getResizeWeight, getRightComponent, getTopComponent, getUI, getUIClassID, isContinuousLayout, isOneTouchExpandable, isValidateRoot, paintChildren, paramString, remove, remove, removeAll, resetToPreferredSizes, setBottomComponent, setContinuousLayout, setDividerLocation, setDividerLocation, setDividerSize, setLastDividerLocation, setLeftComponent, setOneTouchExpandable, setOrientation, setResizeWeight, setRightComponent, setTopComponent, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, paint, paintBorder, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

contentsPane

protected com.klg.jclass.util.swing.JCHTMLPane contentsPane

viewPane

protected com.klg.jclass.util.swing.JCHTMLPane viewPane

titlePane

protected com.klg.jclass.util.swing.JCHTMLPane titlePane

horizontalPane

protected JSplitPane horizontalPane

verticalPane

protected JSplitPane verticalPane

useToolBar

protected boolean useToolBar

toolBarCreated

protected JToolBar toolBarCreated

toolBarButtonsAddedTo

protected JToolBar toolBarButtonsAddedTo

toolBarListenersAddedTo

protected JToolBar toolBarListenersAddedTo

forwardButton

protected JButton forwardButton

backButton

protected JButton backButton

forwardAction

protected com.klg.jclass.util.swing.JCAction forwardAction

backAction

protected com.klg.jclass.util.swing.JCAction backAction

pageListener

protected com.klg.jclass.util.swing.JCHelpPane.PageListener pageListener

urlStack

protected Stack urlStack

currentStackPosition

protected int currentStackPosition

movingThroughStack

protected int movingThroughStack

Constructor Detail

JCHelpPane

public JCHelpPane()

JCHelpPane

public JCHelpPane(URL contents,
                  URL view)

JCHelpPane

public JCHelpPane(URL contents,
                  URL view,
                  URL title)

JCHelpPane

public JCHelpPane(String contents,
                  String view)

JCHelpPane

public JCHelpPane(String contents,
                  String view,
                  String title)

Method Detail

getHorizontalPane

public JSplitPane getHorizontalPane()

getVerticalPane

public JSplitPane getVerticalPane()

resetHelpStack

public void resetHelpStack()

setAbout

public void setAbout(String s)

Provided for Beans property editors - has no effect.

Parameters:

s -

getAbout

public String getAbout()

Returns vendor information.

Returns:

vendor information

getContentsPane

public com.klg.jclass.util.swing.JCHTMLPane getContentsPane()

Returns the HTML pane on the left hand side.

Returns:

the HTML pane on the left hand side

getViewPane

public com.klg.jclass.util.swing.JCHTMLPane getViewPane()

Returns the HTML pane on the right hand side.

Returns:

the HTML pane on the right hand side

setContentsPage

public void setContentsPage(URL page)

Sets the contents page. That is, set the HTML pane on the left hand side.

Parameters:

page -

getContentsPage

public URL getContentsPage()

Returns the URL displayed in the contents pane.

Returns:

URL displayed in the contents pane

setViewPage

public void setViewPage(URL page)

Sets the view page. That is, sets the HTML pane on the right hand side.

Parameters:

page -

getViewPage

public URL getViewPage()

Returns the URL displayed in the contents pane.

Returns:

URL displayed in the contents pane

setTitlePage

public void setTitlePage(URL page)

Sets the title page. That is, sets the HTML pane at the top.

Parameters:

page -

getTitlePage

public URL getTitlePage()

Returns the URL displayed in the title pane.

Returns:

URL displayed in the title pane

setUseToolBar

public void setUseToolBar(boolean use)

If this method returns true, the component traverses up the tree to find its root pane container and adds a tool bar to it if one does not exist. If one exists, it will add the HTML navigation buttons to the existing toolbar. If two buttons exist in the tool bar named HelpHTMLBack and HelpHTMLForward, then it will not add the buttons, but rather add listeners to those buttons.

Parameters:

use -

isUseToolBar

public boolean isUseToolBar()

addNotify

public void addNotify()

When this object is added to its parent.

Overrides:

addNotify in class JComponent

connectToToolBar

protected void connectToToolBar()

Implementation of toolbar activation behavior as described in setUseToolBar.

See Also:

setUseToolBar(boolean)

setupPanes

protected void setupPanes()

back

protected void back()

forward

protected void forward()

enableButtons

protected void enableButtons()