Merge "Mention calling super in View.onProvideContentCaptureStructure javadoc" into sc-dev

This commit is contained in:
Nikita Dubrovsky
2021-02-06 21:50:07 +00:00
committed by Android (Google) Code Review

View File

@@ -8740,14 +8740,17 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
/**
* Populates a {@link ViewStructure} for content capture.
*
* <p>This method is called after a view is that is eligible for content capture
* (for example, if it {@link #isImportantForAutofill()}, an intelligence service is enabled for
* the user, and the activity rendering the view is enabled for content capture) is laid out and
* is visible.
*
* <p>The populated structure is then passed to the service through
* <p>This method is called after a view that is eligible for content capture
* (for example, if it {@link #isImportantForContentCapture()}, an intelligence service is
* enabled for the user, and the activity rendering the view is enabled for content capture)
* is laid out and is visible. The populated structure is then passed to the service through
* {@link ContentCaptureSession#notifyViewAppeared(ViewStructure)}.
*
* <p>The default implementation of this method sets the most relevant properties based on
* related {@link View} methods, and views in the standard Android widgets library also
* override it to set their relevant properties. Therefore, if overriding this method, it
* is recommended to call {@code super.onProvideContentCaptureStructure()}.
*
* <p><b>Note: </b>views that manage a virtual structure under this view must populate just
* the node representing this view and return right away, then asynchronously report (not
* necessarily in the UI thread) when the children nodes appear, disappear or have their text
@@ -8755,7 +8758,7 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
* {@link ContentCaptureSession#notifyViewAppeared(ViewStructure)},
* {@link ContentCaptureSession#notifyViewDisappeared(AutofillId)}, and
* {@link ContentCaptureSession#notifyViewTextChanged(AutofillId, CharSequence)}
* respectively. The structure for the a child must be created using
* respectively. The structure for a child must be created using
* {@link ContentCaptureSession#newVirtualViewStructure(AutofillId, long)}, and the
* {@code autofillId} for a child can be obtained either through
* {@code childStructure.getAutofillId()} or
@@ -8900,7 +8903,7 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
/**
* Called when assist structure is being retrieved from a view as part of
* {@link android.app.Activity#onProvideAssistData Activity.onProvideAssistData} to
* generate additional virtual structure under this view. The defaullt implementation
* generate additional virtual structure under this view. The default implementation
* uses {@link #getAccessibilityNodeProvider()} to try to generate this from the
* view's virtual accessibility nodes, if any. You can override this for a more
* optimal implementation providing this data.