https://source.android.com/ 
/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.view;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.graphics.Matrix;
import android.graphics.Rect;
import android.os.Bundle;
import android.os.LocaleList;
import android.util.Pair;
import android.view.View.AutofillImportance;
import android.view.ViewStructure.HtmlInfo;
import android.view.autofill.AutofillId;
import android.view.autofill.AutofillValue;

import com.android.internal.util.Preconditions;

import java.util.List;


ViewStructure is a container for storing additional per-view data generated by 
View.onProvideStructure and 
View.onProvideAutofillStructure. 
To learn more about using Autofill in your app, read the
Autofill Framework guides.

/**
 * <p><code>ViewStructure</code> is a container for storing additional
 * per-view data generated by {@link View#onProvideStructure
 * View.onProvideStructure} and {@link View#onProvideAutofillStructure
 * View.onProvideAutofillStructure}.
 *
 * <p>To learn more about using Autofill in your app, read the
 * <a href="/guide/topics/text/autofill">Autofill Framework</a> guides.
 *
 */
public abstract class ViewStructure {

    
Set the identifier for this view.

Params:
  • id – The view's identifier, as per View.getId().
  • packageName – The package name of the view's identifier, or null if there is none.
  • typeName – The type name of the view's identifier, or null if there is none.
  • entryName – The entry name of the view's identifier, or null if there is none.
/**
     * 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.

Params:
  • left – The view's left position, in pixels relative to its parent's left edge.
  • top – The view's top position, in pixels relative to its parent's top edge.
  • scrollX – How much the view's x coordinate space has been scrolled, in pixels.
  • scrollY – How much the view's y coordinate space has been scrolled, in pixels.
  • width – The view's visible width, in pixels.  This is the width visible on screen,
not the total data width of a scrollable view.
  • height – The view's visible height, in pixels.  This is the height visible on
screen, not the total data height of a scrollable view.
/**
     * 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 View.getMatrix(), or null if there is none. 
/**
     * 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 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.

/**
     * Set the visual elevation (shadow) of the view, as per
     * {@link View#getZ View.getZ()}.  Note this is <em>not</em> 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 View.getAlpha(). Value ranges from 0 (completely transparent) to 1 (completely opaque); the default is 1, which means no transformation. 
/**
     * 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 View.getVisibility(). 
/**
     * Set the visibility state of this view, as per
     * {@link View#getVisibility View.getVisibility()}.
     */
    public abstract void setVisibility(int visibility);

    
@hide
/** @hide */
    public abstract void setAssistBlocked(boolean state);

    
Set the enabled state of this view, as per View.isEnabled(). 
/**
     * 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 View.isClickable(). 
/**
     * 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 View.isLongClickable(). 
/**
     * 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 View.isContextClickable(). 
/**
     * 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 View.isFocusable(). 
/**
     * 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 View.isFocused(). 
/**
     * 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 View.isAccessibilityFocused(). 
/**
     * 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 Checkable interface. 
/**
     * 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 Checkable.isChecked(). 
/**
     * 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 View.isSelected(). 
/**
     * 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 View.isActivated(). 
/**
     * 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 View.isOpaque(). 
/**
     * 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 View.getAccessibilityClassName(). 
/**
     * 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 View.getContentDescription(). 
/**
     * 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.

/**
     * 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 setText(CharSequence) but with an active selection extending from selectionStart through selectionEnd.

/**
     * Like {@link #setText(CharSequence)} but with an active selection
     * extending from <var>selectionStart</var> through <var>selectionEnd</var>.
     */
    public abstract void setText(CharSequence text, int selectionStart, int selectionEnd);

    
Explicitly set default global style information for text that was previously set with setText. 
Params:
  • size – The size, in pixels, of the text.
  • fgColor – The foreground color, packed as 0xAARRGGBB.
  • bgColor – The background color, packed as 0xAARRGGBB.
  • style – Style flags, as defined by ViewNode.
/**
     * 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 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. 
Params:
  • charOffsets – The offset in to setText where a line starts.
  • baselines – The baseline where the line is drawn on screen.
/**
     * 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.

/**
     * Sets the identifier used to set the text associated with this view.
     *
     * <p>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.

/**
     * 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);

    
Retrieve the last setText(CharSequence). 
/**
     * Retrieve the last {@link #setText(CharSequence)}.
     */
    public abstract CharSequence getText();

    
Retrieve the last selection start set by setText(CharSequence, int, int). 
/**
     * Retrieve the last selection start set by {@link #setText(CharSequence, int, int)}.
     */
    public abstract int getTextSelectionStart();

    
Retrieve the last selection end set by setText(CharSequence, int, int). 
/**
     * Retrieve the last selection end set by {@link #setText(CharSequence, int, int)}.
     */
    public abstract int getTextSelectionEnd();

    
Retrieve the last hint set by setHint. 
/**
     * 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.

/**
     * 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 getExtras has been used to create extra content. 
/**
     * 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 newChild and asyncNewChild. Calling this method again resets all of the child state of the view, removing any children that had previously been added. 
/**
     * 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 setChildCount or addChildCount. The index at which the new child starts in the child array is returned. 
Params:
  • num – The number of new children to add.
Returns:Returns the index in the child array at which the new children start.
/**
     * Add to this view's child count.  This increases the current child count by
     * <var>num</var> 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 setChildCount. 
/**
     * Return the child count as set by {@link #setChildCount}.
     */
    public abstract int getChildCount();

    
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). 
Returns:Returns an fresh ViewStructure ready to be filled in.
/**
     * Create a new child {@link ViewStructure} in this view, putting into the list of
     * children at <var>index</var>.
     *
     * <p><b>NOTE: </b>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 newChild, 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). 
Returns:Returns an fresh ViewStructure ready to be filled in.
/**
     * 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.
     *
     * <p><b>NOTE: </b>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 AutofillId associated with this node. 
/**
     * Gets the {@link AutofillId} associated with this node.
     */
    @Nullable
    public abstract AutofillId getAutofillId();

    
Sets the AutofillId associated with this node. 
/**
     * Sets the {@link AutofillId} associated with this node.
     */
    public abstract void setAutofillId(@NonNull AutofillId id);

    
Sets the AutofillId for this virtual node. 
Params:
/**
     * 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 View.getAutofillType() that can be used to autofill this node. 
/**
     * 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.

/**
     * 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 AutofillValue representing the current value of this node. 
/**
     * 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 View.getAutofillType() is a list to indicate the meaning of each possible value in the list. 
/**
     * Sets the options that can be used to autofill this node.
     *
     * <p>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 importantForAutofill mode of the view associated with this node. 
/**
     * Sets the {@link View#setImportantForAutofill(int) importantForAutofill mode} of the
     * view associated with this node.
     */
    public void setImportantForAutofill(@AutofillImportance int mode) {}

    
Sets the InputType bits of this node. 
Params:
  • inputType – inputType bits as defined by InputType.
/**
     * 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 AutofillService.onFillRequest(FillRequest, CancellationSignal, 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(SaveRequest, 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.

/**
     * 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)}.
     *
     * <p>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.
     *
     * <p>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.
     *
     * <p>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.

/**
     * Sets the minimum width in ems of the text associated with this view, when supported.
     *
     * <p>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.

/**
     * Sets the maximum width in ems of the text associated with this view, when supported.
     *
     * <p>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.

/**
     * Sets the maximum length of the text associated with this view, when supported.
     *
     * <p>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 ViewStructure returned by asyncNewChild. 
/**
     * Call when done populating a {@link ViewStructure} returned by
     * {@link #asyncNewChild}.
     */
    public abstract void asyncCommit();

    
@hide
/** @hide */
    public abstract Rect getTempRect();

    
Sets the Web domain represented by this node.

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

Params:
  • domain – RFC 2396-compliant URI representing the domain.
/**
     * Sets the Web domain represented by this node.
     *
     * <p>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.

/**
     * Sets the the list of locales associated with this node.
     */
    public abstract void setLocaleList(LocaleList localeList);

    
Creates a new Builder for the given HTML tag. 
Params:
  • tagName – name of the HTML tag.
Returns:a new builder.
/**
     * 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.

Params:
  • htmlInfo – HTML properties.
/**
     * Sets the HTML properties of this node when it represents an HTML element.
     *
     * <p>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);

    
Simplified representation of the HTML properties of a node that represents an HTML element.

/**
     * Simplified representation of the HTML properties of a node that represents an HTML element.
     */
    public abstract static class HtmlInfo {

        
Gets the HTML tag.

/**
         * Gets the HTML tag.
         */
        @NonNull
        public abstract String getTag();

        
Gets the list of HTML attributes.

Returns:list of key/value pairs; could contain pairs with the same keys.
/**
         * Gets the list of HTML attributes.
         *
         * @return list of key/value pairs; could contain pairs with the same keys.
         */
        @Nullable
        public abstract List<Pair<String, String>> getAttributes();

        
Builder for HtmlInfo objects. 
/**
         * Builder for {@link HtmlInfo} objects.
         */
        public abstract static class Builder {

            
Adds an HTML attribute.

Params:
  • name – name of the attribute.
  • value – value of the attribute.
Returns:same builder, for chaining.
/**
             * Adds an HTML attribute.
             *
             * @param name name of the attribute.
             * @param value value of the attribute.
             * @return same builder, for chaining.
             */
            public abstract Builder addAttribute(@NonNull String name, @NonNull String value);

            
Builds the HtmlInfo object. 
Returns:a new HtmlInfo instance.
/**
             * Builds the {@link HtmlInfo} object.
             *
             * @return a new {@link HtmlInfo} instance.
             */
            public abstract HtmlInfo build();
        }
    }
}