com.jidesoft.filter
Class CustomFilterEditor

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jidesoft.filter.CustomFilterEditor

All Implemented Interfaces:

FilterEditor, ImageObserver, MenuContainer, Serializable, Accessible

public class CustomFilterEditor
extends JPanel
implements FilterEditor

CustomFilterEditor is a panel for an end user to create a Filter using a user interface.

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

protected JComponent	_conditionComboBox
protected JLabel	_conditionLabel
protected JLabel	_matchLabel
protected boolean	_singleLineMode
protected ValueEditor	_valueEditor1
protected ValueEditor	_valueEditor2

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

CustomFilterEditor(FilterFactoryManager filterManager)

CustomFilterEditor(FilterFactoryManager filterManager, Class type, ConverterContext converterContext, Object[] possibleValues)

Method Summary

protected JComponent	createConditionComboBox() Creates the condition combobox.
protected ValueEditor	createValueEditor(Class type, ConverterContext converterContext, Object[] possibleValues) Creates the ValueEditor.
Filter	getFilter() Gets the filter.
Filter[]	getFilters() Gets the filters from the FilterEditor.
ObjectGrouper	getObjectGrouper() Gets the current ObjectGrouper instance.
Object[]	getPossibleValues() Gets the possible values.
protected String	getResourceString(String key)
Class	getType() Gets the data type of this filter editor.
protected Object	getValidValueForClass(Class expectedClass, Object value) Get valid filter value by the input value and the expected class.
protected void	initComponents()
boolean	isSingleLineMode()
boolean	isVerticalLayout() Gets the flag indicating if the ValueEditor should be put vertically under the condition combo box.
void	setFilter(Filter filter) Sets the filter.
void	setFilters(Filter[] filters) Sets the filters to the FilterEditor, which will update the JComponent accordingly.
void	setLocale(Locale l)
void	setObjectGrouper(ObjectGrouper objectGrouper) Sets the current ObjectGrouper instance.
void	setSingleLineMode(boolean singleLineMode)
void	setVerticalLayout(boolean verticalLayout) Sets the flag indicating if the ValueEditor should be put vertically under the condition combo box.

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

_conditionComboBox

protected JComponent _conditionComboBox

_valueEditor1

protected ValueEditor _valueEditor1

_valueEditor2

protected ValueEditor _valueEditor2

_conditionLabel

protected JLabel _conditionLabel

_matchLabel

protected JLabel _matchLabel

_singleLineMode

protected boolean _singleLineMode

Constructor Detail

CustomFilterEditor

public CustomFilterEditor(FilterFactoryManager filterManager)

CustomFilterEditor

public CustomFilterEditor(FilterFactoryManager filterManager,
                          Class type,
                          ConverterContext converterContext,
                          Object[] possibleValues)

Method Detail

initComponents

protected void initComponents()

setLocale

public void setLocale(Locale l)

Overrides:

setLocale in class Component

createValueEditor

protected ValueEditor createValueEditor(Class type,
                                        ConverterContext converterContext,
                                        Object[] possibleValues)

Creates the ValueEditor.

Parameters:

type - the type.

converterContext - the ConverterContext.

possibleValues - the possible values.

Returns:

a new instance of the ValueEditor.

getPossibleValues

public Object[] getPossibleValues()

Gets the possible values.

Returns:

the possible values.

getType

public Class getType()

Gets the data type of this filter editor.

Returns:

the data type of this filter editor.

createConditionComboBox

protected JComponent createConditionComboBox()

Creates the condition combobox.

Returns:

the condition combobox.

getValidValueForClass

protected Object getValidValueForClass(Class expectedClass,
                                       Object value)

Get valid filter value by the input value and the expected class. In normal cases, the input value itself should be returned. In some cases, if the input is not convertible to the target class, null will be returned.

Parameters:

expectedClass - the target value class

value - the input value

Returns:

the valid value. null if no valid value found.

getFilters

public Filter[] getFilters()

Description copied from interface: FilterEditor

Gets the filters from the FilterEditor.

Specified by:

getFilters in interface FilterEditor

Returns:

the filter array.

setFilters

public void setFilters(Filter[] filters)

Description copied from interface: FilterEditor

Sets the filters to the FilterEditor, which will update the JComponent accordingly.

Specified by:

setFilters in interface FilterEditor

Parameters:

filters - the filters

getFilter

public Filter getFilter()

Gets the filter.

Returns:

the filter.

setFilter

public void setFilter(Filter filter)

Sets the filter.

Parameters:

filter - the filter.

getResourceString

protected String getResourceString(String key)

isSingleLineMode

public boolean isSingleLineMode()

setSingleLineMode

public void setSingleLineMode(boolean singleLineMode)

setVerticalLayout

public void setVerticalLayout(boolean verticalLayout)

Sets the flag indicating if the ValueEditor should be put vertically under the condition combo box.

By default, the value is false to keep consistent behavior with older releases.

Parameters:

verticalLayout - the flag

Since:

3.4.5

isVerticalLayout

public boolean isVerticalLayout()

Gets the flag indicating if the ValueEditor should be put vertically under the condition combo box.

Returns:

true if it should layout vertically. Otherwise false.

Since:

3.4.5

getObjectGrouper

public ObjectGrouper getObjectGrouper()

Gets the current ObjectGrouper instance.

Returns:

the grouper.

Since:

3.4.7

setObjectGrouper

public void setObjectGrouper(ObjectGrouper objectGrouper)

Sets the current ObjectGrouper instance.

Specified by:

setObjectGrouper in interface FilterEditor

Parameters:

objectGrouper - the grouper

Since:

3.4.7