- Direct Known Subclasses:
SynthListUI
ListUI.
BasicListUI instances cannot be shared between multiple
lists.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassThis class should be treated as a "protected" inner class.classTheListDataListenerthat's added to theJListsmodel atinstallUI time, and whenever the JList.model property changes.classThe ListSelectionListener that's added to the JLists selection model at installUI time, and whenever the JList.selectionModel property changes.classMouse input, and focus handling for JList.classThe PropertyChangeListener that's added to the JList at installUI time. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected intThe height of cell.protected int[]The array of cells' heightprotected static final intThe bit relates to cell renderer changed property.protected intThe width of cell.protected static final intThe bit relates to fixed cell height changed property.protected static final intThe bit relates to fixed cell width changed property.protected FocusListenerFocusListenerthat attached toJList.protected static final intThe bit relates to font changed property.The instance ofJList.protected ListDataListenerListDataListenerthat attached toJList.protected ListSelectionListenerListSelectionListenerthat attached toJList.protected static final intThe bit relates to model changed property.protected MouseInputListenerMouseInputListenerthat attached toJList.protected PropertyChangeListenerPropertyChangeListenerthat attached toJList.protected static final intThe bit relates to prototype cell value changed property.protected CellRendererPaneThe instance ofCellRendererPane.protected static final intThe bit relates to selection model changed property.protected intThe value represents changes toJListmodel. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected intconvertRowToY(int row) Return theJListrelative Y coordinate of the origin of the specified row or -1 if row isn't valid.protected intconvertYToRow(int y0) Convert theJListrelative coordinate to the row that contains it, based on the current layout.protected FocusListenerReturns an instance ofFocusListener.protected ListDataListenerCreates an instance ofListDataListenerthat's added to theJListsby model as needed.protected ListSelectionListenerCreates an instance ofListSelectionHandlerthat's added to theJListsby selectionModel as needed.protected MouseInputListenerCreates a delegate that implementsMouseInputListener.protected PropertyChangeListenerCreates an instance ofPropertyChangeHandlerthat's added to theJListbyinstallUI().static ComponentUIcreateUI(JComponent list) Returns a new instance ofBasicListUI.intgetBaseline(JComponent c, int width, int height) Returns the baseline.Returns an enum indicating how the baseline of the component changes as the size changes.getCellBounds(JList<?> list, int index1, int index2) Returns the bounding rectangle, in the given list's coordinate system, for the range of cells specified by the two indices.The preferredSize of the list depends upon the layout orientation.protected intgetRowHeight(int row) Returns the height of the specified row based on the current layout.indexToLocation(JList<?> list, int index) Returns the origin in the givenJList, of the specified item, in the list's coordinate system.protected voidInitializes list properties such as font, foreground, and background, and adds the CellRendererPane.protected voidRegisters the keyboard bindings on theJListthat theBasicListUIis associated with.protected voidCreates and installs the listeners for the JList, its model, and its selectionModel.voidInitializesthis.listby callinginstallDefaults(),installListeners(), andinstallKeyboardActions()in order.intlocationToIndex(JList<?> list, Point location) Returns the cell index in the specifiedJListclosest to the given location in the list's coordinate system.protected voidIf updateLayoutStateNeeded is non zero, call updateLayoutState() and reset updateLayoutStateNeeded.voidpaint(Graphics g, JComponent c) Paint the rows that intersect the Graphics objects clipRect.protected voidpaintCell(Graphics g, int row, Rectangle rowBounds, ListCellRenderer<Object> cellRenderer, ListModel<Object> dataModel, ListSelectionModel selModel, int leadIndex) Paint one List cell: compute the relevant state, get the "rubber stamp" cell renderer component, and then use theCellRendererPaneto paint it.protected voidSelected the previous row and force it to be visible.protected voidSelected the previous row and force it to be visible.protected voidSets the list properties that have not been explicitly overridden tonull.protected voidUnregisters keyboard actions installed frominstallKeyboardActions.protected voidRemoves the listeners from the JList, its model, and its selectionModel.voidUninitializesthis.listby callinguninstallListeners(),uninstallKeyboardActions(), anduninstallDefaults()in order.protected voidRecompute the value of cellHeight or cellHeights based and cellWidth, based on the current font and the current values of fixedCellWidth, fixedCellHeight, and prototypeCellValue.Methods declared in class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, update
-
Field Details
-
list
The instance ofJList. -
rendererPane
The instance ofCellRendererPane. -
focusListener
FocusListenerthat attached toJList. -
mouseInputListener
MouseInputListenerthat attached toJList. -
listSelectionListener
ListSelectionListenerthat attached toJList. -
listDataListener
ListDataListenerthat attached toJList. -
propertyChangeListener
PropertyChangeListenerthat attached toJList. -
cellHeights
protected int[] cellHeightsThe array of cells' height -
cellHeight
protected int cellHeightThe height of cell. -
cellWidth
protected int cellWidthThe width of cell. -
updateLayoutStateNeeded
protected int updateLayoutStateNeededThe value represents changes toJListmodel. -
modelChanged
protected static final int modelChangedThe bit relates to model changed property.- See Also:
-
selectionModelChanged
protected static final int selectionModelChangedThe bit relates to selection model changed property.- See Also:
-
fontChanged
protected static final int fontChangedThe bit relates to font changed property.- See Also:
-
fixedCellWidthChanged
protected static final int fixedCellWidthChangedThe bit relates to fixed cell width changed property.- See Also:
-
fixedCellHeightChanged
protected static final int fixedCellHeightChangedThe bit relates to fixed cell height changed property.- See Also:
-
prototypeCellValueChanged
protected static final int prototypeCellValueChangedThe bit relates to prototype cell value changed property.- See Also:
-
cellRendererChanged
protected static final int cellRendererChangedThe bit relates to cell renderer changed property.- See Also:
-
-
Constructor Details
-
BasicListUI
public BasicListUI()Constructs aBasicListUI.
-
-
Method Details
-
paintCell
protected void paintCell(Graphics g, int row, Rectangle rowBounds, ListCellRenderer<Object> cellRenderer, ListModel<Object> dataModel, ListSelectionModel selModel, int leadIndex) Paint one List cell: compute the relevant state, get the "rubber stamp" cell renderer component, and then use theCellRendererPaneto paint it. Subclasses may want to override this method rather thanpaint().- Parameters:
g- an instance ofGraphicsrow- a rowrowBounds- a bounding rectangle to render tocellRenderer- a list ofListCellRendererdataModel- a list modelselModel- a selection modelleadIndex- a lead index- See Also:
-
paint
Paint the rows that intersect the Graphics objects clipRect. This method calls paintCell as necessary. Subclasses may want to override these methods.- Overrides:
paintin classComponentUI- Parameters:
g- theGraphicscontext in which to paintc- the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components- See Also:
-
getBaseline
Returns the baseline.- Overrides:
getBaselinein classComponentUI- Parameters:
c-JComponentbaseline is being requested forwidth- the width to get the baseline forheight- the height to get the baseline for- Returns:
- baseline or a value < 0 indicating there is no reasonable baseline
- Throws:
NullPointerException- ifcisnullIllegalArgumentException- if width or height is < 0- Since:
- 1.6
- See Also:
-
getBaselineResizeBehavior
Returns an enum indicating how the baseline of the component changes as the size changes.- Overrides:
getBaselineResizeBehaviorin classComponentUI- Parameters:
c-JComponentto return baseline resize behavior for- Returns:
- an enum indicating how the baseline changes as the component size changes
- Throws:
NullPointerException- ifcisnull- Since:
- 1.6
- See Also:
-
getPreferredSize
The preferredSize of the list depends upon the layout orientation.
The above specifies the raw preferred width and height. The resulting preferred width is the above width + insets.left + insets.right and the resulting preferred height is the above height + insets.top + insets.bottom. Where theDescribes the preferred size for each layout orientation 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
JList(width / max cell width), with at least one column. The preferred height then becomes the model size / number of columns * maximum 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.Insetsare determined fromlist.getInsets().- Overrides:
getPreferredSizein classComponentUI- Parameters:
c- The JList component.- Returns:
- The total size of the list.
- See Also:
-
selectPreviousIndex
protected void selectPreviousIndex()Selected the previous row and force it to be visible.- See Also:
-
selectNextIndex
protected void selectNextIndex()Selected the previous row and force it to be visible.- See Also:
-
installKeyboardActions
protected void installKeyboardActions()Registers the keyboard bindings on theJListthat theBasicListUIis associated with. This method is called at installUI() time.- See Also:
-
uninstallKeyboardActions
protected void uninstallKeyboardActions()Unregisters keyboard actions installed frominstallKeyboardActions. This method is called at uninstallUI() time - subclassess should ensure that all of the keyboard actions registered at installUI time are removed here.- See Also:
-
installListeners
protected void installListeners()Creates and installs the listeners for the JList, its model, and its selectionModel. This method is called at installUI() time. -
uninstallListeners
protected void uninstallListeners()Removes the listeners from the JList, its model, and its selectionModel. All of the listener fields, are reset to null here. This method is called at uninstallUI() time, it should be kept in sync with installListeners. -
installDefaults
protected void installDefaults()Initializes list properties such as font, foreground, and background, and adds the CellRendererPane. The font, foreground, and background properties are only set if their current value is either null or a UIResource, other properties are set if the current value is null. -
uninstallDefaults
protected void uninstallDefaults()Sets the list properties that have not been explicitly overridden tonull. A property is considered overridden if its current value is not aUIResource. -
installUI
Initializesthis.listby callinginstallDefaults(),installListeners(), andinstallKeyboardActions()in order.- Overrides:
installUIin classComponentUI- Parameters:
c- the component where this UI delegate is being installed- See Also:
-
uninstallUI
Uninitializesthis.listby callinguninstallListeners(),uninstallKeyboardActions(), anduninstallDefaults()in order. Sets this.list to null.- Overrides:
uninstallUIin classComponentUI- Parameters:
c- the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components- See Also:
-
createUI
Returns a new instance ofBasicListUI.BasicListUIdelegates are allocated one perJList.- Parameters:
list- a component- Returns:
- a new
ListUIimplementation for the Windows look and feel.
-
locationToIndex
Returns the cell index in the specifiedJListclosest to the given location in the list's coordinate system. To determine if the cell actually contains the specified location, compare the point against the cell's bounds, as provided bygetCellBounds. This method returns-1if the list's model is empty.- Specified by:
locationToIndexin classListUI- Parameters:
list- the listlocation- the coordinates of the point- Returns:
- the cell index closest to the given location, or
-1 - Throws:
NullPointerException- iflocationis null
-
indexToLocation
Returns the origin in the givenJList, of the specified item, in the list's coordinate system. Returnsnullif the index isn't valid.- Specified by:
indexToLocationin classListUI- Parameters:
list- the listindex- the cell index- Returns:
- the origin of the cell, or
null
-
getCellBounds
Returns the bounding rectangle, in the given list's coordinate system, for the range of cells specified by the two indices. The indices can be supplied in any order.If the smaller index is outside the list's range of cells, this method returns
null. If the smaller index is valid, but the larger index is outside the list's range, the bounds of just the first index is returned. Otherwise, the bounds of the valid range is returned.- Specified by:
getCellBoundsin classListUI- Parameters:
list- the listindex1- the first index in the rangeindex2- the second index in the range- Returns:
- the bounding rectangle for the range of cells, or
null
-
getRowHeight
protected int getRowHeight(int row) Returns the height of the specified row based on the current layout.- Parameters:
row- a row- Returns:
- the specified row height or -1 if row isn't valid
- See Also:
-
convertYToRow
protected int convertYToRow(int y0) Convert theJListrelative coordinate to the row that contains it, based on the current layout. Ify0doesn't fall within any row, return -1.- Parameters:
y0- a relative Y coordinate- Returns:
- the row that contains y0, or -1
- See Also:
-
convertRowToY
protected int convertRowToY(int row) Return theJListrelative Y coordinate of the origin of the specified row or -1 if row isn't valid.- Parameters:
row- a row- Returns:
- the Y coordinate of the origin of row, or -1
- See Also:
-
maybeUpdateLayoutState
protected void maybeUpdateLayoutState()If updateLayoutStateNeeded is non zero, call updateLayoutState() and reset updateLayoutStateNeeded. This method should be called by methods before doing any computation based on the geometry of the list. For example it's the first call in paint() and getPreferredSize().- See Also:
-
updateLayoutState
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.- See Also:
-
createMouseInputListener
Creates a delegate that implementsMouseInputListener. The delegate is added to the correspondingjava.awt.Componentlistener lists atinstallUI()time. Subclasses can override this method to return a customMouseInputListener, e.g.class MyListUI extends BasicListUI { 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); } } }- Returns:
- an instance of
MouseInputListener - See Also:
-
createFocusListener
Returns an instance ofFocusListener.- Returns:
- an instance of
FocusListener
-
createListSelectionListener
Creates an instance ofListSelectionHandlerthat's added to theJListsby selectionModel as needed. Subclasses can override this method to return a customListSelectionListener, e.g.class MyListUI extends BasicListUI { 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); } } }- Returns:
- an instance of
ListSelectionHandler - See Also:
-
createListDataListener
Creates an instance ofListDataListenerthat's added to theJListsby model as needed. Subclasses can override this method to return a customListDataListener, e.g.class MyListUI extends BasicListUI { 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); } } }- Returns:
- an instance of
ListDataListener - See Also:
-
createPropertyChangeListener
Creates an instance ofPropertyChangeHandlerthat's added to theJListbyinstallUI(). Subclasses can override this method to return a customPropertyChangeListener, e.g.class MyListUI extends BasicListUI { 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); } } }- Returns:
- an instance of
PropertyChangeHandler - See Also:
-