Skip to content

Most visited

Recently visited

navigation

AssistStructure.ViewNode

public static class AssistStructure.ViewNode
extends Object

java.lang.Object
   ↳ android.app.assist.AssistStructure.ViewNode


Describes a single view in the assist data.

Summary

Constants

int TEXT_COLOR_UNDEFINED

Magic value for text color that has not been defined, which is very unlikely to be confused with a real text color.

int TEXT_STYLE_BOLD

int TEXT_STYLE_ITALIC

int TEXT_STYLE_STRIKE_THRU

int TEXT_STYLE_UNDERLINE

Public methods

float getAlpha()

Returns the alpha transformation of the view, used to reduce the overall opacity of the view's contents, as set by ViewStructure.setAlpha(float).

String[] getAutofillHints()

Describes the content of a view so that a autofill service can fill in the appropriate data.

AutofillId getAutofillId()

Gets the id that can be used to autofill the view contents.

CharSequence[] getAutofillOptions()

Gets the options that can be used to autofill this view.

int getAutofillType()

Gets the the type of value that can be used to autofill the view contents.

AutofillValue getAutofillValue()

Gets the the value of this view.

AssistStructure.ViewNode getChildAt(int index)

Return a child of this node, given an index value from 0 to getChildCount()-1.

int getChildCount()

Return the number of children this node has.

String getClassName()

Returns the class name of the node's implementation, indicating its behavior.

CharSequence getContentDescription()

Returns any content description associated with the node, which semantically describes its purpose for accessibility and other uses.

float getElevation()

Returns the visual elevation of the view, used for shadowing and other visual characterstics, as set by ViewStructure.setElevation(float).

Bundle getExtras()

Return a Bundle containing optional vendor-specific extension information.

int getHeight()

Returns the height of this view, in pixels.

String getHint()

Return additional hint text associated with the node; this is typically used with a node that takes user input, describing to the user what the input means.

ViewStructure.HtmlInfo getHtmlInfo()

Returns the HTML properties associated with this view.

int getId()

Returns the ID associated with this view, as per View.getId().

String getIdEntry()

If getId() is a resource identifier, this is the entry name of that identifier.

String getIdPackage()

If getId() is a resource identifier, this is the package name of that identifier.

String getIdType()

If getId() is a resource identifier, this is the type name of that identifier.

int getInputType()

Gets the InputType bits of this structure.

int getLeft()

Returns the left edge of this view, in pixels, relative to the left edge of its parent.

LocaleList getLocaleList()

Returns the the list of locales associated with this view.

int getScrollX()

Returns the current X scroll offset of this view, as per View.getScrollX().

int getScrollY()

Returns the current Y scroll offset of this view, as per View.getScrollY().

CharSequence getText()

Returns any text associated with the node that is displayed to the user, or null if there is none.

int getTextBackgroundColor()

If getText() is non-null, this is the main text background color associated with it.

int getTextColor()

If getText() is non-null, this is the main text color associated with it.

int[] getTextLineBaselines()

Return per-line baselines into the text returned by getText().

int[] getTextLineCharOffsets()

Return per-line offsets into the text returned by getText().

int getTextSelectionEnd()

If getText() is non-null, this is where the current selection starts.

int getTextSelectionStart()

If getText() is non-null, this is where the current selection starts.

float getTextSize()

If getText() is non-null, this is the main text size (in pixels) associated with it.

int getTextStyle()

If getText() is non-null, this is the main text style associated with it, containing a bit mask of TEXT_STYLE_BOLD, TEXT_STYLE_BOLD, TEXT_STYLE_STRIKE_THRU, and/or TEXT_STYLE_UNDERLINE.

int getTop()

Returns the top edge of this view, in pixels, relative to the top edge of its parent.

Matrix getTransformation()

Returns the transformation that has been applied to this view, such as a translation or scaling.

int getVisibility()

Returns the visibility mode of this view, as per View.getVisibility().

String getWebDomain()

Returns the domain of the HTML document represented by this view.

int getWidth()

Returns the width of this view, in pixels.

boolean isAccessibilityFocused()

Returns true if this node currently had accessibility focus at the time that the structure was collected.

boolean isActivated()

Returns true if this node has currently been activated by the user.

boolean isAssistBlocked()

Returns true if assist data has been blocked starting at this node in the hierarchy.

boolean isCheckable()

Returns true if this node represents something that is checkable by the user.

boolean isChecked()

Returns true if this node is currently in a checked state.

boolean isClickable()

Returns true if this node is clickable by the user.

boolean isContextClickable()

Returns true if this node is something the user can perform a context click on.

boolean isEnabled()

Returns true if this node is in an enabled state.

boolean isFocusable()

Returns true if this node can take input focus.

boolean isFocused()

Returns true if this node currently had input focus at the time that the structure was collected.

boolean isLongClickable()

Returns true if this node is something the user can perform a long click/press on.

boolean isOpaque()

Returns true if this node is opaque.

boolean isSelected()

Returns true if this node has currently been selected by the user.

Inherited methods

From class java.lang.Object

Constants

TEXT_COLOR_UNDEFINED

added in API level 23
int TEXT_COLOR_UNDEFINED

Magic value for text color that has not been defined, which is very unlikely to be confused with a real text color.

Constant Value: 1 (0x00000001)

TEXT_STYLE_BOLD

added in API level 23
int TEXT_STYLE_BOLD

Constant Value: 1 (0x00000001)

TEXT_STYLE_ITALIC

added in API level 23
int TEXT_STYLE_ITALIC

Constant Value: 2 (0x00000002)

TEXT_STYLE_STRIKE_THRU

added in API level 23
int TEXT_STYLE_STRIKE_THRU

Constant Value: 8 (0x00000008)

TEXT_STYLE_UNDERLINE

added in API level 23
int TEXT_STYLE_UNDERLINE

Constant Value: 4 (0x00000004)

Public methods

getAlpha

added in API level 23
float getAlpha ()

Returns the alpha transformation of the view, used to reduce the overall opacity of the view's contents, as set by ViewStructure.setAlpha(float).

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
float

getAutofillHints

added in API level 26
String[] getAutofillHints ()

Describes the content of a view so that a autofill service can fill in the appropriate data.

It's only relevant when the AssistStructure is used for autofill purposes, not for Assist - see getAutofillHints() for more info.

Returns
String[] The autofill hints for this view, or null if the structure was created for assist purposes.

getAutofillId

added in API level 26
AutofillId getAutofillId ()

Gets the id that can be used to autofill the view contents.

It's only relevant when the AssistStructure is used for autofill purposes.

Returns
AutofillId id that can be used to autofill the view contents, or null if the structure was created for assist purposes.

getAutofillOptions

added in API level 26
CharSequence[] getAutofillOptions ()

Gets the options that can be used to autofill this view.

Typically used by nodes whose getAutofillType() is a list to indicate the meaning of each possible value in the list.

It's relevant when the AssistStructure is used for autofill purposes, not for assist purposes.

Returns
CharSequence[] the options that can be used to autofill this view, or null if the structure was created for assist purposes.

getAutofillType

added in API level 26
int getAutofillType ()

Gets the the type of value that can be used to autofill the view contents.

It's only relevant when the AssistStructure is used for autofill purposes.

Returns
int autofill type as defined by getAutofillType(), or AUTOFILL_TYPE_NONE if the structure was created for assist purposes.

getAutofillValue

added in API level 26
AutofillValue getAutofillValue ()

Gets the the value of this view.

It's only relevant when the AssistStructure is used for autofill purposes, not for assist purposes.

Returns
AutofillValue the autofill value of this view, or null if the structure was created for assist purposes.

getChildAt

added in API level 23
AssistStructure.ViewNode getChildAt (int index)

Return a child of this node, given an index value from 0 to getChildCount()-1.

Parameters
index int

Returns
AssistStructure.ViewNode

getChildCount

added in API level 23
int getChildCount ()

Return the number of children this node has.

Returns
int

getClassName

added in API level 23
String getClassName ()

Returns the class name of the node's implementation, indicating its behavior. For example, a button will report "android.widget.Button" meaning it behaves like a Button.

Returns
String

getContentDescription

added in API level 23
CharSequence getContentDescription ()

Returns any content description associated with the node, which semantically describes its purpose for accessibility and other uses.

Returns
CharSequence

getElevation

added in API level 23
float getElevation ()

Returns the visual elevation of the view, used for shadowing and other visual characterstics, as set by ViewStructure.setElevation(float).

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
float

getExtras

added in API level 23
Bundle getExtras ()

Return a Bundle containing optional vendor-specific extension information.

Returns
Bundle

getHeight

added in API level 23
int getHeight ()

Returns the height of this view, in pixels.

Returns
int

getHint

added in API level 23
String getHint ()

Return additional hint text associated with the node; this is typically used with a node that takes user input, describing to the user what the input means.

Returns
String

getHtmlInfo

added in API level 26
ViewStructure.HtmlInfo getHtmlInfo ()

Returns the HTML properties associated with this view.

It's only relevant when the AssistStructure is used for autofill purposes, not for assist purposes.

Returns
ViewStructure.HtmlInfo the HTML properties associated with this view, or null if the structure was created for assist purposes.

getId

added in API level 23
int getId ()

Returns the ID associated with this view, as per View.getId().

Returns
int

getIdEntry

added in API level 23
String getIdEntry ()

If getId() is a resource identifier, this is the entry name of that identifier. See ViewStructure.setId for more information.

Returns
String

getIdPackage

added in API level 23
String getIdPackage ()

If getId() is a resource identifier, this is the package name of that identifier. See ViewStructure.setId for more information.

Returns
String

getIdType

added in API level 23
String getIdType ()

If getId() is a resource identifier, this is the type name of that identifier. See ViewStructure.setId for more information.

Returns
String

getInputType

added in API level 26
int getInputType ()

Gets the InputType bits of this structure.

Returns
int bits as defined by InputType.

getLeft

added in API level 23
int getLeft ()

Returns the left edge of this view, in pixels, relative to the left edge of its parent.

Returns
int

getLocaleList

added in API level 26
LocaleList getLocaleList ()

Returns the the list of locales associated with this view.

Returns
LocaleList

This value may be null.

getScrollX

added in API level 23
int getScrollX ()

Returns the current X scroll offset of this view, as per View.getScrollX().

Returns
int

getScrollY

added in API level 23
int getScrollY ()

Returns the current Y scroll offset of this view, as per View.getScrollY().

Returns
int

getText

added in API level 23
CharSequence getText ()

Returns any text associated with the node that is displayed to the user, or null if there is none.

Returns
CharSequence

getTextBackgroundColor

added in API level 23
int getTextBackgroundColor ()

If getText() is non-null, this is the main text background color associated with it. If there is no text background color, TEXT_COLOR_UNDEFINED is returned. Note that the text may also contain style spans that modify the color of specific parts of the text.

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
int

getTextColor

added in API level 23
int getTextColor ()

If getText() is non-null, this is the main text color associated with it. If there is no text color, TEXT_COLOR_UNDEFINED is returned. Note that the text may also contain style spans that modify the color of specific parts of the text.

Returns
int

getTextLineBaselines

added in API level 23
int[] getTextLineBaselines ()

Return per-line baselines into the text returned by getText(). Each entry in the array is a formatted line of text, and the value it contains is the baseline where that text appears in the view. May return null if there is no line information.

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
int[]

getTextLineCharOffsets

added in API level 23
int[] getTextLineCharOffsets ()

Return per-line offsets into the text returned by getText(). Each entry in the array is a formatted line of text, and the value it contains is the offset into the text string where that line starts. May return null if there is no line information.

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
int[]

getTextSelectionEnd

added in API level 23
int getTextSelectionEnd ()

If getText() is non-null, this is where the current selection starts. If there is no selection, returns the same value as getTextSelectionStart(), indicating the cursor position.

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
int

getTextSelectionStart

added in API level 23
int getTextSelectionStart ()

If getText() is non-null, this is where the current selection starts.

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
int

getTextSize

added in API level 23
float getTextSize ()

If getText() is non-null, this is the main text size (in pixels) associated with it. Note that the text may also contain style spans that modify the size of specific parts of the text.

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
float

getTextStyle

added in API level 23
int getTextStyle ()

If getText() is non-null, this is the main text style associated with it, containing a bit mask of TEXT_STYLE_BOLD, TEXT_STYLE_BOLD, TEXT_STYLE_STRIKE_THRU, and/or TEXT_STYLE_UNDERLINE. Note that the text may also contain style spans that modify the style of specific parts of the text.

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
int

getTop

added in API level 23
int getTop ()

Returns the top edge of this view, in pixels, relative to the top edge of its parent.

Returns
int

getTransformation

added in API level 23
Matrix getTransformation ()

Returns the transformation that has been applied to this view, such as a translation or scaling. The returned Matrix object is owned by ViewNode; do not modify it. Returns null if there is no transformation applied to the view.

It's only relevant when the AssistStructure is used for assist purposes, not for autofill purposes.

Returns
Matrix

getVisibility

added in API level 23
int getVisibility ()

Returns the visibility mode of this view, as per View.getVisibility().

Returns
int

getWebDomain

added in API level 26
String getWebDomain ()

Returns the domain of the HTML document represented by this view.

Typically used when the view associated with the view is a container for an HTML document.

Warning: an autofill service cannot trust the value reported by this method without verifing its authenticity—see the "Web security" section of AutofillService for more details.

Returns
String domain-only part of the document. For example, if the full URL is https://example.com/login?user=my_user, it returns example.com.

This value may be null.

getWidth

added in API level 23
int getWidth ()

Returns the width of this view, in pixels.

Returns
int

isAccessibilityFocused

added in API level 23
boolean isAccessibilityFocused ()

Returns true if this node currently had accessibility focus at the time that the structure was collected.

Returns
boolean

isActivated

added in API level 23
boolean isActivated ()

Returns true if this node has currently been activated by the user.

Returns
boolean

isAssistBlocked

added in API level 23
boolean isAssistBlocked ()

Returns true if assist data has been blocked starting at this node in the hierarchy.

Returns
boolean

isCheckable

added in API level 23
boolean isCheckable ()

Returns true if this node represents something that is checkable by the user.

Returns
boolean

isChecked

added in API level 23
boolean isChecked ()

Returns true if this node is currently in a checked state.

Returns
boolean

isClickable

added in API level 23
boolean isClickable ()

Returns true if this node is clickable by the user.

Returns
boolean

isContextClickable

added in API level 23
boolean isContextClickable ()

Returns true if this node is something the user can perform a context click on.

Returns
boolean

isEnabled

added in API level 23
boolean isEnabled ()

Returns true if this node is in an enabled state.

Returns
boolean

isFocusable

added in API level 23
boolean isFocusable ()

Returns true if this node can take input focus.

Returns
boolean

isFocused

added in API level 23
boolean isFocused ()

Returns true if this node currently had input focus at the time that the structure was collected.

Returns
boolean

isLongClickable

added in API level 23
boolean isLongClickable ()

Returns true if this node is something the user can perform a long click/press on.

Returns
boolean

isOpaque

added in API level 26
boolean isOpaque ()

Returns true if this node is opaque.

Returns
boolean

isSelected

added in API level 23
boolean isSelected ()

Returns true if this node has currently been selected by the user.

Returns
boolean

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)