org.jdesktop.swingx
Class JXList

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JList
                  org.jdesktop.swingx.JXList

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

public class JXList
extends javax.swing.JList

JXList. Enabled Rollover/LinkModel handling. Enabled Highlighter support. Added experimental support for filtering/sorting. This feature is disabled by default because it has side-effects which might break "normal" expectations when using a JList: if enabled all row coordinates (including those returned by the selection) are in view coordinates. Furthermore, the model returned from getModel() is a wrapper around the actual data.

Author:

Ramesh Gupta, Jeanette Winzenburg

See Also:

Serialized Form

Nested Class Summary

class

JXList.DelegatingRenderer A decorator for the original ListCellRenderer.

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

javax.swing.JList.DropLocation

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

static java.lang.String

EXECUTE_BUTTON_ACTIONCOMMAND

Fields inherited from class javax.swing.JList

HORIZONTAL_WRAP, VERTICAL, VERTICAL_WRAP

Fields inherited from class javax.swing.JComponent

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

JXList()
Constructs a JXList with an empty model and filters disabled.

JXList(boolean filterEnabled)
Constructs a JXList with an empty model and filterEnabled property.

JXList(javax.swing.ListModel dataModel)
Constructs a JXList that displays the elements in the specified, non-null model and filters disabled.

JXList(javax.swing.ListModel dataModel, boolean filterEnabled)
Constructs a JXList with the specified model and filterEnabled property.

JXList(java.lang.Object[] listData)
Constructs a JXList that displays the elements in the specified array and filters disabled.

JXList(java.lang.Object[] listData, boolean filterEnabled)
Constructs a JXList that displays the elements in the specified array and filterEnabled property.

JXList(java.util.Vector<?> listData)
Constructs a JXList that displays the elements in the specified Vector and filtes disabled.

JXList(java.util.Vector<?> listData, boolean filterEnabled)
Constructs a JXList that displays the elements in the specified Vector and filtersEnabled property.

Method Summary

void	addHighlighter(Highlighter highlighter) Appends a Highlighter to the end of the list of used Highlighters.
int	convertIndexToModel(int viewIndex) Convert row index from view coordinates to model coordinates accounting for the presence of sorters and filters.
int	convertIndexToView(int modelIndex) Convert index from model coordinates to view coordinates accounting for the presence of sorters and filters.
javax.swing.ListCellRenderer	getCellRenderer() Overridden to return the delegating renderer which is wrapped around the original to support highlighting.
java.util.Comparator<?>	getComparator()
java.lang.Object	getElementAt(int viewIndex) returns the element at the given index.
int	getElementCount() Returns the number of elements in this list in view coordinates.
FilterPipeline	getFilters()
Highlighter[]	getHighlighters() Returns the Highlighters used by this table.
Searchable	getSearchable()
SortOrder	getSortOrder() Returns the SortOrder.
java.lang.String	getStringAt(int row) Returns the string representation of the cell value at the given position.
javax.swing.ListCellRenderer	getWrappedCellRenderer() Returns the renderer installed by client code or the default if none has been set.
javax.swing.ListModel	getWrappedModel() returns the underlying model.
boolean	isFilterEnabled()
boolean	isRolloverEnabled() returns the rolloverEnabled property.
void	removeHighlighter(Highlighter highlighter) Removes the given Highlighter.
void	resetSortOrder() Removes the interactive sorter.
void	setCellRenderer(javax.swing.ListCellRenderer renderer) Overridden to wrap the given renderer in a DelegatingRenderer to support highlighting.
void	setComparator(java.util.Comparator<?> comparator) Sets the comparator used.
void	setFilterEnabled(boolean enabled) Enables/disables filtering support.
void	setFilters(FilterPipeline pipeline) Sets the FilterPipeline for filtering the items of this list, maybe null to remove all previously applied filters.
void	setHighlighters(Highlighter... highlighters) Sets the Highlighters to the table, replacing any old settings.
void	setModel(javax.swing.ListModel model) Sets the underlying data model.
void	setRolloverEnabled(boolean rolloverEnabled) Property to enable/disable rollover support.
void	setSearchable(Searchable searchable) sets the Searchable for this editor.
void	setSelectionModel(javax.swing.ListSelectionModel newModel) Overridden to update selectionMapper
void	setSortOrder(SortOrder sortOrder) Sorts the list using SortOrder.
void	toggleSortOrder() Toggles the sort order of the items.
void	updateUI()

Methods inherited from class javax.swing.JList

addListSelectionListener, addSelectionInterval, clearSelection, ensureIndexIsVisible, getAccessibleContext, getAnchorSelectionIndex, getCellBounds, getDragEnabled, getDropLocation, getDropMode, getFirstVisibleIndex, getFixedCellHeight, getFixedCellWidth, getLastVisibleIndex, getLayoutOrientation, getLeadSelectionIndex, getListSelectionListeners, getMaxSelectionIndex, getMinSelectionIndex, getModel, getNextMatch, getPreferredScrollableViewportSize, getPrototypeCellValue, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValues, getSelectionBackground, getSelectionForeground, getSelectionMode, getSelectionModel, getToolTipText, getUI, getUIClassID, getValueIsAdjusting, getVisibleRowCount, indexToLocation, isSelectedIndex, isSelectionEmpty, locationToIndex, removeListSelectionListener, removeSelectionInterval, setDragEnabled, setDropMode, setFixedCellHeight, setFixedCellWidth, setLayoutOrientation, setListData, setListData, setPrototypeCellValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectionBackground, setSelectionForeground, setSelectionInterval, setSelectionMode, setUI, setValueIsAdjusting, setVisibleRowCount

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EXECUTE_BUTTON_ACTIONCOMMAND

public static final java.lang.String EXECUTE_BUTTON_ACTIONCOMMAND

See Also:

Constant Field Values

Constructor Detail

JXList

public JXList()

Constructs a JXList with an empty model and filters disabled.

JXList

public JXList(javax.swing.ListModel dataModel)

Constructs a JXList that displays the elements in the specified, non-null model and filters disabled.

Parameters:

dataModel - the data model for this list

Throws:

java.lang.IllegalArgumentException - if dataModel is null

JXList

public JXList(java.lang.Object[] listData)

Constructs a JXList that displays the elements in the specified array and filters disabled.

Parameters:

listData - the array of Objects to be loaded into the data model

Throws:

java.lang.IllegalArgumentException - if listData is null

JXList

public JXList(java.util.Vector<?> listData)

Constructs a JXList that displays the elements in the specified Vector and filtes disabled.

Parameters:

listData - the Vector to be loaded into the data model

Throws:

java.lang.IllegalArgumentException - if listData is null

JXList

public JXList(boolean filterEnabled)

Constructs a JXList with an empty model and filterEnabled property.

Parameters:

filterEnabled - boolean to determine if filtering/sorting is enabled

JXList

public JXList(javax.swing.ListModel dataModel,
              boolean filterEnabled)

Constructs a JXList with the specified model and filterEnabled property.

Parameters:

dataModel - the data model for this list

filterEnabled - boolean to determine if filtering/sorting is enabled

Throws:

java.lang.IllegalArgumentException - if dataModel is null

JXList

public JXList(java.lang.Object[] listData,
              boolean filterEnabled)

Constructs a JXList that displays the elements in the specified array and filterEnabled property.

Parameters:

listData - the array of Objects to be loaded into the data model

filterEnabled - boolean to determine if filtering/sorting is enabled

Throws:

java.lang.IllegalArgumentException - if listData is null

JXList

public JXList(java.util.Vector<?> listData,
              boolean filterEnabled)

Constructs a JXList that displays the elements in the specified Vector and filtersEnabled property.

Parameters:

listData - the Vector to be loaded into the data model

filterEnabled - boolean to determine if filtering/sorting is enabled

Throws:

java.lang.IllegalArgumentException - if listData is null

Method Detail

getSearchable

public Searchable getSearchable()

Returns:

a not-null Searchable for this editor.

setSearchable

public void setSearchable(Searchable searchable)

sets the Searchable for this editor. If null, a default searchable will be used.

Parameters:

searchable -

setRolloverEnabled

public void setRolloverEnabled(boolean rolloverEnabled)

Property to enable/disable rollover support. This can be enabled to show "live" rollover behaviour, f.i. the cursor over LinkModel cells. Default is disabled.

Parameters:

rolloverEnabled -

isRolloverEnabled

public boolean isRolloverEnabled()

returns the rolloverEnabled property.

Returns:

true if rollover is enabled

resetSortOrder

public void resetSortOrder()

Removes the interactive sorter.

toggleSortOrder

public void toggleSortOrder()

Toggles the sort order of the items.

The exact behaviour is defined by the SortController's toggleSortOrder implementation. Typically a unsorted column is sorted in ascending order, a sorted column's order is reversed.

PENDING: where to get the comparator from?

setSortOrder

public void setSortOrder(SortOrder sortOrder)

Sorts the list using SortOrder. Respects the JXList's sortable and comparator properties: routes the comparator to the SortController and does nothing if !isFilterEnabled().

Parameters:

sortOrder - the sort order to use. If null or SortOrder.UNSORTED, this method has the same effect as resetSortOrder();

getSortOrder

public SortOrder getSortOrder()

Returns the SortOrder.

Returns:

the interactive sorter's SortOrder or SortOrder.UNSORTED

getComparator

public java.util.Comparator<?> getComparator()

Returns:

the comparator used.

See Also:

setComparator(Comparator)

setComparator

public void setComparator(java.util.Comparator<?> comparator)

Sets the comparator used. As a side-effect, the current sort might be updated. The exact behaviour is defined in #updateSortAfterComparatorChange.

Parameters:

comparator - the comparator to use.

getElementAt

public java.lang.Object getElementAt(int viewIndex)

returns the element at the given index. The index is in view coordinates which might differ from model coordinates if filtering is enabled and filters/sorters are active.

Parameters:

viewIndex - the index in view coordinates

Returns:

the element at the index

Throws:

java.lang.IndexOutOfBoundsException - if viewIndex < 0 or viewIndex >= getElementCount()

getElementCount

public int getElementCount()

Returns the number of elements in this list in view coordinates. If filters are active this number might be less than the number of elements in the underlying model.

Returns:

number of elements in this list in view coordinates

convertIndexToModel

public int convertIndexToModel(int viewIndex)

Convert row index from view coordinates to model coordinates accounting for the presence of sorters and filters.

Parameters:

viewIndex - index in view coordinates

Returns:

index in model coordinates

Throws:

java.lang.IndexOutOfBoundsException - if viewIndex < 0 or viewIndex >= getElementCount()

convertIndexToView

public int convertIndexToView(int modelIndex)

Convert index from model coordinates to view coordinates accounting for the presence of sorters and filters. PENDING Filter guards against out of range - should not?

Parameters:

modelIndex - index in model coordinates

Returns:

index in view coordinates if the model index maps to a view coordinate or -1 if not contained in the view.

getWrappedModel

public javax.swing.ListModel getWrappedModel()

returns the underlying model. If !isFilterEnabled this will be the same as getModel().

Returns:

the underlying model

setFilterEnabled

public void setFilterEnabled(boolean enabled)

Enables/disables filtering support. If enabled all row indices - including the selection - are in view coordinates and getModel returns a wrapper around the underlying model. Note: as an implementation side-effect calling this method clears the selection (done in super.setModel). PENDING: cleanup state transitions!! - currently this can be safely applied once only to enable. Internal state is inconsistent if trying to disable again. As a temporary emergency measure, this will throw a IllegalStateException. see Issue #2-swinglabs.

Parameters:

enabled -

Throws:

java.lang.IllegalStateException - if trying to disable again.

isFilterEnabled

public boolean isFilterEnabled()

Returns:

a indicating if filtering is enabled.

See Also:

setFilterEnabled(boolean)

setSelectionModel

public void setSelectionModel(javax.swing.ListSelectionModel newModel)

Overridden to update selectionMapper

Overrides:

setSelectionModel in class javax.swing.JList

setModel

public void setModel(javax.swing.ListModel model)

Sets the underlying data model. Note that if isFilterEnabled you must call getWrappedModel to access the model given here. In this case getModel returns a wrapper around the data!

Overrides:

setModel in class javax.swing.JList

Parameters:

model - the data model for this list.

getFilters

public FilterPipeline getFilters()

Returns:

the FilterPipeline assigned to this list, or null if !isFiltersEnabled().

setFilters

public void setFilters(FilterPipeline pipeline)

Sets the FilterPipeline for filtering the items of this list, maybe null to remove all previously applied filters. Note: the current "interactive" sortState is preserved (by internally copying the old sortKeys to the new pipeline, if any). PRE: isFilterEnabled()

Parameters:

pipeline - the FilterPipeline to use, null removes all filters.

Throws:

java.lang.IllegalStateException - if !isFilterEnabled()

setHighlighters

public void setHighlighters(Highlighter... highlighters)

Sets the Highlighters to the table, replacing any old settings. None of the given Highlighters must be null.

This is a bound property.

Note: as of version #1.257 the null constraint is enforced strictly. To remove all highlighters use this method without param.

Parameters:

highlighters - zero or more not null highlighters to use for renderer decoration.

Throws:

java.lang.NullPointerException - if array is null or array contains null values.

See Also:

getHighlighters(), addHighlighter(Highlighter), removeHighlighter(Highlighter)

getHighlighters

public Highlighter[] getHighlighters()

Returns the Highlighters used by this table. Maybe empty, but guarantees to be never null.

Returns:

the Highlighters used by this table, guaranteed to never null.

See Also:

setHighlighters(Highlighter[])

addHighlighter

public void addHighlighter(Highlighter highlighter)

Appends a Highlighter to the end of the list of used Highlighters. The argument must not be null.

Parameters:

highlighter - the Highlighter to add, must not be null.

Throws:

java.lang.NullPointerException - if Highlighter is null.

See Also:

removeHighlighter(Highlighter), setHighlighters(Highlighter[])

removeHighlighter

public void removeHighlighter(Highlighter highlighter)

Removes the given Highlighter.

Does nothing if the Highlighter is not contained.

Parameters:

highlighter - the Highlighter to remove.

See Also:

addHighlighter(Highlighter), setHighlighters(Highlighter...)

getStringAt

public java.lang.String getStringAt(int row)

Returns the string representation of the cell value at the given position.

Parameters:

row - the row index of the cell in view coordinates

Returns:

the string representation of the cell value as it will appear in the table.

getCellRenderer

public javax.swing.ListCellRenderer getCellRenderer()

Overridden to return the delegating renderer which is wrapped around the original to support highlighting. The returned renderer is of type DelegatingRenderer and guaranteed to not-null

Overrides:

getCellRenderer in class javax.swing.JList

See Also:

setCellRenderer(ListCellRenderer), JXList.DelegatingRenderer

getWrappedCellRenderer

public javax.swing.ListCellRenderer getWrappedCellRenderer()

Returns the renderer installed by client code or the default if none has been set.

Returns:

the wrapped renderer.

See Also:

setCellRenderer(ListCellRenderer)

setCellRenderer

public void setCellRenderer(javax.swing.ListCellRenderer renderer)

Overridden to wrap the given renderer in a DelegatingRenderer to support highlighting.

Note: the wrapping implies that the renderer returned from the getCellRenderer is not the renderer as given here, but the wrapper. To access the original, use getWrappedCellRenderer.

Overrides:

setCellRenderer in class javax.swing.JList

See Also:

getWrappedCellRenderer(), getCellRenderer()

updateUI

public void updateUI()

Overrides:

updateUI in class javax.swing.JList