|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.swing.plaf.ComponentUI
javax.swing.plaf.ListUI
javax.swing.plaf.basic.BasicListUI
org.jdesktop.swingx.plaf.basic.core.BasicXListUI
public class BasicXListUI
An extensible implementation of ListUI
for JXList.
BasicXListUI
instances cannot be shared between multiple
lists.
The heart of added functionality is to support sorting/filtering, that is keep model-selection and RowSorter state synchronized. The details are delegated to a ListSortUI, but this class is responsible to manage the sortUI on changes of list properties, model and view selection (same strategy as in JXTable).
Note: this delegate is mostly a 1:1 copy of BasicListUI. The difference is that it accesses the list elements and list elementCount exclusively through the JXList api. This allows a clean implementation of sorting/filtering.
The differences (goal was to touch as little code as possible as this needs to be updated on every change to core until that is changed to not access the list's model directly, sigh) for core functionality:
Nested Class Summary | |
---|---|
class |
BasicXListUI.FocusHandler
This inner class is marked "public" due to a compiler bug. |
class |
BasicXListUI.ListDataHandler
The ListDataListener that's added to the JLists model at installUI time, and whenever the JList.model property changes. |
class |
BasicXListUI.ListSelectionHandler
The ListSelectionListener that's added to the JLists selection model at installUI time, and whenever the JList.selectionModel property changes. |
class |
BasicXListUI.MouseInputHandler
Mouse input, and focus handling for JList. |
class |
BasicXListUI.PropertyChangeHandler
The PropertyChangeListener that's added to the JList at installUI time. |
Field Summary | |
---|---|
protected int |
cellHeight
|
protected int[] |
cellHeights
|
protected static int |
cellRendererChanged
|
protected int |
cellWidth
|
protected static int |
fixedCellHeightChanged
|
protected static int |
fixedCellWidthChanged
|
protected java.awt.event.FocusListener |
focusListener
|
protected static int |
fontChanged
|
protected JXList |
list
|
protected javax.swing.event.ListDataListener |
listDataListener
|
protected javax.swing.event.ListSelectionListener |
listSelectionListener
|
protected static int |
modelChanged
|
protected javax.swing.event.MouseInputListener |
mouseInputListener
|
protected java.beans.PropertyChangeListener |
propertyChangeListener
|
protected static int |
prototypeCellValueChanged
|
protected javax.swing.CellRendererPane |
rendererPane
|
protected static int |
selectionModelChanged
|
protected int |
updateLayoutStateNeeded
|
Constructor Summary | |
---|---|
BasicXListUI()
|
Method Summary | |
---|---|
protected int |
convertRowToY(int row)
Return the JList relative Y coordinate of the origin of the specified row or -1 if row isn't valid. |
protected int |
convertYToRow(int y0)
Convert the JList relative coordinate to the row that contains it, based on the current layout. |
protected java.awt.event.FocusListener |
createFocusListener()
|
protected javax.swing.event.ListDataListener |
createListDataListener()
Creates an instance of ListDataListener that's added to the JLists by model as needed. |
protected javax.swing.event.ListSelectionListener |
createListSelectionListener()
Creates an instance of ListSelectionHandler that's added to the JLists by selectionModel as needed. |
protected javax.swing.event.MouseInputListener |
createMouseInputListener()
Creates a delegate that implements MouseInputListener. |
protected java.beans.PropertyChangeListener |
createPropertyChangeListener()
Creates an instance of PropertyChangeHandler that's added to the JList by installUI(). |
static javax.swing.plaf.ComponentUI |
createUI(javax.swing.JComponent list)
Returns a new instance of BasicXListUI. |
int |
getBaseline(javax.swing.JComponent c,
int width,
int height)
Returns the baseline. |
java.awt.Component.BaselineResizeBehavior |
getBaselineResizeBehavior(javax.swing.JComponent c)
Returns an enum indicating how the baseline of the component changes as the size changes. |
java.awt.Rectangle |
getCellBounds(javax.swing.JList list,
int index1,
int index2)
|
protected java.lang.Object |
getElementAt(int viewIndex)
|
protected int |
getElementCount()
|
java.awt.Dimension |
getPreferredSize(javax.swing.JComponent c)
The preferredSize of the list depends upon the layout orientation. |
protected int |
getRowHeight(int row)
Returns the height of the specified row based on the current layout. |
protected ListSortUI |
getSortUI()
|
protected javax.swing.ListModel |
getViewModel()
Compatibility Wrapper: a synthetic model which delegates to list api and throws |
java.awt.Point |
indexToLocation(javax.swing.JList list,
int index)
|
protected void |
installDefaults()
Initialize JList properties, e.g. |
protected void |
installKeyboardActions()
Registers the keyboard bindings on the JList that the
BasicXListUI is associated with. |
protected void |
installListeners()
Create and install the listeners for the JList, its model, and its selectionModel. |
protected void |
installSortUI()
Installs SortUI if the list has a rowSorter. |
void |
installUI(javax.swing.JComponent c)
Initializes this.list by calling installDefaults() ,
installListeners() , and installKeyboardActions()
in order. |
void |
invalidateCellSizeCache()
Invalidates the cell size cache and revalidates/-paints the list. |
static void |
loadActionMap(LazyActionMap map)
|
int |
locationToIndex(javax.swing.JList list,
java.awt.Point location)
|
protected void |
maybeUpdateLayoutState()
If updateLayoutStateNeeded is non zero, call updateLayoutState() and reset updateLayoutStateNeeded. |
void |
paint(java.awt.Graphics g,
javax.swing.JComponent c)
Paint the rows that intersect the Graphics objects clipRect. |
protected void |
paintCell(java.awt.Graphics g,
int row,
java.awt.Rectangle rowBounds,
javax.swing.ListCellRenderer cellRenderer,
javax.swing.ListModel dataModel,
javax.swing.ListSelectionModel selModel,
int leadIndex)
Paint one List cell: compute the relevant state, get the "rubber stamp" cell renderer component, and then use the CellRendererPane to paint it. |
protected boolean |
processedBySortUI(javax.swing.event.ListDataEvent e)
Returns a boolean indicating whether or not the event has been processed by the sortUI. |
protected boolean |
processedBySortUI(javax.swing.event.ListSelectionEvent e)
Returns a boolean indicating whether or not the event has been processed by the sortUI. |
protected void |
selectNextIndex()
Selected the previous row and force it to be visible. |
protected void |
selectPreviousIndex()
Selected the previous row and force it to be visible. |
protected void |
uninstallDefaults()
Set the JList properties that haven't been explicitly overridden to null. |
protected void |
uninstallKeyboardActions()
Unregisters keyboard actions installed from installKeyboardActions . |
protected void |
uninstallListeners()
Remove the listeners for the JList, its model, and its selectionModel. |
protected void |
uninstallSortUI()
Dispose and null's the sortUI if installed. |
void |
uninstallUI(javax.swing.JComponent c)
Uninitializes this.list by calling uninstallListeners() ,
uninstallKeyboardActions() , and uninstallDefaults()
in order. |
protected void |
updateLayoutState()
Recompute the value of cellHeight or cellHeights based and cellWidth, based on the current font and the current values of fixedCellWidth, fixedCellHeight, and prototypeCellValue. |
protected void |
updateSortUI(java.lang.String property)
Called from the PropertyChangeHandler. |
Methods inherited from class javax.swing.plaf.ComponentUI |
---|
contains, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, update |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected JXList list
protected javax.swing.CellRendererPane rendererPane
protected java.awt.event.FocusListener focusListener
protected javax.swing.event.MouseInputListener mouseInputListener
protected javax.swing.event.ListSelectionListener listSelectionListener
protected javax.swing.event.ListDataListener listDataListener
protected java.beans.PropertyChangeListener propertyChangeListener
protected int[] cellHeights
protected int cellHeight
protected int cellWidth
protected int updateLayoutStateNeeded
protected static final int modelChanged
protected static final int selectionModelChanged
protected static final int fontChanged
protected static final int fixedCellWidthChanged
protected static final int fixedCellHeightChanged
protected static final int prototypeCellValueChanged
protected static final int cellRendererChanged
Constructor Detail |
---|
public BasicXListUI()
Method Detail |
---|
public static void loadActionMap(LazyActionMap map)
protected javax.swing.ListModel getViewModel()
protected int getElementCount()
protected java.lang.Object getElementAt(int viewIndex)
protected ListSortUI getSortUI()
protected void installSortUI()
protected void uninstallSortUI()
protected void updateSortUI(java.lang.String property)
property
- the name of the changed property.protected boolean processedBySortUI(javax.swing.event.ListDataEvent e)
e
-
protected boolean processedBySortUI(javax.swing.event.ListSelectionEvent e)
e
-
public void invalidateCellSizeCache()
protected void paintCell(java.awt.Graphics g, int row, java.awt.Rectangle rowBounds, javax.swing.ListCellRenderer cellRenderer, javax.swing.ListModel dataModel, javax.swing.ListSelectionModel selModel, int leadIndex)
paintCell
in class javax.swing.plaf.basic.BasicListUI
paint(java.awt.Graphics, javax.swing.JComponent)
public void paint(java.awt.Graphics g, javax.swing.JComponent c)
paint
in class javax.swing.plaf.basic.BasicListUI
paintCell(java.awt.Graphics, int, java.awt.Rectangle, javax.swing.ListCellRenderer, javax.swing.ListModel, javax.swing.ListSelectionModel, int)
public int getBaseline(javax.swing.JComponent c, int width, int height)
getBaseline
in class javax.swing.plaf.basic.BasicListUI
java.lang.NullPointerException
java.lang.IllegalArgumentException
JComponent.getBaseline(int, int)
public java.awt.Component.BaselineResizeBehavior getBaselineResizeBehavior(javax.swing.JComponent c)
getBaselineResizeBehavior
in class javax.swing.plaf.basic.BasicListUI
java.lang.NullPointerException
JComponent.getBaseline(int, int)
public java.awt.Dimension getPreferredSize(javax.swing.JComponent c)
Layout Orientation | Preferred Size |
---|---|
JList.VERTICAL | The preferredSize of the list is total height of the rows and the maximum width of the cells. If JList.fixedCellHeight is specified then the total height of the rows is just (cellVerticalMargins + fixedCellHeight) * model.getSize() where rowVerticalMargins is the space we allocate for drawing the yellow focus outline. Similarly if fixedCellWidth is specified then we just use that. |
JList.VERTICAL_WRAP | If the visible row count is greater than zero, the preferredHeight is the maximum cell height * visibleRowCount. If the visible row count is <= 0, the preferred height is either the current height of the list, or the maximum cell height, whichever is bigger. The preferred width is than the maximum cell width * number of columns needed. Where the number of columns needs is list.height / max cell height. Max cell height is either the fixed cell height, or is determined by iterating through all the cells to find the maximum height from the ListCellRenderer. |
JList.HORIZONTAL_WRAP | If the visible row count is greater than zero, the preferredHeight
is the maximum cell height * adjustedRowCount. Where
visibleRowCount is used to determine the number of columns.
Because this lays out horizontally the number of rows is
then determined from the column count. For example, lets say
you have a model with 10 items and the visible row count is 8.
The number of columns needed to display this is 2, but you no
longer need 8 rows to display this, you only need 5, thus
the adjustedRowCount is 5.
If the visible row
count is <= 0, the preferred height is dictated by the
number of columns, which will be as many as can fit in the width
of the |
Insets
are determined from
list.getInsets()
.
getPreferredSize
in class javax.swing.plaf.basic.BasicListUI
c
- The JList component.
protected void selectPreviousIndex()
selectPreviousIndex
in class javax.swing.plaf.basic.BasicListUI
JList.ensureIndexIsVisible(int)
protected void selectNextIndex()
selectNextIndex
in class javax.swing.plaf.basic.BasicListUI
JList.ensureIndexIsVisible(int)
protected void installKeyboardActions()
JList
that the
BasicXListUI
is associated with. This method is called at
installUI() time.
installKeyboardActions
in class javax.swing.plaf.basic.BasicListUI
installUI(javax.swing.JComponent)
protected void uninstallKeyboardActions()
installKeyboardActions
.
This method is called at uninstallUI() time - subclassess should
ensure that all of the keyboard actions registered at installUI
time are removed here.
uninstallKeyboardActions
in class javax.swing.plaf.basic.BasicListUI
installUI(javax.swing.JComponent)
protected void installListeners()
installListeners
in class javax.swing.plaf.basic.BasicListUI
installUI(javax.swing.JComponent)
,
uninstallListeners()
protected void uninstallListeners()
uninstallListeners
in class javax.swing.plaf.basic.BasicListUI
uninstallUI(javax.swing.JComponent)
,
installListeners()
protected void installDefaults()
installDefaults
in class javax.swing.plaf.basic.BasicListUI
uninstallDefaults()
,
installUI(javax.swing.JComponent)
,
CellRendererPane
protected void uninstallDefaults()
uninstallDefaults
in class javax.swing.plaf.basic.BasicListUI
installDefaults()
,
uninstallUI(javax.swing.JComponent)
,
CellRendererPane
public void installUI(javax.swing.JComponent c)
this.list
by calling installDefaults()
,
installListeners()
, and installKeyboardActions()
in order.
installUI
in class javax.swing.plaf.basic.BasicListUI
installDefaults()
,
installListeners()
,
installKeyboardActions()
public void uninstallUI(javax.swing.JComponent c)
this.list
by calling uninstallListeners()
,
uninstallKeyboardActions()
, and uninstallDefaults()
in order. Sets this.list to null.
uninstallUI
in class javax.swing.plaf.basic.BasicListUI
uninstallListeners()
,
uninstallKeyboardActions()
,
uninstallDefaults()
public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent list)
public int locationToIndex(javax.swing.JList list, java.awt.Point location)
locationToIndex
in class javax.swing.plaf.basic.BasicListUI
java.lang.NullPointerException
public java.awt.Point indexToLocation(javax.swing.JList list, int index)
indexToLocation
in class javax.swing.plaf.basic.BasicListUI
public java.awt.Rectangle getCellBounds(javax.swing.JList list, int index1, int index2)
getCellBounds
in class javax.swing.plaf.basic.BasicListUI
protected int getRowHeight(int row)
getRowHeight
in class javax.swing.plaf.basic.BasicListUI
convertYToRow(int)
,
convertRowToY(int)
,
updateLayoutState()
protected int convertYToRow(int y0)
convertYToRow
in class javax.swing.plaf.basic.BasicListUI
getRowHeight(int)
,
updateLayoutState()
protected int convertRowToY(int row)
convertRowToY
in class javax.swing.plaf.basic.BasicListUI
getRowHeight(int)
,
updateLayoutState()
protected void maybeUpdateLayoutState()
maybeUpdateLayoutState
in class javax.swing.plaf.basic.BasicListUI
updateLayoutState()
protected void updateLayoutState()
updateLayoutState
in class javax.swing.plaf.basic.BasicListUI
maybeUpdateLayoutState()
protected javax.swing.event.MouseInputListener createMouseInputListener()
class MyListUI extends BasicXListUI { protected MouseInputListener createMouseInputListener() { return new MyMouseInputHandler(); } public class MyMouseInputHandler extends MouseInputHandler { public void mouseMoved(MouseEvent e) { // do some extra work when the mouse moves super.mouseMoved(e); } } }
createMouseInputListener
in class javax.swing.plaf.basic.BasicListUI
BasicXListUI.MouseInputHandler
,
installUI(javax.swing.JComponent)
protected java.awt.event.FocusListener createFocusListener()
createFocusListener
in class javax.swing.plaf.basic.BasicListUI
protected javax.swing.event.ListSelectionListener createListSelectionListener()
class MyListUI extends BasicXListUI { protected ListSelectionListener createListSelectionListener() { return new MySelectionListener(); } public class MySelectionListener extends ListSelectionHandler { public void valueChanged(ListSelectionEvent e) { // do some extra work when the selection changes super.valueChange(e); } } }
createListSelectionListener
in class javax.swing.plaf.basic.BasicListUI
BasicXListUI.ListSelectionHandler
,
installUI(javax.swing.JComponent)
protected javax.swing.event.ListDataListener createListDataListener()
class MyListUI extends BasicXListUI { protected ListDataListener createListDataListener() { return new MyListDataListener(); } public class MyListDataListener extends ListDataHandler { public void contentsChanged(ListDataEvent e) { // do some extra work when the models contents change super.contentsChange(e); } } }
createListDataListener
in class javax.swing.plaf.basic.BasicListUI
ListDataListener
,
JList.getModel()
,
installUI(javax.swing.JComponent)
protected java.beans.PropertyChangeListener createPropertyChangeListener()
class MyListUI extends BasicXListUI { protected PropertyChangeListener createPropertyChangeListener() { return new MyPropertyChangeListener(); } public class MyPropertyChangeListener extends PropertyChangeHandler { public void propertyChange(PropertyChangeEvent e) { if (e.getPropertyName().equals("model")) { // do some extra work when the model changes } super.propertyChange(e); } } }
createPropertyChangeListener
in class javax.swing.plaf.basic.BasicListUI
PropertyChangeListener
,
installUI(javax.swing.JComponent)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |