Module org.autogui

Package org.autogui.base.mapping

Class GuiReprValueNumberSpinner

java.lang.Object

org.autogui.base.mapping.GuiReprValue

org.autogui.base.mapping.GuiReprValueNumberSpinner

All Implemented Interfaces:

GuiRepresentation

public class GuiReprValueNumberSpinner
extends GuiReprValue

a spinner text-field component for a Number or primitive number property

     @GuiIncluded public int      intProp;
     @GuiIncluded public byte     byteProp;
     @GuiIncluded public short    shortProp;
     @GuiIncluded public long     longProp;
     @GuiIncluded public float    floatProp;
     @GuiIncluded public double   doubleProp;

     @GuiIncluded public Integer  intObjProp;
     @GuiIncluded public Byte     byteObjProp;
     @GuiIncluded public Short    shortObjProp;
     @GuiIncluded public Long     longObjProp;
     @GuiIncluded public Float    floatObjProp;
     @GuiIncluded public Double   doubleObjProp;

     @GuiIncluded public BigInteger bigIntProp;
     @GuiIncluded public BigDecimal bigDecimalProp;
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiReprValueNumberSpinner.Infinity	a comparable infinity representation, which is not a Number type, but comparable to any other types.
static interface	GuiReprValueNumberSpinner.NumberType	a type information of number.
static class	GuiReprValueNumberSpinner.NumberTypeBigDecimal	the number type for BigDecimal
static class	GuiReprValueNumberSpinner.NumberTypeBigInteger	the number type for BigInteger
static class	GuiReprValueNumberSpinner.NumberTypeByte	the number type for byte
static class	GuiReprValueNumberSpinner.NumberTypeDefault	default impl.
static class	GuiReprValueNumberSpinner.NumberTypeDouble	the number type for double
static class	GuiReprValueNumberSpinner.NumberTypeFloat	the number type for float
static class	GuiReprValueNumberSpinner.NumberTypeInt	the number type for int
static class	GuiReprValueNumberSpinner.NumberTypeLong	the number type for long
static class	GuiReprValueNumberSpinner.NumberTypeShort	the number type for short

Nested classes/interfaces inherited from class org.autogui.base.mapping.GuiReprValue

GuiReprValue.NamedValue, GuiReprValue.ObjectSpecifier, GuiReprValue.ObjectSpecifierIndex, GuiReprValue.ObjectSpecifierNothing

Nested classes/interfaces inherited from interface org.autogui.base.mapping.GuiRepresentation

GuiRepresentation.GuiReprNone

Field Summary

Fields

Modifier and Type	Field	Description
static GuiReprValueNumberSpinner.NumberTypeBigDecimal	BIG_DECIMAL
static GuiReprValueNumberSpinner.NumberTypeBigInteger	BIG_INTEGER
static GuiReprValueNumberSpinner.NumberTypeByte	BYTE
static GuiReprValueNumberSpinner.NumberTypeDouble	DOUBLE
static GuiReprValueNumberSpinner.NumberTypeFloat	FLOAT
protected NumberFormat	format
static GuiReprValueNumberSpinner.NumberTypeInt	INT
static GuiReprValueNumberSpinner.NumberTypeLong	LONG
static GuiReprValueNumberSpinner.Infinity	MAXIMUM
static GuiReprValueNumberSpinner.Infinity	MINIMUM
static GuiReprValueNumberSpinner.NumberTypeShort	SHORT
protected GuiReprValueNumberSpinner.NumberType	type

Fields inherited from class org.autogui.base.mapping.GuiReprValue

NONE, NONE_WITH_CACHE

Constructor Summary

Constructors

Constructor	Description
GuiReprValueNumberSpinner()
GuiReprValueNumberSpinner(GuiReprValueNumberSpinner.NumberType type, NumberFormat format)

Method Summary

Modifier and Type	Method	Description
static int	compare(Number l, Number r)
GuiReprValueNumberSpinner	createNumberSpinner(GuiReprValueNumberSpinner.NumberType type)
Object	fromHumanReadableString(GuiMappingContext context, String str)
Object	fromJson(GuiMappingContext context, Object target, Object json)	create a new value object from the JSON with treating the target as an old value, or update the target with the JSON contents.
static GuiReprValueNumberSpinner.NumberType	getCommonType(GuiReprValueNumberSpinner.NumberType l, GuiReprValueNumberSpinner.NumberType r)	obtains a common type for given 2 number types domains and range l,r byte short int long float double bigInteger bigDecimal byte byte short int long float double bigInteger bigDecimal short short short int long float double bigInteger bigDecimal int int int int long float double bigInteger bigDecimal long long long long long double double bigInteger bigDecimal float float float float double float double bigDecimal bigDecimal double double double double double double double bigDecimal bigDecimal bigInteger bigInteger bigInteger bigInteger bigInteger bigDecimal bigDecimal bigInteger bigDecimal bigDecimal bigDecimal bigDecimal bigDecimal bigDecimal bigDecimal bigDecimal bigDecimal bigDecimal
static GuiReprValueNumberSpinner.NumberType	getCommonTypeForNumbers(Number l, Number r)
NumberFormat	getFormat()
static GuiReprValueNumberSpinner.NumberType	getType(Class<?> cls)
GuiReprValueNumberSpinner.NumberType	getType(GuiMappingContext context)
boolean	isJsonSetter()
boolean	isPrimitiveNumberClass(Class<?> retType)
boolean	isRealNumberType(Class<?> retType)
boolean	isRealNumberType(GuiMappingContext context)
boolean	match(GuiMappingContext context)	match the representation with the typeElement of the context, and if succeeded, it sets this representation to the context, and it might create sub-contexts for recursive matches *
boolean	matchValueType(Class<?> cls)
void	setFormat(NumberFormat format)
static BigDecimal	toBigDecimal(Object n)
static BigInteger	toBigInteger(Object n)
static byte	toByte(Object n)
static double	toDouble(Object n)
static float	toFloat(Object n)
String	toHumanReadableString(GuiMappingContext context, Object source)	method for constructing "toString" copy operations: the returned string will be separated by tabs and new-lines
static int	toInt(Object n)
Object	toJson(GuiMappingContext context, Object source)	convert the source into JSON format
static long	toLong(Object n)
static short	toShort(Object n)
Object	toUpdateValue(GuiMappingContext context, Object value)	called from a GUI element in order to update its value.

Methods inherited from class org.autogui.base.mapping.GuiReprValue

addHistoryValue, castOrMake, checkAndUpdateSource, convertLog, createNewValue, errorWhileAddHistoryValue, fromSource, fromSourceUpdated, getNoneSupplier, getParentSource, getUpdatedSource, getUpdatedValue, getUpdatedValueWithoutNoUpdate, getValue, getValueCollectionElement, getValueCollectionSize, getValueType, getValueWithoutNoUpdate, isEditable, isFromJsonTakingMapWithContextNameEntry, isHistoryValueStored, isHistoryValueStored, isHistoryValueSupported, isHistoryValueSupported, isUpdateContextSourceByUpdateFromGui, notifyUpdateWithParentSourceNone, setSource, toParentSource, toSource, toString, unwrapNoUpdate, update, updateCollectionElement, updateFromGui, updateWithParentSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.autogui.base.mapping.GuiRepresentation

continueCheckAndUpdateSourceForChildren, fromJsonWithNamed, isTaskRunnerUsedFor, matchAndSetNotifiersAsInit, setNotifiersTree, shutdown, toJsonWithNamed, toStringHeader

Field Details

type

protected GuiReprValueNumberSpinner.NumberType type

format

protected NumberFormat format

MAXIMUM

public static GuiReprValueNumberSpinner.Infinity MAXIMUM

MINIMUM

public static GuiReprValueNumberSpinner.Infinity MINIMUM

INT

public static GuiReprValueNumberSpinner.NumberTypeInt INT

LONG

public static GuiReprValueNumberSpinner.NumberTypeLong LONG

SHORT

public static GuiReprValueNumberSpinner.NumberTypeShort SHORT

BYTE

public static GuiReprValueNumberSpinner.NumberTypeByte BYTE

FLOAT

public static GuiReprValueNumberSpinner.NumberTypeFloat FLOAT

DOUBLE

public static GuiReprValueNumberSpinner.NumberTypeDouble DOUBLE

BIG_INTEGER

public static GuiReprValueNumberSpinner.NumberTypeBigInteger BIG_INTEGER

BIG_DECIMAL

public static GuiReprValueNumberSpinner.NumberTypeBigDecimal BIG_DECIMAL

Constructor Details

GuiReprValueNumberSpinner

public GuiReprValueNumberSpinner()

GuiReprValueNumberSpinner

public GuiReprValueNumberSpinner(GuiReprValueNumberSpinner.NumberType type,
 NumberFormat format)

Method Details

match

public boolean match(GuiMappingContext context)

Description copied from interface: GuiRepresentation

match the representation with the typeElement of the context, and if succeeded, it sets this representation to the context, and it might create sub-contexts for recursive matches *

Specified by:

match in interface GuiRepresentation

Overrides:

match in class GuiReprValue

Parameters:

context - the context of the repr.

Returns:

the matching result

createNumberSpinner

public GuiReprValueNumberSpinner createNumberSpinner(GuiReprValueNumberSpinner.NumberType type)

matchValueType

public boolean matchValueType(Class<?> cls)

Overrides:

matchValueType in class GuiReprValue

isPrimitiveNumberClass

public boolean isPrimitiveNumberClass(Class<?> retType)

isRealNumberType

public boolean isRealNumberType(GuiMappingContext context)

isRealNumberType

public boolean isRealNumberType(Class<?> retType)

toUpdateValue

public Object toUpdateValue(GuiMappingContext context,
 Object value)

Description copied from class: GuiReprValue

called from a GUI element in order to update its value. subclass can change to returned type and convert the value to the type. a typical use case is just down-casting and converting null to an empty object.

Overrides:

toUpdateValue in class GuiReprValue

Parameters:

context - the context of the repr.

value - the current value

Returns:

the updated value

toJson

public Object toJson(GuiMappingContext context,
 Object source)

Description copied from interface: GuiRepresentation

convert the source into JSON format

Specified by:

toJson in interface GuiRepresentation

Overrides:

toJson in class GuiReprValue

Parameters:

context - a context holds the representation

source - the converted object

Returns:

Number or String (for BigInteger and BigDecimal). For null and primitive, 0. For null and object, null.

fromJson

public Object fromJson(GuiMappingContext context,
 Object target,
 Object json)

Description copied from interface: GuiRepresentation

create a new value object from the JSON with treating the target as an old value, or update the target with the JSON contents. the behavior can be varied by each representation, confirmed by GuiRepresentation.isJsonSetter().

Specified by:

fromJson in interface GuiRepresentation

Overrides:

fromJson in class GuiReprValue

Parameters:

context - a context holds the representation

target - the target object or null

json - JSON objects representing the target String, Number, Boolean, List, Map or null

Returns:

created object from the json, target if provided, or null.

isJsonSetter

public boolean isJsonSetter()

Returns:

true means GuiRepresentation.fromJson(GuiMappingContext, Object, Object) takes a target object and set json properties to the target. otherwise, the method will return a new value, thus the target can be null

fromHumanReadableString

public Object fromHumanReadableString(GuiMappingContext context,
 String str)

Parameters:

context - the context of the repr.

str - a source string

Returns:

parsed Number or Comparable (including "Infinity") by a NumberFormat returned by getFormat()

toHumanReadableString

public String toHumanReadableString(GuiMappingContext context,
 Object source)

Description copied from interface: GuiRepresentation

method for constructing "toString" copy operations: the returned string will be separated by tabs and new-lines

Parameters:

context - the context of the repr.

source - a Comparable converted to string

Returns:

formatted string by NumberFormat returned by getFormat()

getType

public GuiReprValueNumberSpinner.NumberType getType(GuiMappingContext context)

getFormat

public NumberFormat getFormat()

setFormat

public void setFormat(NumberFormat format)

getType

public static GuiReprValueNumberSpinner.NumberType getType(Class<?> cls)

compare

public static int compare(Number l,
 Number r)

getCommonTypeForNumbers

public static GuiReprValueNumberSpinner.NumberType getCommonTypeForNumbers(Number l,
 Number r)

getCommonType

public static GuiReprValueNumberSpinner.NumberType getCommonType(GuiReprValueNumberSpinner.NumberType l,
 GuiReprValueNumberSpinner.NumberType r)

obtains a common type for given 2 number types

domains and range

l,r	byte	short	int	long	float	double	bigInteger	bigDecimal
byte	byte	short	int	long	float	double	bigInteger	bigDecimal
short	short	short	int	long	float	double	bigInteger	bigDecimal
int	int	int	int	long	float	double	bigInteger	bigDecimal
long	long	long	long	long	double	double	bigInteger	bigDecimal
float	float	float	float	double	float	double	bigDecimal	bigDecimal
double	double	double	double	double	double	double	bigDecimal	bigDecimal
bigInteger	bigInteger	bigInteger	bigInteger	bigInteger	bigDecimal	bigDecimal	bigInteger	bigDecimal
bigDecimal	bigDecimal	bigDecimal	bigDecimal	bigDecimal	bigDecimal	bigDecimal	bigDecimal	bigDecimal

Parameters:

l - a number type

r - a number type

Returns:

a common number type, whose value can be obtained by GuiReprValueNumberSpinner.NumberType.convert(Object)

toInt

public static int toInt(Object n)

toByte

public static byte toByte(Object n)

toShort

public static short toShort(Object n)

toLong

public static long toLong(Object n)

toFloat

public static float toFloat(Object n)

toDouble

public static double toDouble(Object n)

toBigDecimal

public static BigDecimal toBigDecimal(Object n)

toBigInteger

public static BigInteger toBigInteger(Object n)