SubstanceListUI (substance 7.3 API)

java.lang.Object
- javax.swing.plaf.ComponentUI
- - javax.swing.plaf.ListUI
  - - javax.swing.plaf.basic.BasicListUI
    - - org.pushingpixels.substance.internal.ui.SubstanceListUI

All Implemented Interfaces:: UpdateOptimizationAware

public class SubstanceListUI
extends javax.swing.plaf.basic.BasicListUI
implements UpdateOptimizationAware

UI for lists in Substance look and feel.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected class SubstanceListUI.CellRepaintCallback
Repaints a single cell during the fade animation cycle.
- Nested classes/interfaces inherited from class javax.swing.plaf.basic.BasicListUI
  javax.swing.plaf.basic.BasicListUI.FocusHandler, javax.swing.plaf.basic.BasicListUI.ListDataHandler, javax.swing.plaf.basic.BasicListUI.ListSelectionHandler, javax.swing.plaf.basic.BasicListUI.MouseInputHandler, javax.swing.plaf.basic.BasicListUI.PropertyChangeHandler

Nested Classes
Modifier and Type	Class	Description
`protected class`	`SubstanceListUI.CellRepaintCallback`	Repaints a single cell during the fade animation cycle.

Field Summary

Fields
Modifier and Type	Field	Description
`protected int`	`rolledOverIndex`	Holds the currently rolled-over index, or -1 is there is none such.
`protected java.util.Map<java.lang.Integer,java.lang.Object>`	`selectedIndices`	Holds the list of currently selected indices.
`protected org.pushingpixels.substance.internal.ui.SubstanceListUI.RolloverFadeListener`	`substanceFadeRolloverListener`	Listener for transition animations on list rollovers.
`protected javax.swing.event.ListSelectionListener`	`substanceListSelectionListener`	Listener for transition animations on list selections.
`protected java.beans.PropertyChangeListener`	`substancePropertyChangeListener`	Property listener that listens to the `SubstanceLookAndFeel.WATERMARK_VISIBLE` property.

Fields inherited from class javax.swing.plaf.basic.BasicListUI
cellHeight, cellHeights, cellRendererChanged, cellWidth, fixedCellHeightChanged, fixedCellWidthChanged, focusListener, fontChanged, list, listDataListener, listSelectionListener, modelChanged, mouseInputListener, propertyChangeListener, prototypeCellValueChanged, rendererPane, selectionModelChanged, updateLayoutStateNeeded

Constructor Summary

Constructors
Constructor Description

SubstanceListUI()
Creates a UI delegate for list.

Constructors
Constructor	Description
`SubstanceListUI()`	Creates a UI delegate for list.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static javax.swing.plaf.ComponentUI`	`createUI(javax.swing.JComponent comp)`
`ComponentState`	`getCellState(int cellIndex, java.awt.Component rendererComponent)`	Returns the current state for the specified cell.
`StateTransitionTracker.ModelStateInfo`	`getModelStateInfo(int row, java.awt.Component rendererComponent)`
`StateTransitionTracker`	`getStateTransitionTracker(int row)`
`UpdateOptimizationInfo`	`getUpdateOptimizationInfo()`
`protected void`	`installDefaults()`
`protected void`	`installListeners()`
`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)`
`void`	`resetRolloverIndex()`	Resets the rollover index.
`protected void`	`uninstallDefaults()`
`protected void`	`uninstallListeners()`
`void`	`uninstallUI(javax.swing.JComponent c)`
`void`	`update(java.awt.Graphics g, javax.swing.JComponent c)`

Methods inherited from class javax.swing.plaf.basic.BasicListUI
convertRowToY, convertYToRow, createFocusListener, createListDataListener, createListSelectionListener, createMouseInputListener, createPropertyChangeListener, getBaseline, getBaselineResizeBehavior, getCellBounds, getPreferredSize, getRowHeight, indexToLocation, installKeyboardActions, installUI, locationToIndex, maybeUpdateLayoutState, paint, selectNextIndex, selectPreviousIndex, uninstallKeyboardActions, updateLayoutState

Methods inherited from class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- selectedIndices
```
protected java.util.Map<java.lang.Integer,java.lang.Object> selectedIndices
```
  Holds the list of currently selected indices.
- rolledOverIndex
```
protected int rolledOverIndex
```
  Holds the currently rolled-over index, or -1 is there is none such.
- substancePropertyChangeListener
```
protected java.beans.PropertyChangeListener substancePropertyChangeListener
```
  Property listener that listens to the SubstanceLookAndFeel.WATERMARK_VISIBLE property.
- substanceListSelectionListener
```
protected javax.swing.event.ListSelectionListener substanceListSelectionListener
```
  Listener for transition animations on list selections.
- substanceFadeRolloverListener
```
protected org.pushingpixels.substance.internal.ui.SubstanceListUI.RolloverFadeListener substanceFadeRolloverListener
```
  Listener for transition animations on list rollovers.

Constructor Detail
- SubstanceListUI
```
public SubstanceListUI()
```
  Creates a UI delegate for list.

Method Detail

createUI

public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent comp)

installDefaults
```
protected void installDefaults()
```
Overrides:

installDefaults in class javax.swing.plaf.basic.BasicListUI

uninstallDefaults
```
protected void uninstallDefaults()
```
Overrides:

uninstallDefaults in class javax.swing.plaf.basic.BasicListUI

uninstallUI
```
public void uninstallUI(javax.swing.JComponent c)
```
Overrides:

uninstallUI in class javax.swing.plaf.basic.BasicListUI

installListeners
```
protected void installListeners()
```
Overrides:

installListeners in class javax.swing.plaf.basic.BasicListUI

uninstallListeners
```
protected void uninstallListeners()
```
Overrides:

uninstallListeners in class javax.swing.plaf.basic.BasicListUI

paintCell

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)

Overrides:: paintCell in class javax.swing.plaf.basic.BasicListUI

getStateTransitionTracker

public StateTransitionTracker getStateTransitionTracker(int row)

getCellState
```
public ComponentState getCellState(int cellIndex,
                                   java.awt.Component rendererComponent)
```
Returns the current state for the specified cell.

Parameters:

cellIndex - Cell index.

rendererComponent - Renderer component for the specified cell index.

Returns:

The current state for the specified cell.

getModelStateInfo

public StateTransitionTracker.ModelStateInfo getModelStateInfo(int row,
                                                               java.awt.Component rendererComponent)

resetRolloverIndex
```
public void resetRolloverIndex()
```
Resets the rollover index.

update

public void update(java.awt.Graphics g,
                   javax.swing.JComponent c)

Overrides:: update in class javax.swing.plaf.ComponentUI

getUpdateOptimizationInfo
```
public UpdateOptimizationInfo getUpdateOptimizationInfo()
```
Specified by:

getUpdateOptimizationInfo in interface UpdateOptimizationAware

Class SubstanceListUI

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.plaf.basic.BasicListUI

Field Summary

Fields inherited from class javax.swing.plaf.basic.BasicListUI

Constructor Summary

Method Summary

Methods inherited from class javax.swing.plaf.basic.BasicListUI

Methods inherited from class javax.swing.plaf.ComponentUI

Methods inherited from class java.lang.Object

Field Detail

selectedIndices

rolledOverIndex

substancePropertyChangeListener

substanceListSelectionListener

substanceFadeRolloverListener

Constructor Detail

SubstanceListUI

Method Detail

createUI

installDefaults

uninstallDefaults

uninstallUI

installListeners

uninstallListeners

paintCell

getStateTransitionTracker

getCellState

getModelStateInfo

resetRolloverIndex

update

getUpdateOptimizationInfo