mvt.help
Class HelpIndex

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--mvt.help.HelpIndex

All Implemented Interfaces:

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

public class HelpIndex

extends javax.swing.JPanel

implements java.awt.event.MouseListener, java.awt.event.ActionListener, javax.swing.event.DocumentListener

A help index panel with various options. This will search the index for a topic and displays it in a viewer. The viewer uses html, so all help will be written in html. If the xml file for the location is not found the index will be blank. This will also be added to the BorderLayout.WEST side of the browser (which is a BorderLayout).

Author:

Patrick Simek

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

protected static HelpIndexList

list The help index list.

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.Container

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

HelpIndex(HTMLBrowser browser, java.lang.String h)
Constructor for the help index.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent actionEvent) Invoked with the button "Display" is pressed.
void	changedUpdate(javax.swing.event.DocumentEvent documentEvent) Gives notification that an attribute or set of attributes changed - does nothing.
void	insertUpdate(javax.swing.event.DocumentEvent documentEvent) Invoked when text has been typed in the text field.
void	mouseClicked(java.awt.event.MouseEvent mouseEvent) Invoked when the mouse has been clicked on the list.
void	mouseEntered(java.awt.event.MouseEvent mouseEvent) Invoked when the mouse enters the list - does nothing.
void	mouseExited(java.awt.event.MouseEvent mouseEvent) Invoked when the mouse exits the list - does nothing.
void	mousePressed(java.awt.event.MouseEvent mouseEvent) Invoked when a mouse button has been pressed on the list - does nothing.
void	mouseReleased(java.awt.event.MouseEvent mouseEvent) Invoked when a mouse button has been released on the list - does nothing.
void	removeUpdate(javax.swing.event.DocumentEvent documentEvent) Invoked when text has been removed from the text field.
void	selectIndex(int index) Set the selected index in the display list
void	updateDisplay() Sets the current highlighted node to be displayed in the viewing window.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, 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, isValidateRoot, paint, paintBorder, paintChildren, 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, addImpl, 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, remove, remove, removeAll, 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

list

protected static HelpIndexList list

The help index list.

Constructor Detail

HelpIndex

public HelpIndex(HTMLBrowser browser,
                 java.lang.String h)

Constructor for the help index. This sets up a panel and places all the objects necessary. This somewhat mimicks Microsofts help system.

Parameters:

browser - the browser that will display the help system.

See Also:

tools.help.HTMLBrowser

Method Detail

selectIndex

public void selectIndex(int index)

Set the selected index in the display list

Parameters:

index - new selected index

mouseExited

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

Invoked when the mouse exits the list - does nothing.

Specified by:

mouseExited in interface java.awt.event.MouseListener

mouseEntered

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

Invoked when the mouse enters the list - does nothing.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseReleased

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

Invoked when a mouse button has been released on the list - does nothing.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mousePressed

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

Invoked when a mouse button has been pressed on the list - does nothing.

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseClicked

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

Invoked when the mouse has been clicked on the list. If an item on the list is clicked on twice, it is then shown in the viewing window.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

updateDisplay

public void updateDisplay()

Sets the current highlighted node to be displayed in the viewing window.

actionPerformed

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

Invoked with the button "Display" is pressed. Sets the current highlighted node to be displayed in the viewing window.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent documentEvent)

Invoked when text has been removed from the text field. Searches the list backwards for the item in the text field.

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent documentEvent)

Invoked when text has been typed in the text field. Searches forward from the current text in the input file (or fromt he beginning if nothing in the list is highlighted or the last item could not be found.

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent documentEvent)

Gives notification that an attribute or set of attributes changed - does nothing.

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener