io.jmix.ui.component

Class SizeWithUnit

java.lang.Object

io.jmix.ui.component.SizeWithUnit

All Implemented Interfaces:

java.io.Serializable

public class SizeWithUnit
extends java.lang.Object
implements java.io.Serializable

A class for representing a value-unit pair. Also contains utility methods for parsing such pairs from a string.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected float	size
static java.util.regex.Pattern	SIZE_PATTERN
static java.lang.String	SIZE_PATTERN_STRING
protected SizeUnit	unit

Constructor Summary

Constructors

Constructor and Description
SizeWithUnit(float size, SizeUnit unit) Constructs a new SizeWithUnit object representing the pair (size, unit).

Method Summary

Modifier and Type	Method and Description
float	getSize() Returns the numeric value stored in this object.
SizeUnit	getUnit() Returns the size unit stored in this object.
static SizeWithUnit	parseStringSize(java.lang.String size) Returns an object whose numeric value and unit are taken from the string size.
static SizeWithUnit	parseStringSize(java.lang.String sizeString, SizeUnit defaultUnit) Returns an object whose numeric value and unit are taken from the string sizeString.
java.lang.String	stringValue()

Methods inherited from class java.lang.Object

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

Field Detail

SIZE_PATTERN_STRING

public static final java.lang.String SIZE_PATTERN_STRING

See Also:

Constant Field Values

SIZE_PATTERN

public static final java.util.regex.Pattern SIZE_PATTERN

size

protected float size

unit

protected SizeUnit unit

Constructor Detail

SizeWithUnit

public SizeWithUnit(float size,
                    SizeUnit unit)

Constructs a new SizeWithUnit object representing the pair (size, unit).

Parameters:

size - a numeric value

unit - a unit

Method Detail

getSize

public float getSize()

Returns the numeric value stored in this object.

Returns:

the numeric value stored in this object

getUnit

public SizeUnit getUnit()

Returns the size unit stored in this object.

Returns:

the size unit stored in this object

stringValue

public java.lang.String stringValue()

parseStringSize

public static SizeWithUnit parseStringSize(@Nullable
                                           java.lang.String sizeString,
                                           @Nullable
                                           SizeUnit defaultUnit)

Returns an object whose numeric value and unit are taken from the string sizeString. If sizeString does not specify a unit and defaultUnit is not null, defaultUnit is used as the unit. Null, empty or 'AUTO' string will produce {-1, SizeUnit#PIXELS}.

Parameters:

sizeString - the string to be parsed

defaultUnit - The unit to be used if sizeString does not contain any unit. Use null for no default unit.

Returns:

an object containing the parsed value and unit

parseStringSize

public static SizeWithUnit parseStringSize(@Nullable
                                           java.lang.String size)

Returns an object whose numeric value and unit are taken from the string size. Null, empty or 'AUTO' string will produce {-1, SizeUnit#PIXELS}.

Parameters:

size - the string to be parsed

Returns:

an object containing the parsed value and unit