WebListUI

java.lang.Object
- javax.swing.plaf.ComponentUI
- - javax.swing.plaf.ListUI
  - - javax.swing.plaf.basic.BasicListUI
    - - com.alee.laf.list.WebListUI

All Implemented Interfaces:: MarginSupport, PaddingSupport, ShapeProvider, Styleable

public class WebListUI
extends javax.swing.plaf.basic.BasicListUI
implements Styleable, ShapeProvider, MarginSupport, PaddingSupport

Custom UI for JList component.

Nested Class Summary
- 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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`heightChanged`
`protected ListItemHoverBehavior`	`hoverCellTracker`
`protected int`	`hoverIndex`
`protected java.awt.Insets`	`margin` Runtime variables.
`protected java.awt.Insets`	`padding`
`protected IListPainter`	`painter` Component painter.
`protected boolean`	`scrollToSelection`
`protected ListSelectionStyle`	`selectionStyle` Style settings.
`protected javax.swing.event.ListSelectionListener`	`selectionTracker` Listeners.
`protected boolean`	`selectOnHover`
`static int`	`widthChanged`

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

Fields inherited from interface com.alee.managers.style.MarginSupport
EMPTY

Fields inherited from interface com.alee.managers.style.PaddingSupport
EMPTY

Constructor Summary

Constructors
Constructor and Description

WebListUI()

Constructors
Constructor and Description
`WebListUI()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static javax.swing.plaf.ComponentUI`	`createUI(javax.swing.JComponent c)` Returns an instance of the WebListUI for the specified component.
`protected <T> T`	`getBasicListUIValue(java.lang.String field)` Returns basic list UI field value.
`javax.swing.CellRendererPane`	`getCellRendererPane()` Returns tree cell renderer pane.
`protected java.lang.Integer`	`getColumnCount()` Returns cached column count field value.
`int`	`getHoverIndex()` Returns current mousover index.
`protected java.lang.Integer`	`getLayoutOrientation()` Returns layout orientation field value.
`protected java.lang.Integer`	`getListHeight()` Returns cached list height field value.
`protected java.lang.Integer`	`getListWidth()` Returns cached list width field value.
`java.awt.Insets`	`getMargin()` Returns current margin.
`java.awt.Insets`	`getPadding()` Returns current padding.
`Painter`	`getPainter()` Returns list painter.
`protected java.lang.Integer`	`getPreferredHeight()` Returns cached preferred height field value.
`java.awt.Dimension`	`getPreferredSize(javax.swing.JComponent c)`
`protected java.lang.Integer`	`getRowsPerColumn()` Returns cached rows per column amount field value.
`ListSelectionStyle`	`getSelectionStyle()` Returns list selection style.
`StyleId`	`getStyleId()` Returns component style ID.
`protected ToolTipProvider<? extends WebList>`	`getToolTipProvider()` Returns custom WebLaF tooltip provider.
`void`	`installUI(javax.swing.JComponent c)` Installs UI in the specified component.
`boolean`	`isScrollToSelection()` Returns whether to scroll list down to selection automatically or not.
`boolean`	`isSelectOnHover()` Returns whether or not cells should be selected on hover.
`void`	`paint(java.awt.Graphics g, javax.swing.JComponent c)`
`java.awt.Shape`	`provideShape()` Returns component shape.
`void`	`redrawList()` Requests full list update.
`void`	`requestLayoutStateUpdate()` Force list to update layout.
`void`	`setMargin(java.awt.Insets margin)` Sets new margin.
`void`	`setPadding(java.awt.Insets padding)` Sets new padding.
`void`	`setPainter(Painter painter)` Sets list painter.
`void`	`setScrollToSelection(boolean scroll)` Sets whether to scroll list down to selection automatically or not.
`void`	`setSelectionStyle(ListSelectionStyle style)` Sets list selection style.
`void`	`setSelectOnHover(boolean select)` Sets whether or not cells should be selected on hover.
`StyleId`	`setStyleId(StyleId id)` Sets new component style ID.
`void`	`uninstallUI(javax.swing.JComponent c)` Uninstalls UI from the specified component.
`protected void`	`validateListLayout()` Perform list layout validation.

Methods inherited from class javax.swing.plaf.basic.BasicListUI
convertRowToY, convertYToRow, createFocusListener, createListDataListener, createListSelectionListener, createMouseInputListener, createPropertyChangeListener, getBaseline, getBaselineResizeBehavior, getCellBounds, getRowHeight, indexToLocation, installDefaults, installKeyboardActions, installListeners, locationToIndex, maybeUpdateLayoutState, paintCell, selectNextIndex, selectPreviousIndex, uninstallDefaults, uninstallKeyboardActions, uninstallListeners, updateLayoutState

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
  - heightChanged
```
public static final int heightChanged
```
    See Also:
    
    Constant Field Values
  - widthChanged
```
public static final int widthChanged
```
    See Also:
    
    Constant Field Values
  - selectionStyle
```
protected ListSelectionStyle selectionStyle
```
    Style settings.
  - selectOnHover
```
protected boolean selectOnHover
```
  - scrollToSelection
```
protected boolean scrollToSelection
```
  - selectionTracker
```
protected javax.swing.event.ListSelectionListener selectionTracker
```
    Listeners.
  - hoverCellTracker
```
protected ListItemHoverBehavior hoverCellTracker
```
  - painter
```
@DefaultPainter(value=ListPainter.class)
protected IListPainter painter
```
    Component painter.
  - margin
```
protected java.awt.Insets margin
```
    Runtime variables.
  - padding
```
protected java.awt.Insets padding
```
  - hoverIndex
```
protected int hoverIndex
```
- Constructor Detail
  - WebListUI
```
public WebListUI()
```
- Method Detail
  - createUI
```
public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent c)
```
    Returns an instance of the WebListUI for the specified component. This tricky method is used by UIManager to create component UIs when needed.
    
    Parameters:
    
    c - component that will use UI instance
    
    Returns:
    
    instance of the WebListUI
  - installUI
```
public void installUI(javax.swing.JComponent c)
```
    Installs UI in the specified component.
    
    Overrides:
    
    installUI in class javax.swing.plaf.basic.BasicListUI
    
    Parameters:
    
    c - component for this UI
  - uninstallUI
```
public void uninstallUI(javax.swing.JComponent c)
```
    Uninstalls UI from the specified component.
    
    Overrides:
    
    uninstallUI in class javax.swing.plaf.basic.BasicListUI
    
    Parameters:
    
    c - component with this UI
  - getStyleId
```
public StyleId getStyleId()
```
    Description copied from interface: Styleable
    
    Returns component style ID.
    
    Specified by:
    
    getStyleId in interface Styleable
    
    Returns:
    
    component style ID
  - setStyleId
```
public StyleId setStyleId(StyleId id)
```
    Description copied from interface: Styleable
    
    Sets new component style ID. If style for the specified ID cannot be found in skin then its default style will be used instead. This method forces component to instantly apply style with the specified ID to itself.
    
    Specified by:
    
    setStyleId in interface Styleable
    
    Parameters:
    
    id - custom component style ID
    
    Returns:
    
    previously used style ID
  - provideShape
```
public java.awt.Shape provideShape()
```
    Description copied from interface: ShapeProvider
    
    Returns component shape.
    
    Specified by:
    
    provideShape in interface ShapeProvider
    
    Returns:
    
    component shape
  - getMargin
```
public java.awt.Insets getMargin()
```
    Description copied from interface: MarginSupport
    
    Returns current margin. Might return null which is basically the same as an empty [0,0,0,0] margin.
    
    Specified by:
    
    getMargin in interface MarginSupport
    
    Returns:
    
    current margin
  - setMargin
```
public void setMargin(java.awt.Insets margin)
```
    Description copied from interface: MarginSupport
    
    Sets new margin. null can be provided to set an empty [0,0,0,0] margin.
    
    Specified by:
    
    setMargin in interface MarginSupport
    
    Parameters:
    
    margin - new margin
  - getPadding
```
public java.awt.Insets getPadding()
```
    Description copied from interface: PaddingSupport
    
    Returns current padding. Might return null which is basically the same as an empty [0,0,0,0] padding.
    
    Specified by:
    
    getPadding in interface PaddingSupport
    
    Returns:
    
    current padding
  - setPadding
```
public void setPadding(java.awt.Insets padding)
```
    Description copied from interface: PaddingSupport
    
    Sets new padding. null can be provided to set an empty [0,0,0,0] padding.
    
    Specified by:
    
    setPadding in interface PaddingSupport
    
    Parameters:
    
    padding - new padding
  - getPainter
```
public Painter getPainter()
```
    Returns list painter.
    
    Returns:
    
    list painter
  - setPainter
```
public void setPainter(Painter painter)
```
    Sets list painter. Pass null to remove list painter.
    
    Parameters:
    
    painter - new list painter
  - getHoverIndex
```
public int getHoverIndex()
```
    Returns current mousover index.
    
    Returns:
    
    current mousover index
  - getSelectionStyle
```
public ListSelectionStyle getSelectionStyle()
```
    Returns list selection style.
    
    Returns:
    
    list selection style
  - setSelectionStyle
```
public void setSelectionStyle(ListSelectionStyle style)
```
    Sets list selection style.
    
    Parameters:
    
    style - list selection style
  - isSelectOnHover
```
public boolean isSelectOnHover()
```
    Returns whether or not cells should be selected on hover.
    
    Returns:
    
    true if cells should be selected on hover, false otherwise
  - setSelectOnHover
```
public void setSelectOnHover(boolean select)
```
    Sets whether or not cells should be selected on hover.
    
    Parameters:
    
    select - whether or not cells should be selected on hover
  - isScrollToSelection
```
public boolean isScrollToSelection()
```
    Returns whether to scroll list down to selection automatically or not.
    
    Returns:
    
    true if list is being automatically scrolled to selection, false otherwise
  - setScrollToSelection
```
public void setScrollToSelection(boolean scroll)
```
    Sets whether to scroll list down to selection automatically or not.
    
    Parameters:
    
    scroll - whether to scroll list down to selection automatically or not
  - requestLayoutStateUpdate
```
public void requestLayoutStateUpdate()
```
    Force list to update layout.
  - getCellRendererPane
```
public javax.swing.CellRendererPane getCellRendererPane()
```
    Returns tree cell renderer pane.
    
    Returns:
    
    tree cell renderer pane
  - paint
```
public void paint(java.awt.Graphics g,
                  javax.swing.JComponent c)
```
    Overrides:
    
    paint in class javax.swing.plaf.basic.BasicListUI
  - validateListLayout
```
protected void validateListLayout()
```
    Perform list layout validation.
  - redrawList
```
public void redrawList()
```
    Requests full list update.
  - getLayoutOrientation
```
protected java.lang.Integer getLayoutOrientation()
```
    Returns layout orientation field value. This is a bridge method to access private basic list UI field.
    
    Returns:
    
    layout orientation field value
  - getListHeight
```
protected java.lang.Integer getListHeight()
```
    Returns cached list height field value. This is a bridge method to access private basic list UI field.
    
    Returns:
    
    cached list height field value
  - getListWidth
```
protected java.lang.Integer getListWidth()
```
    Returns cached list width field value. This is a bridge method to access private basic list UI field.
    
    Returns:
    
    cached list width field value
  - getColumnCount
```
protected java.lang.Integer getColumnCount()
```
    Returns cached column count field value. This is a bridge method to access private basic list UI field.
    
    Returns:
    
    cached column count field value
  - getRowsPerColumn
```
protected java.lang.Integer getRowsPerColumn()
```
    Returns cached rows per column amount field value. This is a bridge method to access private basic list UI field.
    
    Returns:
    
    cached rows per column amount field value
  - getPreferredHeight
```
protected java.lang.Integer getPreferredHeight()
```
    Returns cached preferred height field value. This is a bridge method to access private basic list UI field.
    
    Returns:
    
    cached preferred height field value
  - getBasicListUIValue
```
protected <T> T getBasicListUIValue(java.lang.String field)
```
    Returns basic list UI field value. This is a bridge method to access private basic list UI field.
    
    Type Parameters:
    
    T - field type
    
    Parameters:
    
    field - field name
    
    Returns:
    
    basic list UI field value
  - getToolTipProvider
```
protected ToolTipProvider<? extends WebList> getToolTipProvider()
```
    Returns custom WebLaF tooltip provider.
    
    Returns:
    
    custom WebLaF tooltip provider
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize(javax.swing.JComponent c)
```
    Overrides:
    
    getPreferredSize in class javax.swing.plaf.basic.BasicListUI

Class WebListUI

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

Fields inherited from interface com.alee.managers.style.MarginSupport

Fields inherited from interface com.alee.managers.style.PaddingSupport

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

heightChanged

widthChanged

selectionStyle

selectOnHover

scrollToSelection

selectionTracker

hoverCellTracker

painter

margin

padding

hoverIndex

Constructor Detail

WebListUI

Method Detail

createUI

installUI

uninstallUI

getStyleId

setStyleId

provideShape

getMargin

setMargin

getPadding

setPadding

getPainter

setPainter

getHoverIndex

getSelectionStyle

setSelectionStyle

isSelectOnHover

setSelectOnHover

isScrollToSelection

setScrollToSelection

requestLayoutStateUpdate

getCellRendererPane

paint

validateListLayout

redrawList

getLayoutOrientation

getListHeight

getListWidth

getColumnCount

getRowsPerColumn

getPreferredHeight

getBasicListUIValue

getToolTipProvider

getPreferredSize