Package adams.gui.core

Class SearchableBaseListWithButtons

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.core.BasePanelWithButtons

adams.gui.core.AbstractComponentWithButtons<T>

adams.gui.core.AbstractDoubleClickableComponentWithButtons<BaseList>

adams.gui.core.BaseListWithButtons

adams.gui.core.SearchableBaseListWithButtons

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class SearchableBaseListWithButtons
extends BaseListWithButtons

Searchable list widget with buttons on the right.

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 SearchPanel	m_PanelSearch	the search panel, if search is required.

Fields inherited from class adams.gui.core.BaseListWithButtons

m_CountModelListener

Fields inherited from class adams.gui.core.AbstractDoubleClickableComponentWithButtons

m_DoubleClickAction, m_DoubleClickButton

Fields inherited from class adams.gui.core.AbstractComponentWithButtons

m_Component, m_LabelInfo, m_PanelAll, m_PanelInfo, m_ScrollPane

Fields inherited from class adams.gui.core.BasePanelWithButtons

m_LayoutButtons, m_PanelButtons

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
SearchableBaseListWithButtons()	The default constructor.
SearchableBaseListWithButtons(ListModel model)	Initializes the list with the specified model.

Method Summary

Modifier and Type	Method	Description
void	clearSearch()	Clears the search (if search is allowed).
protected BaseList	createComponent()	Creates the component to use in the panel.
int	getActualIndex(int index)	Returns the actual index in the model.
boolean	getAllowSearch()	Returns whether search is available.
protected void	initGUI()	Initializes the widgets.
void	search(String search)	Performs a search using the specified search string (if search is allowed).
void	setAllowSearch(boolean value)	Sets whether searching is possible.

Methods inherited from class adams.gui.core.BaseListWithButtons

addListSelectionListener, addRemoveItemsListener, canMoveDown, canMoveUp, getModel, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValuesList, getSelectionMode, getSelectionModel, invertSelection, isValidDoubleClick, moveBottom, moveDown, moveTop, moveUp, removeListSelectionListener, removeRemoveItemsListener, requiresScrollPane, selectAll, selectNone, setInfoVisible, setModel, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectionMode, setSelectionModel, updateCounts, updateCountsModelListener

Methods inherited from class adams.gui.core.AbstractDoubleClickableComponentWithButtons

getDoubleClickAction, getDoubleClickButton, setDoubleClickAction, setDoubleClickButton

Methods inherited from class adams.gui.core.AbstractComponentWithButtons

addKeyListener, getComponent, getScrollPane, isInfoVisible, removeKeyListener, updateInfo

Methods inherited from class adams.gui.core.BasePanelWithButtons

addToButtonsPanel, clearButtonsPanel, removeFromButtonsPanel

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

protected SearchPanel m_PanelSearch

the search panel, if search is required.

Constructor Detail

SearchableBaseListWithButtons

public SearchableBaseListWithButtons()

The default constructor.

SearchableBaseListWithButtons

public SearchableBaseListWithButtons(ListModel model)

Initializes the list with the specified model.

Parameters:

model - the model to use

Method Detail

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class AbstractDoubleClickableComponentWithButtons<BaseList>

createComponent

protected BaseList createComponent()

Creates the component to use in the panel. If a

Overrides:

createComponent in class BaseListWithButtons

Returns:

the component

setAllowSearch

public void setAllowSearch(boolean value)

Sets whether searching is possible.

Parameters:

value - true if to allow

getAllowSearch

public boolean getAllowSearch()

Returns whether search is available.

Returns:

true if allowed

getActualIndex

public int getActualIndex(int index)

Returns the actual index in the model.

Parameters:

index - the index of the currently displayed data

Returns:

the index in the underlying data

search

public void search(String search)

Performs a search using the specified search string (if search is allowed).

Parameters:

search - the string to search for

See Also:

getAllowSearch()

clearSearch

public void clearSearch()

Clears the search (if search is allowed).