Added in API level 1

Summary: Constants | Fields | Ctors | Methods | Inherited Methods

TypedValue

Kotlin |Java

public class TypedValue
extends Object

java.lang.Object
↳	android.util.TypedValue

Container for a dynamically typed data value. Primarily used with Resources for holding resource values.

Summary

Constants
`int`	`COMPLEX_MANTISSA_MASK` Complex data: mask to extract mantissa information (after shifting by `COMPLEX_MANTISSA_SHIFT`).
`int`	`COMPLEX_MANTISSA_SHIFT` Complex data: bit location of mantissa information.
`int`	`COMPLEX_RADIX_0p23` Complex data: the mantissa magnitude is 0 bits -- i.e, 0x0.nnnnnn
`int`	`COMPLEX_RADIX_16p7` Complex data: the mantissa magnitude is 16 bits -- i.e, 0xnnnn.nn
`int`	`COMPLEX_RADIX_23p0` Complex data: the mantissa is an integral number -- i.e., 0xnnnnnn.0
`int`	`COMPLEX_RADIX_8p15` Complex data: the mantissa magnitude is 8 bits -- i.e, 0xnn.nnnn
`int`	`COMPLEX_RADIX_MASK` Complex data: mask to extract radix information (after shifting by `COMPLEX_RADIX_SHIFT`).
`int`	`COMPLEX_RADIX_SHIFT` Complex data: where the radix information is, telling where the decimal place appears in the mantissa.
`int`	`COMPLEX_UNIT_DIP` `TYPE_DIMENSION` complex unit: Value is Device Independent Pixels.
`int`	`COMPLEX_UNIT_FRACTION` `TYPE_FRACTION` complex unit: A basic fraction of the overall size.
`int`	`COMPLEX_UNIT_FRACTION_PARENT` `TYPE_FRACTION` complex unit: A fraction of the parent size.
`int`	`COMPLEX_UNIT_IN` `TYPE_DIMENSION` complex unit: Value is in inches.
`int`	`COMPLEX_UNIT_MASK` Complex data: mask to extract unit information (after shifting by `COMPLEX_UNIT_SHIFT`).
`int`	`COMPLEX_UNIT_MM` `TYPE_DIMENSION` complex unit: Value is in millimeters.
`int`	`COMPLEX_UNIT_PT` `TYPE_DIMENSION` complex unit: Value is in points.
`int`	`COMPLEX_UNIT_PX` `TYPE_DIMENSION` complex unit: Value is raw pixels.
`int`	`COMPLEX_UNIT_SHIFT` Complex data: bit location of unit information.
`int`	`COMPLEX_UNIT_SP` `TYPE_DIMENSION` complex unit: Value is a scaled pixel.
`int`	`DATA_NULL_EMPTY` `TYPE_NULL` data indicating the value was explicitly set to null.
`int`	`DATA_NULL_UNDEFINED` `TYPE_NULL` data indicating the value was not specified.
`int`	`DENSITY_DEFAULT` If `density` is equal to this value, then the density should be treated as the system's default density value: `DisplayMetrics.DENSITY_DEFAULT`.
`int`	`DENSITY_NONE` If `density` is equal to this value, then there is no density associated with the resource and it should not be scaled.
`int`	`TYPE_ATTRIBUTE` The `data` field holds an attribute resource identifier (referencing an attribute in the current theme style, not a resource entry).
`int`	`TYPE_DIMENSION` The `data` field holds a complex number encoding a dimension value.
`int`	`TYPE_FIRST_COLOR_INT` Identifies the start of integer values that were specified as color constants (starting with '#').
`int`	`TYPE_FIRST_INT` Identifies the start of plain integer values.
`int`	`TYPE_FLOAT` The `data` field holds an IEEE 754 floating point number.
`int`	`TYPE_FRACTION` The `data` field holds a complex number encoding a fraction of a container.
`int`	`TYPE_INT_BOOLEAN` `data` holds 0 to represent `false`, or a value different from 0 to represent `true`.
`int`	`TYPE_INT_COLOR_ARGB4` The `data` field holds a color that was originally specified as #argb.
`int`	`TYPE_INT_COLOR_ARGB8` The `data` field holds a color that was originally specified as #aarrggbb.
`int`	`TYPE_INT_COLOR_RGB4` The `data` field holds a color that was originally specified as #rgb.
`int`	`TYPE_INT_COLOR_RGB8` The `data` field holds a color that was originally specified as #rrggbb.
`int`	`TYPE_INT_DEC` The `data` field holds a number that was originally specified in decimal.
`int`	`TYPE_INT_HEX` The `data` field holds a number that was originally specified in hexadecimal (0xn).
`int`	`TYPE_LAST_COLOR_INT` Identifies the end of integer values that were specified as color constants.
`int`	`TYPE_LAST_INT` Identifies the end of plain integer values.
`int`	`TYPE_NULL` The value contains no data.
`int`	`TYPE_REFERENCE` The `data` field holds a resource identifier.
`int`	`TYPE_STRING` The `string` field holds string data.

Fields
`public int`	`assetCookie` Additional information about where the value came from; only set for strings.
`public int`	`changingConfigurations` If the value came from a resource, these are the configurations for which its contents can change.
`public int`	`data` Basic data in the value, interpreted according to `type`
`public int`	`density` If the Value came from a resource, this holds the corresponding pixel density.
`public int`	`resourceId` If Value came from a resource, this holds the corresponding resource id.
`public int`	`sourceResourceId` If the Value came from a style resource or a layout resource (set in an XML layout), this holds the corresponding style or layout resource id against which the attribute was resolved.
`public CharSequence`	`string` If the value holds a string, this is it.
`public int`	`type` The type held by this value, as defined by the constants here.

Public constructors
`TypedValue()`

Public methods
`static float`	`applyDimension(int unit, float value, DisplayMetrics metrics)` Converts an unpacked complex data value holding a dimension to its final floating point pixel value.
`static final String`	`coerceToString(int type, int data)` Perform type conversion as per `coerceToString()` on an explicitly supplied type and data.
`final CharSequence`	`coerceToString()` Regardless of the actual type of the value, try to convert it to a string value.
`static float`	`complexToDimension(int data, DisplayMetrics metrics)` Converts a complex data value holding a dimension to its final floating point value.
`static int`	`complexToDimensionPixelOffset(int data, DisplayMetrics metrics)` Converts a complex data value holding a dimension to its final value as an integer pixel offset.
`static int`	`complexToDimensionPixelSize(int data, DisplayMetrics metrics)` Converts a complex data value holding a dimension to its final value as an integer pixel size.
`static float`	`complexToFloat(int complex)` Retrieve the base value from a complex data integer.
`static float`	`complexToFraction(int data, float base, float pbase)` Converts a complex data value holding a fraction to its final floating point value.
`static float`	`convertDimensionToPixels(int unitToConvertFrom, float value, DisplayMetrics metrics)` Converts a dimension value to raw pixels, e.g. DP to PX.
`static float`	`convertPixelsToDimension(int unitToConvertTo, float pixelValue, DisplayMetrics metrics)` Converts a pixel value to the given dimension, e.g. PX to DP.
`static float`	`deriveDimension(int unitToConvertTo, float pixelValue, DisplayMetrics metrics)` Converts a pixel value to the given dimension, e.g. PX to DP.
`int`	`getComplexUnit()` Return the complex unit type for this value.
`float`	`getDimension(DisplayMetrics metrics)` Return the data for this value as a dimension.
`final float`	`getFloat()` Return the data for this value as a float.
`float`	`getFraction(float base, float pbase)` Return the data for this value as a fraction.
`boolean`	`isColorType()` Determine if a value is a color.
`void`	`setTo(TypedValue other)`
`String`	`toString()` Returns a string representation of the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

COMPLEX_MANTISSA_MASK

Added in API level 1

public static final int COMPLEX_MANTISSA_MASK

Complex data: mask to extract mantissa information (after shifting by COMPLEX_MANTISSA_SHIFT). This gives us 23 bits of precision; the top bit is the sign.

Constant Value: 16777215 (0x00ffffff)

COMPLEX_MANTISSA_SHIFT

Added in API level 1

public static final int COMPLEX_MANTISSA_SHIFT

Complex data: bit location of mantissa information.

Constant Value: 8 (0x00000008)

COMPLEX_RADIX_0p23

Added in API level 1

public static final int COMPLEX_RADIX_0p23

Complex data: the mantissa magnitude is 0 bits -- i.e, 0x0.nnnnnn

Constant Value: 3 (0x00000003)

COMPLEX_RADIX_16p7

Added in API level 1

public static final int COMPLEX_RADIX_16p7

Complex data: the mantissa magnitude is 16 bits -- i.e, 0xnnnn.nn

Constant Value: 1 (0x00000001)

COMPLEX_RADIX_23p0

Added in API level 1

public static final int COMPLEX_RADIX_23p0

Complex data: the mantissa is an integral number -- i.e., 0xnnnnnn.0

Constant Value: 0 (0x00000000)

COMPLEX_RADIX_8p15

Added in API level 1

public static final int COMPLEX_RADIX_8p15

Complex data: the mantissa magnitude is 8 bits -- i.e, 0xnn.nnnn

Constant Value: 2 (0x00000002)

COMPLEX_RADIX_MASK

Added in API level 1

public static final int COMPLEX_RADIX_MASK

Complex data: mask to extract radix information (after shifting by COMPLEX_RADIX_SHIFT). This give us 4 possible fixed point representations as defined below.

Constant Value: 3 (0x00000003)

COMPLEX_RADIX_SHIFT

Added in API level 1

public static final int COMPLEX_RADIX_SHIFT

Complex data: where the radix information is, telling where the decimal place appears in the mantissa.

Constant Value: 4 (0x00000004)

COMPLEX_UNIT_DIP

Added in API level 1

public static final int COMPLEX_UNIT_DIP

TYPE_DIMENSION complex unit: Value is Device Independent Pixels.

Constant Value: 1 (0x00000001)

COMPLEX_UNIT_FRACTION

Added in API level 1

public static final int COMPLEX_UNIT_FRACTION

TYPE_FRACTION complex unit: A basic fraction of the overall size.

Constant Value: 0 (0x00000000)

COMPLEX_UNIT_FRACTION_PARENT

Added in API level 1

public static final int COMPLEX_UNIT_FRACTION_PARENT

TYPE_FRACTION complex unit: A fraction of the parent size.

Constant Value: 1 (0x00000001)

COMPLEX_UNIT_IN

Added in API level 1

public static final int COMPLEX_UNIT_IN

TYPE_DIMENSION complex unit: Value is in inches.

Constant Value: 4 (0x00000004)

COMPLEX_UNIT_MASK

Added in API level 1

public static final int COMPLEX_UNIT_MASK

Complex data: mask to extract unit information (after shifting by COMPLEX_UNIT_SHIFT). This gives us 16 possible types, as defined below.

Constant Value: 15 (0x0000000f)

COMPLEX_UNIT_MM

Added in API level 1

public static final int COMPLEX_UNIT_MM

TYPE_DIMENSION complex unit: Value is in millimeters.

Constant Value: 5 (0x00000005)

COMPLEX_UNIT_PT

Added in API level 1

public static final int COMPLEX_UNIT_PT

TYPE_DIMENSION complex unit: Value is in points.

Constant Value: 3 (0x00000003)

COMPLEX_UNIT_PX

Added in API level 1

public static final int COMPLEX_UNIT_PX

TYPE_DIMENSION complex unit: Value is raw pixels.

Constant Value: 0 (0x00000000)

COMPLEX_UNIT_SHIFT

Added in API level 1

public static final int COMPLEX_UNIT_SHIFT

Complex data: bit location of unit information.

Constant Value: 0 (0x00000000)

COMPLEX_UNIT_SP

Added in API level 1

public static final int COMPLEX_UNIT_SP

TYPE_DIMENSION complex unit: Value is a scaled pixel.

Constant Value: 2 (0x00000002)

DATA_NULL_EMPTY

Added in API level 22

public static final int DATA_NULL_EMPTY

TYPE_NULL data indicating the value was explicitly set to null.

Constant Value: 1 (0x00000001)

DATA_NULL_UNDEFINED

Added in API level 22

public static final int DATA_NULL_UNDEFINED

TYPE_NULL data indicating the value was not specified.

Constant Value: 0 (0x00000000)

DENSITY_DEFAULT

Added in API level 4

public static final int DENSITY_DEFAULT

If density is equal to this value, then the density should be treated as the system's default density value: DisplayMetrics.DENSITY_DEFAULT.

Constant Value: 0 (0x00000000)

DENSITY_NONE

Added in API level 4

public static final int DENSITY_NONE

If density is equal to this value, then there is no density associated with the resource and it should not be scaled.

Constant Value: 65535 (0x0000ffff)

TYPE_ATTRIBUTE

Added in API level 1

public static final int TYPE_ATTRIBUTE

The data field holds an attribute resource identifier (referencing an attribute in the current theme style, not a resource entry).

Constant Value: 2 (0x00000002)

TYPE_DIMENSION

Added in API level 1

public static final int TYPE_DIMENSION

The data field holds a complex number encoding a dimension value.

Constant Value: 5 (0x00000005)

TYPE_FIRST_COLOR_INT

Added in API level 1

public static final int TYPE_FIRST_COLOR_INT

Identifies the start of integer values that were specified as color constants (starting with '#').

Constant Value: 28 (0x0000001c)

TYPE_FIRST_INT

Added in API level 1

public static final int TYPE_FIRST_INT

Identifies the start of plain integer values. Any type value from this to TYPE_LAST_INT means the data field holds a generic integer value.

Constant Value: 16 (0x00000010)

TYPE_FLOAT

Added in API level 1

public static final int TYPE_FLOAT

The data field holds an IEEE 754 floating point number.

Constant Value: 4 (0x00000004)

TYPE_FRACTION

Added in API level 1

public static final int TYPE_FRACTION

The data field holds a complex number encoding a fraction of a container.

Constant Value: 6 (0x00000006)

TYPE_INT_BOOLEAN

Added in API level 1

public static final int TYPE_INT_BOOLEAN

data holds 0 to represent false, or a value different from 0 to represent true.

Constant Value: 18 (0x00000012)

TYPE_INT_COLOR_ARGB4

Added in API level 1

public static final int TYPE_INT_COLOR_ARGB4

The data field holds a color that was originally specified as #argb.

Constant Value: 30 (0x0000001e)

TYPE_INT_COLOR_ARGB8

Added in API level 1

public static final int TYPE_INT_COLOR_ARGB8

The data field holds a color that was originally specified as #aarrggbb.

Constant Value: 28 (0x0000001c)

TYPE_INT_COLOR_RGB4

Added in API level 1

public static final int TYPE_INT_COLOR_RGB4

The data field holds a color that was originally specified as #rgb.

Constant Value: 31 (0x0000001f)

TYPE_INT_COLOR_RGB8

Added in API level 1

public static final int TYPE_INT_COLOR_RGB8

The data field holds a color that was originally specified as #rrggbb.

Constant Value: 29 (0x0000001d)

TYPE_INT_DEC

Added in API level 1

public static final int TYPE_INT_DEC

The data field holds a number that was originally specified in decimal.

Constant Value: 16 (0x00000010)

TYPE_INT_HEX

Added in API level 1

public static final int TYPE_INT_HEX

The data field holds a number that was originally specified in hexadecimal (0xn).

Constant Value: 17 (0x00000011)

TYPE_LAST_COLOR_INT

Added in API level 1

public static final int TYPE_LAST_COLOR_INT

Identifies the end of integer values that were specified as color constants.

Constant Value: 31 (0x0000001f)

TYPE_LAST_INT

Added in API level 1

public static final int TYPE_LAST_INT

Identifies the end of plain integer values.

Constant Value: 31 (0x0000001f)

TYPE_NULL

Added in API level 1

public static final int TYPE_NULL

The value contains no data.

Constant Value: 0 (0x00000000)

TYPE_REFERENCE

Added in API level 1

public static final int TYPE_REFERENCE

The data field holds a resource identifier.

Constant Value: 1 (0x00000001)

TYPE_STRING

Added in API level 1

public static final int TYPE_STRING

The string field holds string data. In addition, if data is non-zero then it is the string block index of the string and assetCookie is the set of assets the string came from.

Constant Value: 3 (0x00000003)

Fields

assetCookie

Added in API level 1

public int assetCookie

Additional information about where the value came from; only set for strings.

changingConfigurations

Added in API level 1

public int changingConfigurations

If the value came from a resource, these are the configurations for which its contents can change.

For example, if a resource has a value defined for the -land resource qualifier, this field will have the ActivityInfo.CONFIG_ORIENTATION bit set.

Value is either 0 or a combination of ActivityInfo.CONFIG_MCC, ActivityInfo.CONFIG_MNC, ActivityInfo.CONFIG_LOCALE, ActivityInfo.CONFIG_TOUCHSCREEN, ActivityInfo.CONFIG_KEYBOARD, ActivityInfo.CONFIG_KEYBOARD_HIDDEN, ActivityInfo.CONFIG_NAVIGATION, ActivityInfo.CONFIG_ORIENTATION, ActivityInfo.CONFIG_SCREEN_LAYOUT, ActivityInfo.CONFIG_UI_MODE, ActivityInfo.CONFIG_SCREEN_SIZE, ActivityInfo.CONFIG_SMALLEST_SCREEN_SIZE, ActivityInfo.CONFIG_DENSITY, ActivityInfo.CONFIG_LAYOUT_DIRECTION, ActivityInfo.CONFIG_COLOR_MODE, ActivityInfo.CONFIG_FONT_SCALE, ActivityInfo.CONFIG_GRAMMATICAL_GENDER, ActivityInfo.CONFIG_ASSETS_PATHS, and ActivityInfo.CONFIG_RESOURCES_UNUSED

See also:

data

Added in API level 1

public int data

Basic data in the value, interpreted according to type

density

Added in API level 4

public int density

If the Value came from a resource, this holds the corresponding pixel density.

resourceId

Added in API level 1

public int resourceId

If Value came from a resource, this holds the corresponding resource id.

sourceResourceId

Added in API level 29

public int sourceResourceId

If the Value came from a style resource or a layout resource (set in an XML layout), this holds the corresponding style or layout resource id against which the attribute was resolved.

string

Added in API level 1

public CharSequence string

If the value holds a string, this is it.

type

Added in API level 1

public int type

The type held by this value, as defined by the constants here. This tells you how to interpret the other fields in the object.

Public constructors

TypedValue

public TypedValue ()

Public methods

applyDimension

Added in API level 1

public static float applyDimension (int unit, 
                float value, 
                DisplayMetrics metrics)

Converts an unpacked complex data value holding a dimension to its final floating point pixel value. The two parameters unit and value are as in TYPE_DIMENSION.

To convert the other way, e.g. from pixels to DP, use deriveDimension(int, float, android.util.DisplayMetrics).

Parameters
`unit`	`int`: The unit to convert from. Value is `COMPLEX_UNIT_PX`, `COMPLEX_UNIT_DIP`, `COMPLEX_UNIT_SP`, `COMPLEX_UNIT_PT`, `COMPLEX_UNIT_IN`, or `COMPLEX_UNIT_MM`
`value`	`float`: The value to apply the unit to.
`metrics`	`DisplayMetrics`: Current display metrics to use in the conversion -- supplies display density and scaling information.

Returns
`float`	The equivalent pixel value\u2014i.e. the complex floating point value multiplied by the appropriate metrics depending on its unit\u2014or zero if unit is not valid.

coerceToString

Added in API level 1

public static final String coerceToString (int type, 
                int data)

Perform type conversion as per coerceToString() on an explicitly supplied type and data.

Parameters
`type`	`int`: The data type identifier.
`data`	`int`: The data value.

Returns
`String`	String The coerced string value. If the value is null or the type is not known, null is returned.

coerceToString

Added in API level 1

public final CharSequence coerceToString ()

Regardless of the actual type of the value, try to convert it to a string value. For example, a color type will be converted to a string of the form #aarrggbb.

Returns
`CharSequence`	CharSequence The coerced string value. If the value is null or the type is not known, null is returned.

complexToDimension

Added in API level 1

public static float complexToDimension (int data, 
                DisplayMetrics metrics)

Converts a complex data value holding a dimension to its final floating point value. The given data must be structured as a TYPE_DIMENSION.

Parameters
`data`	`int`: A complex data value holding a unit, magnitude, and mantissa.
`metrics`	`DisplayMetrics`: Current display metrics to use in the conversion -- supplies display density and scaling information.

Returns
`float`	The complex floating point value multiplied by the appropriate metrics depending on its unit.

complexToDimensionPixelOffset

Added in API level 1

public static int complexToDimensionPixelOffset (int data, 
                DisplayMetrics metrics)

Converts a complex data value holding a dimension to its final value as an integer pixel offset. This is the same as complexToDimension(int, DisplayMetrics), except the raw floating point value is truncated to an integer (pixel) value. The given data must be structured as a TYPE_DIMENSION.

Parameters
`data`	`int`: A complex data value holding a unit, magnitude, and mantissa.
`metrics`	`DisplayMetrics`: Current display metrics to use in the conversion -- supplies display density and scaling information.

Returns
`int`	The number of pixels specified by the data and its desired multiplier and units.

complexToDimensionPixelSize

Added in API level 1

public static int complexToDimensionPixelSize (int data, 
                DisplayMetrics metrics)

Converts a complex data value holding a dimension to its final value as an integer pixel size. This is the same as complexToDimension(int, DisplayMetrics), except the raw floating point value is converted to an integer (pixel) value for use as a size. A size conversion involves rounding the base value, and ensuring that a non-zero base value is at least one pixel in size. The given data must be structured as a TYPE_DIMENSION.

Parameters
`data`	`int`: A complex data value holding a unit, magnitude, and mantissa.
`metrics`	`DisplayMetrics`: Current display metrics to use in the conversion -- supplies display density and scaling information.

Returns
`int`	The number of pixels specified by the data and its desired multiplier and units.

complexToFloat

Added in API level 1

public static float complexToFloat (int complex)

Retrieve the base value from a complex data integer. This uses the COMPLEX_MANTISSA_MASK and COMPLEX_RADIX_MASK fields of the data to compute a floating point representation of the number they describe. The units are ignored.

Parameters
`complex`	`int`: A complex data value.

Returns
`float`	A floating point value corresponding to the complex data.

complexToFraction

Added in API level 1

public static float complexToFraction (int data, 
                float base, 
                float pbase)

Converts a complex data value holding a fraction to its final floating point value. The given data must be structured as a TYPE_FRACTION.

Parameters
`data`	`int`: A complex data value holding a unit, magnitude, and mantissa.
`base`	`float`: The base value of this fraction. In other words, a standard fraction is multiplied by this value.
`pbase`	`float`: The parent base value of this fraction. In other words, a parent fraction (nn%p) is multiplied by this value.

Returns
`float`	The complex floating point value multiplied by the appropriate base value depending on its unit.

convertDimensionToPixels

Added in API level 34

public static float convertDimensionToPixels (int unitToConvertFrom, 
                float value, 
                DisplayMetrics metrics)

Converts a dimension value to raw pixels, e.g. DP to PX.

This is just an alias of applyDimension(int, float, android.util.DisplayMetrics) with an easier-to-find name.

Parameters
`unitToConvertFrom`	`int`: The unit to convert from. Value is `COMPLEX_UNIT_PX`, `COMPLEX_UNIT_DIP`, `COMPLEX_UNIT_SP`, `COMPLEX_UNIT_PT`, `COMPLEX_UNIT_IN`, or `COMPLEX_UNIT_MM`
`value`	`float`: The dimension value to apply the unit to.
`metrics`	`DisplayMetrics`: Current display metrics to use in the conversion -- supplies display density and scaling information. This value cannot be `null`.

Returns
`float`	The equivalent pixel value\u2014i.e. the complex floating point value multiplied by the appropriate metrics depending on its unit\u2014or zero if unit is not valid.

convertPixelsToDimension

Added in API level 34

public static float convertPixelsToDimension (int unitToConvertTo, 
                float pixelValue, 
                DisplayMetrics metrics)

Converts a pixel value to the given dimension, e.g. PX to DP.

This is just an alias of deriveDimension(int, float, android.util.DisplayMetrics) with an easier-to-find name.

Parameters
`unitToConvertTo`	`int`: The unit to convert to. Value is `COMPLEX_UNIT_PX`, `COMPLEX_UNIT_DIP`, `COMPLEX_UNIT_SP`, `COMPLEX_UNIT_PT`, `COMPLEX_UNIT_IN`, or `COMPLEX_UNIT_MM`
`pixelValue`	`float`: The raw pixels value to convert from.
`metrics`	`DisplayMetrics`: Current display metrics to use in the conversion -- supplies display density and scaling information. This value cannot be `null`.

Returns
`float`	A dimension value equivalent to the given number of pixels

Throws
`IllegalArgumentException`	if unitToConvertTo is not valid.

deriveDimension

Added in API level 34

public static float deriveDimension (int unitToConvertTo, 
                float pixelValue, 
                DisplayMetrics metrics)

Converts a pixel value to the given dimension, e.g. PX to DP.

This is the inverse of applyDimension(int, float, android.util.DisplayMetrics)

Parameters
`unitToConvertTo`	`int`: The unit to convert to. Value is `COMPLEX_UNIT_PX`, `COMPLEX_UNIT_DIP`, `COMPLEX_UNIT_SP`, `COMPLEX_UNIT_PT`, `COMPLEX_UNIT_IN`, or `COMPLEX_UNIT_MM`
`pixelValue`	`float`: The raw pixels value to convert from.
`metrics`	`DisplayMetrics`: Current display metrics to use in the conversion -- supplies display density and scaling information. This value cannot be `null`.

Returns
`float`	A dimension value equivalent to the given number of pixels

Throws
`IllegalArgumentException`	if unitToConvertTo is not valid.

getComplexUnit

Added in API level 22

public int getComplexUnit ()

Return the complex unit type for this value. For example, a dimen type with value 12sp will return COMPLEX_UNIT_SP. Only use for values whose type is TYPE_DIMENSION.

Returns
`int`	The complex unit type.

getDimension

Added in API level 1

public float getDimension (DisplayMetrics metrics)

Return the data for this value as a dimension. Only use for values whose type is TYPE_DIMENSION.

Parameters
`metrics`	`DisplayMetrics`: Current display metrics to use in the conversion -- supplies display density and scaling information.

Returns
`float`	The complex floating point value multiplied by the appropriate metrics depending on its unit.

getFloat

Added in API level 1

public final float getFloat ()

Return the data for this value as a float. Only use for values whose type is TYPE_FLOAT.

Returns
`float`

getFraction

Added in API level 1

public float getFraction (float base, 
                float pbase)

Return the data for this value as a fraction. Only use for values whose type is TYPE_FRACTION.

Parameters
`base`	`float`: The base value of this fraction. In other words, a standard fraction is multiplied by this value.
`pbase`	`float`: The parent base value of this fraction. In other words, a parent fraction (nn%p) is multiplied by this value.

Returns
`float`	The complex floating point value multiplied by the appropriate base value depending on its unit.

isColorType

Added in API level 29

public boolean isColorType ()

Determine if a value is a color. This works by comparing type to TYPE_FIRST_COLOR_INT and TYPE_LAST_COLOR_INT.

Returns
`boolean`	true if this value is a color

setTo

Added in API level 1

public void setTo (TypedValue other)

Parameters
`other`	`TypedValue`

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.