ContentCaptureNodeProperties

public class ContentCaptureNodeProperties
extends Object

Properties of a Node for Content Capture.

Used to provide changes from a UI node (e.g. a View or a virtual view) to the Content Capture System efficiently. An instance of this class should be reused during view tree traversal to minimize memory allocations.

To use this class:

1. Obtain the AutofillId of the node. For virtual views, use ContentCaptureSession.newAutofillId(AutofillId,long).
2. Set the desired properties on an instance of this class (e.g., setText(CharSequence), setBounds(int, int, int, int)).
3. Pass the ID and this properties instance to ContentCaptureSession.notifyNodeAppearedOrChanged(AutofillId,ContentCaptureNodeProperties).
4. Call clear() to reset the properties before reusing the instance for the next node.

To track which properties have been modified explicitly this class offers methods like hasBounds(), hasText() that will return true only if the corresponding property was explicitly set. Calling clear() removes all set fields and brings back this class to its initial state to be reused.

Calling a getter method when the corresponding property has not been set (i.e. when has*() returns false) will throw an IllegalStateException. Callers should check has*() prior to calling the getter.

Summary

Public constructors

public ContentCaptureNodeProperties ()

Public methods

public void clear ()

public void getBounds (Rect outBounds)

public CharSequence getContentDescription ()

public AutofillId getParentId ()

public CharSequence getText ()

public boolean hasBounds ()

public boolean hasContentDescription ()

public boolean hasParentId ()

public boolean hasText ()

public void setBounds (int left, 
                int top, 
                int right, 
                int bottom)

public void setContentDescription (CharSequence contentDescription)

public void setParentId (AutofillId parentId)

public void setText (CharSequence text)