{% setvar book_path %}/reference/kotlin/dokkatest/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}
annotation ViewDebug.ExportedProperty
This annotation can be used to mark fields and methods to be dumped bythe view server. Only non-void methods with no arguments can be annotatedby this annotation.
Public functions |
|
---|---|
abstract String |
category() Specifies the category the property falls into, such as measurement,layout, drawing, etc. |
abstract Boolean |
When deep export is turned on, this property is not dumped. |
abstract Array<ViewDebug.FlagToString> |
A flags mapping can be defined to map flags encoded in an integer tospecific strings. |
abstract Boolean |
Indicates whether or not to format an |
abstract Boolean |
Indicates whether or not the key to value mappings are held in adjacent indices.Note: Applies only to fields and methods that return String[]. |
abstract Array<ViewDebug.IntToString> |
A mapping can be defined to map array indices to specific strings.A mapping can be used to see human readable values for the indicesof an array: |
abstract Array<ViewDebug.IntToString> |
mapping() A mapping can be defined to map int values to specific strings. |
abstract String |
prefix() The prefix to use on child properties when deep export is enabled |
abstract Boolean |
When resolveId is true, and if the annotated field/method return valueis an int, the value is converted to an Android's resource name. |
abstract fun category(): String
Specifies the category the property falls into, such as measurement,layout, drawing, etc.
Returns | |
---|---|
String |
the category as String |
abstract fun deepExport(): Boolean
When deep export is turned on, this property is not dumped. Instead, theproperties contained in this property are dumped. Each child propertyis prefixed with the name of this property.
Returns | |
---|---|
Boolean |
true if the properties of this property should be dumped |
See also | |
---|---|
prefix |
#prefix() |
abstract fun flagMapping(): Array<ViewDebug.FlagToString>
A flags mapping can be defined to map flags encoded in an integer tospecific strings. A mapping can be used to see human readable valuesfor the flags of an integer:
{@literal @}
ViewDebug.ExportedProperty(flagMapping = {{@literal @}
ViewDebug.FlagToString(mask = ENABLED_MASK, equals = ENABLED, name = "ENABLED"),{@literal @}
ViewDebug.FlagToString(mask = ENABLED_MASK, equals = DISABLED, name = "DISABLED"), }) private int mFlags;A specified String is output when the following is true:
Returns | |
---|---|
Array<ViewDebug.FlagToString> |
An array of int to String mappings |
abstract fun formatToHexString(): Boolean
Indicates whether or not to format an {@code int}
or {@code byte}
value as a hex string.
Returns | |
---|---|
Boolean |
true if the supported values should be formatted as a hex string. |
abstract fun hasAdjacentMapping(): Boolean
Indicates whether or not the key to value mappings are held in adjacent indices.Note: Applies only to fields and methods that return String[].
Returns | |
---|---|
Boolean |
true if the key to value mappings are held in adjacent indices. |
abstract fun indexMapping(): Array<ViewDebug.IntToString>
A mapping can be defined to map array indices to specific strings.A mapping can be used to see human readable values for the indicesof an array:
{@literal @}
ViewDebug.ExportedProperty(indexMapping = {{@literal @}
ViewDebug.IntToString(from = 0, to = "INVALID"),{@literal @}
ViewDebug.IntToString(from = 1, to = "FIRST"),{@literal @}
ViewDebug.IntToString(from = 2, to = "SECOND") }) private int[] mElements;
Returns | |
---|---|
Array<ViewDebug.IntToString> |
An array of int to String mappings |
See also | |
---|---|
ViewDebug.IntToString |
|
mapping |
#mapping() |
abstract fun mapping(): Array<ViewDebug.IntToString>
A mapping can be defined to map int values to specific strings. Forinstance, View.getVisibility() returns 0, 4 or 8. However, these valuesactually mean VISIBLE, INVISIBLE and GONE. A mapping can be used to seethese human readable values:
{@literal @}
ViewDebug.ExportedProperty(mapping = {{@literal @}
ViewDebug.IntToString(from = 0, to = "VISIBLE"),{@literal @}
ViewDebug.IntToString(from = 4, to = "INVISIBLE"),{@literal @}
ViewDebug.IntToString(from = 8, to = "GONE") }) public int getVisibility() { ...
Returns | |
---|---|
Array<ViewDebug.IntToString> |
An array of int to String mappings |
See also | |
---|---|
ViewDebug.IntToString |
abstract fun prefix(): String
The prefix to use on child properties when deep export is enabled
Returns | |
---|---|
String |
a prefix as a String |
See also | |
---|---|
deepExport |
#deepExport() |