Package org.jdesktop.swingx

Class JXList<E>

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JList<E>
org.jdesktop.swingx.JXList<E>
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, Scrollable
@JavaBean public class JXList<E> extends JList<E>
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);

Location of Trigger for ComponentPopupMenu

JXList allows access to the mouse location that triggered the showing of the componentPopupMenu. This feature allows to implement dynamic cell-context sensitive popupMenus, either in the menu actions or in a PopupMenuListener.

The example below selects the cell that was clicked, event being the PopupMenuEvent received in a PopupMenuListener. 

 
 JXList list = (JXList) ((JPopupMenu) e.getSource()).getInvoker();
 Point trigger = list.getPopupTriggerLocation();
 if (trigger != null) {
     int row = list.locationToIndex(trigger);
     list.setSelectedIndex(row);
 }

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.

Author:
Ramesh Gupta, Jeanette Winzenburg
See Also:

  • Field Details

  • Constructor Details

    • JXList

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

    • JXList

      public JXList(ListModel<E> 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(E[] 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<E> 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<E> 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(E[] 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<E> 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 Details

    • 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

      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:

    • getNextMatch

      public int getNextMatch(String prefix, int startIndex, Position.Bias bias)

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

      Overrides:
      getNextMatch in class JList<E>

    • 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

      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:

    • getRolloverController

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

      Returns:
      the RolloverController for this list, guaranteed to be not null.
      See Also:

    • createRolloverController

      protected ListRolloverController<JXList<E>> createRolloverController()
      Creates and returns a RolloverController appropriate for this component.
      Returns:
      a RolloverController appropriate for this component.
      See Also:

    • createRolloverProducer

      protected RolloverProducer createRolloverProducer()
      Creates and returns the RolloverProducer to use with this list.
      Returns:
      RolloverProducer to use with this list
      See Also:

    • getPopupLocation

      public Point getPopupLocation(MouseEvent event)

      Overridden for bookkeeping: the given event location is stored for later access.

      Overrides:
      getPopupLocation in class JComponent
      See Also:

    • updatePopupTrigger

      protected void updatePopupTrigger(MouseEvent event)
      Handles internal bookkeeping related to popupLocation, called from getPopupLocation.

      This implementation stores the mouse location as popupTriggerLocation.

      Parameters:
      event - the event that triggered the showing of the componentPopup, might be null if triggered by keyboard

    • getPopupTriggerLocation

      public Point getPopupTriggerLocation()
      Returns the location of the mouseEvent that triggered the showing of the ComponentPopupMenu.
      Returns:
      the location of the mouseEvent that triggered the last showing of the ComponentPopup, or null if it was triggered by keyboard.

    • getAutoCreateRowSorter

      public boolean getAutoCreateRowSorter()
      Returns true if whenever the model changes, a new RowSorter should be created and installed as the list'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

    • createDefaultRowSorter

      protected RowSorter<? extends ListModel<E>> 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<E>> getRowSorter()
      Returns the object responsible for sorting.
      Returns:
      the object responsible for sorting
      Since:
      1.6

    • setRowSorter

      public void setRowSorter(RowSorter<? extends ListModel<E>> 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 component supports sortable columns
      See Also:

    • isSortable

      public boolean isSortable()
      Returns the list's sortable property.
      Returns:
      true if the list 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 list'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 list'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

      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 <R extends ListModel<Object>> void setRowFilter(RowFilter<? super R,? super Integer> filter)
      Sets the filter to the sorter, if available and of type SortController. Does nothing otherwise.
      Type Parameters:
      R - RowFilter, a type which extends ListModel
      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<Object>> 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 list has a SortController. If true, the call to getSortController is guaranteed to return a not-null value.
      Returns:
      a boolean indicating whether the list has a SortController.
      See Also:

    • getControlsSorterProperties

      protected boolean getControlsSorterProperties()
      Returns a boolean indicating whether the list configures the sorter's properties. If true, guaranteed that list'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 list to the sorter. Changing the sorter under the list's feet might lead to undefined behaviour.

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

    • getElementAt

      public E 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()

    • getSelectedValue

      public E getSelectedValue()
      Returns the value for the smallest selected cell index; the selected value when only a single item is selected in the list. When multiple items are selected, it is simply the value for the smallest selected index. Returns null if there is no selection.

      This is a convenience method that simply returns the model value for getMinSelectionIndex, taking into account sorting and filtering.

      Overrides:
      getSelectedValue in class JList<E>
      Returns:
      the first selected value
      See Also:

    • setSelectedValue

      public void setSelectedValue(Object anObject, boolean shouldScroll)
      Selects the specified object from the list, taking into account sorting and filtering.
      Overrides:
      setSelectedValue in class JList<E>
      Parameters:
      anObject - the object to select
      shouldScroll - true if the list should scroll to display the selected object, if one exists; otherwise false

    • getSelectedValues

      @Deprecated public Object[] getSelectedValues()
      Deprecated.
      Overrides:
      getSelectedValues in class JList<E>

    • getSelectedValuesList

      public List<E> getSelectedValuesList()

      use SortController as model

      Overrides:
      getSelectedValuesList in class JList<E>

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

    • setModel

      public void setModel(ListModel<E> 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 JList<E>
      Parameters:
      model - the data model for this list.

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

      public Highlighter[] getHighlighters()
      Returns the Highlighters used by this list. Maybe empty, but guarantees to be never null.
      Returns:
      the Highlighters used by this list, guaranteed to never null.
      See Also:

    • 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

      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:

    • getCompoundHighlighter

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

    • 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 list 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 list, 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:
      the current string value registry

    • 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 list.

    • createDefaultCellRenderer

      protected ListCellRenderer<E> 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<E> 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 JList<E>
      See Also:

    • getWrappedCellRenderer

      public ListCellRenderer<? super E> getWrappedCellRenderer()
      Returns the renderer installed by client code or the default if none has been set.
      Returns:
      the wrapped renderer.
      See Also:

    • setCellRenderer

      public void setCellRenderer(ListCellRenderer<? super E> 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 JList<E>
      See Also:

    • invalidateCellSizeCache

      public void invalidateCellSizeCache()
      Invalidates cell size caching in the ui delegate. May do nothing if there's no safe (i.e. without reflection) way to message the delegate.

      This implementation calls the corresponding method on BasicXListUI if available, does nothing otherwise.

    • updateUI

      public void updateUI()

      Overridden to update renderer and Highlighters.

      Overrides:
      updateUI in class JList<E>

    • getUIClassID

      public String getUIClassID()

      Overrides:
      getUIClassID in class JList<E>
      Returns:
      the custom uiClassID

    • updateHighlighterUI

      protected void updateHighlighterUI()
      Updates highlighter after updateUI changes.
      See Also: