Package adams.gui.goe

Class GenericObjectEditorClassTreePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.goe.GenericObjectEditorClassTreePanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class GenericObjectEditorClassTreePanel
extends BasePanel

Creates a panel with a class tree.

Author:

Len Trigg ([email protected]), Xin Xu ([email protected]), Richard Kirkby ([email protected]), 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 BaseCheckBox	m_CheckBoxFilter	The checkbox for enabling/disabling the class tree filter.
protected BaseCheckBox	m_CheckBoxStrict	The checkbox for enabling/disabling strict filtering.
protected BaseButton	m_CloseButton	The button for closing the popup again.
protected JLabel	m_LabelInfo	the info text at the top.
protected int	m_MinimumChars	the minimum number of characters before triggering search events.
protected FilterPanel	m_PanelFilter	the filter text box.
protected JPanel	m_PanelFilterArea	the panel for the filter.
protected JPanel	m_PanelInfo	the info panel at the top.
protected BaseScrollPane	m_ScrollPane	The scroll pane.
protected GenericObjectEditorClassTreePanel	m_Self	the popup itself.
protected ClassTree	m_Tree	The tree.

Fields inherited from class adams.gui.core.BasePanel

m_FileChooser

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
GenericObjectEditorClassTreePanel(ClassTree tree)	Constructs a new popup menu.

Method Summary

Modifier and Type	Method	Description
void	focusSearch()	Focus the search text field.
String	getInfoText()	Returns the current info text, if any.
int	getMinimumChars()	Returns the minimum number of characters that the user needs to enter before triggering a search event.
BaseScrollPane	getScrollPane()	Returns the scroll pane.
protected void	initGUI()	Initializes the widgets.
boolean	isCloseButtonVisible()	Returns whether the close button is visible.
boolean	isReadOnly()	Returns the readonly state.
void	setCloseButtonVisible(boolean value)	Sets whether the close button is visible or not.
void	setInfoText(String value)	Sets the info text to display at the top.
void	setMinimumChars(int value)	Sets the minimum number of characters that the user needs to enter before triggering a search event.
void	setReadOnly(boolean value)	Sets the readonly state.
void	updateFilterPanel()	Updates whether the filter panel is visible.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initFileChooser, initialize, main, printErrorMessage, printException, saveComponent, 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_Self

protected GenericObjectEditorClassTreePanel m_Self

the popup itself.

m_PanelInfo

protected JPanel m_PanelInfo

the info panel at the top.

m_LabelInfo

protected JLabel m_LabelInfo

the info text at the top.

m_Tree

protected ClassTree m_Tree

The tree.

m_ScrollPane

protected BaseScrollPane m_ScrollPane

The scroll pane.

m_CloseButton

protected BaseButton m_CloseButton

The button for closing the popup again.

m_PanelFilterArea

protected JPanel m_PanelFilterArea

the panel for the filter.

m_PanelFilter

protected FilterPanel m_PanelFilter

the filter text box.

m_CheckBoxFilter

protected BaseCheckBox m_CheckBoxFilter

The checkbox for enabling/disabling the class tree filter.

m_CheckBoxStrict

protected BaseCheckBox m_CheckBoxStrict

The checkbox for enabling/disabling strict filtering.

m_MinimumChars

protected int m_MinimumChars

the minimum number of characters before triggering search events.

Constructor Detail

GenericObjectEditorClassTreePanel

public GenericObjectEditorClassTreePanel(ClassTree tree)

Constructs a new popup menu.

Parameters:

tree - the tree to put in the menu

Method Detail

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BasePanel

setMinimumChars

public void setMinimumChars(int value)

Sets the minimum number of characters that the user needs to enter before triggering a search event.

Parameters:

value - the minimum number of characters (>= 1)

getMinimumChars

public int getMinimumChars()

Returns the minimum number of characters that the user needs to enter before triggering a search event.

Returns:

the minimum number of characters (>= 1)

setInfoText

public void setInfoText(String value)

Sets the info text to display at the top. Use "_" before the character to use as the mnemonic for jumping into the tree via the keyboard.

Parameters:

value - the info text, null or empty to remove

getInfoText

public String getInfoText()

Returns the current info text, if any.

Returns:

the text, empty if none displayed

getScrollPane

public BaseScrollPane getScrollPane()

Returns the scroll pane.

Returns:

the scroll pane

setCloseButtonVisible

public void setCloseButtonVisible(boolean value)

Sets whether the close button is visible or not.

Parameters:

value - true if visible

isCloseButtonVisible

public boolean isCloseButtonVisible()

Returns whether the close button is visible.

Returns:

true if visible

focusSearch

public void focusSearch()

Focus the search text field.

updateFilterPanel

public void updateFilterPanel()

Updates whether the filter panel is visible.

setReadOnly

public void setReadOnly(boolean value)

Sets the readonly state.

Parameters:

value - true if readonly

isReadOnly

public boolean isReadOnly()

Returns the readonly state.

Returns:

true if readonly