com.alee.laf.list

Class ListPainter<E extends javax.swing.JList,U extends WebListUI,D extends IDecoration<E,D>>

java.lang.Object

com.alee.painter.AbstractPainter<E,U>

com.alee.painter.decoration.AbstractDecorationPainter<E,U,D>

com.alee.laf.list.ListPainter<E,U,D>

Type Parameters:

E - component type

U - component UI type

D - decoration type

All Implemented Interfaces:

IListPainter<E,U>, PainterShapeProvider<E>, Painter<E,U>, SpecificPainter<E,U>, BorderMethods, com.alee.utils.swing.SwingMethods

public class ListPainter<E extends javax.swing.JList,U extends WebListUI,D extends IDecoration<E,D>>
extends AbstractDecorationPainter<E,U,D>
implements IListPainter<E,U>

Basic painter for JList component. It is used as WebListUI default painter.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cellHeight
protected int[]	cellHeights
protected int	cellWidth
protected java.lang.Integer	columnCount
protected IListItemPainter	hoverPainter Hover list item decoration painter.
protected java.lang.Integer	layoutOrientation Painting variables.
protected java.lang.Integer	listHeight
protected javax.swing.event.ListSelectionListener	listSelectionListener Listeners.
protected java.lang.Integer	listWidth
protected java.lang.Integer	preferredHeight
protected javax.swing.CellRendererPane	rendererPane
protected java.lang.Integer	rowsPerColumn
protected IListItemPainter	selectionPainter Selected list items decoration painter.

Fields inherited from class com.alee.painter.decoration.AbstractDecorationPainter

ancestor, DECORATION_STATES_PROPERTY, decorationCache, decorations, focused, focusStateTracker, hierarchyTracker, hover, hoverStateTracker, neighboursTracker, states

Fields inherited from class com.alee.painter.AbstractPainter

component, listeners, ltr, propertyChangeListener, ui

Constructor Summary

Constructors

Constructor and Description
ListPainter()

Method Summary

Modifier and Type	Method and Description
protected int	adjustIndex(int index, E list) Returns corrected item index.
protected int	convertLocationToColumn(int x, int y) Returns the column at the location specified by X and Y coordinates.
protected int	convertLocationToRow(int x, int y0, boolean closest) Returns the row at the location specified by X and Y coordinates.
protected int	convertLocationToRowInColumn(int y, int column) Returns the closest row that starts at the specified y-location in the passed in column.
protected int	getHeight(int column, int row) Returns the height of the cell at the passed in location.
protected int	getModelIndex(int column, int row) Returns the model index for the specified display location.
protected int	getRowCount(int column) Returns the number of rows in the given column.
protected java.util.List<java.awt.Rectangle>	getSelectionRects() Returns list of list selections bounds.
void	install(E c, U ui) Called when painter is installed onto some component.
boolean	isHoverDecorationSupported() Returns whether or not hover item decoration is supported by this list painter.
protected void	paintCell(java.awt.Graphics2D g2d, int index, 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 void	paintContent(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui) Paints content decorated by this painter.
protected void	paintDropLocation(java.awt.Graphics2D g2d) Paints list drop location.
protected void	paintHoverCellBackground(java.awt.Graphics2D g2d) Paints hover cell highlight.
protected void	paintList(java.awt.Graphics2D g2d) Paints existing list items.
protected void	paintSelectedCellsBackground(java.awt.Graphics2D g2d) Paints special WebLaF list cells selection.
void	prepareToPaint(java.lang.Integer layoutOrientation, java.lang.Integer listHeight, java.lang.Integer listWidth, java.lang.Integer columnCount, java.lang.Integer rowsPerColumn, java.lang.Integer preferredHeight, int cellWidth, int cellHeight, int[] cellHeights) Prepares painter to pain list.
protected void	repaintSelection() Repaints all rectangles containing list selections.
void	uninstall(E c, U ui) Called when painter is installed into some component.

Methods inherited from class com.alee.painter.decoration.AbstractDecorationPainter

adjustBounds, asList, collectDecorationStates, getBorders, getDecoration, getDecorations, getDecorationSize, getDecorationStates, getPreferredSize, getSectionPainters, installFocusListener, installHierarchyListener, installHoverListener, isDecorated, isDecorationPaintAllowed, isEnabled, isFocused, isHover, isOpaque, isOpaqueDecorated, isOpaqueUndecorated, isPlainBackgroundPaintAllowed, paint, propertyChange, provideShape, uninstallFocusListener, uninstallHierarchyListener, uninstallHoverListener, updateDecorationState, usesState, usesState

Methods inherited from class com.alee.painter.AbstractPainter

addPainterListener, b, borderChange, getCompleteBorder, i, i, i, installPropertyChangeListener, isSectionPainter, isSettingsUpdateAllowed, orientationChange, p, removePainterListener, repaint, repaint, repaint, revalidate, saveOrientation, uninstallPropertyChangeListener, updateAll, updateBorder, updateOpacity, updateOrientation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.alee.painter.Painter

addPainterListener, getBorders, getPreferredSize, isOpaque, paint, removePainterListener

Field Detail

hoverPainter

@DefaultPainter(value=ListItemPainter.class)
protected IListItemPainter hoverPainter

Hover list item decoration painter.

selectionPainter

@DefaultPainter(value=ListItemPainter.class)
protected IListItemPainter selectionPainter

Selected list items decoration painter.

listSelectionListener

protected javax.swing.event.ListSelectionListener listSelectionListener

Listeners.

layoutOrientation

protected java.lang.Integer layoutOrientation

Painting variables.

rendererPane

protected javax.swing.CellRendererPane rendererPane

listHeight

protected java.lang.Integer listHeight

listWidth

protected java.lang.Integer listWidth

columnCount

protected java.lang.Integer columnCount

preferredHeight

protected java.lang.Integer preferredHeight

rowsPerColumn

protected java.lang.Integer rowsPerColumn

cellWidth

protected int cellWidth

cellHeight

protected int cellHeight

cellHeights

protected int[] cellHeights

Constructor Detail

ListPainter

public ListPainter()

Method Detail

install

public void install(E c,
                    U ui)

Description copied from interface: Painter

Called when painter is installed onto some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

install in interface Painter<E extends javax.swing.JList,U extends WebListUI>

Overrides:

install in class AbstractDecorationPainter<E extends javax.swing.JList,U extends WebListUI,D extends IDecoration<E,D>>

Parameters:

c - component this painter is being installed onto

ui - component UI

uninstall

public void uninstall(E c,
                      U ui)

Description copied from interface: Painter

Called when painter is installed into some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

uninstall in interface Painter<E extends javax.swing.JList,U extends WebListUI>

Overrides:

uninstall in class AbstractDecorationPainter<E extends javax.swing.JList,U extends WebListUI,D extends IDecoration<E,D>>

Parameters:

c - component this painter is being uninstalled from

ui - component UI

prepareToPaint

public void prepareToPaint(java.lang.Integer layoutOrientation,
                           java.lang.Integer listHeight,
                           java.lang.Integer listWidth,
                           java.lang.Integer columnCount,
                           java.lang.Integer rowsPerColumn,
                           java.lang.Integer preferredHeight,
                           int cellWidth,
                           int cellHeight,
                           int[] cellHeights)

Description copied from interface: IListPainter

Prepares painter to pain list.

Specified by:

prepareToPaint in interface IListPainter<E extends javax.swing.JList,U extends WebListUI>

Parameters:

layoutOrientation - cached layout orientation

listHeight - cached list height

listWidth - cached list width

columnCount - cached column count

rowsPerColumn - cached rows per column amount

preferredHeight - cached preferred height

cellWidth - cached cell width

cellHeight - cached cell height

cellHeights - cached cell heights

paintContent

protected void paintContent(java.awt.Graphics2D g2d,
                            java.awt.Rectangle bounds,
                            E c,
                            U ui)

Description copied from class: AbstractDecorationPainter

Paints content decorated by this painter. todo This method should eventually be removed since all content will be painted by IContent implementations

Overrides:

paintContent in class AbstractDecorationPainter<E extends javax.swing.JList,U extends WebListUI,D extends IDecoration<E,D>>

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

ui - painted component UI

paintList

protected void paintList(java.awt.Graphics2D g2d)

Paints existing list items.

Parameters:

g2d - graphics context

getHeight

protected int getHeight(int column,
                        int row)

Returns the height of the cell at the passed in location.

Parameters:

column - list column

row - list row

Returns:

height of the cell at the passed in location

getModelIndex

protected int getModelIndex(int column,
                            int row)

Returns the model index for the specified display location. If column x row is beyond the length of the model, this will return the model size - 1.

Parameters:

column - list column

row - list row

Returns:

model index for the specified display location

getRowCount

protected int getRowCount(int column)

Returns the number of rows in the given column.

Parameters:

column - column index

Returns:

number of rows in the given column

convertLocationToRowInColumn

protected int convertLocationToRowInColumn(int y,
                                           int column)

Returns the closest row that starts at the specified y-location in the passed in column.

Parameters:

y - Y location

column - column index

Returns:

closest row that starts at the specified y-location in the passed in column

convertLocationToRow

protected int convertLocationToRow(int x,
                                   int y0,
                                   boolean closest)

Returns the row at the location specified by X and Y coordinates. If closest is true and the location doesn't exactly match a particular location, closest row will be returned.

Parameters:

x - X location

y0 - Y location

closest - whether or not should try finding closest row if exact location doesn't match any

Returns:

row at the location specified by X and Y coordinates

convertLocationToColumn

protected int convertLocationToColumn(int x,
                                      int y)

Returns the column at the location specified by X and Y coordinates.

Parameters:

x - X location

y - Y location

Returns:

column at the location specified by X and Y coordinates

adjustIndex

protected int adjustIndex(int index,
                          E list)

Returns corrected item index.

Parameters:

index - list item index

list - painted list

Returns:

corrected item index

paintDropLocation

protected void paintDropLocation(java.awt.Graphics2D g2d)

Paints list drop location.

Parameters:

g2d - graphics context

paintCell

protected void paintCell(java.awt.Graphics2D g2d,
                         int index,
                         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. Subclasses may want to override this method rather than paint().

Parameters:

g2d - graphics context

index - cell index

rowBounds - cell bounds

cellRenderer - cell renderer

dataModel - list model

selModel - list selection model

leadIndex - lead cell index

See Also:

AbstractDecorationPainter.paint(java.awt.Graphics2D, java.awt.Rectangle, E, U)

isHoverDecorationSupported

public boolean isHoverDecorationSupported()

Description copied from interface: IListPainter

Returns whether or not hover item decoration is supported by this list painter.

Specified by:

isHoverDecorationSupported in interface IListPainter<E extends javax.swing.JList,U extends WebListUI>

Returns:

true if hover item decoration is supported by this list painter, false otherwise

paintHoverCellBackground

protected void paintHoverCellBackground(java.awt.Graphics2D g2d)

Paints hover cell highlight.

Parameters:

g2d - graphics context

paintSelectedCellsBackground

protected void paintSelectedCellsBackground(java.awt.Graphics2D g2d)

Paints special WebLaF list cells selection. It is rendered separately from cells allowing you to simplify your list cell renderer component.

Parameters:

g2d - graphics context

getSelectionRects

protected java.util.List<java.awt.Rectangle> getSelectionRects()

Returns list of list selections bounds. This method takes selection style into account.

Returns:

list of list selections bounds

repaintSelection

protected void repaintSelection()

Repaints all rectangles containing list selections. This method is optimized to repaint only those area which are actually have selection in them.