Package adams.gui.tools

Class ClassHelpPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.tools.ClassHelpPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class ClassHelpPanel
extends BasePanel

Simple panel for lookup of help information on classes (if available).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<ChangeListener>	m_ChangeListeners	the change listeners.
protected DelayedActionRunnable	m_DelayedAction	for updating the search etc.
protected SearchableBaseList	m_ListClasses	the flow editor for displaying flows.
protected BaseHtmlEditorPane	m_TextPaneHelp	for displaying the help.
protected BaseTextField	m_TextSearch	the search panel.

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor	Description
ClassHelpPanel()

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(ChangeListener l)	Adds the change listener to notify whenever the class changes.
protected void	clearHelp()	Removes all text.
protected void	displayHelp(String clsName)	Displays the help for the specified class.
List<String>	getListedClassNames()	Returns the currently listed class names.
String	getSelectedClassName()	Returns the currently selected class.
protected void	initGUI()	For initializing the GUI.
protected void	initialize()	Initializes the listeners.
void	listAllClassNames(boolean managed)	Updates the listed classes.
protected void	notifyChangeListeners()	Notifies all change listeners.
void	removeChangeListener(ChangeListener l)	Removes the change listener from notifications whenever the class changes.
void	setListedClassNames(String[] classes)	Sets the class names to list.
void	setListedClassNames(List<String> classes)	Sets the class names to list.
void	setSelectedClass(String value)	Sets the initially selected class.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, main, printErrorMessage, printException, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

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, getBaseline, getBaselineResizeBehavior, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_TextSearch

protected BaseTextField m_TextSearch

the search panel.

m_ListClasses

protected SearchableBaseList m_ListClasses

the flow editor for displaying flows.

m_TextPaneHelp

protected BaseHtmlEditorPane m_TextPaneHelp

for displaying the help.

m_ChangeListeners

protected Set<ChangeListener> m_ChangeListeners

the change listeners.

m_DelayedAction

protected DelayedActionRunnable m_DelayedAction

for updating the search etc.

Constructor Detail

ClassHelpPanel

public ClassHelpPanel()

Method Detail

initialize

protected void initialize()

Initializes the listeners.

Overrides:

initialize in class BasePanel

initGUI

protected void initGUI()

For initializing the GUI.

Overrides:

initGUI in class BasePanel

clearHelp

protected void clearHelp()

Removes all text.

displayHelp

protected void displayHelp(String clsName)

Displays the help for the specified class.

Parameters:

clsName - the class to display the help for

listAllClassNames

public void listAllClassNames(boolean managed)

Updates the listed classes.

Parameters:

managed - whether to list only managed classes or all

See Also:

setListedClassNames(List)

setListedClassNames

public void setListedClassNames(String[] classes)

Sets the class names to list.

Parameters:

classes - the class names

setListedClassNames

public void setListedClassNames(List<String> classes)

Sets the class names to list.

Parameters:

classes - the class names

getListedClassNames

public List<String> getListedClassNames()

Returns the currently listed class names.

Returns:

the class names

setSelectedClass

public void setSelectedClass(String value)

Sets the initially selected class.

Parameters:

value - the class to select

getSelectedClassName

public String getSelectedClassName()

Returns the currently selected class.

Returns:

the class, null if none selected

addChangeListener

public void addChangeListener(ChangeListener l)

Adds the change listener to notify whenever the class changes.

Parameters:

l - the listener to add

removeChangeListener

public void removeChangeListener(ChangeListener l)

Removes the change listener from notifications whenever the class changes.

Parameters:

l - the listener to remove

notifyChangeListeners

protected void notifyChangeListeners()

Notifies all change listeners.