ViewStructure

ViewStructure

public ViewStructure ()

addChildCount

public abstract int addChildCount (int num)

Add to this view's child count. This increases the current child count by num children beyond what was last set by setChildCount(int) or addChildCount(int). The index at which the new child starts in the child array is returned.

asyncCommit

public abstract void asyncCommit ()

Call when done populating a ViewStructure returned by asyncNewChild(int).

asyncNewChild

public abstract ViewStructure asyncNewChild (int index)

Like newChild(int), but allows the caller to asynchronously populate the returned child. It can transfer the returned ViewStructure to another thread for it to build its content (and children etc). Once done, some thread must call asyncCommit() to tell the containing ViewStructure that the async population is done.

NOTE: you must pre-allocate space for the child first, by calling either addChildCount(int) or setChildCount(int).

clearCredentialManagerRequest

public void clearCredentialManagerRequest ()

Clears the credential request previously set through ViewStructure#setPendingCredentialRequest(GetCredentialRequest, OutcomeReceiver)

getAutofillId

public abstract AutofillId getAutofillId ()

Gets the AutofillId associated with this node.

getChildCount

public abstract int getChildCount ()

Return the child count as set by setChildCount(int).

getExtras

public abstract Bundle getExtras ()

Get extra data associated with this view structure; the returned Bundle is mutable, allowing you to view and modify its contents. Keys placed in the Bundle should use an appropriate namespace prefix (such as com.google.MY_KEY) to avoid conflicts.

getHint

public abstract CharSequence getHint ()

Retrieve the last hint set by setHint(CharSequence).

getPendingCredentialCallback

public OutcomeReceiver<GetCredentialResponse, GetCredentialException> getPendingCredentialCallback ()

Gets the callback associated with this node.

If null, no callback or request is associated with this node, and hence no CredentialManager request will be fired when this node is focused.

For details on how a request and callback can be set, see ViewStructure#setPendingCredentialRequest(GetCredentialRequest, OutcomeReceiver)

getPendingCredentialRequest

public GetCredentialRequest getPendingCredentialRequest ()

Gets the GetCredentialRequest associated with this node.

If null, no request is associated with this node, and hence no CredentialManager request will be fired when this node is focused.

For details on how a request and callback can be set, see ViewStructure#setPendingCredentialRequest(GetCredentialRequest, OutcomeReceiver)

getText

public abstract CharSequence getText ()

Retrieve the last setText(java.lang.CharSequence).

getTextSelectionEnd

public abstract int getTextSelectionEnd ()

Retrieve the last selection end set by setText(java.lang.CharSequence, int, int).

getTextSelectionStart

public abstract int getTextSelectionStart ()

Retrieve the last selection start set by setText(java.lang.CharSequence, int, int).

hasExtras

public abstract boolean hasExtras ()

Returns true if getExtras() has been used to create extra content.

newChild

public abstract ViewStructure newChild (int index)

Create a new child ViewStructure in this view, putting into the list of children at index.

NOTE: you must pre-allocate space for the child first, by calling either addChildCount(int) or setChildCount(int).

newHtmlInfoBuilder

public abstract ViewStructure.HtmlInfo.Builder newHtmlInfoBuilder (String tagName)

Creates a new HtmlInfo.Builder for the given HTML tag.

setAccessibilityFocused

public abstract void setAccessibilityFocused (boolean state)

Set the accessibility focused state of this view, as per View.isAccessibilityFocused().

setActivated

public abstract void setActivated (boolean state)

Set the activated state of this view, as per View.isActivated().

setAlpha

public abstract void setAlpha (float alpha)

Set an alpha transformation that is applied to this view, as per View.getAlpha(). Value ranges from 0 (completely transparent) to 1 (completely opaque); the default is 1, which means no transformation.

setAutofillHints

public abstract void setAutofillHints (String[] hint)

Sets the a hints that helps the autofill service to select the appropriate data to fill the view.

setAutofillId

public abstract void setAutofillId (AutofillId id)

Sets the AutofillId associated with this node.

setAutofillId

public abstract void setAutofillId (AutofillId parentId, 
                int virtualId)

Sets the AutofillId for this virtual node.

setAutofillOptions

public abstract void setAutofillOptions (CharSequence[] options)

Sets the options that can be used to autofill this node.

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

setAutofillType

public abstract void setAutofillType (int type)

Sets the View#getAutofillType() that can be used to autofill this node.

setAutofillValue

public abstract void setAutofillValue (AutofillValue value)

Sets the AutofillValue representing the current value of this node.

setCheckable

public abstract void setCheckable (boolean state)

Set the checkable state of this view, such as whether it implements the Checkable interface.

setChecked

public abstract void setChecked (boolean state)

Set the checked state of this view, such as Checkable.isChecked().

setChildCount

public abstract void setChildCount (int num)

Set the number of children of this view, which defines the range of indices you can use with newChild(int) and asyncNewChild(int). Calling this method again resets all of the child state of the view, removing any children that had previously been added.

setClassName

public abstract void setClassName (String className)

Set the class name of the view, as per View.getAccessibilityClassName().

setClickable

public abstract void setClickable (boolean state)

Set the clickable state of this view, as per View.isClickable().

setContentDescription

public abstract void setContentDescription (CharSequence contentDescription)

Set the content description of the view, as per View.getContentDescription().

setContextClickable

public abstract void setContextClickable (boolean state)

Set the context clickable state of this view, as per View.isContextClickable().

setDataIsSensitive

public abstract void setDataIsSensitive (boolean sensitive)

Sets whether the data on this node is sensitive; if it is, then its content (text, autofill value, etc..) is striped before calls to AutofillService.onFillRequest(android.service.autofill.FillRequest, android.os.CancellationSignal, android.service.autofill.FillCallback).

By default, all nodes are assumed to be sensitive, and only nodes that does not have PII (Personally Identifiable Information - sensitive data such as email addresses, credit card numbers, passwords, etc...) should be marked as non-sensitive; a good rule of thumb is to mark as non-sensitive nodes whose value were statically set from resources.

Notice that the content of even sensitive nodes are sent to the service (through the AutofillService.onSaveRequest(android.service.autofill.SaveRequest, android.service.autofill.SaveCallback) call) when the user consented to save thedata, so it is important to set the content of sensitive nodes as well, but mark them as sensitive.

Should only be set when the node is used for autofill purposes - it will be ignored when used for Assist.

setDimens

public abstract void setDimens (int left, 
                int top, 
                int scrollX, 
                int scrollY, 
                int width, 
                int height)

Set the basic dimensions of this view.

setElevation

public abstract void setElevation (float elevation)

Set the visual elevation (shadow) of the view, as per View.getZ(). Note this is not related to the physical Z-ordering of this view relative to its other siblings (that is how they overlap when drawing), it is only the visual representation for shadowing.

setEnabled

public abstract void setEnabled (boolean state)

Set the enabled state of this view, as per View.isEnabled().

setFocusable

public abstract void setFocusable (boolean state)

Set the focusable state of this view, as per View.isFocusable().

setFocused

public abstract void setFocused (boolean state)

Set the focused state of this view, as per View.isFocused().

setHint

public abstract void setHint (CharSequence hint)

Set optional hint text associated with this view; this is for example the text that is shown by an EditText when it is empty to indicate to the user the kind of text to input.

setHintIdEntry

public void setHintIdEntry (String entryName)

Sets the identifier used to set the hint associated with this view.

Used as metadata for fingerprinting view nodes/structures.

Should only be set when the node is used for autofill purposes - it will be ignored when used for Assist.

setHtmlInfo

public abstract void setHtmlInfo (ViewStructure.HtmlInfo htmlInfo)

Sets the HTML properties of this node when it represents an HTML element.

Should only be set when the node is used for autofill purposes - it will be ignored when used for assist.

setId

public abstract void setId (int id, 
                String packageName, 
                String typeName, 
                String entryName)

Set the identifier for this view.

setImportantForAutofill

public void setImportantForAutofill (int mode)

Sets the importantForAutofill mode of the view associated with this node.

setInputType

public abstract void setInputType (int inputType)

Sets the InputType bits of this node.

setLocaleList

public abstract void setLocaleList (LocaleList localeList)

Sets the the list of locales associated with this node.

setLongClickable

public abstract void setLongClickable (boolean state)

Set the long clickable state of this view, as per View.isLongClickable().

setMaxTextEms

public void setMaxTextEms (int maxEms)

Sets the maximum width in ems of the text associated with this view, when supported.

Should only be set when the node is used for autofill purposes - it will be ignored when used for Assist.

setMaxTextLength

public void setMaxTextLength (int maxLength)

Sets the maximum length of the text associated with this view, when supported.

Should only be set when the node is used for autofill purposes - it will be ignored when used for Assist.

setMinTextEms

public void setMinTextEms (int minEms)

Sets the minimum width in ems of the text associated with this view, when supported.

Should only be set when the node is used for autofill purposes - it will be ignored when used for Assist.

setOpaque

public abstract void setOpaque (boolean opaque)

Set the opaque state of this view, as per View.isOpaque().

setPendingCredentialRequest

public void setPendingCredentialRequest (GetCredentialRequest request, 
                OutcomeReceiver<GetCredentialResponse, GetCredentialException> callback)

Sets a credential request to be fired to CredentialManager when this node is focused

setReceiveContentMimeTypes

public void setReceiveContentMimeTypes (String[] mimeTypes)

Sets the MIME types accepted by this view. See View#getReceiveContentMimeTypes().

Should only be set when the node is used for Autofill or Content Capture purposes - it will be ignored when used for Assist.

setSelected

public abstract void setSelected (boolean state)

Set the selected state of this view, as per View.isSelected().

setText

public abstract void setText (CharSequence text)

Set the text that is associated with this view. There is no selection associated with the text. The text may have style spans to supply additional display and semantic information.

setText

public abstract void setText (CharSequence text, 
                int selectionStart, 
                int selectionEnd)

Like setText(java.lang.CharSequence) but with an active selection extending from selectionStart through selectionEnd.

setTextIdEntry

public void setTextIdEntry (String entryName)

Sets the identifier used to set the text associated with this view.

Should only be set when the node is used for autofill purposes - it will be ignored when used for Assist.

setTextLines

public abstract void setTextLines (int[] charOffsets, 
                int[] baselines)

Set line information for test that was previously supplied through setText(java.lang.CharSequence). This provides the line breaking of the text as it is shown on screen. This function takes ownership of the provided arrays; you should not make further modification to them.

setTextStyle

public abstract void setTextStyle (float size, 
                int fgColor, 
                int bgColor, 
                int style)

Explicitly set default global style information for text that was previously set with setText(CharSequence).

setTransformation

public abstract void setTransformation (Matrix matrix)

Set the transformation matrix associated with this view, as per View.getMatrix(), or null if there is none.

setVisibility

public abstract void setVisibility (int visibility)

Set the visibility state of this view, as per View.getVisibility().

setWebDomain

public abstract void setWebDomain (String domain)

Sets the Web domain represented by this node.

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