jsynoptic.ui
Class HelpViewer

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      jsynoptic.ui.HelpViewer

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.HyperlinkListener, javax.swing.event.TreeSelectionListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class HelpViewer
extends javax.swing.JDialog
implements javax.swing.event.HyperlinkListener, javax.swing.event.TreeSelectionListener, java.awt.event.ActionListener

Version:

1.6 2006

Author:

zxpletran007

See Also:

Serialized Form

Nested Class Summary

class	HelpViewer.AntiAliasedTextPane
class	HelpViewer.HelpFileFilter A file filter to show only directories
class	HelpViewer.HtmlWriterFileFilter

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected java.util.Stack	backward Stacks for forward, backward actions
static HelpBundle	basicHelp Resources
protected javax.swing.JButton	bBack tools bar buttons
protected javax.swing.JButton	bHome tools bar buttons
protected javax.swing.JButton	bNext tools bar buttons
protected javax.swing.JButton	bSave tools bar buttons
protected java.util.Stack	forward Stacks for forward, backward actions
protected javax.swing.JTree	helpTree Help table of contents is displayed into this tree
protected javax.swing.JFileChooser	htmlFileChooser
protected java.util.HashMap	nodeTable target --> node in helpTree table
static MenuResourceBundle	resources
protected HelpNode	rootNode Help root node.
protected javax.swing.tree.DefaultMutableTreeNode	rootTreeNode Help tree root node.
protected javax.swing.tree.DefaultMutableTreeNode	searchRootTreeNode Search tree root node.
protected javax.swing.JTree	searchTree Search results are displayed into this tree
protected HelpViewer.AntiAliasedTextPane	viewer Help pages are displayed into this pane
protected javax.swing.text.html.StyleSheet	viewerStyle viewer style

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

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, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

HelpViewer(java.awt.Frame parent, java.lang.String title)

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
protected void	back()
protected void	concatenateHTMLFiles(java.util.ArrayList children, HTMLWriter writer)
protected static void	copyResource(java.net.URL source, java.io.File destination) Copy the resource to another destination
protected void	createIndexOfContentsHTMLFiles(java.util.ArrayList children, HTMLWriter writer)
protected void	displayPage(java.net.URL page)
protected static java.net.URL[]	getResources(java.net.URL repositoryURL) Get all html resources contained into repository
void	hyperlinkUpdate(javax.swing.event.HyperlinkEvent event)
static void	main(java.lang.String[] argv)
protected void	next()
protected void	save() Create a html document gathering the whole JSYnoptic help.
void	valueChanged(javax.swing.event.TreeSelectionEvent e)

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, remove, 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

Field Detail

basicHelp

public static HelpBundle basicHelp

Resources

resources

public static MenuResourceBundle resources

backward

protected java.util.Stack backward

Stacks for forward, backward actions

forward

protected java.util.Stack forward

Stacks for forward, backward actions

viewer

protected HelpViewer.AntiAliasedTextPane viewer

Help pages are displayed into this pane

viewerStyle

protected javax.swing.text.html.StyleSheet viewerStyle

viewer style

helpTree

protected javax.swing.JTree helpTree

Help table of contents is displayed into this tree

rootNode

protected HelpNode rootNode

Help root node. The root node in the help structure

rootTreeNode

protected javax.swing.tree.DefaultMutableTreeNode rootTreeNode

Help tree root node. The root node in the help tree

bHome

protected javax.swing.JButton bHome

tools bar buttons

bSave

protected javax.swing.JButton bSave

tools bar buttons

bBack

protected javax.swing.JButton bBack

tools bar buttons

bNext

protected javax.swing.JButton bNext

tools bar buttons

searchTree

protected javax.swing.JTree searchTree

Search results are displayed into this tree

searchRootTreeNode

protected javax.swing.tree.DefaultMutableTreeNode searchRootTreeNode

Search tree root node. The root node in the help tree

htmlFileChooser

protected javax.swing.JFileChooser htmlFileChooser

nodeTable

protected java.util.HashMap nodeTable

target --> node in helpTree table

Constructor Detail

HelpViewer

public HelpViewer(java.awt.Frame parent,
                  java.lang.String title)

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

save

protected void save()

Create a html document gathering the whole JSYnoptic help.

createIndexOfContentsHTMLFiles

protected void createIndexOfContentsHTMLFiles(java.util.ArrayList children,
                                              HTMLWriter writer)
                                       throws java.io.IOException

Throws:

java.io.IOException

concatenateHTMLFiles

protected void concatenateHTMLFiles(java.util.ArrayList children,
                                    HTMLWriter writer)
                             throws java.io.IOException

Throws:

java.io.IOException

valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent e)

Specified by:

valueChanged in interface javax.swing.event.TreeSelectionListener

hyperlinkUpdate

public void hyperlinkUpdate(javax.swing.event.HyperlinkEvent event)

Specified by:

hyperlinkUpdate in interface javax.swing.event.HyperlinkListener

displayPage

protected void displayPage(java.net.URL page)

back

protected void back()

next

protected void next()

main

public static void main(java.lang.String[] argv)

getResources

protected static java.net.URL[] getResources(java.net.URL repositoryURL)

Get all html resources contained into repository

Parameters:

repositoryURL - the url definition of repository

Returns:

a url list of founded resources

copyResource

protected static void copyResource(java.net.URL source,
                                   java.io.File destination)

Copy the resource to another destination

Parameters:

source -

destination -