Class DefaultListRenderer
- java.lang.Object
-
- org.jdesktop.swingx.renderer.AbstractRenderer
-
- org.jdesktop.swingx.renderer.DefaultListRenderer
-
- All Implemented Interfaces:
java.io.Serializable
,javax.swing.ListCellRenderer
,UIDependent
,StringValue
,RolloverRenderer
public class DefaultListRenderer extends AbstractRenderer implements javax.swing.ListCellRenderer
Adapter to glue SwingX renderer support to core API. It has convenience constructors to create a LabelProvider, optionally configured with a StringValue and horizontal alignment. Typically, client code does not interact with this class except at instantiation time.Note: core DefaultListCellRenderer shows either an icon or the element's toString representation, depending on whether or not the given value is of type icon or implementors. This renderer's empty/null provider constructor takes care of configuring the default provider with a converter which mimics that behaviour. When instantiating this renderer with any of the constructors which have converters as parameters, it's up to the client code to supply the appropriate converter, if needed:
StringValue sv = new StringValue() { public String getString(Object value) { if (value instanceof Icon) { return ""; } return StringValue.TO_STRING.getString(value); } }; StringValue lv = new MappedValue(sv, IconValue.ICON); listRenderer = new DefaultListRenderer(lv, alignment);
- Author:
- Jeanette Winzenburg
- See Also:
ComponentProvider
,StringValue
,IconValue
,MappedValue
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected ListCellContext
cellContext
-
Fields inherited from class org.jdesktop.swingx.renderer.AbstractRenderer
componentController
-
-
Constructor Summary
Constructors Constructor Description DefaultListRenderer()
Instantiates a default list renderer with the default component provider.DefaultListRenderer(ComponentProvider<?> componentProvider)
Instantiates a ListCellRenderer with the given ComponentProvider.DefaultListRenderer(StringValue converter)
Instantiates a default table renderer with a default component controller using the given converter.DefaultListRenderer(StringValue converter, int alignment)
Instantiates a default list renderer with a default component controller using the given converter and horizontal alignment.DefaultListRenderer(StringValue stringValue, IconValue iconValue)
Instantiates a default list renderer with default component provider using both converters.DefaultListRenderer(StringValue stringValue, IconValue iconValue, int alignment)
Instantiates a default list renderer with default component provider using both converters and the given alignment.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ComponentProvider<?>
createDefaultComponentProvider()
The default ComponentProvider to use if no special.java.awt.Component
getListCellRendererComponent(javax.swing.JList list, java.lang.Object value, int index, boolean isSelected, boolean cellHasFocus)
Returns a configured component, appropriate to render the given list cell.-
Methods inherited from class org.jdesktop.swingx.renderer.AbstractRenderer
doClick, getComponentProvider, getString, isEnabled, setBackground, setForeground, updateUI
-
-
-
-
Field Detail
-
cellContext
protected ListCellContext cellContext
-
-
Constructor Detail
-
DefaultListRenderer
public DefaultListRenderer()
Instantiates a default list renderer with the default component provider.
-
DefaultListRenderer
public DefaultListRenderer(ComponentProvider<?> componentProvider)
Instantiates a ListCellRenderer with the given ComponentProvider. If the provider is null, creates and uses a default. The default provider is of typeLabelProvider
Note: the default provider is configured with a custom StringValue which behaves exactly as core DefaultListCellRenderer: depending on whether or not given value is of type icon or implementors, it shows either the icon or the element's toString.
- Parameters:
componentProvider
- the provider of the configured component to use for cell rendering
-
DefaultListRenderer
public DefaultListRenderer(StringValue converter)
Instantiates a default table renderer with a default component controller using the given converter.PENDING JW: how to guarantee core consistent icon handling? Leave to client code?
- Parameters:
converter
- the converter to use for mapping the content value to a String representation.
-
DefaultListRenderer
public DefaultListRenderer(StringValue converter, int alignment)
Instantiates a default list renderer with a default component controller using the given converter and horizontal alignment. PENDING JW: how to guarantee core consistent icon handling? Leave to client code?- Parameters:
converter
- the converter to use for mapping the content value to a String representation.alignment
- the horizontal alignment.
-
DefaultListRenderer
public DefaultListRenderer(StringValue stringValue, IconValue iconValue)
Instantiates a default list renderer with default component provider using both converters.- Parameters:
stringValue
- the converter to use for the string representationiconValue
- the converter to use for the icon representation
-
DefaultListRenderer
public DefaultListRenderer(StringValue stringValue, IconValue iconValue, int alignment)
Instantiates a default list renderer with default component provider using both converters and the given alignment.- Parameters:
stringValue
- the converter to use for the string representationiconValue
- the converter to use for the icon representationalignment
- the rendering component's horizontal alignment
-
-
Method Detail
-
getListCellRendererComponent
public java.awt.Component getListCellRendererComponent(javax.swing.JList list, java.lang.Object value, int index, boolean isSelected, boolean cellHasFocus)
Returns a configured component, appropriate to render the given list cell.Note: The component's name is set to "List.cellRenderer" for the sake of Synth-based LAFs.
- Specified by:
getListCellRendererComponent
in interfacejavax.swing.ListCellRenderer
- Parameters:
list
- theJList
to render onvalue
- the value to assign to the cellisSelected
- true if cell is selectedcellHasFocus
- true if cell has focusindex
- the row index (in view coordinates) of the cell to render- Returns:
- a component to render the given list cell.
-
createDefaultComponentProvider
protected ComponentProvider<?> createDefaultComponentProvider()
The default ComponentProvider to use if no special.- Specified by:
createDefaultComponentProvider
in classAbstractRenderer
- Returns:
- the default
ComponentProvider
-
-