# Print output for @column tags ?>
public
static
class
AssistStructure.ViewNode
extends Object
java.lang.Object | |
↳ | android.app.assist.AssistStructure.ViewNode |
Describes a single view in the assist data.
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 |
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 type of value that can be used to autofill the view contents. |
AutofillValue
|
getAutofillValue()
Gets the value of this view. |
AssistStructure.ViewNode
|
getChildAt(int index)
Return a child of this node, given an index value from 0 to
|
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 |
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. |
String
|
getHintIdEntry()
Gets the identifier used to set the hint associated with this view. |
ViewStructure.HtmlInfo
|
getHtmlInfo()
Returns the HTML properties associated with this view. |
int
|
getId()
Returns the ID associated with this view, as per |
String
|
getIdEntry()
If |
String
|
getIdPackage()
If |
String
|
getIdType()
If |
int
|
getImportantForAutofill()
Gets the |
int
|
getInputType()
Gets the |
int
|
getLeft()
Returns the left edge of this view, in pixels, relative to the left edge of its parent. |
LocaleList
|
getLocaleList()
Returns the list of locales associated with this view. |
int
|
getMaxTextEms()
Returns the maximum width in ems of the text associated with this node, or |
int
|
getMaxTextLength()
Returns the maximum length of the text associated with this node node, or |
int
|
getMinTextEms()
Returns the minimum width in ems of the text associated with this node, or |
int
|
getScrollX()
Returns the current X scroll offset of this view, as per
|
int
|
getScrollY()
Returns the current Y scroll offset of this view, as per
|
CharSequence
|
getText()
Returns any text associated with the node that is displayed to the user, or null if there is none. |
int
|
getTextBackgroundColor()
If |
int
|
getTextColor()
If |
String
|
getTextIdEntry()
Gets the identifier used to set the text associated with this view. |
int[]
|
getTextLineBaselines()
Return per-line baselines into the text returned by |
int[]
|
getTextLineCharOffsets()
Return per-line offsets into the text returned by |
int
|
getTextSelectionEnd()
If |
int
|
getTextSelectionStart()
If |
float
|
getTextSize()
If |
int
|
getTextStyle()
If |
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
|
String
|
getWebDomain()
Returns the domain of the HTML document represented by this view. |
String
|
getWebScheme()
Returns the scheme 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 | |
---|---|
public static final 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)
public static final int TEXT_STYLE_BOLD
Constant Value: 1 (0x00000001)
public static final int TEXT_STYLE_ITALIC
Constant Value: 2 (0x00000002)
public static final int TEXT_STYLE_STRIKE_THRU
Constant Value: 8 (0x00000008)
public static final int TEXT_STYLE_UNDERLINE
Constant Value: 4 (0x00000004)
public 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
.
It's only relevant when the AssistStructure
is used for assist purposes,
not for autofill purposes.
Returns | |
---|---|
float |
public 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 View#getAutofillHints()
for more info.
Returns | |
---|---|
String[] |
The autofill hints for this view, or null if the structure was created
for assist purposes. |
public 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. |
public CharSequence[] getAutofillOptions ()
Gets the options that can be used to autofill this view.
Typically used by nodes whose View#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. |
public int getAutofillType ()
Gets 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 View#getAutofillType() ,
or View#AUTOFILL_TYPE_NONE if the structure was created for assist purposes.
Value is View.AUTOFILL_TYPE_NONE , View.AUTOFILL_TYPE_TEXT , View.AUTOFILL_TYPE_TOGGLE , View.AUTOFILL_TYPE_LIST , or View.AUTOFILL_TYPE_DATE |
public AutofillValue getAutofillValue ()
Gets 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. |
public 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 |
public int getChildCount ()
Return the number of children this node has.
Returns | |
---|---|
int |
public 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 |
This value may be null . |
public CharSequence getContentDescription ()
Returns any content description associated with the node, which semantically describes its purpose for accessibility and other uses.
Returns | |
---|---|
CharSequence |
This value may be null . |
public float getElevation ()
Returns the visual elevation of the view, used for shadowing and other visual
characterstics, as set by ViewStructure#setElevation
.
It's only relevant when the AssistStructure
is used for assist purposes,
not for autofill purposes.
Returns | |
---|---|
float |
public Bundle getExtras ()
Return a Bundle containing optional vendor-specific extension information.
Returns | |
---|---|
Bundle |
This value may be null . |
public int getHeight ()
Returns the height of this view, in pixels.
Returns | |
---|---|
int |
public 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 |
This value may be null . |
public String getHintIdEntry ()
Gets the identifier used to set the hint associated with this view.
It's only relevant when the AssistStructure
is used for autofill purposes,
not for assist purposes.
Returns | |
---|---|
String |
This value may be null . |
public 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. |
public int getId ()
Returns the ID associated with this view, as per View#getId()
.
Returns | |
---|---|
int |
public String getIdEntry ()
If getId()
is a resource identifier, this is the entry name of that
identifier. See ViewStructure.setId
for more information.
Returns | |
---|---|
String |
This value may be null . |
public String getIdPackage ()
If getId()
is a resource identifier, this is the package name of that
identifier. See ViewStructure.setId
for more information.
Returns | |
---|---|
String |
This value may be null . |
public String getIdType ()
If getId()
is a resource identifier, this is the type name of that
identifier. See ViewStructure.setId
for more information.
Returns | |
---|---|
String |
This value may be null . |
public int getImportantForAutofill ()
Gets the View#setImportantForAutofill(int)
of
the view associated with this node.
It's only relevant when the AssistStructure
is used for autofill purposes.
public int getInputType ()
Gets the InputType
bits of this structure.
Returns | |
---|---|
int |
bits as defined by InputType . |
public int getLeft ()
Returns the left edge of this view, in pixels, relative to the left edge of its parent.
Returns | |
---|---|
int |
public LocaleList getLocaleList ()
Returns the list of locales associated with this view.
Returns | |
---|---|
LocaleList |
This value may be null . |
public int getMaxTextEms ()
Returns the maximum width in ems of the text associated with this node, or -1
if not supported by the node.
It's only relevant when the AssistStructure
is used for autofill purposes,
not for assist purposes.
Returns | |
---|---|
int |
public int getMaxTextLength ()
Returns the maximum length of the text associated with this node node, or -1
if not supported by the node or not set.
It's only relevant when the AssistStructure
is used for autofill purposes,
not for assist purposes.
Returns | |
---|---|
int |
public int getMinTextEms ()
Returns the minimum width in ems of the text associated with this node, or -1
if not supported by the node.
It's only relevant when the AssistStructure
is used for autofill purposes,
not for assist purposes.
Returns | |
---|---|
int |
public int getScrollX ()
Returns the current X scroll offset of this view, as per
View.getScrollX()
.
Returns | |
---|---|
int |
public int getScrollY ()
Returns the current Y scroll offset of this view, as per
View.getScrollY()
.
Returns | |
---|---|
int |
public CharSequence getText ()
Returns any text associated with the node that is displayed to the user, or null if there is none.
Returns | |
---|---|
CharSequence |
public 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 |
public 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 |
public String getTextIdEntry ()
Gets the identifier used to set the text associated with this view.
It's only relevant when the AssistStructure
is used for autofill purposes,
not for assist purposes.
Returns | |
---|---|
String |
This value may be null . |
public 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[] |
public 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[] |
public 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 |
public 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 |
public 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 |
public 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 |
public int getTop ()
Returns the top edge of this view, in pixels, relative to the top edge of its parent.
Returns | |
---|---|
int |
public 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 |
public int getVisibility ()
Returns the visibility mode of this view, as per
View.getVisibility()
.
Returns | |
---|---|
int |
public 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 . |
public String getWebScheme ()
Returns the scheme of the HTML document represented by this view.
Typically used when the view associated with the view is a container for an HTML document.
Returns | |
---|---|
String |
scheme-only part of the document. For example, if the full URL is
https://example.com/login?user=my_user , it returns https .
This value may be null . |
public int getWidth ()
Returns the width of this view, in pixels.
Returns | |
---|---|
int |
public boolean isAccessibilityFocused ()
Returns true if this node currently had accessibility focus at the time that the structure was collected.
Returns | |
---|---|
boolean |
public boolean isActivated ()
Returns true if this node has currently been activated by the user.
Returns | |
---|---|
boolean |
public boolean isAssistBlocked ()
Returns true if assist data has been blocked starting at this node in the hierarchy.
Returns | |
---|---|
boolean |
public boolean isCheckable ()
Returns true if this node represents something that is checkable by the user.
Returns | |
---|---|
boolean |
public boolean isChecked ()
Returns true if this node is currently in a checked state.
Returns | |
---|---|
boolean |
public boolean isClickable ()
Returns true if this node is clickable by the user.
Returns | |
---|---|
boolean |
public boolean isContextClickable ()
Returns true if this node is something the user can perform a context click on.
Returns | |
---|---|
boolean |
public boolean isEnabled ()
Returns true if this node is in an enabled state.
Returns | |
---|---|
boolean |
public boolean isFocusable ()
Returns true if this node can take input focus.
Returns | |
---|---|
boolean |
public boolean isFocused ()
Returns true if this node currently had input focus at the time that the structure was collected.
Returns | |
---|---|
boolean |
public boolean isLongClickable ()
Returns true if this node is something the user can perform a long click/press on.
Returns | |
---|---|
boolean |
public boolean isOpaque ()
Returns true if this node is opaque.
Returns | |
---|---|
boolean |
public boolean isSelected ()
Returns true if this node has currently been selected by the user.
Returns | |
---|---|
boolean |