Venice 0.751beta

nz.org.venice.help
Class HelpModule

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bynz.org.venice.help.HelpModule
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, Module, java.io.Serializable

public class HelpModule
extends javax.swing.JPanel
implements Module

This module provides a help browser for Venice. It allows traveresal of a tree like document in a extremely cut down HTML type browser. The tree is made from HelpPage pages.

See Also:
HelpPage, 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
 
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
HelpModule(javax.swing.JDesktopPane desktop)
          Create a new help browser loaded at the root page.
HelpModule(javax.swing.JDesktopPane desktop, HelpModuleSettings settings)
          Create a new help browser loaded at the root page.
HelpModule(javax.swing.JDesktopPane desktop, java.lang.String start)
          Create a new help browser loaded at page whose chapter name is the given name
 
Method Summary
 void addModuleChangeListener(java.beans.PropertyChangeListener listener)
          Add a property change listener for module change events.
 boolean encloseInScrollPane()
          Return whether the module should be enclosed in a scroll pane.
 javax.swing.JComponent getComponent()
          Return displayed component for this module.
 javax.swing.ImageIcon getFrameIcon()
          Return frame icon for chart module.
 javax.swing.JMenuBar getJMenuBar()
          Return menu bar for chart module.
 Settings getSettings()
          Return the Settings for the module.
 java.lang.String getTitle()
          Return the window title.
 void removeModuleChangeListener(java.beans.PropertyChangeListener listener)
          Remove a property change listener for module change events.
 void save()
          Tell module to save any current state data / preferences data because the window is being closed.
 
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
 

Constructor Detail

HelpModule

public HelpModule(javax.swing.JDesktopPane desktop)
Create a new help browser loaded at the root page.

Parameters:
desktop - the parent desktop.

HelpModule

public HelpModule(javax.swing.JDesktopPane desktop,
                  java.lang.String start)
Create a new help browser loaded at page whose chapter name is the given name

Parameters:
desktop - the parent desktop.
start - the chapter name to open

HelpModule

public HelpModule(javax.swing.JDesktopPane desktop,
                  HelpModuleSettings settings)
Create a new help browser loaded at the root page.

Parameters:
desktop - the parent desktop.
settings - the HelpModule settings
Method Detail

getTitle

public java.lang.String getTitle()
Return the window title.

Specified by:
getTitle in interface Module
Returns:
the window title

addModuleChangeListener

public void addModuleChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener for module change events.

Specified by:
addModuleChangeListener in interface Module
Parameters:
listener - listener

removeModuleChangeListener

public void removeModuleChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change listener for module change events.

Specified by:
removeModuleChangeListener in interface Module
Parameters:
listener - listener

getComponent

public javax.swing.JComponent getComponent()
Return displayed component for this module.

Specified by:
getComponent in interface Module
Returns:
the component to display.

getJMenuBar

public javax.swing.JMenuBar getJMenuBar()
Return menu bar for chart module.

Specified by:
getJMenuBar in interface Module
Returns:
the menu bar.

getFrameIcon

public javax.swing.ImageIcon getFrameIcon()
Return frame icon for chart module.

Specified by:
getFrameIcon in interface Module
Returns:
the frame icon

encloseInScrollPane

public boolean encloseInScrollPane()
Return whether the module should be enclosed in a scroll pane.

Specified by:
encloseInScrollPane in interface Module
Returns:
enclose module in scroll bar

save

public void save()
Tell module to save any current state data / preferences data because the window is being closed.

Specified by:
save in interface Module

getSettings

public Settings getSettings()
Description copied from interface: Module
Return the Settings for the module.

Specified by:
getSettings in interface Module

Venice 0.751beta