com.jidesoft.lucene
Class LuceneQuickListFilterField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jidesoft.swing.LabeledTextField
                      com.jidesoft.grid.QuickFilterField
                          com.jidesoft.list.QuickListFilterField
                              com.jidesoft.lucene.LuceneQuickListFilterField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class LuceneQuickListFilterField
extends QuickListFilterField

LuceneQuickListFilterField works along with LuceneFilterableListModel to provide high performance searching feature.

See Also:

QuickListFilterField, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jidesoft.grid.QuickFilterField

QuickFilterField.FieldFilter

Nested classes/interfaces inherited from class com.jidesoft.swing.LabeledTextField

LabeledTextField.PopupMenuCustomizer

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 inherited from class com.jidesoft.grid.QuickFilterField

_filter, _searchingText, PROPERTY_CASE_SENSITIVE, PROPERTY_FROM_END, PROPERTY_FROM_START, PROPERTY_REGEX_ENABLED, PROPERTY_SEARCH_TEXT, PROPERTY_WILDCARD_ENABLED

Fields inherited from class com.jidesoft.swing.LabeledTextField

_button, _contextMenuKeyStroke, _customizer, _hintLabel, _hintText, _icon, _label, _labelText, _showHintTextWhenFocused, _textField

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

LuceneQuickListFilterField()
Creates an empty LuceneQuickListFilterField.

LuceneQuickListFilterField(ListModel listModel)
Creates a LuceneQuickListFilterField using the specified listModel.

Method Summary

void	applyFilter(String text)
protected JidePopupMenu	createContextMenu() Get the popup menu for the instance of LuceneQuickTableFilterField Please see LuceneQuickTableFilterField for details of the menu items.
protected FilterableListModel	createDisplayListModel(ListModel listModel) Create a filtering wrapper list model for LuceneQuickListFilterField.
com.jidesoft.lucene.LuceneDocumentProvider	getLuceneDocumentProvider()
String	getResourceString(String key)
JTextField	getTextField()
boolean	isLuceneInputMode() Get the flag if current input mode for JTextField is lucene input mode.
protected void	prepareQuery(String text) prepare other query based on the input text.
void	setListModel(ListModel listModel) Sets the table model used by this component.
void	setLuceneInputMode(boolean luceneInputMode) Set the flag if current input mode for JTextField is lucene input mode.

Methods inherited from class com.jidesoft.list.QuickListFilterField

applyFilter, getDisplayListModel, getList, getListModel, setList

Methods inherited from class com.jidesoft.grid.QuickFilterField

adjustMismatchColor, applyFilter, compare, compare, convertElementToString, createButton, createFilter, getDefaultFilterIcon, getDefaultResetIcon, getDefaultResetRolloverIcon, getFilter, getFilterIcon, getMismatchColor, getResetIcon, getResetRolloverIcon, getResourceString, getSearchingDelay, getSearchingText, getWildcardSupport, initComponent, installListeners, isCaseSensitive, isConfigurationChanged, isFromEnd, isFromStart, isRegexEnabled, isShowMismatchColor, isWildcardEnabled, matches, setCaseSensitive, setConfigurationChanged, setDefaultFilterIcon, setDefaultResetIcon, setDefaultResetRolloverIcon, setFilterIcon, setFromEnd, setFromStart, setMismatchColor, setRegexEnabled, setResetIcon, setResetRolloverIcon, setSearchingDelay, setSearchingText, setShowMismatchColor, setWildcardEnabled, setWildcardSupport, uninstallListeners

Methods inherited from class com.jidesoft.swing.LabeledTextField

createLabel, createTextField, getBaseline, getButton, getContextMenuKeyStroke, getHintText, getIcon, getLabel, getLabelText, getPopupMenuCustomizer, getText, getTextField, initLayout, isShowHintTextWhenFocused, setColumns, setContextMenuKeyStroke, setEnabled, setHintText, setIcon, setLabelText, setPopupMenuCustomizer, setShowHintTextWhenFocused, setText, showContextMenu, updateUI

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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

Constructor Detail

LuceneQuickListFilterField

public LuceneQuickListFilterField()

Creates an empty LuceneQuickListFilterField. This method is useless since LuceneQuickListFilterField has to have a table model in order to work correctly. So we have this method in place mainly to make it JavaBean compatible. You must call setListModel(javax.swing.ListModel) after you create LuceneQuickListFilterField using this constructor.

LuceneQuickListFilterField

public LuceneQuickListFilterField(ListModel listModel)

Creates a LuceneQuickListFilterField using the specified listModel.

Parameters:

listModel - the ListModel

Method Detail

setListModel

public void setListModel(ListModel listModel)

Sets the table model used by this component. It could be any table model, not necessarily be a FilterableListModel.

Overrides:

setListModel in class QuickListFilterField

Parameters:

listModel - the ListModel

createDisplayListModel

protected FilterableListModel createDisplayListModel(ListModel listModel)

Create a filtering wrapper list model for LuceneQuickListFilterField.

In this method, we will create a LuceneFilterableListModel instance by default.

Overrides:

createDisplayListModel in class QuickListFilterField

Parameters:

listModel - the list model

Returns:

a FilterableListModel instance.

createContextMenu

protected JidePopupMenu createContextMenu()

Get the popup menu for the instance of LuceneQuickTableFilterField

Please see LuceneQuickTableFilterField for details of the menu items.

Overrides:

createContextMenu in class QuickFilterField

Returns:

the popup menu.

getLuceneDocumentProvider

public com.jidesoft.lucene.LuceneDocumentProvider getLuceneDocumentProvider()

prepareQuery

protected void prepareQuery(String text)

Description copied from class: QuickListFilterField

prepare other query based on the input text.

By default, the implementation is null. You can update your information if you subclass this class.

Overrides:

prepareQuery in class QuickListFilterField

Parameters:

text - the input text

isLuceneInputMode

public boolean isLuceneInputMode()

Get the flag if current input mode for JTextField is lucene input mode.

Returns:

the flag.

setLuceneInputMode

public void setLuceneInputMode(boolean luceneInputMode)

Set the flag if current input mode for JTextField is lucene input mode.

Parameters:

luceneInputMode - the flag

applyFilter

public void applyFilter(String text)

getTextField

public JTextField getTextField()

getResourceString

public String getResourceString(String key)