org.jdesktop.swingx.renderer

Class FormatStringValue

java.lang.Object

org.jdesktop.swingx.renderer.FormatStringValue

All Implemented Interfaces:

java.io.Serializable, StringValue

public class FormatStringValue
extends java.lang.Object
implements StringValue

Base type for Format-backed StringValue. Has static defaults for Date and Number which use the locale-dependent default Formats as returned from xxFormat.getInstance().

This class is intended to ease the handling of formatted cell content. F.i. to show a list of Dates in the default Locale's FULL version and right align the text:

    StringValue stringValue = new FormatStringValue(
        DateFormat.getInstance(DateFormat.FULL));
    list.setCellRenderer(
        new DefaultListRenderer(stringValue, JLabel.RIGHT);  
 

PENDING: need to update on Locale change? How to detect? When?

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FormatStringValue	DATE_TO_STRING Deprecated. Use StringValues.DATE_TO_STRING instead
protected java.text.Format	format the format used in creating the String representation.
static FormatStringValue	NUMBER_TO_STRING Deprecated. Use StringValues.NUMBER_TO_STRING instead

Fields inherited from interface org.jdesktop.swingx.renderer.StringValue

EMPTY, TO_STRING

Constructor Summary

Constructors

Constructor and Description
FormatStringValue() Instantiates a formatted converter with null format.
FormatStringValue(java.text.Format format) Instantiates a formatted converter with the given Format.

Method Summary

Methods

Modifier and Type	Method and Description
java.text.Format	getFormat()
java.lang.String	getString(java.lang.Object value) Returns a string representation of the given value.

Methods inherited from class java.lang.Object

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

Field Detail

DATE_TO_STRING

@Deprecated
public static final FormatStringValue DATE_TO_STRING

Deprecated. Use StringValues.DATE_TO_STRING instead

Default converter for Date types. Uses the default format as returned from DateFormat.

NUMBER_TO_STRING

@Deprecated
public static final FormatStringValue NUMBER_TO_STRING

Deprecated. Use StringValues.NUMBER_TO_STRING instead

Default converter for Number types. Uses the default format as returned from NumberFormat.

format

protected java.text.Format format

the format used in creating the String representation.

Constructor Detail

FormatStringValue

public FormatStringValue()

Instantiates a formatted converter with null format.

FormatStringValue

public FormatStringValue(java.text.Format format)

Instantiates a formatted converter with the given Format.

Parameters:

format - the format to use in creating the String representation.

Method Detail

getFormat

public java.text.Format getFormat()

Returns:

the format used in creating the String representation.

getString

public java.lang.String getString(java.lang.Object value)

Returns a string representation of the given value.

PENDING JW: forgot - why not null return guaranteed?

Specified by:

getString in interface StringValue

Parameters:

value - the object to present as a string

Returns:

a string representation of the given value, guaranteed to be not null