|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
HelpPanel
public class HelpPanel
This class handles the creation and viewing of CLIP's users help system.
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) javax.swing.tree.DefaultMutableTreeNode |
advanceOptionNode
Section 4: Advanced Options |
(package private) javax.swing.tree.DefaultMutableTreeNode |
appOverviewNode
Section 1: Application Overview |
(package private) javax.swing.tree.DefaultMutableTreeNode |
arrangingTilesNode
Section 2: Arranging Tiles |
(package private) javax.swing.tree.DefaultMutableTreeNode |
basicOptionNode
Section 4: Basic Options |
(package private) UserInterface |
CLIPUI
CLIP's UserInterface component |
(package private) javax.swing.tree.DefaultMutableTreeNode |
commentViewingNode
Section 3: Viewing Comments |
(package private) javax.swing.tree.DefaultMutableTreeNode |
controlsNode
Section 3: Using the Controls |
(package private) javax.swing.tree.DefaultMutableTreeNode |
displayNode
Section 3: Information Display |
(package private) javax.swing.JEditorPane |
editorPane
Editor Pane that displays the help pages |
(package private) javax.swing.tree.DefaultMutableTreeNode |
fileFormatNode
Section 1: File Formats |
(package private) javax.swing.JTree |
helpTree
The help tree |
(package private) javax.swing.tree.DefaultMutableTreeNode |
loadIncompleteArrangementNode
Section 2: Incomplete Tile Arrangements |
(package private) javax.swing.JScrollPane |
pane
The scroll pane contianing the help pages |
(package private) javax.swing.tree.DefaultMutableTreeNode |
savingArrangementNode
Section 2: Saving a Tile Arrangement |
(package private) javax.swing.tree.DefaultMutableTreeNode |
sectionFiveNode
Section 5: Preloaded Sets tree node |
(package private) javax.swing.tree.DefaultMutableTreeNode |
sectionFourNode
Section 4: Creating & Modifying Tile Sets tree node |
(package private) javax.swing.tree.DefaultMutableTreeNode |
sectionOneNode
Section 1: Getting Started tree node |
(package private) javax.swing.tree.DefaultMutableTreeNode |
sectionSixNode
Section 6: Glossary tree node |
(package private) javax.swing.tree.DefaultMutableTreeNode |
sectionThreeNode
Section 3: Playback tree node |
(package private) javax.swing.tree.DefaultMutableTreeNode |
sectionTwoNode
Section 2: Tile Arrangement tree node |
private static long |
serialVersionUID
|
(package private) javax.swing.tree.DefaultMutableTreeNode |
setNode
Section 4: Tile Set |
(package private) javax.swing.tree.DefaultMutableTreeNode |
tileArrangementNode
Section 3: Viewing Tile Arrangements |
(package private) javax.swing.tree.DefaultMutableTreeNode |
tileSetNode
Section 2: Tile Set |
(package private) javax.swing.tree.DefaultMutableTreeNode |
tilesNode
Section 4: Tiles |
(package private) javax.swing.tree.DefaultMutableTreeNode |
welcomeNode
Section 1: Welcome |
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 | |
---|---|
HelpPanel(UserInterface ui)
The constructor sets up the help system to display. |
Method Summary | |
---|---|
javax.swing.JPanel |
createTreePanel()
Creates the panel that displays the help tree. |
void |
displayPane(java.lang.String page)
Displays the passed in help page in the help window. |
void |
valueChanged(javax.swing.event.TreeSelectionEvent ev)
Listens for changes to the help tree and displays the appropriate help page that the user desires to see. |
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 |
---|
private static final long serialVersionUID
javax.swing.JTree helpTree
javax.swing.JScrollPane pane
javax.swing.JEditorPane editorPane
javax.swing.tree.DefaultMutableTreeNode sectionOneNode
javax.swing.tree.DefaultMutableTreeNode sectionTwoNode
javax.swing.tree.DefaultMutableTreeNode sectionThreeNode
javax.swing.tree.DefaultMutableTreeNode sectionFourNode
javax.swing.tree.DefaultMutableTreeNode sectionFiveNode
javax.swing.tree.DefaultMutableTreeNode sectionSixNode
javax.swing.tree.DefaultMutableTreeNode welcomeNode
javax.swing.tree.DefaultMutableTreeNode appOverviewNode
javax.swing.tree.DefaultMutableTreeNode fileFormatNode
javax.swing.tree.DefaultMutableTreeNode tileSetNode
javax.swing.tree.DefaultMutableTreeNode arrangingTilesNode
javax.swing.tree.DefaultMutableTreeNode savingArrangementNode
javax.swing.tree.DefaultMutableTreeNode loadIncompleteArrangementNode
javax.swing.tree.DefaultMutableTreeNode tileArrangementNode
javax.swing.tree.DefaultMutableTreeNode controlsNode
javax.swing.tree.DefaultMutableTreeNode displayNode
javax.swing.tree.DefaultMutableTreeNode commentViewingNode
javax.swing.tree.DefaultMutableTreeNode setNode
javax.swing.tree.DefaultMutableTreeNode basicOptionNode
javax.swing.tree.DefaultMutableTreeNode advanceOptionNode
javax.swing.tree.DefaultMutableTreeNode tilesNode
UserInterface CLIPUI
Constructor Detail |
---|
public HelpPanel(UserInterface ui)
ui
- CLIP's UserInterface objectcreateTreePanel()
Method Detail |
---|
public javax.swing.JPanel createTreePanel()
public void displayPane(java.lang.String page)
page
- The path of the help page to displaypublic void valueChanged(javax.swing.event.TreeSelectionEvent ev)
valueChanged
in interface javax.swing.event.TreeSelectionListener
ev
- The TreeSelectionEvent
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |