Package snap.text

Class NumberFormat

java.lang.Object

snap.props.PropObject

snap.text.NumberFormat

All Implemented Interfaces:

Cloneable, PropChange.DoChange, TextFormat, XMLArchiver.Archivable

public class NumberFormat
extends PropObject
implements TextFormat, Cloneable

A class to format tick labels.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NumberFormat.ExpStyle

Field Summary

Fields

Modifier and Type	Field	Description
protected DecimalFormat	_format
protected String	_pattern
static final NumberFormat	DEFAULT
static final String	ExpStyle_Prop
protected static String	NULL_PATTERN
static final String	Pattern_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
NumberFormat()	Constructor.
NumberFormat(String aPattern)	Constructor.
NumberFormat(String aPattern, NumberFormat.ExpStyle anExpStyle)	Constructor.

Method Summary

Modifier and Type	Method	Description
NumberFormat	clone()	Standard clone implementation.
NumberFormat	copyForProps(Object... theProps)	Copy object for given array of property names and values.
boolean	equals(Object anObj)	Standard equals implementation.
String	format(double aValue)	Returns a formatted value.
String	format(Object anObj)	Returns a formatted value.
Object	fromXML(XMLArchiver anArchiver, XMLElement anElement)	Unarchival.
protected int	getExponentForValue(double aValue)	Returns the exponent for given value.
NumberFormat.ExpStyle	getExpStyle()	Returns the exponent style.
protected DecimalFormat	getFormat()	Returns the DecimalFormat.
static NumberFormat	getFormat(TextFormat aFormat)	Returns a NumberFormat or null.
static NumberFormat	getFormatOrDefault(TextFormat aFormat)	Returns a NumberFormat or DEFAULT.
String	getPattern()	Returns the format pattern.
Object	getPropValue(String aPropName)	Returns the prop value for given key.
int	hashCode()	Standard hashCode implementation.
protected void	initProps(PropSet aPropSet)	Override to register props.
boolean	isPatternSet()	Returns whether pattern is set.
protected void	setExpStyle(NumberFormat.ExpStyle anExpStyle)	Sets the exponent style.
void	setPattern(String aPattern)	Sets the format pattern.
void	setPropValue(String aPropName, Object aValue)	Sets the prop value for given key.
String	toString()	Standard toString implementation.
XMLElement	toXML(XMLArchiver anArchiver)	Archival.

Methods inherited from class snap.props.PropObject

addDeepChangeListener, addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropDefault, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, getPropsString, isPropDefault, processPropChange, removeDeepChangeListener, removePropChangeListener, removePropChangeListener, setPropsString, setPropValues, toStringProps

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface snap.text.TextFormat

formatStyle

Field Details

_pattern

protected String _pattern

_format

protected DecimalFormat _format

NULL_PATTERN

protected static String NULL_PATTERN

Pattern_Prop

public static final String Pattern_Prop

See Also:

• Constant Field Values

ExpStyle_Prop

public static final String ExpStyle_Prop

See Also:

• Constant Field Values

DEFAULT

public static final NumberFormat DEFAULT

Constructor Details

NumberFormat

public NumberFormat()

Constructor.

NumberFormat

public NumberFormat(String aPattern)

Constructor.

NumberFormat

public NumberFormat(String aPattern,
 NumberFormat.ExpStyle anExpStyle)

Constructor.

Method Details

isPatternSet

public boolean isPatternSet()

Returns whether pattern is set.

getPattern

public String getPattern()

Returns the format pattern.

Specified by:

getPattern in interface TextFormat

setPattern

public void setPattern(String aPattern)

Sets the format pattern.

Specified by:

setPattern in interface TextFormat

getFormat

protected DecimalFormat getFormat()

Returns the DecimalFormat.

getExpStyle

public NumberFormat.ExpStyle getExpStyle()

Returns the exponent style.

setExpStyle

protected void setExpStyle(NumberFormat.ExpStyle anExpStyle)

Sets the exponent style.

format

public String format(Object anObj)

Returns a formatted value.

Specified by:

format in interface TextFormat

format

public String format(double aValue)

Returns a formatted value.

getExponentForValue

protected int getExponentForValue(double aValue)

Returns the exponent for given value.

copyForProps

public NumberFormat copyForProps(Object... theProps)

Copy object for given array of property names and values.

clone

public NumberFormat clone()

Standard clone implementation.

Overrides:

clone in class PropObject

equals

public boolean equals(Object anObj)

Standard equals implementation.

Overrides:

equals in class Object

hashCode

public int hashCode()

Standard hashCode implementation.

Overrides:

hashCode in class Object

toString

public String toString()

Standard toString implementation.

Overrides:

toString in class PropObject

initProps

protected void initProps(PropSet aPropSet)

Override to register props.

Overrides:

initProps in class PropObject

getPropValue

public Object getPropValue(String aPropName)

Returns the prop value for given key.

Overrides:

getPropValue in class PropObject

setPropValue

public void setPropValue(String aPropName,
 Object aValue)

Sets the prop value for given key.

Overrides:

setPropValue in class PropObject

toXML

public XMLElement toXML(XMLArchiver anArchiver)

Archival.

Specified by:

toXML in interface XMLArchiver.Archivable

fromXML

public Object fromXML(XMLArchiver anArchiver,
 XMLElement anElement)

Unarchival.

Specified by:

fromXML in interface XMLArchiver.Archivable

getFormat

public static NumberFormat getFormat(TextFormat aFormat)

Returns a NumberFormat or null.

getFormatOrDefault

public static NumberFormat getFormatOrDefault(TextFormat aFormat)

Returns a NumberFormat or DEFAULT.