com.sencha.gxt.widget.core.client.form

Class NumberPropertyEditor<N extends Number & Comparable<N>>

java.lang.Object

com.sencha.gxt.widget.core.client.form.PropertyEditor<N>

com.sencha.gxt.widget.core.client.form.NumberPropertyEditor<N>

Type Parameters:

N - the number type

All Implemented Interfaces:

Comparator<N>

Direct Known Subclasses:

NumberPropertyEditor.BigDecimalPropertyEditor, NumberPropertyEditor.BigIntegerPropertyEditor, NumberPropertyEditor.DoublePropertyEditor, NumberPropertyEditor.FloatPropertyEditor, NumberPropertyEditor.IntegerPropertyEditor, NumberPropertyEditor.LongPropertyEditor, NumberPropertyEditor.ShortPropertyEditor

public abstract class NumberPropertyEditor<N extends Number & Comparable<N>>
extends PropertyEditor<N>
implements Comparator<N>

A property editor that converts typed numbers to strings and strings back to numbers. Also handles incrementing and decrementing the typed numbers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumberPropertyEditor.BigDecimalPropertyEditor A number property editor for use with BigDecimal.
static class	NumberPropertyEditor.BigIntegerPropertyEditor A number property editor for use with BigInteger.
static class	NumberPropertyEditor.DoublePropertyEditor A number property editor for use with Double.
static class	NumberPropertyEditor.FloatPropertyEditor A number property editor for use with Float.
static class	NumberPropertyEditor.IntegerPropertyEditor A number property editor for use with Integer.
static class	NumberPropertyEditor.LongPropertyEditor A number property editor for use with Long.
static class	NumberPropertyEditor.ShortPropertyEditor A number property editor for use with Short.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	alphaRegex
protected String	currencySymbolRegex
protected NumberFormat	format
protected String	groupSeparator
protected NumberConstants	numbers

Fields inherited from class com.sencha.gxt.widget.core.client.form.PropertyEditor

DEFAULT

Constructor Summary

Constructors

Constructor and Description
NumberPropertyEditor(N incrAmount) Creates a new number property editor with the default number type (Double).
NumberPropertyEditor(NumberFormat format, N incrAmount) Creates a new number property editor.

Method Summary

Modifier and Type	Method and Description
int	compare(N n1, N n2) Compares the first value with the second value using the objects natural compareTo.
N	decr(N value) Decrements a value by the current increment amount.
protected abstract N	doDecr(N value)
protected abstract N	doIncr(N value)
NumberFormat	getFormat() Returns the editor's format.
N	getIncrement() Gets the current increment amount.
N	incr(N value) Increments a value by the current increment amount.
N	parse(CharSequence text)
protected abstract N	parseString(String string)
String	render(Number value)
protected abstract N	returnTypedValue(Number number)
void	setFormat(NumberFormat format) Sets the editor's format.
void	setIncrement(N value) Sets the increment amount (defaults to zero).
protected String	stripValue(String value)

Methods inherited from class com.sencha.gxt.widget.core.client.form.PropertyEditor

render

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

numbers

protected NumberConstants numbers

format

protected NumberFormat format

alphaRegex

protected String alphaRegex

currencySymbolRegex

protected String currencySymbolRegex

groupSeparator

protected String groupSeparator

Constructor Detail

NumberPropertyEditor

public NumberPropertyEditor(N incrAmount)

Creates a new number property editor with the default number type (Double).

NumberPropertyEditor

public NumberPropertyEditor(NumberFormat format,
                            N incrAmount)

Creates a new number property editor.

Parameters:

format - the number format

Method Detail

compare

public int compare(N n1,
                   N n2)

Compares the first value with the second value using the objects natural compareTo. If the first is a null and the second isn't, it will be greater than.

Specified by:

compare in interface Comparator<N extends Number & Comparable<N>>

Parameters:

n1 - first number

n2 - second number

Returns:

returns compares equality based on -1, 0 or 1

decr

public N decr(N value)

Decrements a value by the current increment amount.

Parameters:

value - the value to decrement

Returns:

the decremented value

getFormat

public NumberFormat getFormat()

Returns the editor's format.

Returns:

the number format

getIncrement

public N getIncrement()

Gets the current increment amount.

Returns:

the current increment amount.

incr

public N incr(N value)

Increments a value by the current increment amount.

Parameters:

value - the value to increment

Returns:

the incremented value

parse

public N parse(CharSequence text)
        throws ParseException

Throws:

ParseException

render

public String render(Number value)

setFormat

public void setFormat(NumberFormat format)

Sets the editor's format.

Parameters:

format - the format

setIncrement

public void setIncrement(N value)

Sets the increment amount (defaults to zero).

Parameters:

value - the new increment amount

doDecr

protected abstract N doDecr(N value)

doIncr

protected abstract N doIncr(N value)

parseString

protected abstract N parseString(String string)

returnTypedValue

protected abstract N returnTypedValue(Number number)

stripValue

protected String stripValue(String value)