org.jdesktop.swingx
Class JXList

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JList
                  extended by org.jdesktop.swingx.JXList
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

public class JXList
extends JList

Enhanced List component with support for general SwingX sorting/filtering, rendering, highlighting, rollover and search functionality. List specific enhancements include ?? PENDING JW ...

Sorting and Filtering

JXList supports sorting and filtering. Changed to use core support. Usage is very similar to J/X/Table. It provides api to apply a specific sort order, to toggle the sort order and to reset a sort. Sort sequence can be configured by setting a custom comparator.

 list.setAutoCreateRowSorter(true);
 list.setComparator(myComparator);
 list.setSortOrder(SortOrder.DESCENDING);
 list.toggleSortOder();
 list.resetSortOrder();
 

JXList provides api to access items of the underlying model in view coordinates and to convert from/to model coordinates. Note: JXList needs a specific ui-delegate - BasicXListUI and subclasses - which is aware of model vs. view coordiate systems and which controls the synchronization of selection/dataModel and sorter state. SwingX comes with a subclass for Synth.

Rendering and Highlighting

As all SwingX collection views, a JXList is a HighlighterClient (PENDING JW: formally define and implement, like in AbstractTestHighlighter), that is it provides consistent api to add and remove Highlighters which can visually decorate the rendering component.


 
 JXList list = new JXList(new Contributors());
 // implement a custom string representation, concated from first-, lastName
 StringValue sv = new StringValue() {
     public String getString(Object value) {
        if (value instanceof Contributor) {
           Contributor contributor = (Contributor) value;
           return contributor.lastName() + ", " + contributor.firstName(); 
        }
        return StringValues.TO_STRING(value);
     }
 };
 list.setCellRenderer(new DefaultListRenderer(sv); 
 // highlight condition: gold merits
 HighlightPredicate predicate = new HighlightPredicate() {
    public boolean isHighlighted(Component renderer,
                     ComponentAdapter adapter) {
       if (!(value instanceof Contributor)) return false;              
       return ((Contributor) value).hasGold();
    }
 };
 // highlight with foreground color 
 list.addHighlighter(new PainterHighlighter(predicate, goldStarPainter);      
 
 
Note: to support the highlighting this implementation wraps the ListCellRenderer set by client code with a DelegatingRenderer which applies the Highlighter after delegating the default configuration to the wrappee. As a side-effect, getCellRenderer does return the wrapper instead of the custom renderer. To access the latter, client code must call getWrappedCellRenderer.

Rollover

As all SwingX collection views, a JXList supports per-cell rollover. If enabled, the component fires rollover events on enter/exit of a cell which by default is promoted to the renderer if it implements RolloverRenderer, that is simulates live behaviour. The rollover events can be used by client code as well, f.i. to decorate the rollover row using a Highlighter.

 
 JXList list = new JXList();
 list.setRolloverEnabled(true);
 list.setCellRenderer(new DefaultListRenderer());
 list.addHighlighter(new ColorHighlighter(HighlightPredicate.ROLLOVER_ROW, 
      null, Color.RED);      
 
 

Search

As all SwingX collection views, a JXList is searchable. A search action is registered in its ActionMap under the key "find". The default behaviour is to ask the SearchFactory to open a search component on this component. The default keybinding is retrieved from the SearchFactory, typically ctrl-f (or cmd-f for Mac). Client code can register custom actions and/or bindings as appropriate.

JXList provides api to vend a renderer-controlled String representation of cell content. This allows the Searchable and Highlighters to use WYSIWYM (What-You-See-Is-What-You-Match), that is pattern matching against the actual string as seen by the user.

See Also:
Serialized Form

Nested Class Summary
 class JXList.DelegatingRenderer
          A decorator for the original ListCellRenderer.
protected static class JXList.ListAdapter
          A component adapter targeted at a JXList.
 
Nested classes/interfaces inherited from class javax.swing.JList
JList.AccessibleJList, JList.DropLocation
 
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  CompoundHighlighter compoundHighlighter
          The pipeline holding the highlighters.
protected  ComponentAdapter dataAdapter
          The ComponentAdapter for model data access.
static String EXECUTE_BUTTON_ACTIONCOMMAND
           
static String uiClassID
          UI Class ID
 
Fields inherited from class javax.swing.JList
HORIZONTAL_WRAP, VERTICAL, VERTICAL_WRAP
 
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
JXList()
          Constructs a JXList with an empty model and filters disabled.
JXList(boolean autoCreateRowSorter)
          Constructs a JXList with an empty model and automatic creation of a RowSorter as given.
JXList(ListModel dataModel)
          Constructs a JXList that displays the elements in the specified, non-null model and automatic creation of a RowSorter disabled.
JXList(ListModel dataModel, boolean autoCreateRowSorter)
          Constructs a JXList with the specified model and automatic creation of a RowSorter as given.
JXList(Object[] listData)
          Constructs a JXList that displays the elements in the specified array and automatic creation of a RowSorter disabled.
JXList(Object[] listData, boolean autoCreateRowSorter)
          Constructs a JXList that displays the elements in the specified array and automatic creation of a RowSorter as given.
JXList(Vector<?> listData)
          Constructs a JXList that displays the elements in the specified Vector and automatic creation of a RowSorter disabled.
JXList(Vector<?> listData, boolean autoCreateRowSorter)
          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.
protected  void configureSorterProperties()
          Propagates sort-related properties from table/columns to the sorter if it is of type SortController, does nothing otherwise.
 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.
protected  ListCellRenderer createDefaultCellRenderer()
          Creates and returns the default cell renderer to use.
protected  RowSorter<? extends ListModel> createDefaultRowSorter()
          Creates and returns the default RowSorter.
protected  StringValueRegistry createDefaultStringValueRegistry()
          Creates and returns the default registry for StringValues.
protected  ChangeListener createHighlighterChangeListener()
          Creates and returns the ChangeListener observing Highlighters.
protected  ListRolloverController<JXList> createLinkController()
          Creates and returns a RolloverController appropriate for this component.
protected  RolloverProducer createRolloverProducer()
          Creates and returns the RolloverProducer to use with this tree.
protected  void doFind()
          Starts a search on this List's visible items.
 boolean getAutoCreateRowSorter()
          Returns true if whenever the model changes, a new RowSorter should be created and installed as the table's sorter; otherwise, returns false.
 ListCellRenderer getCellRenderer()
          Returns the object responsible for painting list items.
 Comparator<?> getComparator()
           
protected  ComponentAdapter getComponentAdapter()
           
protected  ComponentAdapter getComponentAdapter(int index)
          Convenience to access a configured ComponentAdapter.
protected  CompoundHighlighter getCompoundHighlighter()
          Returns the CompoundHighlighter assigned to the table, null if none.
protected  boolean getControlsSorterProperties()
          Returns a boolean indicating whether the table configures the sorter's properties.
 Object getElementAt(int viewIndex)
          Returns the element at the given index.
 int getElementCount()
          Returns the number of elements in this list in view coordinates.
protected  ChangeListener getHighlighterChangeListener()
          Returns the ChangeListener to use with highlighters.
 Highlighter[] getHighlighters()
          Returns the Highlighters used by this table.
protected  ListRolloverController<JXList> getLinkController()
          Returns the RolloverController for this component.
 int getNextMatch(String prefix, int startIndex, Position.Bias bias)
          Returns the next list element whose toString value starts with the given prefix.
 RowFilter<?,?> getRowFilter()
          Returns the filter of the sorter, if available and of type SortController.
 RowSorter<? extends ListModel> getRowSorter()
          Returns the object responsible for sorting.
 Searchable getSearchable()
          Returns a Searchable for this component, guaranteed to be not null.
protected  SortController<? extends ListModel> getSortController()
          Returns the currently active SortController.
 SortOrder getSortOrder()
          Returns the SortOrder.
 SortOrder[] getSortOrderCycle()
          Returns the sortOrder cycle used when toggle sorting this table's columns, guaranteed to be not null.
 boolean getSortsOnUpdates()
          Returns true if a sort should happen when the underlying model is updated; otherwise, returns false.
 String getStringAt(int row)
          Returns the string representation of the cell value at the given position.
protected  StringValueRegistry getStringValueRegistry()
          Returns the StringValueRegistry which defines the string representation for each cells.
 String getUIClassID()
          Returns "ListUI", the UIDefaults key used to look up the name of the javax.swing.plaf.ListUI class that defines the look and feel for this component.
 ListCellRenderer getWrappedCellRenderer()
          Returns the renderer installed by client code or the default if none has been set.
 ListModel getWrappedModel()
          Deprecated. no longer used - custom ui-delegate does-the-right-thing when accessing elements.
protected  boolean hasSortController()
          Returns a boolean indicating whether the table has a SortController.
 boolean isRolloverEnabled()
          Returns a boolean indicating whether or not rollover support is enabled.
 boolean isSortable()
          Returns the table's sortable property.
 void removeHighlighter(Highlighter highlighter)
          Removes the given Highlighter.
 void resetSortOrder()
          Resets sorting of all columns.
 void setAutoCreateRowSorter(boolean autoCreateRowSorter)
          Specifies whether a RowSorter should be created for the list whenever its model changes.
 void setCellRenderer(ListCellRenderer renderer)
          Sets the delegate that is used to paint each cell in the list.
 void setComparator(Comparator<?> comparator)
          Sets the comparator to use for sorting.
 void setHighlighters(Highlighter... highlighters)
          Sets the Highlighters to the table, replacing any old settings.
 void setModel(ListModel model)
          Sets the model that represents the contents or "value" of the list, notifies property change listeners, and then clears the list's selection.
 void setRolloverEnabled(boolean rolloverEnabled)
          Sets the property to enable/disable rollover support.
 void setRowFilter(RowFilter<? super ListModel,? super Integer> filter)
          Sets the filter to the sorter, if available and of type SortController.
 void setRowSorter(RowSorter<? extends ListModel> sorter)
          Sets the RowSorter.
 void setSearchable(Searchable searchable)
          Sets the Searchable for this component.
 void setSortable(boolean sortable)
          Sets "sortable" property indicating whether or not this list isSortable.
 void setSortOrder(SortOrder sortOrder)
          Sorts the list using SortOrder.
 void setSortOrderCycle(SortOrder... cycle)
          Sets the sortorder cycle used when toggle sorting this table's columns.
 void setSortsOnUpdates(boolean sortsOnUpdates)
          If true, specifies that a sort should happen when the underlying model is updated (rowsUpdated is invoked).
 void toggleSortOrder()
          Toggles the sort order of the list.
protected  void updateHighlighterUI()
          Updates highlighter after updateUI changes.
protected  void updateSortAfterComparatorChange()
          Updates the SortController's comparator, if available.
 void updateUI()
          Resets the ListUI property by setting it to the value provided by the current look and feel.
 
Methods inherited from class javax.swing.JList
addListSelectionListener, addSelectionInterval, clearSelection, createSelectionModel, ensureIndexIsVisible, fireSelectionValueChanged, getAccessibleContext, getAnchorSelectionIndex, getCellBounds, getDragEnabled, getDropLocation, getDropMode, getFirstVisibleIndex, getFixedCellHeight, getFixedCellWidth, getLastVisibleIndex, getLayoutOrientation, getLeadSelectionIndex, getListSelectionListeners, getMaxSelectionIndex, getMinSelectionIndex, getModel, getPreferredScrollableViewportSize, getPrototypeCellValue, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValues, getSelectionBackground, getSelectionForeground, getSelectionMode, getSelectionModel, getToolTipText, getUI, getValueIsAdjusting, getVisibleRowCount, indexToLocation, isSelectedIndex, isSelectionEmpty, locationToIndex, paramString, removeListSelectionListener, removeSelectionInterval, setDragEnabled, setDropMode, setFixedCellHeight, setFixedCellWidth, setLayoutOrientation, setListData, setListData, setPrototypeCellValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectionBackground, setSelectionForeground, setSelectionInterval, setSelectionMode, setSelectionModel, setUI, setValueIsAdjusting, setVisibleRowCount
 
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, 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, 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
 

Field Detail

uiClassID

public static final String uiClassID
UI Class ID

See Also:
Constant Field Values

EXECUTE_BUTTON_ACTIONCOMMAND

public static final String EXECUTE_BUTTON_ACTIONCOMMAND
See Also:
Constant Field Values

compoundHighlighter

protected CompoundHighlighter compoundHighlighter
The pipeline holding the highlighters.


dataAdapter

protected ComponentAdapter dataAdapter
The ComponentAdapter for model data access.

Constructor Detail

JXList

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


JXList

public JXList(ListModel dataModel)
Constructs a JXList that displays the elements in the specified, non-null model and automatic creation of a RowSorter disabled.

Parameters:
dataModel - the data model for this list
Throws:
IllegalArgumentException - if dataModel is null

JXList

public JXList(Object[] listData)
Constructs a JXList that displays the elements in the specified array and automatic creation of a RowSorter disabled.

Parameters:
listData - the array of Objects to be loaded into the data model
Throws:
IllegalArgumentException - if listData is null

JXList

public JXList(Vector<?> listData)
Constructs a JXList that displays the elements in the specified Vector and automatic creation of a RowSorter disabled.

Parameters:
listData - the Vector to be loaded into the data model
Throws:
IllegalArgumentException - if listData is null

JXList

public JXList(boolean autoCreateRowSorter)
Constructs a JXList with an empty model and automatic creation of a RowSorter as given.

Parameters:
autoCreateRowSorter - boolean to determine if a RowSorter should be created automatically.

JXList

public JXList(ListModel dataModel,
              boolean autoCreateRowSorter)
Constructs a JXList with the specified model and automatic creation of a RowSorter as given.

Parameters:
dataModel - the data model for this list
autoCreateRowSorter - boolean to determine if a RowSorter should be created automatically.
Throws:
IllegalArgumentException - if dataModel is null

JXList

public JXList(Object[] listData,
              boolean autoCreateRowSorter)
Constructs a JXList that displays the elements in the specified array and automatic creation of a RowSorter as given.

Parameters:
listData - the array of Objects to be loaded into the data model
autoCreateRowSorter - boolean to determine if a RowSorter should be created automatically.
Throws:
IllegalArgumentException - if listData is null

JXList

public JXList(Vector<?> listData,
              boolean autoCreateRowSorter)
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
autoCreateRowSorter - boolean to determine if a RowSorter should be created automatically.
Throws:
IllegalArgumentException - if listData is null
Method Detail

doFind

protected void doFind()
Starts a search on this List's visible items. This implementation asks the SearchFactory to open a find widget on itself.


getSearchable

public Searchable getSearchable()
Returns a Searchable for this component, guaranteed to be not null. This implementation lazily creates a ListSearchable if necessary.

Returns:
a not-null Searchable for this list.
See Also:
setSearchable(Searchable), ListSearchable

setSearchable

public void setSearchable(Searchable searchable)
Sets the Searchable for this component. If null, a default Searchable will be created and used.

Parameters:
searchable - the Searchable to use for this component, may be null to indicate using the list's default searchable.
See Also:
getSearchable()

getNextMatch

public int getNextMatch(String prefix,
                        int startIndex,
                        Position.Bias bias)
Returns the next list element whose toString value starts with the given prefix.

Overridden to cope with sorting/filtering, taking over completely.

Overrides:
getNextMatch in class JList
Parameters:
prefix - the string to test for a match
startIndex - the index for starting the search
bias - the search direction, either Position.Bias.Forward or Position.Bias.Backward.
Returns:
the index of the next list element that starts with the prefix; otherwise -1

setRolloverEnabled

public void setRolloverEnabled(boolean rolloverEnabled)
Sets the property to enable/disable rollover support. If enabled, the list fires property changes on per-cell mouse rollover state, i.e. when the mouse enters/leaves a list cell.

This can be enabled to show "live" rollover behaviour, f.i. the cursor over a cell rendered by a JXHyperlink.

Default value is disabled.

Parameters:
rolloverEnabled - a boolean indicating whether or not the rollover functionality should be enabled.
See Also:
isRolloverEnabled(), getLinkController(), createRolloverProducer(), RolloverRenderer

isRolloverEnabled

public boolean isRolloverEnabled()
Returns a boolean indicating whether or not rollover support is enabled.

Returns:
a boolean indicating whether or not rollover support is enabled.
See Also:
setRolloverEnabled(boolean)

getLinkController

protected ListRolloverController<JXList> getLinkController()
Returns the RolloverController for this component. Lazyly creates the controller if necessary, that is the return value is guaranteed to be not null.

PENDING JW: rename to getRolloverController

Returns:
the RolloverController for this tree, guaranteed to be not null.
See Also:
setRolloverEnabled(boolean), createLinkController(), RolloverController

createLinkController

protected ListRolloverController<JXList> createLinkController()
Creates and returns a RolloverController appropriate for this component.

Returns:
a RolloverController appropriate for this component.
See Also:
getLinkController(), RolloverController

createRolloverProducer

protected RolloverProducer createRolloverProducer()
Creates and returns the RolloverProducer to use with this tree.

Returns:
RolloverProducer to use with this tree
See Also:
setRolloverEnabled(boolean)

getAutoCreateRowSorter

public boolean getAutoCreateRowSorter()
Returns true if whenever the model changes, a new RowSorter should be created and installed as the table's sorter; otherwise, returns false.

Returns:
true if a RowSorter should be created when the model changes
Since:
1.6

setAutoCreateRowSorter

public void setAutoCreateRowSorter(boolean autoCreateRowSorter)
Specifies whether a RowSorter should be created for the list whenever its model changes.

When setAutoCreateRowSorter(true) is invoked, a RowSorter is immediately created and installed on the list. While the autoCreateRowSorter property remains true, every time the model is changed, a new RowSorter is created and set as the list's row sorter.

The default value is false.

Parameters:
autoCreateRowSorter - whether or not a RowSorter should be automatically created
This class has associated bean info for instrumenting visual editors named
bound: true preferred: true description: Whether or not to turn on sorting by default.

createDefaultRowSorter

protected RowSorter<? extends ListModel> createDefaultRowSorter()
Creates and returns the default RowSorter. Note that this is already configured to the current ListModel. PENDING JW: review method signature - better expose the need for the model by adding a parameter?

Returns:
the default RowSorter.

getRowSorter

public RowSorter<? extends ListModel> getRowSorter()
Returns the object responsible for sorting.

Returns:
the object responsible for sorting
Since:
1.6

setRowSorter

public void setRowSorter(RowSorter<? extends ListModel> sorter)
Sets the RowSorter. RowSorter is used to provide sorting and filtering to a JXList.

This method clears the selection and resets any variable row heights.

If the underlying model of the RowSorter differs from that of this JXList undefined behavior will result.

Parameters:
sorter - the RowSorter; null turns sorting off

configureSorterProperties

protected void configureSorterProperties()
Propagates sort-related properties from table/columns to the sorter if it is of type SortController, does nothing otherwise.


setSortable

public void setSortable(boolean sortable)
Sets "sortable" property indicating whether or not this list isSortable. Note: as of post-1.0 this property is propagated to the SortController. Whether or not a change triggers a re-sort is up to either the concrete controller implementation (the default doesn't) or client code. This behaviour is different from old SwingX style sorting.

Parameters:
sortable - boolean indicating whether or not this table supports sortable columns
See Also:
TableColumnExt.isSortable()

isSortable

public boolean isSortable()
Returns the table's sortable property.

Returns:
true if the table is sortable.

setSortsOnUpdates

public void setSortsOnUpdates(boolean sortsOnUpdates)
If true, specifies that a sort should happen when the underlying model is updated (rowsUpdated is invoked). For example, if this is true and the user edits an entry the location of that item in the view may change. The default is true.

Parameters:
sortsOnUpdates - whether or not to sort on update events

getSortsOnUpdates

public boolean getSortsOnUpdates()
Returns true if a sort should happen when the underlying model is updated; otherwise, returns false.

Returns:
whether or not to sort when the model is updated

setSortOrderCycle

public void setSortOrderCycle(SortOrder... cycle)
Sets the sortorder cycle used when toggle sorting this table's columns. This property is propagated to the SortController if controlsSorterProperties is true.

Parameters:
cycle - the sequence of zero or more not-null SortOrders to cycle through.
Throws:
NullPointerException - if the array or any of its elements are null

getSortOrderCycle

public SortOrder[] getSortOrderCycle()
Returns the sortOrder cycle used when toggle sorting this table's columns, guaranteed to be not null.

Returns:
the sort order cycle used in toggle sort, not null

getComparator

public Comparator<?> getComparator()
Returns:
the comparator used.
See Also:
setComparator(Comparator)

setComparator

public void setComparator(Comparator<?> comparator)
Sets the comparator to use for sorting.

Note: as of post-1.0 the property is propagated to the SortController, if available. Whether or not a change triggers a re-sort is up to either the concrete controller implementation (the default doesn't) or client code. This behaviour is different from old SwingX style sorting.

Parameters:
comparator - the comparator to use.

updateSortAfterComparatorChange

protected void updateSortAfterComparatorChange()
Updates the SortController's comparator, if available. Does nothing otherwise.


setRowFilter

public void setRowFilter(RowFilter<? super ListModel,? super Integer> filter)
Sets the filter to the sorter, if available and of type SortController. Does nothing otherwise.

Parameters:
filter - the filter used to determine what entries should be included

getRowFilter

public RowFilter<?,?> getRowFilter()
Returns the filter of the sorter, if available and of type SortController. Returns null otherwise.

PENDING JW: generics? had to remove return type from getSortController to make this compilable, so probably wrong.

Returns:
the filter used in the sorter.

resetSortOrder

public void resetSortOrder()
Resets sorting of all columns. Delegates to the SortController if available, or does nothing if not.

PENDING JW: method name - consistent in SortController and here.


toggleSortOrder

public void toggleSortOrder()
Toggles the sort order of the list. Delegates to the SortController if available, or does nothing if not.

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


setSortOrder

public void setSortOrder(SortOrder sortOrder)
Sorts the list using SortOrder. Delegates to the SortController if available, or does nothing if not.

Parameters:
sortOrder - the sort order to use.

getSortOrder

public SortOrder getSortOrder()
Returns the SortOrder. Delegates to the SortController if available, or returns SortOrder.UNSORTED if not.

Returns:
the current SortOrder

getSortController

protected SortController<? extends ListModel> getSortController()
Returns the currently active SortController. May be null if RowSorter is null or not of type SortController.

PENDING JW: swaying about hiding or not - currently the only way to make the view not configure a RowSorter of type SortController is to let this return null.

Returns:
the currently active SortController may be null

hasSortController

protected boolean hasSortController()
Returns a boolean indicating whether the table has a SortController. If true, the call to getSortController is guaranteed to return a not-null value.

Returns:
a boolean indicating whether the table has a SortController.
See Also:
getSortController()

getControlsSorterProperties

protected boolean getControlsSorterProperties()
Returns a boolean indicating whether the table configures the sorter's properties. If true, guaranteed that table's and the columns' sort related properties are propagated to the sorter. If false, guaranteed to not touch the sorter's configuration.

This implementation returns true if the sorter is of type SortController. Note: the synchronization is unidirection from the table to the sorter. Changing the sorter under the table's feet might lead to undefined behaviour.

Returns:
a boolean indicating whether the table configurers the sorter's properties.

getElementAt

public 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:
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:
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.

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

@Deprecated
public ListModel getWrappedModel()
Deprecated. no longer used - custom ui-delegate does-the-right-thing when accessing elements.

Returns:
the underlying model, same as getModel().

setModel

public void setModel(ListModel model)
Sets the model that represents the contents or "value" of the list, notifies property change listeners, and then clears the list's selection.

This is a JavaBeans bound property.

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 JList
Parameters:
model - the data model for this list.
See Also:
JList.getModel(), JList.clearSelection()

getComponentAdapter

protected ComponentAdapter getComponentAdapter()
Returns:
the unconfigured ComponentAdapter.

getComponentAdapter

protected ComponentAdapter getComponentAdapter(int index)
Convenience to access a configured ComponentAdapter. Note: the column index of the configured adapter is always 0.

Parameters:
index - the row index in view coordinates, must be valid.
Returns:
the configured ComponentAdapter.

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:
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:
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...)

getCompoundHighlighter

protected CompoundHighlighter getCompoundHighlighter()
Returns the CompoundHighlighter assigned to the table, null if none. PENDING: open up for subclasses again?.

Returns:
the CompoundHighlighter assigned to the table.

getHighlighterChangeListener

protected ChangeListener getHighlighterChangeListener()
Returns the ChangeListener to use with highlighters. Lazily creates the listener.

Returns:
the ChangeListener for observing changes of highlighters, guaranteed to be not-null

createHighlighterChangeListener

protected ChangeListener createHighlighterChangeListener()
Creates and returns the ChangeListener observing Highlighters.

Here: repaints the table on receiving a stateChanged.

Returns:
the ChangeListener defining the reaction to changes of highlighters.

getStringValueRegistry

protected StringValueRegistry getStringValueRegistry()
Returns the StringValueRegistry which defines the string representation for each cells. This is strictly for internal use by the table, which has the responsibility to keep in synch with registered renderers.

Currently exposed for testing reasons, client code is recommended to not use nor override.

Returns:

createDefaultStringValueRegistry

protected StringValueRegistry createDefaultStringValueRegistry()
Creates and returns the default registry for StringValues.

Returns:
the default registry for StringValues.

getStringAt

public 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.

createDefaultCellRenderer

protected ListCellRenderer createDefaultCellRenderer()
Creates and returns the default cell renderer to use. Subclasses may override to use a different type. Here: returns a DefaultListRenderer.

Returns:
the default cell renderer to use with this list.

getCellRenderer

public ListCellRenderer getCellRenderer()
Returns the object responsible for painting list items.

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 JList
Returns:
the value of the cellRenderer property
See Also:
setCellRenderer(ListCellRenderer), JXList.DelegatingRenderer

getWrappedCellRenderer

public 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(ListCellRenderer renderer)
Sets the delegate that is used to paint each cell in the list. The job of a cell renderer is discussed in detail in the class level documentation.

If the prototypeCellValue property is non-null, setting the cell renderer also causes the fixedCellWidth and fixedCellHeight properties to be re-calculated. Only one PropertyChangeEvent is generated however - for the cellRenderer property.

The default value of this property is provided by the ListUI delegate, i.e. by the look and feel implementation.

This is a JavaBeans bound property.

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 JList
Parameters:
renderer - the ListCellRenderer that paints list cells
See Also:
getWrappedCellRenderer(), getCellRenderer()

updateUI

public void updateUI()
Resets the ListUI property by setting it to the value provided by the current look and feel. If the current cell renderer was installed by the developer (rather than the look and feel itself), this also causes the cell renderer and its children to be updated, by calling SwingUtilities.updateComponentTreeUI on it.

Overridden to update renderer and Highlighters.

Overrides:
updateUI in class JList
See Also:
UIManager.getUI(javax.swing.JComponent), SwingUtilities.updateComponentTreeUI(java.awt.Component)

getUIClassID

public String getUIClassID()
Description copied from class: javax.swing.JList
Returns "ListUI", the UIDefaults key used to look up the name of the javax.swing.plaf.ListUI class that defines the look and feel for this component.

Overrides:
getUIClassID in class JList
Returns:
the string "ListUI"
See Also:
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

updateHighlighterUI

protected void updateHighlighterUI()
Updates highlighter after updateUI changes.

See Also:
UIDependent