com.actinarium.rhythm

Interface ArgumentsBundle

All Known Implementing Classes:

MagicVariablesArgumentsBundle, SimpleArgumentsBundle

public interface ArgumentsBundle

An interface that defines an arguments container that will be used by RhythmSpecLayerFactory implementations to query spec layer properties when creating new layers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ArgumentsBundle.DimensionUnits Type definition for dimension argument units
static interface	ArgumentsBundle.EdgeAffinity Type definition for screen edge that a keyline or pattern must be attached to.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNITS_DP
static int	UNITS_IN
static int	UNITS_MM
static int	UNITS_NULL
static int	UNITS_NUMBER
static int	UNITS_PERCENT
static int	UNITS_PT
static int	UNITS_PX
static int	UNITS_SP

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(java.lang.String key, boolean defaultValue) Get boolean argument.
int	getColor(java.lang.String key, int defaultValue) Get argument value as color integer with fallback to default value if argument is missing.
float	getDimensionPixelExact(java.lang.String key, float defaultValue) Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
int	getDimensionPixelOffset(java.lang.String key, int defaultValue) Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
int	getDimensionPixelSize(java.lang.String key, int defaultValue) Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
int	getDimensionUnits(java.lang.String key) Get the units of a dimension argument.
float	getDimensionValue(java.lang.String key, float defaultValue) Get raw numeric value from dimension argument disregarding units and NOT performing any conversion to pixels.
android.util.DisplayMetrics	getDisplayMetrics() Get display metrics associated with this arguments bundle.
int	getEdgeAffinity(java.lang.String key, int defaultValue) Get argument as an ArgumentsBundle.EdgeAffinity constant, which can be either Gravity.TOP, Gravity.LEFT, Gravity.RIGHT, or Gravity.BOTTOM, with fallback to default value if argument is missing or invalid.
float	getFloat(java.lang.String key, float defaultValue) Get argument value as float with fallback to default value if argument is missing.
int	getGravity(java.lang.String key, int defaultValue) Get argument value as a gravity value (a combination of Gravity constants) with fallback to default value if argument is missing.
int	getInt(java.lang.String key, int defaultValue) Get argument value as integer with fallback to default value if argument is missing.
java.lang.String	getString(java.lang.String key) Get argument value as a string.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Get argument value as a string with fallback to default value if argument is missing.
boolean	hasArgument(java.lang.String key) Test if there's an argument with given key in the bundle, even if the value is null.

Field Detail

UNITS_NULL

static final int UNITS_NULL

See Also:

Constant Field Values

UNITS_NUMBER

static final int UNITS_NUMBER

See Also:

Constant Field Values

UNITS_PERCENT

static final int UNITS_PERCENT

See Also:

Constant Field Values

UNITS_PX

static final int UNITS_PX

See Also:

Constant Field Values

UNITS_DP

static final int UNITS_DP

See Also:

Constant Field Values

UNITS_SP

static final int UNITS_SP

See Also:

Constant Field Values

UNITS_PT

static final int UNITS_PT

See Also:

Constant Field Values

UNITS_IN

static final int UNITS_IN

See Also:

Constant Field Values

UNITS_MM

static final int UNITS_MM

See Also:

Constant Field Values

Method Detail

hasArgument

boolean hasArgument(java.lang.String key)

Test if there's an argument with given key in the bundle, even if the value is null.

Parameters:

key - argument key

Returns:

true if argument is present regardless of value

getString

java.lang.String getString(java.lang.String key)

Get argument value as a string.

Parameters:

key - argument key

Returns:

argument value as a string, or null if the argument has null value or it cannot be retrieved

getString

java.lang.String getString(java.lang.String key,
                           @Nullable
                           java.lang.String defaultValue)

Get argument value as a string with fallback to default value if argument is missing.

Parameters:

key - argument key

defaultValue - fallback value

Returns:

argument value as raw string

getInt

int getInt(java.lang.String key,
           int defaultValue)

Get argument value as integer with fallback to default value if argument is missing.

Parameters:

key - argument key

defaultValue - fallback value

Returns:

argument value parsed as integer

getFloat

float getFloat(java.lang.String key,
               float defaultValue)

Get argument value as float with fallback to default value if argument is missing.

Parameters:

key - argument key

defaultValue - fallback value

Returns:

argument value parsed as float

getBoolean

boolean getBoolean(java.lang.String key,
                   boolean defaultValue)

Get boolean argument. Arguments specified as arg are identical to arg=true.

Parameters:

key - argument key

defaultValue - value if argument is not present

Returns:

argument boolean value

getColor

int getColor(java.lang.String key,
             int defaultValue)

Get argument value as color integer with fallback to default value if argument is missing.

Parameters:

key - argument key

defaultValue - fallback value

Returns:

argument value parsed as color integer

getGravity

int getGravity(java.lang.String key,
               int defaultValue)

Get argument value as a gravity value (a combination of Gravity constants) with fallback to default value if argument is missing.

Parameters:

key - argument key

defaultValue - fallback value

Returns:

gravity constant

See Also:

getEdgeAffinity(String, int)

getEdgeAffinity

int getEdgeAffinity(java.lang.String key,
                    int defaultValue)

Get argument as an ArgumentsBundle.EdgeAffinity constant, which can be either Gravity.TOP, Gravity.LEFT, Gravity.RIGHT, or Gravity.BOTTOM, with fallback to default value if argument is missing or invalid.

Parameters:

key - argument key

defaultValue - fallback value

Returns:

gravity constant

See Also:

getGravity(String, int)

getDimensionUnits

int getDimensionUnits(java.lang.String key)

Get the units of a dimension argument.

Parameters:

key - argument key

Returns:

dimension argument units, or UNITS_NULL if the argument is null or missing

getDimensionValue

float getDimensionValue(java.lang.String key,
                        float defaultValue)

Get raw numeric value from dimension argument disregarding units and NOT performing any conversion to pixels.

Parameters:

key - argument key

defaultValue - fallback value in pixels

Returns:

dimension argument raw value

See Also:

getDimensionPixelSize(String, int), getDimensionPixelOffset(String, int)

getDimensionPixelExact

float getDimensionPixelExact(java.lang.String key,
                             float defaultValue)

Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid. Unlike getDimensionPixelSize(String, int) and getDimensionPixelSize(String, int), this method doesn't perform any rounding.

Parameters:

key - argument key

defaultValue - fallback value in pixels

Returns:

argument value converted to pixels

See Also:

getDimensionPixelSize(String, int), getDimensionPixelOffset(String, int)

getDimensionPixelOffset

int getDimensionPixelOffset(java.lang.String key,
                            int defaultValue)

Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid. Unlike getDimensionPixelSize(String, int), this method is expected to round the raw value down to the closest integer.

Parameters:

key - argument key

defaultValue - fallback value in pixels

Returns:

argument value converted to pixels

See Also:

getDimensionPixelSize(String, int), getDimensionPixelExact(String, float)

getDimensionPixelSize

int getDimensionPixelSize(java.lang.String key,
                          int defaultValue)

Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid. Unlike getDimensionPixelOffset(String, int)}, this method is expected to round the raw value up or down to the closest integer by common rules, and must ensure the result is at least 1px if original value is not 0.

Parameters:

key - argument key

defaultValue - fallback value in pixels

Returns:

argument value converted to pixels

See Also:

getDimensionPixelOffset(String, int), getDimensionPixelExact(String, float)

getDisplayMetrics

android.util.DisplayMetrics getDisplayMetrics()

Get display metrics associated with this arguments bundle.

Returns:

display metrics object