| |
|
| javax.swing.JComponent javax.swing.JList org.jdesktop.swingx.JXList
JXList | public class JXList extends JList (Code) | | 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 author: Jeanette Winzenburg |
Inner Class :public static class ListRolloverController extends RolloverController | |
Constructor Summary | |
public | JXList() Constructs a JXList with an empty model and filters disabled. | public | JXList(ListModel dataModel) Constructs a JXList that displays the elements in the
specified, non-null model and filters disabled. | public | JXList(Object[] listData) Constructs a JXList that displays the elements in
the specified array and filters disabled. | public | JXList(Vector> listData) Constructs a JXList that displays the elements in
the specified Vector and filtes disabled. | public | JXList(boolean filterEnabled) Constructs a JXList with an empty model and
filterEnabled property. | public | JXList(ListModel dataModel, boolean filterEnabled) Constructs a JXList with the specified model and
filterEnabled property. | public | JXList(Object[] listData, boolean filterEnabled) Constructs a JXList that displays the elements in
the specified array and filterEnabled property. | public | JXList(Vector> listData, boolean filterEnabled) Constructs a JXList that displays the elements in
the specified Vector and filtersEnabled property. |
EXECUTE_BUTTON_ACTIONCOMMAND | final public static String EXECUTE_BUTTON_ACTIONCOMMAND(Code) | | |
JXList | public JXList()(Code) | | Constructs a JXList with an empty model and filters disabled.
|
JXList | public JXList(ListModel dataModel)(Code) | | Constructs a JXList that displays the elements in the
specified, non-null model and filters disabled.
Parameters: dataModel - the data model for this list exception: IllegalArgumentException - if dataModel is null |
JXList | public JXList(Object[] listData)(Code) | | 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: IllegalArgumentException - if listData is null |
JXList | public JXList(Vector> listData)(Code) | | Constructs a JXList that displays the elements in
the specified Vector and filtes disabled.
Parameters: listData - the Vector to be loaded into thedata model throws: IllegalArgumentException - if listData is null |
JXList | public JXList(boolean filterEnabled)(Code) | | Constructs a JXList with an empty model and
filterEnabled property.
Parameters: filterEnabled - boolean to determine if filtering/sorting is enabled |
JXList | public JXList(ListModel dataModel, boolean filterEnabled)(Code) | | Constructs a JXList with the specified model and
filterEnabled property.
Parameters: dataModel - the data model for this list Parameters: filterEnabled - boolean to determine if filtering/sorting is enabled throws: IllegalArgumentException - if dataModel is null |
JXList | public JXList(Object[] listData, boolean filterEnabled)(Code) | | 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 Parameters: filterEnabled - boolean to determine if filtering/sortingis enabled throws: IllegalArgumentException - if listData is null |
JXList | public JXList(Vector> listData, boolean filterEnabled)(Code) | | Constructs a JXList that displays the elements in
the specified Vector and filtersEnabled property.
Parameters: listData - the Vector to be loaded into thedata model Parameters: filterEnabled - boolean to determine if filtering/sortingis enabled throws: IllegalArgumentException - if listData is null |
addHighlighter | public void addHighlighter(Highlighter highlighter)(Code) | | Adds a Highlighter.
If the HighlighterPipeline returned from getHighlighters() is null, creates
and sets a new pipeline containing the given Highlighter. Else, appends
the Highlighter to the end of the pipeline.
Parameters: highlighter - the Highlighter to add - must not be null. throws: NullPointerException - if highlighter is null. |
convertIndexToModel | public int convertIndexToModel(int viewIndex)(Code) | | Convert row index from view coordinates to model coordinates accounting
for the presence of sorters and filters.
Parameters: viewIndex - index in view coordinates index in model coordinates throws: IndexOutOfBoundsException - if viewIndex < 0 or viewIndex >= getElementCount() |
convertIndexToView | public int convertIndexToView(int modelIndex)(Code) | | 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 index in view coordinates if the model index maps to a view coordinateor -1 if not contained in the view. |
createDefaultCellRenderer | protected ListCellRenderer createDefaultCellRenderer()(Code) | | Creates and returns the default cell renderer to use. Subclasses
may override to use a different type. Here: returns a DefaultListRenderer .
the default cell renderer to use with this list. |
createLinkController | protected ListRolloverController createLinkController()(Code) | | |
createPipelineListener | protected PipelineListener createPipelineListener()(Code) | | creates the listener for changes in filters.
|
createRolloverProducer | protected RolloverProducer createRolloverProducer()(Code) | | creates and returns the RolloverProducer to use with this tree.
RolloverProducer to use with this tree |
doFind | protected void doFind()(Code) | | |
getElementAt | public Object getElementAt(int viewIndex)(Code) | | 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 the element at the index throws: IndexOutOfBoundsException - if viewIndex < 0 or viewIndex >=getElementCount() |
getElementCount | public int getElementCount()(Code) | | 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.
number of elements in this list in view coordinates |
getFilterPipelineListener | protected PipelineListener getFilterPipelineListener()(Code) | | returns the listener for changes in filters.
|
getFilters | public FilterPipeline getFilters()(Code) | | the FilterPipeline assigned to this list, ornull if !isFiltersEnabled(). |
getHighlighterChangeListener | protected ChangeListener getHighlighterChangeListener()(Code) | | returns the ChangeListener to use with highlighters. Creates one if
necessary.
!= null |
getLinkController | protected ListRolloverController getLinkController()(Code) | | |
getSearchable | public Searchable getSearchable()(Code) | | a not-null Searchable for this editor. |
getSelectionMapper | protected SelectionMapper getSelectionMapper()(Code) | | widened access for testing...
the selection mapper |
getSortController | protected SortController getSortController()(Code) | | returns the currently active SortController. Will be null if
!isFilterEnabled().
the currently active SortController may be null |
getSortOrder | public SortOrder getSortOrder()(Code) | | Returns the SortOrder.
the interactive sorter's SortOrder or SortOrder.UNSORTED |
getWrappedModel | public ListModel getWrappedModel()(Code) | | returns the underlying model. If !isFilterEnabled this will be the same
as getModel().
the underlying model |
isRolloverEnabled | public boolean isRolloverEnabled()(Code) | | returns the rolloverEnabled property.
TODO: why doesn't this just return rolloverEnabled???
true if rollover is enabled |
removeHighlighter | public void removeHighlighter(Highlighter highlighter)(Code) | | Removes the Highlighter.
Does nothing if the HighlighterPipeline is null or does not contain
the given Highlighter.
Parameters: highlighter - the Highlighter to remove. |
resetSortOrder | public void resetSortOrder()(Code) | | Removes the interactive sorter.
|
setComparator | public void setComparator(Comparator comparator)(Code) | | 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. |
setFilterEnabled | public void setFilterEnabled(boolean enabled)(Code) | | 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: IllegalStateException - if trying to disable again. |
setFilters | public void setFilters(FilterPipeline pipeline)(Code) | | 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 removesall filters. throws: IllegalStateException - if !isFilterEnabled() |
setHighlighters | public void setHighlighters(HighlighterPipeline pipeline)(Code) | | Assigns a HighlighterPipeline to the list. This is a bound property.
Parameters: pipeline - the HighlighterPipeline to use for rendererdecoration, maybe null to remove all Highlighters. |
setModel | public void setModel(ListModel model)(Code) | | set's 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!
|
setRolloverEnabled | public void setRolloverEnabled(boolean rolloverEnabled)(Code) | | 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 - |
setSearchable | public void setSearchable(Searchable searchable)(Code) | | sets the Searchable for this editor. If null, a default
searchable will be used.
Parameters: searchable - |
setSortOrder | public void setSortOrder(SortOrder sortOrder)(Code) | | 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(); |
toggleSortOrder | public void toggleSortOrder()(Code) | | 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?
|
updateOnFilterContentChanged | protected void updateOnFilterContentChanged()(Code) | | method called on change notification from filterpipeline.
|
updateSortAfterComparatorChange | protected void updateSortAfterComparatorChange()(Code) | | Updates sort after comparator has changed.
Here: sets the current sortOrder with the new comparator.
|
updateUI | public void updateUI()(Code) | | |
Methods inherited from javax.swing.JList | public void addListSelectionListener(ListSelectionListener listener)(Code)(Java Doc) public void addSelectionInterval(int anchor, int lead)(Code)(Java Doc) public void clearSelection()(Code)(Java Doc) protected ListSelectionModel createSelectionModel()(Code)(Java Doc) public void ensureIndexIsVisible(int index)(Code)(Java Doc) protected void fireSelectionValueChanged(int firstIndex, int lastIndex, boolean isAdjusting)(Code)(Java Doc) public AccessibleContext getAccessibleContext()(Code)(Java Doc) public int getAnchorSelectionIndex()(Code)(Java Doc) public Rectangle getCellBounds(int index0, int index1)(Code)(Java Doc) public ListCellRenderer getCellRenderer()(Code)(Java Doc) public boolean getDragEnabled()(Code)(Java Doc) final public DropLocation getDropLocation()(Code)(Java Doc) final public DropMode getDropMode()(Code)(Java Doc) public int getFirstVisibleIndex()(Code)(Java Doc) public int getFixedCellHeight()(Code)(Java Doc) public int getFixedCellWidth()(Code)(Java Doc) public int getLastVisibleIndex()(Code)(Java Doc) public int getLayoutOrientation()(Code)(Java Doc) public int getLeadSelectionIndex()(Code)(Java Doc) public ListSelectionListener[] getListSelectionListeners()(Code)(Java Doc) public int getMaxSelectionIndex()(Code)(Java Doc) public int getMinSelectionIndex()(Code)(Java Doc) public ListModel getModel()(Code)(Java Doc) public int getNextMatch(String prefix, int startIndex, Position.Bias bias)(Code)(Java Doc) public Dimension getPreferredScrollableViewportSize()(Code)(Java Doc) public Object getPrototypeCellValue()(Code)(Java Doc) public int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)(Code)(Java Doc) public boolean getScrollableTracksViewportHeight()(Code)(Java Doc) public boolean getScrollableTracksViewportWidth()(Code)(Java Doc) public int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)(Code)(Java Doc) public int getSelectedIndex()(Code)(Java Doc) public int[] getSelectedIndices()(Code)(Java Doc) public Object getSelectedValue()(Code)(Java Doc) public Object[] getSelectedValues()(Code)(Java Doc) public Color getSelectionBackground()(Code)(Java Doc) public Color getSelectionForeground()(Code)(Java Doc) public int getSelectionMode()(Code)(Java Doc) public ListSelectionModel getSelectionModel()(Code)(Java Doc) public String getToolTipText(MouseEvent event)(Code)(Java Doc) public ListUI getUI()(Code)(Java Doc) public String getUIClassID()(Code)(Java Doc) public boolean getValueIsAdjusting()(Code)(Java Doc) public int getVisibleRowCount()(Code)(Java Doc) public Point indexToLocation(int index)(Code)(Java Doc) public boolean isSelectedIndex(int index)(Code)(Java Doc) public boolean isSelectionEmpty()(Code)(Java Doc) public int locationToIndex(Point location)(Code)(Java Doc) protected String paramString()(Code)(Java Doc) public void removeListSelectionListener(ListSelectionListener listener)(Code)(Java Doc) public void removeSelectionInterval(int index0, int index1)(Code)(Java Doc) public void setCellRenderer(ListCellRenderer cellRenderer)(Code)(Java Doc) public void setDragEnabled(boolean b)(Code)(Java Doc) final public void setDropMode(DropMode dropMode)(Code)(Java Doc) public void setFixedCellHeight(int height)(Code)(Java Doc) public void setFixedCellWidth(int width)(Code)(Java Doc) public void setLayoutOrientation(int layoutOrientation)(Code)(Java Doc) public void setListData(Object[] listData)(Code)(Java Doc) public void setListData(Vector> listData)(Code)(Java Doc) public void setModel(ListModel model)(Code)(Java Doc) public void setPrototypeCellValue(Object prototypeCellValue)(Code)(Java Doc) public void setSelectedIndex(int index)(Code)(Java Doc) public void setSelectedIndices(int[] indices)(Code)(Java Doc) public void setSelectedValue(Object anObject, boolean shouldScroll)(Code)(Java Doc) public void setSelectionBackground(Color selectionBackground)(Code)(Java Doc) public void setSelectionForeground(Color selectionForeground)(Code)(Java Doc) public void setSelectionInterval(int anchor, int lead)(Code)(Java Doc) public void setSelectionMode(int selectionMode)(Code)(Java Doc) public void setSelectionModel(ListSelectionModel selectionModel)(Code)(Java Doc) public void setUI(ListUI ui)(Code)(Java Doc) public void setValueIsAdjusting(boolean b)(Code)(Java Doc) public void setVisibleRowCount(int visibleRowCount)(Code)(Java Doc) public void updateUI()(Code)(Java Doc)
|
Methods inherited from javax.swing.JComponent | public void addAncestorListener(AncestorListener listener)(Code)(Java Doc) public void addNotify()(Code)(Java Doc) public synchronized void addVetoableChangeListener(VetoableChangeListener listener)(Code)(Java Doc) public void computeVisibleRect(Rectangle visibleRect)(Code)(Java Doc) public boolean contains(int x, int y)(Code)(Java Doc) public JToolTip createToolTip()(Code)(Java Doc) public void disable()(Code)(Java Doc) public void enable()(Code)(Java Doc) public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)(Code)(Java Doc) public void firePropertyChange(String propertyName, int oldValue, int newValue)(Code)(Java Doc) public void firePropertyChange(String propertyName, char oldValue, char newValue)(Code)(Java Doc) protected void fireVetoableChange(String propertyName, Object oldValue, Object newValue) throws java.beans.PropertyVetoException(Code)(Java Doc) public AccessibleContext getAccessibleContext()(Code)(Java Doc) public ActionListener getActionForKeyStroke(KeyStroke aKeyStroke)(Code)(Java Doc) final public ActionMap getActionMap()(Code)(Java Doc) public float getAlignmentX()(Code)(Java Doc) public float getAlignmentY()(Code)(Java Doc) public AncestorListener[] getAncestorListeners()(Code)(Java Doc) public boolean getAutoscrolls()(Code)(Java Doc) public int getBaseline(int width, int height)(Code)(Java Doc) public BaselineResizeBehavior getBaselineResizeBehavior()(Code)(Java Doc) public Border getBorder()(Code)(Java Doc) public Rectangle getBounds(Rectangle rv)(Code)(Java Doc) final public Object getClientProperty(Object key)(Code)(Java Doc) protected Graphics getComponentGraphics(Graphics g)(Code)(Java Doc) public JPopupMenu getComponentPopupMenu()(Code)(Java Doc) public int getConditionForKeyStroke(KeyStroke aKeyStroke)(Code)(Java Doc) public int getDebugGraphicsOptions()(Code)(Java Doc) public static Locale getDefaultLocale()(Code)(Java Doc) public FontMetrics getFontMetrics(Font font)(Code)(Java Doc) public Graphics getGraphics()(Code)(Java Doc) public int getHeight()(Code)(Java Doc) public boolean getInheritsPopupMenu()(Code)(Java Doc) final public InputMap getInputMap(int condition)(Code)(Java Doc) final public InputMap getInputMap()(Code)(Java Doc) public InputVerifier getInputVerifier()(Code)(Java Doc) public Insets getInsets()(Code)(Java Doc) public Insets getInsets(Insets insets)(Code)(Java Doc) public T[] getListeners(Class<T> listenerType)(Code)(Java Doc) public Point getLocation(Point rv)(Code)(Java Doc) public Dimension getMaximumSize()(Code)(Java Doc) public Dimension getMinimumSize()(Code)(Java Doc) public Component getNextFocusableComponent()(Code)(Java Doc) public Point getPopupLocation(MouseEvent event)(Code)(Java Doc) public Dimension getPreferredSize()(Code)(Java Doc) public KeyStroke[] getRegisteredKeyStrokes()(Code)(Java Doc) public JRootPane getRootPane()(Code)(Java Doc) public Dimension getSize(Dimension rv)(Code)(Java Doc) public Point getToolTipLocation(MouseEvent event)(Code)(Java Doc) public String getToolTipText()(Code)(Java Doc) public String getToolTipText(MouseEvent event)(Code)(Java Doc) public Container getTopLevelAncestor()(Code)(Java Doc) public TransferHandler getTransferHandler()(Code)(Java Doc) public String getUIClassID()(Code)(Java Doc) public boolean getVerifyInputWhenFocusTarget()(Code)(Java Doc) public synchronized VetoableChangeListener[] getVetoableChangeListeners()(Code)(Java Doc) public Rectangle getVisibleRect()(Code)(Java Doc) public int getWidth()(Code)(Java Doc) public int getX()(Code)(Java Doc) public int getY()(Code)(Java Doc) public void grabFocus()(Code)(Java Doc) public boolean isDoubleBuffered()(Code)(Java Doc) public static boolean isLightweightComponent(Component c)(Code)(Java Doc) public boolean isManagingFocus()(Code)(Java Doc) public boolean isOpaque()(Code)(Java Doc) public boolean isOptimizedDrawingEnabled()(Code)(Java Doc) final public boolean isPaintingForPrint()(Code)(Java Doc) public boolean isPaintingTile()(Code)(Java Doc) public boolean isRequestFocusEnabled()(Code)(Java Doc) public boolean isValidateRoot()(Code)(Java Doc) public void paint(Graphics g)(Code)(Java Doc) protected void paintBorder(Graphics g)(Code)(Java Doc) protected void paintChildren(Graphics g)(Code)(Java Doc) protected void paintComponent(Graphics g)(Code)(Java Doc) public void paintImmediately(int x, int y, int w, int h)(Code)(Java Doc) public void paintImmediately(Rectangle r)(Code)(Java Doc) protected String paramString()(Code)(Java Doc) public void print(Graphics g)(Code)(Java Doc) public void printAll(Graphics g)(Code)(Java Doc) protected void printBorder(Graphics g)(Code)(Java Doc) protected void printChildren(Graphics g)(Code)(Java Doc) protected void printComponent(Graphics g)(Code)(Java Doc) protected void processComponentKeyEvent(KeyEvent e)(Code)(Java Doc) protected boolean processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)(Code)(Java Doc) protected void processKeyEvent(KeyEvent e)(Code)(Java Doc) protected void processMouseEvent(MouseEvent e)(Code)(Java Doc) protected void processMouseMotionEvent(MouseEvent e)(Code)(Java Doc) final public void putClientProperty(Object key, Object value)(Code)(Java Doc) public void registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition)(Code)(Java Doc) public void registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition)(Code)(Java Doc) public void removeAncestorListener(AncestorListener listener)(Code)(Java Doc) public void removeNotify()(Code)(Java Doc) public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)(Code)(Java Doc) public void repaint(long tm, int x, int y, int width, int height)(Code)(Java Doc) public void repaint(Rectangle r)(Code)(Java Doc) public boolean requestDefaultFocus()(Code)(Java Doc) public void requestFocus()(Code)(Java Doc) public boolean requestFocus(boolean temporary)(Code)(Java Doc) public boolean requestFocusInWindow()(Code)(Java Doc) protected boolean requestFocusInWindow(boolean temporary)(Code)(Java Doc) public void resetKeyboardActions()(Code)(Java Doc) public void reshape(int x, int y, int w, int h)(Code)(Java Doc) public void revalidate()(Code)(Java Doc) public void scrollRectToVisible(Rectangle aRect)(Code)(Java Doc) final public void setActionMap(ActionMap am)(Code)(Java Doc) public void setAlignmentX(float alignmentX)(Code)(Java Doc) public void setAlignmentY(float alignmentY)(Code)(Java Doc) public void setAutoscrolls(boolean autoscrolls)(Code)(Java Doc) public void setBackground(Color bg)(Code)(Java Doc) public void setBorder(Border border)(Code)(Java Doc) public void setComponentPopupMenu(JPopupMenu popup)(Code)(Java Doc) public void setDebugGraphicsOptions(int debugOptions)(Code)(Java Doc) public static void setDefaultLocale(Locale l)(Code)(Java Doc) public void setDoubleBuffered(boolean aFlag)(Code)(Java Doc) public void setEnabled(boolean enabled)(Code)(Java Doc) public void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)(Code)(Java Doc) public void setFont(Font font)(Code)(Java Doc) public void setForeground(Color fg)(Code)(Java Doc) public void setInheritsPopupMenu(boolean value)(Code)(Java Doc) final public void setInputMap(int condition, InputMap map)(Code)(Java Doc) public void setInputVerifier(InputVerifier inputVerifier)(Code)(Java Doc) public void setMaximumSize(Dimension maximumSize)(Code)(Java Doc) public void setMinimumSize(Dimension minimumSize)(Code)(Java Doc) public void setNextFocusableComponent(Component aComponent)(Code)(Java Doc) public void setOpaque(boolean isOpaque)(Code)(Java Doc) public void setPreferredSize(Dimension preferredSize)(Code)(Java Doc) public void setRequestFocusEnabled(boolean requestFocusEnabled)(Code)(Java Doc) public void setToolTipText(String text)(Code)(Java Doc) public void setTransferHandler(TransferHandler newHandler)(Code)(Java Doc) protected void setUI(ComponentUI newUI)(Code)(Java Doc) public void setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget)(Code)(Java Doc) public void setVisible(boolean aFlag)(Code)(Java Doc) public void unregisterKeyboardAction(KeyStroke aKeyStroke)(Code)(Java Doc) public void update(Graphics g)(Code)(Java Doc) public void updateUI()(Code)(Java Doc)
|
|
|
|