com.simsilica.lemur.value

Class DefaultValueRenderer<T>

java.lang.Object

com.simsilica.lemur.value.DefaultValueRenderer<T>

All Implemented Interfaces:

ValueRenderer<T>, java.lang.Cloneable

public class DefaultValueRenderer<T>
extends java.lang.Object
implements ValueRenderer<T>, java.lang.Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
static com.simsilica.lemur.style.ElementId	DEFAULT_ID

Constructor Summary

Constructors

Constructor and Description
DefaultValueRenderer() Creates a value renderer with no preconfigured style, element ID, or string function.
DefaultValueRenderer(com.simsilica.lemur.style.ElementId elementId, java.lang.String style) Creates a value renderer with the preconfigured elementID and style.
DefaultValueRenderer(com.simsilica.lemur.style.ElementId elementId, java.lang.String style, com.google.common.base.Function<? super T,java.lang.String> toString) Creates a value renderer with a custom string function and the preconfigured elementID and style.
DefaultValueRenderer(com.google.common.base.Function<? super T,java.lang.String> toString) Creates a value renderer with the specified string function but no configured element ID or style.

Method Summary

Modifier and Type	Method and Description
DefaultValueRenderer<T>	clone()
void	configureStyle(com.simsilica.lemur.style.ElementId elementId, java.lang.String style) Default implementation uses the specified style unless the renderer already has an elementId and style set.
protected com.simsilica.lemur.Label	createView(T value, boolean selected) Called by getView() to create the new view when the existing view doesn't exist.
com.simsilica.lemur.style.ElementId	getElementId()
com.google.common.base.Function<? super T,java.lang.String>	getStringTransform()
java.lang.String	getStyle()
com.simsilica.lemur.Panel	getView(T value, boolean selected, com.simsilica.lemur.Panel existing) Returns a new view Panel or returns a reconfigured version of the existing Panel that will display the specified value.
void	setElementId(com.simsilica.lemur.style.ElementId elementId) Sets a preconfigured ElementId for created Panels.
void	setStringTransform(com.google.common.base.Function<? super T,java.lang.String> toString) Sets the function that will convert values to Strings.
void	setStyle(java.lang.String style) Sets a preconfigured style for created Panels.
protected java.lang.String	valueToString(T value) Called by getView() and createView() to conver the value to a string.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ID

public static final com.simsilica.lemur.style.ElementId DEFAULT_ID

Constructor Detail

DefaultValueRenderer

public DefaultValueRenderer()

Creates a value renderer with no preconfigured style, element ID, or string function. The renderer will pick up the style information that the using GUI element prefers.

DefaultValueRenderer

public DefaultValueRenderer(com.google.common.base.Function<? super T,java.lang.String> toString)

Creates a value renderer with the specified string function but no configured element ID or style. The renderer will pick up the style information that the using GUI element prefers.

DefaultValueRenderer

public DefaultValueRenderer(com.simsilica.lemur.style.ElementId elementId,
                            java.lang.String style)

Creates a value renderer with the preconfigured elementID and style. For non-null elementId and style, this will ignore any style set by the using GUI element. Values will be converted to Strings using String.valueOf().

DefaultValueRenderer

public DefaultValueRenderer(com.simsilica.lemur.style.ElementId elementId,
                            java.lang.String style,
                            com.google.common.base.Function<? super T,java.lang.String> toString)

Creates a value renderer with a custom string function and the preconfigured elementID and style. This will ignore any style set by the using GUI element if elementId or style are non-null.

Method Detail

clone

public DefaultValueRenderer<T> clone()

Overrides:

clone in class java.lang.Object

configureStyle

public void configureStyle(com.simsilica.lemur.style.ElementId elementId,
                           java.lang.String style)

Default implementation uses the specified style unless the renderer already has an elementId and style set.

Specified by:

configureStyle in interface ValueRenderer<T>

setStringTransform

public void setStringTransform(com.google.common.base.Function<? super T,java.lang.String> toString)

Sets the function that will convert values to Strings. Set to null to use the default String.valueOf() behavior.

getStringTransform

public com.google.common.base.Function<? super T,java.lang.String> getStringTransform()

setElementId

public void setElementId(com.simsilica.lemur.style.ElementId elementId)

Sets a preconfigured ElementId for created Panels. If this is non-null then the default implementation of configureStyle() will ignore the configureStyle() elementId argument.

getElementId

public com.simsilica.lemur.style.ElementId getElementId()

setStyle

public void setStyle(java.lang.String style)

Sets a preconfigured style for created Panels. If this is non-null then the default implementation of configureStyle() will ignore the configureStyle() style argument.

getStyle

public java.lang.String getStyle()

valueToString

protected java.lang.String valueToString(T value)

Called by getView() and createView() to conver the value to a string. Default implementation passes the value to the current string transform.

createView

protected com.simsilica.lemur.Label createView(T value,
                                               boolean selected)

Called by getView() to create the new view when the existing view doesn't exist. Subclasses can override this to provide custom Label subclasses (like Button) to present the view. The default implementation creates a regular Label.

getView

public com.simsilica.lemur.Panel getView(T value,
                                         boolean selected,
                                         com.simsilica.lemur.Panel existing)

Description copied from interface: ValueRenderer

Returns a new view Panel or returns a reconfigured version of the existing Panel that will display the specified value. The 'selected' flag can indicate if the value should appear as selected or focused. For example, some views may change their color or animate if they are the selected view.

Specified by:

getView in interface ValueRenderer<T>