net.sourceforge.helpgui.gui
Class HelpView

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  net.sourceforge.helpgui.gui.HelpView

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.HyperlinkListener

public class HelpView
extends javax.swing.JPanel
implements java.awt.event.MouseListener, javax.swing.event.HyperlinkListener

View for the project, contain the tree on the left and the text on the right

Author:

Alexandre THOMAS

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

(package private) LinkedPage	linkedPage The linked page to store the list of the viewed pages
private javax.swing.tree.DefaultTreeModel	model Model of the tree.
private PageRoot	pageRoot Root of the Tree
private TextArea	textarea Panel on the right.
private javax.swing.JTree	tree Tree on the left.

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

HelpView()
Constructor.

Method Summary

void	firstNodeExpand() Expand the first node of the Tree
Page	getCurrentPage() Return the current page
javax.swing.JTree	getJTree() Get the JTree of the panel
private Page	getLinkedPage(java.util.Enumeration e, java.lang.String url) Return the page with the specify url
private Page	getLinkedPagebyKey(java.util.Enumeration e, java.lang.String key) Return the page with the specify key
TextArea	getTextArea() Get the TextArea of the panel
void	goHome() Go to the home page
private boolean	goHomePage(java.util.Enumeration e) Recursive function to parse all page to get the home page
void	gotoTopic(java.lang.String key) Goes to a help topic based on the passed key, or ignores the request if the key is not found
void	hyperlinkUpdate(javax.swing.event.HyperlinkEvent e) Action when a link is pressed (for HTML listener)
void	mouseClicked(java.awt.event.MouseEvent e) Invoked when the mouse button has been clicked (pressed and released) on a component.
void	mouseEntered(java.awt.event.MouseEvent e) Invoked when the mouse enters a component.
void	mouseExited(java.awt.event.MouseEvent e) Invoked when the mouse exits a component.
void	mousePressed(java.awt.event.MouseEvent e) Invoked when a mouse button has been pressed on a component.
void	mouseReleased(java.awt.event.MouseEvent e) Invoked when a mouse button has been released on a component.
void	nextPage() Set the next page
void	previousPage() Set the previous page
void	print() Print the page
void	updatePage(Page page, java.lang.String anchor, boolean insert) Set a new page on the browser and and it on the list of the last page view
void	updateTreeSelection(java.awt.event.MouseEvent e) Updates tree selection on a mouse event.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

tree

private javax.swing.JTree tree

Tree on the left.

textarea

private TextArea textarea

Panel on the right.

model

private javax.swing.tree.DefaultTreeModel model

Model of the tree.

pageRoot

private PageRoot pageRoot

Root of the Tree

linkedPage

LinkedPage linkedPage

The linked page to store the list of the viewed pages

Constructor Detail

HelpView

public HelpView()

Constructor.

Method Detail

getJTree

public javax.swing.JTree getJTree()

Get the JTree of the panel

getTextArea

public TextArea getTextArea()

Get the TextArea of the panel

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Invoked when the mouse button has been clicked (pressed and released) on a component.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Invoked when the mouse enters a component.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Invoked when the mouse exits a component.

Specified by:

mouseExited in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Invoked when a mouse button has been pressed on a component.

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Invoked when a mouse button has been released on a component.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

updateTreeSelection

public void updateTreeSelection(java.awt.event.MouseEvent e)

Updates tree selection on a mouse event.

goHome

public void goHome()

Go to the home page

goHomePage

private boolean goHomePage(java.util.Enumeration e)

Recursive function to parse all page to get the home page

firstNodeExpand

public void firstNodeExpand()

Expand the first node of the Tree

previousPage

public void previousPage()

Set the previous page

nextPage

public void nextPage()

Set the next page

getCurrentPage

public Page getCurrentPage()

Return the current page

hyperlinkUpdate

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

Action when a link is pressed (for HTML listener)

Specified by:

hyperlinkUpdate in interface javax.swing.event.HyperlinkListener

getLinkedPage

private Page getLinkedPage(java.util.Enumeration e,
                           java.lang.String url)

Return the page with the specify url

getLinkedPagebyKey

private Page getLinkedPagebyKey(java.util.Enumeration e,
                                java.lang.String key)

Return the page with the specify key

Parameters:

e - an enumeration of pages to search

key - the key to search for

Returns:

the matching page, or null if none are found

updatePage

public void updatePage(Page page,
                       java.lang.String anchor,
                       boolean insert)

Set a new page on the browser and and it on the list of the last page view

gotoTopic

public void gotoTopic(java.lang.String key)

Goes to a help topic based on the passed key, or ignores the request if the key is not found

Parameters:

key - A key corresponding to a page's key

print

public void print()

Print the page