ViewStructure is a container for storing additional
* per-view data generated by {@link View#onProvideStructure
* View.onProvideStructure} and {@link View#onProvideAutofillStructure
* View.onProvideAutofillStructure}.
*
*
To learn more about using Autofill in your app, read the * Autofill Framework guides. * */ public abstract class ViewStructure { /** * Key used for writing active child view information to the content capture bundle. * * The value stored under this key will be an ordered list of Autofill IDs of child views. * * TODO(b/241498401): Add @TestApi in Android U * @hide */ public static final String EXTRA_ACTIVE_CHILDREN_IDS = "android.view.ViewStructure.extra.ACTIVE_CHILDREN_IDS"; /** * Key used for writing the first active child's position to the content capture bundle. * * When active child view information is provided under the * {@link #EXTRA_ACTIVE_CHILDREN_IDS}, the value stored under this key will be the * 0-based position of the first child view in the list relative to the positions of child views * in the containing View's dataset. * * TODO(b/241498401): Add @TestApi in Android U * @hide */ public static final String EXTRA_FIRST_ACTIVE_POSITION = "android.view.ViewStructure.extra.FIRST_ACTIVE_POSITION"; /** * Key used for writing the type of the view that generated the virtual structure of its * children. * * For example, if the virtual structure is generated by a webview, the value would be * "WebView". If the virtual structure is generated by a compose view, then the value would be * "ComposeView". The value is of type String. * * This value is added to mainly help with debugging purpose. * * @hide */ public static final String EXTRA_VIRTUAL_STRUCTURE_TYPE = "android.view.ViewStructure.extra.VIRTUAL_STRUCTURE_TYPE"; /** * Key used for specifying the version of the view that generated the virtual structure for * itself and its children * * For example, if the virtual structure is generated by a webview of version "104.0.5112.69", * then the value should be "104.0.5112.69" * * @hide */ public static final String EXTRA_VIRTUAL_STRUCTURE_VERSION_NUMBER = "android.view.ViewStructure.extra.VIRTUAL_STRUCTURE_VERSION_NUMBER"; /** * Set the identifier for this view. * * @param id The view's identifier, as per {@link View#getId View.getId()}. * @param packageName The package name of the view's identifier, or null if there is none. * @param typeName The type name of the view's identifier, or null if there is none. * @param entryName The entry name of the view's identifier, or null if there is none. */ public abstract void setId(int id, String packageName, String typeName, String entryName); /** * Set the basic dimensions of this view. * * @param left The view's left position, in pixels relative to its parent's left edge. * @param top The view's top position, in pixels relative to its parent's top edge. * @param scrollX How much the view's x coordinate space has been scrolled, in pixels. * @param scrollY How much the view's y coordinate space has been scrolled, in pixels. * @param width The view's visible width, in pixels. This is the width visible on screen, * not the total data width of a scrollable view. * @param height The view's visible height, in pixels. This is the height visible on * screen, not the total data height of a scrollable view. */ public abstract void setDimens(int left, int top, int scrollX, int scrollY, int width, int height); /** * Set the transformation matrix associated with this view, as per * {@link View#getMatrix View.getMatrix()}, or null if there is none. */ public abstract void setTransformation(Matrix matrix); /** * Set the visual elevation (shadow) of the view, as per * {@link View#getZ 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. */ public abstract void setElevation(float elevation); /** * Set an alpha transformation that is applied to this view, as per * {@link View#getAlpha View.getAlpha()}. Value ranges from 0 * (completely transparent) to 1 (completely opaque); the default is 1, which means * no transformation. */ public abstract void setAlpha(float alpha); /** * Set the visibility state of this view, as per * {@link View#getVisibility View.getVisibility()}. */ public abstract void setVisibility(int visibility); /** @hide */ @SuppressWarnings("HiddenAbstractMethod") public abstract void setAssistBlocked(boolean state); /** * Set the enabled state of this view, as per {@link View#isEnabled View.isEnabled()}. */ public abstract void setEnabled(boolean state); /** * Set the clickable state of this view, as per {@link View#isClickable View.isClickable()}. */ public abstract void setClickable(boolean state); /** * Set the long clickable state of this view, as per * {@link View#isLongClickable View.isLongClickable()}. */ public abstract void setLongClickable(boolean state); /** * Set the context clickable state of this view, as per * {@link View#isContextClickable View.isContextClickable()}. */ public abstract void setContextClickable(boolean state); /** * Set the focusable state of this view, as per {@link View#isFocusable View.isFocusable()}. */ public abstract void setFocusable(boolean state); /** * Set the focused state of this view, as per {@link View#isFocused View.isFocused()}. */ public abstract void setFocused(boolean state); /** * Set the accessibility focused state of this view, as per * {@link View#isAccessibilityFocused View.isAccessibilityFocused()}. */ public abstract void setAccessibilityFocused(boolean state); /** * Set the checkable state of this view, such as whether it implements the * {@link android.widget.Checkable} interface. */ public abstract void setCheckable(boolean state); /** * Set the checked state of this view, such as * {@link android.widget.Checkable#isChecked Checkable.isChecked()}. */ public abstract void setChecked(boolean state); /** * Set the selected state of this view, as per {@link View#isSelected View.isSelected()}. */ public abstract void setSelected(boolean state); /** * Set the activated state of this view, as per {@link View#isActivated View.isActivated()}. */ public abstract void setActivated(boolean state); /** * Set the opaque state of this view, as per {@link View#isOpaque View.isOpaque()}. */ public abstract void setOpaque(boolean opaque); /** * Set the class name of the view, as per * {@link View#getAccessibilityClassName View.getAccessibilityClassName()}. */ public abstract void setClassName(String className); /** * Set the content description of the view, as per * {@link View#getContentDescription View.getContentDescription()}. */ public abstract void setContentDescription(CharSequence contentDescription); /** * 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. */ public abstract void setText(CharSequence text); /** * Like {@link #setText(CharSequence)} but with an active selection * extending from selectionStart through selectionEnd. */ public abstract void setText(CharSequence text, int selectionStart, int selectionEnd); /** * Explicitly set default global style information for text that was previously set with * {@link #setText}. * * @param size The size, in pixels, of the text. * @param fgColor The foreground color, packed as 0xAARRGGBB. * @param bgColor The background color, packed as 0xAARRGGBB. * @param style Style flags, as defined by {@link android.app.assist.AssistStructure.ViewNode}. */ public abstract void setTextStyle(float size, int fgColor, int bgColor, int style); /** * Set line information for test that was previously supplied through * {@link #setText(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. * * @param charOffsets The offset in to {@link #setText} where a line starts. * @param baselines The baseline where the line is drawn on screen. */ public abstract void setTextLines(int[] charOffsets, int[] baselines); /** * 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. */ public void setTextIdEntry(@NonNull String entryName) { Preconditions.checkNotNull(entryName); } /** * 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. */ public abstract void setHint(CharSequence hint); /** * 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. */ public void setHintIdEntry(@NonNull String entryName) { Preconditions.checkNotNull(entryName); } /** * Retrieve the last {@link #setText(CharSequence)}. */ public abstract CharSequence getText(); /** * Retrieve the last selection start set by {@link #setText(CharSequence, int, int)}. */ public abstract int getTextSelectionStart(); /** * Retrieve the last selection end set by {@link #setText(CharSequence, int, int)}. */ public abstract int getTextSelectionEnd(); /** * Retrieve the last hint set by {@link #setHint}. */ public abstract CharSequence getHint(); /** * 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. */ public abstract Bundle getExtras(); /** * Returns true if {@link #getExtras} has been used to create extra content. */ public abstract boolean hasExtras(); /** * Set the number of children of this view, which defines the range of indices you can * use with {@link #newChild} and {@link #asyncNewChild}. Calling this method again * resets all of the child state of the view, removing any children that had previously * been added. */ public abstract void setChildCount(int num); /** * Add to this view's child count. This increases the current child count by * num children beyond what was last set by {@link #setChildCount} * or {@link #addChildCount}. The index at which the new * child starts in the child * array is returned. * * @param num The number of new children to add. * @return Returns the index in the child array at which the new children start. */ public abstract int addChildCount(int num); /** * Return the child count as set by {@link #setChildCount}. */ public abstract int getChildCount(); /** * Create a new child {@link 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 * {@link #addChildCount(int)} or {@link #setChildCount(int)}. * * @return Returns an fresh {@link ViewStructure} ready to be filled in. */ public abstract ViewStructure newChild(int index); /** * Like {@link #newChild}, but allows the caller to asynchronously populate the returned * child. It can transfer the returned {@link ViewStructure} to another thread for it * to build its content (and children etc). Once done, some thread must call * {@link #asyncCommit} to tell the containing {@link ViewStructure} that the async * population is done. * *
NOTE: you must pre-allocate space for the child first, by calling either * {@link #addChildCount(int)} or {@link #setChildCount(int)}. * * @return Returns an fresh {@link ViewStructure} ready to be filled in. */ public abstract ViewStructure asyncNewChild(int index); /** * Gets the {@link GetCredentialRequest} associated with this node. * *
If null, no request is associated with this node, and hence no * {@link android.credentials.CredentialManager} request will be fired when this * node is focused. *
For details on how a request and callback can be set, see * {@link ViewStructure#setPendingCredentialRequest(GetCredentialRequest, OutcomeReceiver)} */ @Nullable @FlaggedApi(FLAG_AUTOFILL_CREDMAN_DEV_INTEGRATION) public GetCredentialRequest getPendingCredentialRequest() { return null; } /** * Gets the {@code callback} associated with this node. * *
If null, no callback or request is associated with this node, and hence no * {@link android.credentials.CredentialManager} request will be fired when this * node is focused. *
For details on how a request and callback can be set, see * {@link ViewStructure#setPendingCredentialRequest(GetCredentialRequest, OutcomeReceiver)} */ @Nullable @FlaggedApi(FLAG_AUTOFILL_CREDMAN_DEV_INTEGRATION) public OutcomeReceiver< GetCredentialResponse, GetCredentialException> getPendingCredentialCallback() { return null; } /** * Gets the {@link AutofillId} associated with this node. */ @Nullable public abstract AutofillId getAutofillId(); /** * Sets the {@link AutofillId} associated with this node. */ public abstract void setAutofillId(@NonNull AutofillId id); /** * Sets the {@link AutofillId} for this virtual node. * * @param parentId id of the parent node. * @param virtualId an opaque ID to the Android System; it's the same id used on * {@link View#autofill(android.util.SparseArray)}. */ public abstract void setAutofillId(@NonNull AutofillId parentId, int virtualId); /** * Sets the {@link View#getAutofillType()} that can be used to autofill this node. */ public abstract void setAutofillType(@View.AutofillType int type); /** * Sets the a hints that helps the autofill service to select the appropriate data to fill the * view. */ public abstract void setAutofillHints(@Nullable String[] hint); /** * Sets the {@link AutofillValue} representing the current value of this node. */ public abstract void setAutofillValue(AutofillValue value); /** * Sets the options that can be used to autofill this node. * *
Typically used by nodes whose {@link View#getAutofillType()} is a list to indicate the * meaning of each possible value in the list. */ public abstract void setAutofillOptions(CharSequence[] options); /** * Sets the {@link View#setImportantForAutofill(int) importantForAutofill mode} of the * view associated with this node. */ public void setImportantForAutofill(@AutofillImportance int mode) {} /** * Sets whether the node is a credential. See {@link View#isCredential}. * * @hide */ public void setIsCredential(boolean isCredential) {} /** * Sets the MIME types accepted by this view. See {@link 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. */ public void setReceiveContentMimeTypes( @SuppressLint("NullableCollection") @Nullable String[] mimeTypes) {} /** * Sets the {@link android.text.InputType} bits of this node. * * @param inputType inputType bits as defined by {@link android.text.InputType}. */ public abstract void setInputType(int inputType); /** * Sets whether the data on this node is sensitive; if it is, then its content (text, autofill * value, etc..) is striped before calls to {@link * android.service.autofill.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 * {@link * android.service.autofill.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. */ public abstract void setDataIsSensitive(boolean sensitive); /** * 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. */ public void setMinTextEms(@SuppressWarnings("unused") int minEms) {} /** * 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. */ public void setMaxTextEms(@SuppressWarnings("unused") int maxEms) {} /** * 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. */ public void setMaxTextLength(@SuppressWarnings("unused") int maxLength) {} /** * Call when done populating a {@link ViewStructure} returned by * {@link #asyncNewChild}. */ public abstract void asyncCommit(); /** @hide */ @SuppressWarnings("HiddenAbstractMethod") public abstract Rect getTempRect(); /** * Sets the Web domain represented by this node. * *
Typically used when the view is a container for an HTML document. * * @param domain RFC 2396-compliant URI representing the domain. */ public abstract void setWebDomain(@Nullable String domain); /** * Sets the the list of locales associated with this node. */ public abstract void setLocaleList(LocaleList localeList); /** * Creates a new {@link HtmlInfo.Builder} for the given HTML tag. * * @param tagName name of the HTML tag. * @return a new builder. */ public abstract HtmlInfo.Builder newHtmlInfoBuilder(@NonNull String tagName); /** * 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.
*
* @param htmlInfo HTML properties.
*/
public abstract void setHtmlInfo(@NonNull HtmlInfo htmlInfo);
/**
* Sets a credential request to be fired to {@link android.credentials.CredentialManager}
* when this node is focused
*
* @param request the request to be fired
* @param callback the callback where the response or exception, is returned
*/
@FlaggedApi(FLAG_AUTOFILL_CREDMAN_DEV_INTEGRATION)
public void setPendingCredentialRequest(@NonNull GetCredentialRequest request,
@NonNull OutcomeReceiver