Added in API level 3

GLSurfaceView

---

Kotlin |Java

open class GLSurfaceView : SurfaceView, SurfaceHolder.Callback2

kotlin.Any
↳	android.view.View
	↳	android.view.SurfaceView
		↳	android.opengl.GLSurfaceView

An implementation of SurfaceView that uses the dedicated surface for displaying OpenGL rendering.

A GLSurfaceView provides the following features:

• Manages a surface, which is a special piece of memory that can be composited into the Android view system.
• Manages an EGL display, which enables OpenGL to render into a surface.
• Accepts a user-provided Renderer object that does the actual rendering.
• Renders on a dedicated thread to decouple rendering performance from the UI thread.
• Supports both on-demand and continuous rendering.
• Optionally wraps, traces, and/or error-checks the renderer's OpenGL calls.

Developer Guides

For more information about how to use OpenGL, read the OpenGL developer guide.

Using GLSurfaceView

Typically you use GLSurfaceView by subclassing it and overriding one or more of the View system input event methods. If your application does not need to override event methods then GLSurfaceView can be used as-is. For the most part GLSurfaceView behavior is customized by calling "set" methods rather than by subclassing. For example, unlike a regular View, drawing is delegated to a separate Renderer object which is registered with the GLSurfaceView using the setRenderer(android.opengl.GLSurfaceView.Renderer) call.

Initializing GLSurfaceView

All you have to do to initialize a GLSurfaceView is call setRenderer(android.opengl.GLSurfaceView.Renderer). However, if desired, you can modify the default behavior of GLSurfaceView by calling one or more of these methods before calling setRenderer:

• setDebugFlags(int)
• setEGLConfigChooser(boolean)
• setEGLConfigChooser(android.opengl.GLSurfaceView.EGLConfigChooser)
• setEGLConfigChooser(int,int,int,int,int,int)
• setGLWrapper(android.opengl.GLSurfaceView.GLWrapper)

Specifying the android.view.Surface

By default GLSurfaceView will create a PixelFormat.RGB_888 format surface. If a translucent surface is required, call getHolder().setFormat(PixelFormat.TRANSLUCENT). The exact format of a TRANSLUCENT surface is device dependent, but it will be a 32-bit-per-pixel surface with 8 bits per component.

Choosing an EGL Configuration

A given Android device may support multiple EGLConfig rendering configurations. The available configurations may differ in how many channels of data are present, as well as how many bits are allocated to each channel. Therefore, the first thing GLSurfaceView has to do when starting to render is choose what EGLConfig to use.

By default GLSurfaceView chooses a EGLConfig that has an RGB_888 pixel format, with at least a 16-bit depth buffer and no stencil.

If you would prefer a different EGLConfig you can override the default behavior by calling one of the setEGLConfigChooser methods.

Debug Behavior

You can optionally modify the behavior of GLSurfaceView by calling one or more of the debugging methods setDebugFlags(int), and setGLWrapper. These methods may be called before and/or after setRenderer, but typically they are called before setRenderer so that they take effect immediately.

Setting a Renderer

Finally, you must call setRenderer to register a Renderer. The renderer is responsible for doing the actual OpenGL rendering.

Rendering Mode

Once the renderer is set, you can control whether the renderer draws continuously or on-demand by calling setRenderMode. The default is continuous rendering.

Activity Life-cycle

A GLSurfaceView must be notified when to pause and resume rendering. GLSurfaceView clients are required to call onPause() when the activity stops and onResume() when the activity starts. These calls allow GLSurfaceView to pause and resume the rendering thread, and also allow GLSurfaceView to release and recreate the OpenGL display.

Handling events

To handle an event you will typically subclass GLSurfaceView and override the appropriate method, just as you would with any other View. However, when handling the event, you may need to communicate with the Renderer object that's running in the rendering thread. You can do this using any standard Java cross-thread communication mechanism. In addition, one relatively easy way to communicate with your renderer is to call queueEvent(java.lang.Runnable). For example:

class MyGLSurfaceView extends GLSurfaceView {
 
      private MyRenderer mMyRenderer;
 
      public void start() {
          mMyRenderer = ...;
          setRenderer(mMyRenderer);
      }
 
      public boolean onKeyDown(int keyCode, KeyEvent event) {
          if (keyCode == KeyEvent.KEYCODE_DPAD_CENTER) {
              queueEvent(new Runnable() {
                  // This method will be called on the rendering
                  // thread:
                  public void run() {
                      mMyRenderer.handleDpadCenter();
                  }});
              return true;
          }
          return super.onKeyDown(keyCode, event);
      }
  }
  

Summary

Nested classes
abstract	EGLConfigChooser An interface for choosing an EGLConfig configuration from a list of potential configurations.
abstract	EGLContextFactory An interface for customizing the eglCreateContext and eglDestroyContext calls.
abstract	EGLWindowSurfaceFactory An interface for customizing the eglCreateWindowSurface and eglDestroySurface calls.
abstract	GLWrapper An interface used to wrap a GL interface.
abstract	Renderer A generic renderer interface.

Inherited XML attributes

From class View android:accessibilityHeading Whether or not this view is a heading for accessibility purposes. May be a boolean value, such as "true" or "false". android:allowClickWhenDisabled Whether or not allow clicks on disabled view. May be a boolean value, such as "true" or "false". android:alpha alpha property of the view, as a value between 0 (completely transparent) and 1 (completely opaque). May be a floating point value, such as "1.2". android:background A drawable to use as the background. This can be either a reference to a full drawable resource (such as a PNG image, 9-patch, XML state list description, etc), or a solid color such as "#ff000000" (black). May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". May be a color value, in the form of "rgb", "argb", "rrggbb", or "aarrggbb". android:clickable Defines whether this view reacts to click events. May be a boolean value, such as "true" or "false". android:clipToOutline Whether the View's Outline should be used to clip the contents of the View. Only a single non-rectangular clip can be applied on a View at any time. Circular clips from a android.view.ViewAnimationUtils#createCircularReveal(View, int, int, float, * float) circular reveal animation take priority over Outline clipping, and child Outline clipping takes priority over Outline clipping done by a parent. Note that this flag will only be respected if the View's Outline returns true from android.graphics.Outline#canClip(). May be a boolean value, such as "true" or "false". android:contentDescription Defines text that briefly describes content of the view. This property is used primarily for accessibility. Since some views do not have textual representation this attribute can be used for providing such. May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character; android:drawingCacheQuality Defines the quality of translucent drawing caches. This property is used only when the drawing cache is enabled and translucent. The default value is auto. Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. Must be one of the following constant values. Constant Value Description auto 0 Lets the framework decide what quality level should be used for the drawing cache. Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. high 2 High quality. When set to high quality, the drawing cache uses a higher color depth but uses more memory. Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. low 1 Low quality. When set to low quality, the drawing cache uses a lower color depth, thus losing precision in rendering gradients, but uses less memory. Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. android:duplicateParentState When this attribute is set to true, the view gets its drawable state (focused, pressed, etc.) from its direct parent rather than from itself. May be a boolean value, such as "true" or "false". android:fadeScrollbars Defines whether to fade out scrollbars when they are not in use. May be a boolean value, such as "true" or "false". android:fadingEdgeLength Defines the length of the fading edges. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:filterTouchesWhenObscured Specifies whether to filter touches when the view's window is obscured by another visible window. When set to true, the view will not receive touches whenever a toast, dialog or other window appears above the view's window. Refer to the android.view.View security documentation for more details. May be a boolean value, such as "true" or "false". android:fitsSystemWindows Boolean internal attribute to adjust view layout based on system windows such as the status bar. If true, adjusts the padding of this view to leave space for the system windows. Will only take effect if this view is in a non-embedded activity. May be a boolean value, such as "true" or "false". android:focusable Controls whether a view can take focus. By default, this is "auto" which lets the framework determine whether a user can move focus to a view. By setting this attribute to true the view is allowed to take focus. By setting it to "false" the view will not take focus. This value does not impact the behavior of directly calling android.view.View#requestFocus, which will always request focus regardless of this view. It only impacts where focus navigation will try to move focus. May be a boolean value, such as "true" or "false". Must be one of the following constant values. Constant Value Description auto 10 android:focusableInTouchMode Boolean that controls whether a view can take focus while in touch mode. If this is true for a view, that view can gain focus when clicked on, and can keep focus if another view is clicked on that doesn't have this attribute set to true. May be a boolean value, such as "true" or "false". android:focusedByDefault Whether this view is a default-focus view. Only one view per keyboard navigation cluster can have this attribute set to true. See android.view.View#setFocusedByDefault(boolean). May be a boolean value, such as "true" or "false". android:hapticFeedbackEnabled Boolean that controls whether a view should have haptic feedback enabled for events such as long presses. May be a boolean value, such as "true" or "false". android:id Supply an identifier name for this view, to later retrieve it with View.findViewById() or Activity.findViewById(). This must be a resource reference; typically you set this using the @+ syntax to create a new ID resources. For example: android:id="@+id/my_id" which allows you to later retrieve the view with findViewById(R.id.my_id). May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:isScrollContainer Set this if the view will serve as a scrolling container, meaning that it can be resized to shrink its overall window so that there will be space for an input method. If not set, the default value will be true if "scrollbars" has the vertical scrollbar set, else it will be false. May be a boolean value, such as "true" or "false". android:keepScreenOn Controls whether the view's window should keep the screen on while visible. May be a boolean value, such as "true" or "false". android:keyboardNavigationCluster Whether this view is a root of a keyboard navigation cluster. See android.view.View#setKeyboardNavigationCluster(boolean). May be a boolean value, such as "true" or "false". android:layerType Specifies the type of layer backing this view. The default value is none. Refer to android.view.View#setLayerType(int, android.graphics.Paint) for more information. Must be one of the following constant values. Constant Value Description hardware 2 Use a hardware layer. Refer to android.view.View#setLayerType(int, android.graphics.Paint) for more information. none 0 Don't use a layer. software 1 Use a software layer. Refer to android.view.View#setLayerType(int, android.graphics.Paint) for more information. android:layoutDirection Defines the direction of layout drawing. This typically is associated with writing direction of the language script used. The possible values are "ltr" for Left-to-Right, "rtl" for Right-to-Left, "locale", and "inherit" from parent view. If there is nothing to inherit, "locale" is used. "locale" falls back to "en-US". "ltr" is the direction used in "en-US". The default for this attribute is "inherit". Must be one of the following constant values. Constant Value Description inherit 2 Inherit from parent. locale 3 Locale. ltr 0 Left-to-Right. rtl 1 Right-to-Left. android:longClickable Defines whether this view reacts to long click events. May be a boolean value, such as "true" or "false". android:minHeight Defines the minimum height of the view. It is not guaranteed the view will be able to achieve this minimum height (for example, if its parent layout constrains it with less available height). May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:minWidth Defines the minimum width of the view. It is not guaranteed the view will be able to achieve this minimum width (for example, if its parent layout constrains it with less available width). May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:nextClusterForward Defines the next keyboard navigation cluster. If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a java.lang.RuntimeException will result when the reference is accessed. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:nextFocusDown Defines the next view to give focus to when the next focus is android.view.View#FOCUS_DOWN If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a java.lang.RuntimeException will result when the reference is accessed. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:nextFocusLeft Defines the next view to give focus to when the next focus is android.view.View#FOCUS_LEFT. If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a java.lang.RuntimeException will result when the reference is accessed. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:nextFocusRight Defines the next view to give focus to when the next focus is android.view.View#FOCUS_RIGHT If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a java.lang.RuntimeException will result when the reference is accessed. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:nextFocusUp Defines the next view to give focus to when the next focus is android.view.View#FOCUS_UP If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a java.lang.RuntimeException will result when the reference is accessed. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:onClick Name of the method in this View's context to invoke when the view is clicked. This name must correspond to a public method that takes exactly one parameter of type View. For instance, if you specify android:onClick="sayHello", you must declare a public void sayHello(View v) method of your context (typically, your Activity). {@deprecated View actually traverses the Context * hierarchy looking for the relevant method, which is fragile (an intermediate * ContextWrapper adding a same-named method would change behavior) and restricts * bytecode optimizers such as R8. Instead, use View.setOnClickListener.} May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character; android:outlineAmbientShadowColor Sets the color of the ambient shadow that is drawn when the view has a positive Z or elevation value. By default the shadow color is black. Generally, this color will be opaque so the intensity of the shadow is consistent between different views with different colors. The opacity of the final ambient shadow is a function of the shadow caster height, the alpha channel of the outlineAmbientShadowColor (typically opaque), and the android.R.attr#ambientShadowAlpha theme attribute. May be a color value, in the form of "rgb", "argb", "rrggbb", or "aarrggbb". android:outlineSpotShadowColor Sets the color of the spot shadow that is drawn when the view has a positive Z or elevation value. By default the shadow color is black. Generally, this color will be opaque so the intensity of the shadow is consistent between different views with different colors. The opacity of the final spot shadow is a function of the shadow caster height, the alpha channel of the outlineSpotShadowColor (typically opaque), and the android.R.attr#spotShadowAlpha theme attribute. May be a color value, in the form of "rgb", "argb", "rrggbb", or "aarrggbb". android:padding Sets the padding, in pixels, of all four edges. Padding is defined as space between the edges of the view and the view's content. This value will take precedence over any of the edge-specific values (paddingLeft, paddingTop, paddingRight, paddingBottom, paddingHorizontal and paddingVertical), but will not override paddingStart or paddingEnd, if set. A view's size will include its padding. If a android.R.attr#background is provided, the padding will initially be set to that (0 if the drawable does not have padding). Explicitly setting a padding value will override the corresponding padding found in the background. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:paddingBottom Sets the padding, in pixels, of the bottom edge; see android.R.attr#padding. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:paddingEnd Sets the padding, in pixels, of the end edge; see android.R.attr#padding. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:paddingHorizontal Sets the padding, in pixels, of the left and right edges; see android.R.attr#padding. This value will take precedence over paddingLeft and paddingRight, but not paddingStart or paddingEnd (if set). May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:paddingLeft Sets the padding, in pixels, of the left edge; see android.R.attr#padding. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:paddingRight Sets the padding, in pixels, of the right edge; see android.R.attr#padding. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:paddingStart Sets the padding, in pixels, of the start edge; see android.R.attr#padding. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:paddingTop Sets the padding, in pixels, of the top edge; see android.R.attr#padding. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:paddingVertical Sets the padding, in pixels, of the top and bottom edges; see android.R.attr#padding. This value will take precedence over paddingTop and paddingBottom, if set. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:requiresFadingEdge Defines which edges should be faded on scrolling. Must be one or more (separated by '|') of the following constant values. Constant Value Description horizontal 1000 Fades horizontal edges only. none 0 No edge is faded. vertical 2000 Fades vertical edges only. android:rotation rotation of the view, in degrees. May be a floating point value, such as "1.2". android:rotationX rotation of the view around the x axis, in degrees. May be a floating point value, such as "1.2". android:rotationY rotation of the view around the y axis, in degrees. May be a floating point value, such as "1.2". android:saveEnabled If false, no state will be saved for this view when it is being frozen. The default is true, allowing the view to be saved (however it also must have an ID assigned to it for its state to be saved). Setting this to false only disables the state for this view, not for its children which may still be saved. May be a boolean value, such as "true" or "false". android:scaleX scale of the view in the x direction. May be a floating point value, such as "1.2". android:scaleY scale of the view in the y direction. May be a floating point value, such as "1.2". android:scrollX The initial horizontal scroll offset, in pixels. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:scrollY The initial vertical scroll offset, in pixels. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:scrollbarAlwaysDrawHorizontalTrack Defines whether the horizontal scrollbar track should always be drawn. May be a boolean value, such as "true" or "false". android:scrollbarAlwaysDrawVerticalTrack Defines whether the vertical scrollbar track should always be drawn. May be a boolean value, such as "true" or "false". android:scrollbarDefaultDelayBeforeFade Defines the delay in milliseconds that a scrollbar waits before fade out. May be an integer value, such as "100". android:scrollbarFadeDuration Defines the delay in milliseconds that a scrollbar takes to fade out. May be an integer value, such as "100". android:scrollbarSize Sets the width of vertical scrollbars and height of horizontal scrollbars. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:scrollbarStyle Controls the scrollbar style and position. The scrollbars can be overlaid or inset. When inset, they add to the padding of the view. And the scrollbars can be drawn inside the padding area or on the edge of the view. For example, if a view has a background drawable and you want to draw the scrollbars inside the padding specified by the drawable, you can use insideOverlay or insideInset. If you want them to appear at the edge of the view, ignoring the padding, then you can use outsideOverlay or outsideInset. Must be one of the following constant values. Constant Value Description insideInset 1000000 Inside the padding and inset. insideOverlay 0 Inside the padding and overlaid. outsideInset 3000000 Edge of the view and inset. outsideOverlay 2000000 Edge of the view and overlaid. android:scrollbarThumbHorizontal Defines the horizontal scrollbar thumb drawable. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:scrollbarThumbVertical Defines the vertical scrollbar thumb drawable. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:scrollbarTrackHorizontal Defines the horizontal scrollbar track drawable. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:scrollbarTrackVertical Defines the vertical scrollbar track drawable. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:scrollbars Defines which scrollbars should be displayed on scrolling or not. Must be one or more (separated by '|') of the following constant values. Constant Value Description horizontal 100 Displays horizontal scrollbar only. none 0 No scrollbar is displayed. vertical 200 Displays vertical scrollbar only. android:soundEffectsEnabled Boolean that controls whether a view should have sound effects enabled for events such as clicking and touching. May be a boolean value, such as "true" or "false". android:stateListAnimator Sets the state-based animator for the View. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:tag Supply a tag for this view containing a String, to be retrieved later with android.view.View#getTag or searched for with View.findViewWithTag(). It is generally preferable to use IDs (through the android:id attribute) instead of tags because they are faster and allow for compile-time type checking. May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character; android:textAlignment Defines the alignment of the text. May be an integer value, such as "100". Must be one of the following constant values. Constant Value Description center 4 Center the paragraph, for example: ALIGN_CENTER. gravity 1 Default for the root view. The gravity determines the alignment, ALIGN_NORMAL, ALIGN_CENTER, or ALIGN_OPPOSITE, which are relative to each paragraph’s text direction. inherit 0 Default. textEnd 3 Align to the end of the paragraph, for example: ALIGN_OPPOSITE. textStart 2 Align to the start of the paragraph, for example: ALIGN_NORMAL. viewEnd 6 Align to the end of the view, which is ALIGN_RIGHT if the view’s resolved layoutDirection is LTR, and ALIGN_LEFT otherwise. viewStart 5 Align to the start of the view, which is ALIGN_LEFT if the view’s resolved layoutDirection is LTR, and ALIGN_RIGHT otherwise. android:textDirection Defines the direction of the text. May be an integer value, such as "100". Must be one of the following constant values. Constant Value Description anyRtl 2 The paragraph direction is RTL if it contains any strong RTL character, otherwise it is LTR if it contains any strong LTR characters. If there are neither, the paragraph direction is the view’s resolved layout direction. firstStrong 1 Default for the root view. The first strong directional character determines the paragraph direction. If there is no strong directional character, the paragraph direction is the view’s resolved layout direction. firstStrongLtr 6 The first strong directional character determines the paragraph direction. If there is no strong directional character, the paragraph direction is LTR. firstStrongRtl 7 The first strong directional character determines the paragraph direction. If there is no strong directional character, the paragraph direction is RTL. inherit 0 Default. locale 5 The paragraph direction is coming from the system Locale. ltr 3 The paragraph direction is left to right. rtl 4 The paragraph direction is right to left. android:theme Specifies a theme override for a view. When a theme override is set, the view will be inflated using a android.content.Context themed with the specified resource. During XML inflation, any child views under the view with a theme override will inherit the themed context. May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name". android:transformPivotX x location of the pivot point around which the view will rotate and scale. This xml attribute sets the pivotX property of the View. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:transformPivotY y location of the pivot point around which the view will rotate and scale. This xml attribute sets the pivotY property of the View. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:transitionName Names a View such that it can be identified for Transitions. Names should be unique in the View hierarchy. May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character; android:translationX translation in x of the view. This value is added post-layout to the left property of the view, which is set by its layout. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:translationY translation in y of the view. This value is added post-layout to the top property of the view, which is set by its layout. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:translationZ translation in z of the view. This value is added to its elevation. May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), and mm (millimeters). android:visibility Controls the initial visibility of the view. Must be one of the following constant values. Constant Value Description gone 2 Completely hidden, as if the view had not been added. invisible 1 Not displayed, but taken into account during layout (space is left for it). visible 0 Visible on screen; the default value.

Constants
static Int	DEBUG_CHECK_GL_ERROR Check glError() after every GL call and throw an exception if glError indicates that an error has occurred.
static Int	DEBUG_LOG_GL_CALLS Log GL calls to the system log at "verbose" level with tag "GLSurfaceView".
static Int	RENDERMODE_CONTINUOUSLY The renderer is called continuously to re-render the scene.
static Int	RENDERMODE_WHEN_DIRTY The renderer only renders when the surface is created, or when requestRender is called.

Inherited constants
From class View Int ACCESSIBILITY_DATA_SENSITIVE_AUTO Automatically determine whether the view should only allow interactions from android.accessibilityservice.AccessibilityServices with the android.accessibilityservice.AccessibilityServiceInfo#isAccessibilityTool property set to true. Accessibility interactions from services without isAccessibilityTool set to true are disallowed for any of the following conditions: this view sets getFilterTouchesWhenObscured(). any parent of this view returns true from isAccessibilityDataSensitive(). Int ACCESSIBILITY_DATA_SENSITIVE_NO Allow interactions from all android.accessibilityservice.AccessibilityServices, regardless of their android.accessibilityservice.AccessibilityServiceInfo#isAccessibilityTool property. Int ACCESSIBILITY_DATA_SENSITIVE_YES Only allow interactions from android.accessibilityservice.AccessibilityServices with the android.accessibilityservice.AccessibilityServiceInfo#isAccessibilityTool property set to true. Int ACCESSIBILITY_LIVE_REGION_ASSERTIVE Live region mode specifying that accessibility services should immediately notify users of changes to this view. For example, a screen reader may interrupt ongoing speech to immediately announce these changes. Use with setAccessibilityLiveRegion(int). Int ACCESSIBILITY_LIVE_REGION_NONE Live region mode specifying that accessibility services should not automatically announce changes to this view. This is the default live region mode for most views. Use with setAccessibilityLiveRegion(int). Int ACCESSIBILITY_LIVE_REGION_POLITE Live region mode specifying that accessibility services should notify users of changes to this view. Use with setAccessibilityLiveRegion(int). Int AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS Flag requesting you to add views that are marked as not important for autofill (see setImportantForAutofill(int)) to a ViewStructure. String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE Hint indicating that this view can be autofilled with a credit card expiration date. It should be used when the credit card expiration date is represented by just one view; if it is represented by more than one (for example, one view for the month and another view for the year), then each of these views should use the hint specific for the unit (AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH, or AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR). Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE}). When annotating a view with this hint, it's recommended to use a date autofill value to avoid ambiguity when the autofill service provides a value for it. To understand why a value can be ambiguous, consider "April of 2020", which could be represented as either of the following options: "04/2020" "4/2020" "2020/04" "2020/4" "April/2020" "Apr/2020" You define a date autofill value for the view by overriding the following methods: getAutofillType() to return AUTOFILL_TYPE_DATE. getAutofillValue() to return a date autofillvalue. autofill(android.view.autofill.AutofillValue) to expect a data autofillvalue. See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY Hint indicating that this view can be autofilled with a credit card expiration day. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH Hint indicating that this view can be autofilled with a credit card expiration month. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH}). When annotating a view with this hint, it's recommended to use a text autofill value whose value is the numerical representation of the month, starting on 1 to avoid ambiguity when the autofill service provides a value for it. To understand why a value can be ambiguous, consider "January", which could be represented as either of "1": recommended way. "0": if following the Calendar#MONTH convention. "January": full name, in English. "jan": abbreviated name, in English. "Janeiro": full name, in another language. Another recommended approach is to use a date autofill value - see AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE for more details. See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR Hint indicating that this view can be autofilled with a credit card expiration year. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_CREDIT_CARD_NUMBER Hint indicating that this view can be autofilled with a credit card number. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_CREDIT_CARD_NUMBER}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE Hint indicating that this view can be autofilled with a credit card security code. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_EMAIL_ADDRESS Hint indicating that this view can be autofilled with an email address. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_EMAIL_ADDRESS}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_NAME Hint indicating that this view can be autofilled with a user's real name. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_NAME}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_PASSWORD Hint indicating that this view can be autofilled with a password. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_PASSWORD}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_PHONE Hint indicating that this view can be autofilled with a phone number. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_PHONE}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_POSTAL_ADDRESS Hint indicating that this view can be autofilled with a postal address. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_POSTAL_ADDRESS}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_POSTAL_CODE Hint indicating that this view can be autofilled with a postal code. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_POSTAL_CODE}). See setAutofillHints(java.lang.String...) for more info about autofill hints. String AUTOFILL_HINT_USERNAME Hint indicating that this view can be autofilled with a username. Can be used with either setAutofillHints(java.lang.String[]) or android:autofillHint (in which case the value should be {@value #AUTOFILL_HINT_USERNAME}). See setAutofillHints(java.lang.String...) for more info about autofill hints. Int AUTOFILL_TYPE_DATE Autofill type for a field that contains a date, which is represented by a long representing the number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT (see java.util.Date#getTime(). AutofillValue instances for autofilling a View can be obtained through AutofillValue#forDate(long), and the values passed to autofill a View can be fetched through AutofillValue#getDateValue(). Int AUTOFILL_TYPE_LIST Autofill type for a selection list field, which is filled by an int representing the element index inside the list (starting at 0). AutofillValue instances for autofilling a View can be obtained through AutofillValue#forList(int), and the value passed to autofill a View can be fetched through AutofillValue#getListValue(). The available options in the selection list are typically provided by android.app.assist.AssistStructure.ViewNode#getAutofillOptions(). Int AUTOFILL_TYPE_NONE Autofill type for views that cannot be autofilled. Typically used when the view is read-only; for example, a text label. Int AUTOFILL_TYPE_TEXT Autofill type for a text field, which is filled by a CharSequence. AutofillValue instances for autofilling a View can be obtained through AutofillValue#forText(CharSequence), and the value passed to autofill a View can be fetched through AutofillValue#getTextValue(). Int AUTOFILL_TYPE_TOGGLE Autofill type for a togglable field, which is filled by a boolean. AutofillValue instances for autofilling a View can be obtained through AutofillValue#forToggle(boolean), and the value passed to autofill a View can be fetched through AutofillValue#getToggleValue(). Int CONTENT_SENSITIVITY_AUTO Content sensitivity is determined by the framework. The framework uses a heuristic to determine if this view displays sensitive content. Autofill hints i.e. getAutofillHints() are used in the heuristic to determine if this view should be considered as a sensitive view. AUTOFILL_HINT_USERNAME, AUTOFILL_HINT_PASSWORD, AUTOFILL_HINT_CREDIT_CARD_NUMBER, AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR are considered sensitive hints by the framework, and the list may include more hints in the future. The window hosting a sensitive view will be marked as secure during an active media projection session. This would be equivalent to applying android.view.WindowManager.LayoutParams#FLAG_SECURE to the window. Int CONTENT_SENSITIVITY_NOT_SENSITIVE The view doesn't display sensitive content. Int CONTENT_SENSITIVITY_SENSITIVE The view displays sensitive content. The window hosting a sensitive view will be marked as secure during an active media projection session. This would be equivalent to applying android.view.WindowManager.LayoutParams#FLAG_SECURE to the window. Int DRAG_FLAG_ACCESSIBILITY_ACTION Flag indicating that the drag was initiated with AccessibilityNodeInfo.AccessibilityAction#ACTION_DRAG_START. When startDragAndDrop(android.content.ClipData,android.view.View.DragShadowBuilder,java.lang.Object,int) is called, this is used by the system to perform a drag without animations. Int DRAG_FLAG_GLOBAL Flag indicating that a drag can cross window boundaries. When startDragAndDrop(android.content.ClipData,android.view.View.DragShadowBuilder,java.lang.Object,int) is called with this flag set, all visible applications with targetSdkVersion >= API 24 will be able to participate in the drag operation and receive the dragged content. If this is the only flag set, then the drag recipient will only have access to text data and intents contained in the ClipData object. Access to URIs contained in the ClipData is determined by other DRAG_FLAG_GLOBAL_* flags Int DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION When this flag is used with DRAG_FLAG_GLOBAL_URI_READ and/or DRAG_FLAG_GLOBAL_URI_WRITE, the URI permission grant can be persisted across device reboots until explicitly revoked with android.content.Context#revokeUriPermission(Uri, int) Context.revokeUriPermission}. Int DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION When this flag is used with DRAG_FLAG_GLOBAL_URI_READ and/or DRAG_FLAG_GLOBAL_URI_WRITE, the URI permission grant applies to any URI that is a prefix match against the original granted URI. Int DRAG_FLAG_GLOBAL_SAME_APPLICATION Flag indicating that a drag can cross window boundaries (within the same application). When startDragAndDrop(android.content.ClipData,android.view.View.DragShadowBuilder,java.lang.Object,int) is called with this flag set, only visible windows belonging to the same application (ie. share the same UID) with targetSdkVersion >= API 24 will be able to participate in the drag operation and receive the dragged content. If both DRAG_FLAG_GLOBAL_SAME_APPLICATION and DRAG_FLAG_GLOBAL are set, then DRAG_FLAG_GLOBAL_SAME_APPLICATION takes precedence and the drag will only go to visible windows from the same application. Int DRAG_FLAG_GLOBAL_URI_READ When this flag is used with DRAG_FLAG_GLOBAL, the drag recipient will be able to request read access to the content URI(s) contained in the ClipData object. Int DRAG_FLAG_GLOBAL_URI_WRITE When this flag is used with DRAG_FLAG_GLOBAL, the drag recipient will be able to request write access to the content URI(s) contained in the ClipData object. Int DRAG_FLAG_OPAQUE Flag indicating that the drag shadow will be opaque. When startDragAndDrop(android.content.ClipData,android.view.View.DragShadowBuilder,java.lang.Object,int) is called with this flag set, the drag shadow will be opaque, otherwise, it will be semitransparent. Int DRAG_FLAG_START_INTENT_SENDER_ON_UNHANDLED_DRAG Flag indicating that an unhandled drag should be delegated to the system to be started if no visible window wishes to handle the drop. When using this flag, the caller must provide ClipData with an Item that contains an immutable IntentSender to an activity to be launched (not a broadcast, service, etc). See ClipData.Item.Builder#setIntentSender(IntentSender). The system can decide to launch the intent or not based on factors like the current screen size or windowing mode. If the system does not launch the intent, it will be canceled via the normal drag and drop flow. Int DRAWING_CACHE_QUALITY_AUTO Enables automatic quality mode for the drawing cache. Int DRAWING_CACHE_QUALITY_HIGH Enables high quality mode for the drawing cache. Int DRAWING_CACHE_QUALITY_LOW Enables low quality mode for the drawing cache. Int FIND_VIEWS_WITH_CONTENT_DESCRIPTION Find find views that contain the specified content description. Int FIND_VIEWS_WITH_TEXT Find views that render the specified text. Int FOCUSABLE This view wants keystrokes. Use with setFocusable(int) and android:focusable. Int FOCUSABLES_ALL View flag indicating whether addFocusables(java.util.ArrayList,int,int) should add all focusable Views regardless if they are focusable in touch mode. Int FOCUSABLES_TOUCH_MODE View flag indicating whether addFocusables(java.util.ArrayList,int,int) should add only Views focusable in touch mode. Int FOCUSABLE_AUTO This view determines focusability automatically. This is the default. Use with setFocusable(int) and android:focusable. Int FOCUS_BACKWARD Use with focusSearch(int). Move focus to the previous selectable item. Int FOCUS_DOWN Use with focusSearch(int). Move focus down. Int FOCUS_FORWARD Use with focusSearch(int). Move focus to the next selectable item. Int FOCUS_LEFT Use with focusSearch(int). Move focus to the left. Int FOCUS_RIGHT Use with focusSearch(int). Move focus to the right. Int FOCUS_UP Use with focusSearch(int). Move focus up. Int GONE This view is invisible, and it doesn't take any space for layout purposes. Use with setVisibility and android:visibility. Int HAPTIC_FEEDBACK_ENABLED View flag indicating whether this view should have haptic feedback enabled for events such as long presses. Int IMPORTANT_FOR_ACCESSIBILITY_AUTO Automatically determine whether a view is important for accessibility. Int IMPORTANT_FOR_ACCESSIBILITY_NO The view is not important for accessibility. Int IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS The view is not important for accessibility, nor are any of its descendant views. Int IMPORTANT_FOR_ACCESSIBILITY_YES The view is important for accessibility. Int IMPORTANT_FOR_AUTOFILL_AUTO Automatically determine whether a view is important for autofill. Int IMPORTANT_FOR_AUTOFILL_NO The view is not important for autofill, but its children (if any) will be traversed. Int IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS The view is not important for autofill, and its children (if any) will not be traversed. Int IMPORTANT_FOR_AUTOFILL_YES The view is important for autofill, and its children (if any) will be traversed. Int IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS The view is important for autofill, but its children (if any) will not be traversed. Int IMPORTANT_FOR_CONTENT_CAPTURE_AUTO Automatically determine whether a view is important for content capture. Int IMPORTANT_FOR_CONTENT_CAPTURE_NO The view is not important for content capture, but its children (if any) will be traversed. Int IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS The view is not important for content capture, and its children (if any) will not be traversed. Int IMPORTANT_FOR_CONTENT_CAPTURE_YES The view is important for content capture, and its children (if any) will be traversed. Int IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS The view is important for content capture, but its children (if any) will not be traversed. Int INVISIBLE This view is invisible, but it still takes up space for layout purposes. Use with setVisibility and android:visibility. Int KEEP_SCREEN_ON View flag indicating that the screen should remain on while the window containing this view is visible to the user. This effectively takes care of automatically setting the WindowManager's WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON. Int LAYER_TYPE_HARDWARE Indicates that the view has a hardware layer. A hardware layer is backed by a hardware specific texture (generally Frame Buffer Objects or FBO on OpenGL hardware) and causes the view to be rendered using Android's hardware rendering pipeline, but only if hardware acceleration is turned on for the view hierarchy. When hardware acceleration is turned off, hardware layers behave exactly as software layers. A hardware layer is useful to apply a specific color filter and/or blending mode and/or translucency to a view and all its children. A hardware layer can be used to cache a complex view tree into a texture and reduce the complexity of drawing operations. For instance, when animating a complex view tree with a translation, a hardware layer can be used to render the view tree only once. A hardware layer can also be used to increase the rendering quality when rotation transformations are applied on a view. It can also be used to prevent potential clipping issues when applying 3D transforms on a view. Int LAYER_TYPE_NONE Indicates that the view does not have a layer. Int LAYER_TYPE_SOFTWARE Indicates that the view has a software layer. A software layer is backed by a bitmap and causes the view to be rendered using Android's software rendering pipeline, even if hardware acceleration is enabled. Software layers have various usages: When the application is not using hardware acceleration, a software layer is useful to apply a specific color filter and/or blending mode and/or translucency to a view and all its children. When the application is using hardware acceleration, a software layer is useful to render drawing primitives not supported by the hardware accelerated pipeline. It can also be used to cache a complex view tree into a texture and reduce the complexity of drawing operations. For instance, when animating a complex view tree with a translation, a software layer can be used to render the view tree only once. Software layers should be avoided when the affected view tree updates often. Every update will require to re-render the software layer, which can potentially be slow (particularly when hardware acceleration is turned on since the layer will have to be uploaded into a hardware texture after every update.) Int LAYOUT_DIRECTION_INHERIT Horizontal layout direction of this view is inherited from its parent. Use with setLayoutDirection. Int LAYOUT_DIRECTION_LOCALE Horizontal layout direction of this view is from deduced from the default language script for the locale. Use with setLayoutDirection. Int LAYOUT_DIRECTION_LTR Horizontal layout direction of this view is from Left to Right. Use with setLayoutDirection. Int LAYOUT_DIRECTION_RTL Horizontal layout direction of this view is from Right to Left. Use with setLayoutDirection. Int MEASURED_HEIGHT_STATE_SHIFT Bit shift of MEASURED_STATE_MASK to get to the height bits for functions that combine both width and height into a single int, such as getMeasuredState() and the childState argument of resolveSizeAndState(int,int,int). Int MEASURED_SIZE_MASK Bits of getMeasuredWidthAndState() and getMeasuredWidthAndState() that provide the actual measured size. Int MEASURED_STATE_MASK Bits of getMeasuredWidthAndState() and getMeasuredWidthAndState() that provide the additional state bits. Int MEASURED_STATE_TOO_SMALL Bit of getMeasuredWidthAndState() and getMeasuredWidthAndState() that indicates the measured size is smaller that the space the view would like to have. Int NOT_FOCUSABLE This view does not want keystrokes. Use with setFocusable(int) and android:focusable. Int NO_ID Used to mark a View that has no ID. Int OVER_SCROLL_ALWAYS Always allow a user to over-scroll this view, provided it is a view that can scroll. Int OVER_SCROLL_IF_CONTENT_SCROLLS Allow a user to over-scroll this view only if the content is large enough to meaningfully scroll, provided it is a view that can scroll. Int OVER_SCROLL_NEVER Never allow a user to over-scroll this view. Float REQUESTED_FRAME_RATE_CATEGORY_DEFAULT Float REQUESTED_FRAME_RATE_CATEGORY_HIGH Float REQUESTED_FRAME_RATE_CATEGORY_LOW Float REQUESTED_FRAME_RATE_CATEGORY_NORMAL Float REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE Int SCREEN_STATE_OFF Indicates that the screen has changed state and is now off. Int SCREEN_STATE_ON Indicates that the screen has changed state and is now on. Int SCROLLBARS_INSIDE_INSET The scrollbar style to display the scrollbars inside the padded area, increasing the padding of the view. The scrollbars will not overlap the content area of the view. Int SCROLLBARS_INSIDE_OVERLAY The scrollbar style to display the scrollbars inside the content area, without increasing the padding. The scrollbars will be overlaid with translucency on the view's content. Int SCROLLBARS_OUTSIDE_INSET The scrollbar style to display the scrollbars at the edge of the view, increasing the padding of the view. The scrollbars will only overlap the background, if any. Int SCROLLBARS_OUTSIDE_OVERLAY The scrollbar style to display the scrollbars at the edge of the view, without increasing the padding. The scrollbars will be overlaid with translucency. Int SCROLLBAR_POSITION_DEFAULT Position the scroll bar at the default position as determined by the system. Int SCROLLBAR_POSITION_LEFT Position the scroll bar along the left edge. Int SCROLLBAR_POSITION_RIGHT Position the scroll bar along the right edge. Int SCROLL_AXIS_HORIZONTAL Indicates scrolling along the horizontal axis. Int SCROLL_AXIS_NONE Indicates no axis of view scrolling. Int SCROLL_AXIS_VERTICAL Indicates scrolling along the vertical axis. Int SCROLL_CAPTURE_HINT_AUTO The content of this view will be considered for scroll capture if scrolling is possible. Int SCROLL_CAPTURE_HINT_EXCLUDE Explicitly exclude this view as a potential scroll capture target. The system will not consider it. Mutually exclusive with SCROLL_CAPTURE_HINT_INCLUDE, which this flag takes precedence over. Int SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS Explicitly exclude all children of this view as potential scroll capture targets. This view is unaffected. Note: Excluded children are not considered, regardless of SCROLL_CAPTURE_HINT_INCLUDE. Int SCROLL_CAPTURE_HINT_INCLUDE Explicitly include this view as a potential scroll capture target. When locating a scroll capture target, this view will be prioritized before others without this flag. Mutually exclusive with SCROLL_CAPTURE_HINT_EXCLUDE, which takes precedence. Int SCROLL_INDICATOR_BOTTOM Scroll indicator direction for the bottom edge of the view. Int SCROLL_INDICATOR_END Scroll indicator direction for the ending edge of the view. Resolved according to the view's layout direction, see getLayoutDirection() for more information. Int SCROLL_INDICATOR_LEFT Scroll indicator direction for the left edge of the view. Int SCROLL_INDICATOR_RIGHT Scroll indicator direction for the right edge of the view. Int SCROLL_INDICATOR_START Scroll indicator direction for the starting edge of the view. Resolved according to the view's layout direction, see getLayoutDirection() for more information. Int SCROLL_INDICATOR_TOP Scroll indicator direction for the top edge of the view. Int SOUND_EFFECTS_ENABLED View flag indicating whether this view should have sound effects enabled for events such as clicking and touching. Int STATUS_BAR_HIDDEN Int STATUS_BAR_VISIBLE Int SYSTEM_UI_FLAG_FULLSCREEN Flag for setSystemUiVisibility(int): View has requested to go into the normal fullscreen mode so that its content can take over the screen while still allowing the user to interact with the application. This has the same visual effect as WindowManager.LayoutParams.FLAG_FULLSCREEN, meaning that non-critical screen decorations (such as the status bar) will be hidden while the user is in the View's window, focusing the experience on that content. Unlike the window flag, if you are using ActionBar in overlay mode with Window.FEATURE_ACTION_BAR_OVERLAY, then enabling this flag will also hide the action bar. This approach to going fullscreen is best used over the window flag when it is a transient state -- that is, the application does this at certain points in its user interaction where it wants to allow the user to focus on content, but not as a continuous state. For situations where the application would like to simply stay full screen the entire time (such as a game that wants to take over the screen), the window flag is usually a better approach. The state set here will be removed by the system in various situations (such as the user moving to another application) like the other system UI states. When using this flag, the application should provide some easy facility for the user to go out of it. A common example would be in an e-book reader, where tapping on the screen brings back whatever screen and UI decorations that had been hidden while the user was immersed in reading the book. Int SYSTEM_UI_FLAG_HIDE_NAVIGATION Flag for setSystemUiVisibility(int): View has requested that the system navigation be temporarily hidden. This is an even less obtrusive state than that called for by SYSTEM_UI_FLAG_LOW_PROFILE; on devices that draw essential navigation controls (Home, Back, and the like) on screen, SYSTEM_UI_FLAG_HIDE_NAVIGATION will cause those to disappear. This is useful (in conjunction with the FLAG_FULLSCREEN and FLAG_LAYOUT_IN_SCREEN window flags) for displaying content using every last pixel on the display. There is a limitation: because navigation controls are so important, the least user interaction will cause them to reappear immediately. When this happens, both this flag and SYSTEM_UI_FLAG_FULLSCREEN will be cleared automatically, so that both elements reappear at the same time. Int SYSTEM_UI_FLAG_IMMERSIVE Flag for setSystemUiVisibility(int): View would like to remain interactive when hiding the navigation bar with SYSTEM_UI_FLAG_HIDE_NAVIGATION. If this flag is not set, SYSTEM_UI_FLAG_HIDE_NAVIGATION will be force cleared by the system on any user interaction. Since this flag is a modifier for SYSTEM_UI_FLAG_HIDE_NAVIGATION, it only has an effect when used in combination with that flag. Int SYSTEM_UI_FLAG_IMMERSIVE_STICKY Flag for setSystemUiVisibility(int): View would like to remain interactive when hiding the status bar with SYSTEM_UI_FLAG_FULLSCREEN and/or hiding the navigation bar with SYSTEM_UI_FLAG_HIDE_NAVIGATION. Use this flag to create an immersive experience while also hiding the system bars. If this flag is not set, SYSTEM_UI_FLAG_HIDE_NAVIGATION will be force cleared by the system on any user interaction, and SYSTEM_UI_FLAG_FULLSCREEN will be force-cleared by the system if the user swipes from the top of the screen. When system bars are hidden in immersive mode, they can be revealed temporarily with system gestures, such as swiping from the top of the screen. These transient system bars will overlay app's content, may have some degree of transparency, and will automatically hide after a short timeout. Since this flag is a modifier for SYSTEM_UI_FLAG_FULLSCREEN and SYSTEM_UI_FLAG_HIDE_NAVIGATION, it only has an effect when used in combination with one or both of those flags. Int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN Flag for setSystemUiVisibility(int): View would like its window to be laid out as if it has requested SYSTEM_UI_FLAG_FULLSCREEN, even if it currently hasn't. This allows it to avoid artifacts when switching in and out of that mode, at the expense that some of its user interface may be covered by screen decorations when they are shown. You can perform layout of your inner UI elements to account for non-fullscreen system UI through the fitSystemWindows(android.graphics.Rect) method. Note: on displays that have a DisplayCutout, the window may still be placed differently than if SYSTEM_UI_FLAG_FULLSCREEN was set, if the window's layoutInDisplayCutoutMode is LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT. To avoid this, use either of the other modes. Int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION Flag for setSystemUiVisibility(int): View would like its window to be laid out as if it has requested SYSTEM_UI_FLAG_HIDE_NAVIGATION, even if it currently hasn't. This allows it to avoid artifacts when switching in and out of that mode, at the expense that some of its user interface may be covered by screen decorations when they are shown. You can perform layout of your inner UI elements to account for the navigation system UI through the fitSystemWindows(android.graphics.Rect) method. Int SYSTEM_UI_FLAG_LAYOUT_STABLE Flag for setSystemUiVisibility(int): When using other layout flags, we would like a stable view of the content insets given to fitSystemWindows(android.graphics.Rect). This means that the insets seen there will always represent the worst case that the application can expect as a continuous state. In the stock Android UI this is the space for the system bar, nav bar, and status bar, but not more transient elements such as an input method. The stable layout your UI sees is based on the system UI modes you can switch to. That is, if you specify SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN then you will get a stable layout for changes of the SYSTEM_UI_FLAG_FULLSCREEN mode; if you specify SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN and SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, then you can transition to SYSTEM_UI_FLAG_FULLSCREEN and SYSTEM_UI_FLAG_HIDE_NAVIGATION with a stable layout. (Note that you should avoid using SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION by itself.) If you have set the window flag WindowManager.LayoutParams#FLAG_FULLSCREEN to hide the status bar (instead of using SYSTEM_UI_FLAG_FULLSCREEN), then a hidden status bar will be considered a "stable" state for purposes here. This allows your UI to continually hide the status bar, while still using the system UI flags to hide the action bar while still retaining a stable layout. Note that changing the window fullscreen flag will never provide a stable layout for a clean transition. If you are using ActionBar in overlay mode with Window.FEATURE_ACTION_BAR_OVERLAY, this flag will also impact the insets it adds to those given to the application. Int SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR Flag for setSystemUiVisibility(int): Requests the navigation bar to draw in a mode that is compatible with light navigation bar backgrounds. For this to take effect, the window must request FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS but not FLAG_TRANSLUCENT_NAVIGATION. Int SYSTEM_UI_FLAG_LIGHT_STATUS_BAR Flag for setSystemUiVisibility(int): Requests the status bar to draw in a mode that is compatible with light status bar backgrounds. For this to take effect, the window must request FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS but not FLAG_TRANSLUCENT_STATUS. Int SYSTEM_UI_FLAG_LOW_PROFILE Flag for setSystemUiVisibility(int): View has requested the system UI to enter an unobtrusive "low profile" mode. This is for use in games, book readers, video players, or any other "immersive" application where the usual system chrome is deemed too distracting. In low profile mode, the status bar and/or navigation icons may dim. Int SYSTEM_UI_FLAG_VISIBLE Special constant for setSystemUiVisibility(int): View has requested the system UI (status bar) to be visible (the default). Int SYSTEM_UI_LAYOUT_FLAGS Flags that can impact the layout in relation to system UI. Int TEXT_ALIGNMENT_CENTER Center the paragraph, e.g. ALIGN_CENTER. Use with setTextAlignment(int) Int TEXT_ALIGNMENT_GRAVITY Default for the root view. The gravity determines the text alignment, ALIGN_NORMAL, ALIGN_CENTER, or ALIGN_OPPOSITE, which are relative to each paragraph's text direction. Use with setTextAlignment(int) Int TEXT_ALIGNMENT_INHERIT Default text alignment. The text alignment of this View is inherited from its parent. Use with setTextAlignment(int) Int TEXT_ALIGNMENT_TEXT_END Align to the end of the paragraph, e.g. ALIGN_OPPOSITE. Use with setTextAlignment(int) Int TEXT_ALIGNMENT_TEXT_START Align to the start of the paragraph, e.g. ALIGN_NORMAL. Use with setTextAlignment(int) Int TEXT_ALIGNMENT_VIEW_END Align to the end of the view, which is ALIGN_RIGHT if the view's resolved layoutDirection is LTR, and ALIGN_LEFT otherwise. Use with setTextAlignment(int) Int TEXT_ALIGNMENT_VIEW_START Align to the start of the view, which is ALIGN_LEFT if the view's resolved layoutDirection is LTR, and ALIGN_RIGHT otherwise. Use with setTextAlignment(int) Int TEXT_DIRECTION_ANY_RTL Text direction is using "any-RTL" algorithm. The paragraph direction is RTL if it contains any strong RTL character, otherwise it is LTR if it contains any strong LTR characters. If there are neither, the paragraph direction is the view's resolved layout direction. Int TEXT_DIRECTION_FIRST_STRONG Text direction is using "first strong algorithm". The first strong directional character determines the paragraph direction. If there is no strong directional character, the paragraph direction is the view's resolved layout direction. Int TEXT_DIRECTION_FIRST_STRONG_LTR Text direction is using "first strong algorithm". The first strong directional character determines the paragraph direction. If there is no strong directional character, the paragraph direction is LTR. Int TEXT_DIRECTION_FIRST_STRONG_RTL Text direction is using "first strong algorithm". The first strong directional character determines the paragraph direction. If there is no strong directional character, the paragraph direction is RTL. Int TEXT_DIRECTION_INHERIT Text direction is inherited through ViewGroup Int TEXT_DIRECTION_LOCALE Text direction is coming from the system Locale. Int TEXT_DIRECTION_LTR Text direction is forced to LTR. Int TEXT_DIRECTION_RTL Text direction is forced to RTL. String VIEW_LOG_TAG The logging tag used by this class with android.util.Log. Int VISIBLE This view is visible. Use with setVisibility and android:visibility.
From class SurfaceView Int SURFACE_LIFECYCLE_DEFAULT Default lifecycle of the Surface owned by this SurfaceView. The default lifecycle matches SURFACE_LIFECYCLE_FOLLOWS_VISIBILITY. Int SURFACE_LIFECYCLE_FOLLOWS_ATTACHMENT The Surface lifecycle is tied to SurfaceView attachment. The Surface is created when the SurfaceView first becomes attached, but is not destroyed until this SurfaceView has been detached from the current window. Int SURFACE_LIFECYCLE_FOLLOWS_VISIBILITY The Surface lifecycle is tied to SurfaceView visibility. The Surface is created when the SurfaceView becomes visible, and is destroyed when the SurfaceView is no longer visible.

Public constructors
GLSurfaceView(context: Context!) Standard View constructor.
GLSurfaceView(context: Context!, attrs: AttributeSet!) Standard View constructor.

Public methods
open Int	getDebugFlags() Get the current value of the debug flags.
open Boolean	getPreserveEGLContextOnPause()
open Int	getRenderMode() Get the current rendering mode.
open Unit	onPause() Pause the rendering thread, optionally tearing down the EGL context depending upon the value of setPreserveEGLContextOnPause(boolean).
open Unit	onResume() Resumes the rendering thread, re-creating the OpenGL context if necessary.
open Unit	queueEvent(r: Runnable!) Queue a runnable to be run on the GL rendering thread.
open Unit	requestRender() Request that the renderer render a frame.
open Unit	setDebugFlags(debugFlags: Int) Set the debug flags to a new value.
open Unit	setEGLConfigChooser(configChooser: GLSurfaceView.EGLConfigChooser!) Install a custom EGLConfigChooser.
open Unit	setEGLConfigChooser(needDepth: Boolean) Install a config chooser which will choose a config as close to 16-bit RGB as possible, with or without an optional depth buffer as close to 16-bits as possible.
open Unit	setEGLConfigChooser(redSize: Int, greenSize: Int, blueSize: Int, alphaSize: Int, depthSize: Int, stencilSize: Int) Install a config chooser which will choose a config with at least the specified depthSize and stencilSize, and exactly the specified redSize, greenSize, blueSize and alphaSize.
open Unit	setEGLContextClientVersion(version: Int) Inform the default EGLContextFactory and default EGLConfigChooser which EGLContext client version to pick.
open Unit	setEGLContextFactory(factory: GLSurfaceView.EGLContextFactory!) Install a custom EGLContextFactory.
open Unit	setEGLWindowSurfaceFactory(factory: GLSurfaceView.EGLWindowSurfaceFactory!) Install a custom EGLWindowSurfaceFactory.
open Unit	setGLWrapper(glWrapper: GLSurfaceView.GLWrapper!) Set the glWrapper.
open Unit	setPreserveEGLContextOnPause(preserveOnPause: Boolean) Control whether the EGL context is preserved when the GLSurfaceView is paused and resumed.
open Unit	setRenderMode(renderMode: Int) Set the rendering mode.
open Unit	setRenderer(renderer: GLSurfaceView.Renderer!) Set the renderer associated with this view.
open Unit	surfaceChanged(holder: SurfaceHolder, format: Int, w: Int, h: Int) This method is part of the SurfaceHolder.
open Unit	surfaceCreated(holder: SurfaceHolder) This method is part of the SurfaceHolder.
open Unit	surfaceDestroyed(holder: SurfaceHolder) This method is part of the SurfaceHolder.
open Unit	surfaceRedrawNeeded(holder: SurfaceHolder) This method is part of the SurfaceHolder.
open Unit	surfaceRedrawNeededAsync(holder: SurfaceHolder, finishDrawing: Runnable) This method is part of the SurfaceHolder.

Protected methods
open Unit	finalize()
open Unit	onAttachedToWindow() This method is used as part of the View class and is not normally called or subclassed by clients of GLSurfaceView.
open Unit	onDetachedFromWindow()

Inherited functions
From class View Unit addChildrenForAccessibility(outChildren: ArrayList<View!>!) Adds the children of this View relevant for accessibility to the given list as output. Since some Views are not important for accessibility the added child views are not necessarily direct children of this view, rather they are the first level of descendants important for accessibility. Unit addExtraDataToAccessibilityNodeInfo(info: AccessibilityNodeInfo, extraDataKey: String, arguments: Bundle?) Adds extra data to an AccessibilityNodeInfo based on an explicit request for the additional data. This method only needs overloading if the node is marked as having extra data available. Unit addFocusables(views: ArrayList<View!>!, direction: Int) Add any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views. If we are in touch mode, only add views that are also focusable in touch mode. Unit addFocusables(views: ArrayList<View!>!, direction: Int, focusableMode: Int) Adds any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views. This method adds all focusable views regardless if we are in touch mode or only views focusable in touch mode if we are in touch mode or only views that can take accessibility focus if accessibility is enabled depending on the focusable mode parameter. Unit addKeyboardNavigationClusters(views: MutableCollection<View!>, direction: Int) Adds any keyboard navigation cluster roots that are descendants of this view (possibly including this view if it is a cluster root itself) to views. Unit addOnAttachStateChangeListener(listener: View.OnAttachStateChangeListener!) Add a listener for attach state changes. This listener will be called whenever this view is attached or detached from a window. Remove the listener using removeOnAttachStateChangeListener(android.view.View.OnAttachStateChangeListener). Unit addOnLayoutChangeListener(listener: View.OnLayoutChangeListener!) Add a listener that will be called when the bounds of the view change due to layout processing. Unit addOnUnhandledKeyEventListener(listener: View.OnUnhandledKeyEventListener!) Adds a listener which will receive unhandled KeyEvents. This must be called on the UI thread. Unit addTouchables(views: ArrayList<View!>!) Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views. ViewPropertyAnimator! animate() This method returns a ViewPropertyAnimator object, which can be used to animate specific properties on this View. Unit announceForAccessibility(text: CharSequence!) Convenience method for sending a AccessibilityEvent#TYPE_ANNOUNCEMENT AccessibilityEvent to suggest that an accessibility service announce the specified text to its users. Note: The event generated with this API carries no semantic meaning, and is appropriate only in exceptional situations. Apps can generally achieve correct behavior for accessibility by accurately supplying the semantics of their UI. They should not need to specify what exactly is announced to users. In general, only announce transitions and don't generate a confirmation message for simple actions like a button press. Label your controls concisely and precisely instead, and for significant UI changes like window changes, use android.app.Activity#setTitle(CharSequence) and setAccessibilityPaneTitle(java.lang.CharSequence). Use setAccessibilityLiveRegion(int) to inform the user of changes to critical views within the user interface. These should still be used sparingly as they may generate announcements every time a View is updated. For notifying users about errors, such as in a login screen with text that displays an "incorrect password" notification, that view should send an AccessibilityEvent of type AccessibilityEvent#CONTENT_CHANGE_TYPE_ERROR and set AccessibilityNodeInfo#setError(CharSequence) instead. Custom widgets should expose error-setting methods that support accessibility automatically. For example, instead of explicitly sending this event when using a TextView, use android.widget.TextView#setError(CharSequence). Use setStateDescription(java.lang.CharSequence) to convey state changes to views within the user interface. While a live region may send different types of events generated by the view, state description will send AccessibilityEvent#TYPE_WINDOW_CONTENT_CHANGED events of type AccessibilityEvent#CONTENT_CHANGE_TYPE_STATE_DESCRIPTION. Unit autofill(value: AutofillValue!) Automatically fills the content of this view with the value. Views support the Autofill Framework mainly by: Providing the metadata defining what the view means and how it can be autofilled. Implementing the methods that autofill the view. onProvideAutofillStructure(android.view.ViewStructure,int) is responsible for the former, this method is responsible for latter. This method does nothing by default, but when overridden it typically: Checks if the provided value matches the expected type (which is defined by getAutofillType()). Checks if the view is editable - if it isn't, it should return right away. Call the proper getter method on AutofillValue to fetch the actual value. Pass the actual value to the equivalent setter in the view. For example, a text-field view could implement the method this way: @Override public void autofill(AutofillValue value) { if (!value.isText() || !this.isEditable()) { return; } CharSequence text = value.getTextValue(); if (text != null) { this.setText(text); } } If the value is updated asynchronously, the next call to AutofillManager#notifyValueChanged(View) must happen after the value was changed to the autofilled value. If not, the view will not be considered autofilled. Note: After this method is called, the value returned by getAutofillValue() must be equal to the value passed to it, otherwise the view will not be highlighted as autofilled. Unit autofill(values: SparseArray<AutofillValue!>) Automatically fills the content of the virtual children within this view. Views with virtual children support the Autofill Framework mainly by: Providing the metadata defining what the virtual children mean and how they can be autofilled. Implementing the methods that autofill the virtual children. onProvideAutofillVirtualStructure(android.view.ViewStructure,int) is responsible for the former, this method is responsible for the latter - see autofill(android.view.autofill.AutofillValue) and onProvideAutofillVirtualStructure(android.view.ViewStructure,int) for more info about autofill. If a child value is updated asynchronously, the next call to AutofillManager#notifyValueChanged(View, int, AutofillValue) must happen after the value was changed to the autofilled value. If not, the child will not be considered autofilled. Note: To indicate that a virtual view was autofilled, ?android:attr/autofilledHighlight should be drawn over it until the data changes. Boolean awakenScrollBars() Trigger the scrollbars to draw. When invoked this method starts an animation to fade the scrollbars out after a default delay. If a subclass provides animated scrolling, the start delay should equal the duration of the scrolling animation. The animation starts only if at least one of the scrollbars is enabled, as specified by isHorizontalScrollBarEnabled() and isVerticalScrollBarEnabled(). When the animation is started, this method returns true, and false otherwise. If the animation is started, this method calls invalidate(); in that case the caller should not call invalidate(). This method should be invoked every time a subclass directly updates the scroll parameters. This method is automatically invoked by scrollBy(int,int) and scrollTo(int,int). Boolean awakenScrollBars(startDelay: Int) Trigger the scrollbars to draw. When invoked this method starts an animation to fade the scrollbars out after a fixed delay. If a subclass provides animated scrolling, the start delay should equal the duration of the scrolling animation. The animation starts only if at least one of the scrollbars is enabled, as specified by isHorizontalScrollBarEnabled() and isVerticalScrollBarEnabled(). When the animation is started, this method returns true, and false otherwise. If the animation is started, this method calls invalidate(); in that case the caller should not call invalidate(). This method should be invoked every time a subclass directly updates the scroll parameters. Boolean awakenScrollBars(startDelay: Int, invalidate: Boolean) Trigger the scrollbars to draw. When invoked this method starts an animation to fade the scrollbars out after a fixed delay. If a subclass provides animated scrolling, the start delay should equal the duration of the scrolling animation. The animation starts only if at least one of the scrollbars is enabled, as specified by isHorizontalScrollBarEnabled() and isVerticalScrollBarEnabled(). When the animation is started, this method returns true, and false otherwise. If the animation is started, this method calls invalidate() if the invalidate parameter is set to true; in that case the caller should not call invalidate(). This method should be invoked every time a subclass directly updates the scroll parameters. Unit bringToFront() Change the view's z order in the tree, so it's on top of other sibling views. This ordering change may affect layout, if the parent container uses an order-dependent layout scheme (e.g., LinearLayout). Prior to android.os.Build.VERSION_CODES#KITKAT this method should be followed by calls to requestLayout() and View#invalidate() on the view's parent to force the parent to redraw with the new child ordering. Unit buildDrawingCache() Calling this method is equivalent to calling buildDrawingCache(false). Unit buildDrawingCache(autoScale: Boolean) Forces the drawing cache to be built if the drawing cache is invalid. If you call buildDrawingCache() manually without calling setDrawingCacheEnabled(true), you should cleanup the cache by calling destroyDrawingCache() afterwards. Note about auto scaling in compatibility mode: When auto scaling is not enabled, this method will create a bitmap of the same size as this view. Because this bitmap will be drawn scaled by the parent ViewGroup, the result on screen might show scaling artifacts. To avoid such artifacts, you should call this method by setting the auto scaling to true. Doing so, however, will generate a bitmap of a different size than the view. This implies that your application must be able to handle this size. You should avoid calling this method when hardware acceleration is enabled. If you do not need the drawing cache bitmap, calling this method will increase memory usage and cause the view to be rendered in software once, thus negatively impacting performance. Unit buildLayer() Forces this view's layer to be created and this view to be rendered into its layer. If this view's layer type is set to LAYER_TYPE_NONE, invoking this method will have no effect. This method can for instance be used to render a view into its layer before starting an animation. If this view is complex, rendering into the layer before starting the animation will avoid skipping frames. Boolean callOnClick() Directly call any attached OnClickListener. Unlike performClick(), this only calls the listener, and does not do any associated clicking actions like reporting an accessibility event. Boolean canResolveLayoutDirection() Check if layout direction resolution can be done. Boolean canResolveTextAlignment() Check if text alignment resolution can be done. Boolean canResolveTextDirection() Check if text direction resolution can be done. Boolean canScrollHorizontally(direction: Int) Check if this view can be scrolled horizontally in a certain direction. This is without regard to whether the view is enabled or not, or if it will scroll in response to user input or not. Boolean canScrollVertically(direction: Int) Check if this view can be scrolled vertically in a certain direction. This is without regard to whether the view is enabled or not, or if it will scroll in response to user input or not. Unit cancelDragAndDrop() Cancels an ongoing drag and drop operation. A android.view.DragEvent object with android.view.DragEvent#getAction() value of android.view.DragEvent#ACTION_DRAG_ENDED and android.view.DragEvent#getResult() value of false will be sent to every View that received android.view.DragEvent#ACTION_DRAG_STARTED even if they are not currently visible. This method can be called on any View in the same window as the View on which startDragAndDrop was called. Unit cancelLongPress() Cancels a pending long press. Your subclass can use this if you want the context menu to come up if the user presses and holds at the same place, but you don't want it to come up if they press and then move around enough to cause scrolling. Unit cancelPendingInputEvents() Cancel any deferred high-level input events that were previously posted to the event queue. Many views post high-level events such as click handlers to the event queue to run deferred in order to preserve a desired user experience - clearing visible pressed states before executing, etc. This method will abort any events of this nature that are currently in flight. Custom views that generate their own high-level deferred input events should override onCancelPendingInputEvents() and remove those pending events from the queue. This will also cancel pending input events for any child views. Note that this may not be sufficient as a debouncing strategy for clicks in all cases. This will not impact newer events posted after this call that may occur as a result of lower-level input events still waiting in the queue. If you are trying to prevent double-submitted events for the duration of some sort of asynchronous transaction you should also take other steps to protect against unexpected double inputs e.g. calling setEnabled(false) and re-enabling the view when the transaction completes, tracking already submitted transaction IDs, etc. Boolean checkInputConnectionProxy(view: View!) Called by the android.view.inputmethod.InputMethodManager when a view who is not the current input connection target is trying to make a call on the manager. The default implementation returns false; you can override this to return true for certain views if you are performing InputConnection proxying to them. Unit clearAnimation() Cancels any animations for this view. Unit clearFocus() Called when this view wants to give up focus. If focus is cleared onFocusChanged(boolean,int,android.graphics.Rect) is called. Note: When not in touch-mode, the framework will try to give focus to the first focusable View from the top after focus is cleared. Hence, if this View is the first from the top that can take focus, then all callbacks related to clearing focus will be invoked after which the framework will give focus to this view. Unit clearPendingCredentialRequest() Clears the request and callback previously set through View#setPendingCredentialRequest. Once this API is invoked, there will be no request fired to CredentialManager on future view focus events. Unit clearViewTranslationCallback() Clear the ViewTranslationCallback from this view. Int combineMeasuredStates(curState: Int, newState: Int) Merge two states as returned by getMeasuredState(). Int computeHorizontalScrollExtent() Compute the horizontal extent of the horizontal scrollbar's thumb within the horizontal range. This value is used to compute the length of the thumb within the scrollbar's track. The range is expressed in arbitrary units that must be the same as the units used by computeHorizontalScrollRange() and computeHorizontalScrollOffset(). The default extent is the drawing width of this view. Int computeHorizontalScrollOffset() Compute the horizontal offset of the horizontal scrollbar's thumb within the horizontal range. This value is used to compute the position of the thumb within the scrollbar's track. The range is expressed in arbitrary units that must be the same as the units used by computeHorizontalScrollRange() and computeHorizontalScrollExtent(). The default offset is the scroll offset of this view. Int computeHorizontalScrollRange() Compute the horizontal range that the horizontal scrollbar represents. The range is expressed in arbitrary units that must be the same as the units used by computeHorizontalScrollExtent() and computeHorizontalScrollOffset(). The default range is the drawing width of this view. Unit computeScroll() Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary. This will typically be done if the child is animating a scroll using a Scroller object. WindowInsets! computeSystemWindowInsets(in: WindowInsets!, outLocalInsets: Rect!) Compute insets that should be consumed by this view and the ones that should propagate to those under it. Int computeVerticalScrollExtent() Compute the vertical extent of the vertical scrollbar's thumb within the vertical range. This value is used to compute the length of the thumb within the scrollbar's track. The range is expressed in arbitrary units that must be the same as the units used by computeVerticalScrollRange() and computeVerticalScrollOffset(). The default extent is the drawing height of this view. Int computeVerticalScrollOffset() Compute the vertical offset of the vertical scrollbar's thumb within the horizontal range. This value is used to compute the position of the thumb within the scrollbar's track. The range is expressed in arbitrary units that must be the same as the units used by computeVerticalScrollRange() and computeVerticalScrollExtent(). The default offset is the scroll offset of this view. Int computeVerticalScrollRange() Compute the vertical range that the vertical scrollbar represents. The range is expressed in arbitrary units that must be the same as the units used by computeVerticalScrollExtent() and computeVerticalScrollOffset(). AccessibilityNodeInfo! createAccessibilityNodeInfo() Returns an AccessibilityNodeInfo representing this view from the point of view of an android.accessibilityservice.AccessibilityService. This method is responsible for obtaining an accessibility node info from a pool of reusable instances and calling onInitializeAccessibilityNodeInfo(android.view.accessibility.AccessibilityNodeInfo) on this view to initialize the former. Note: The client is responsible for recycling the obtained instance by calling AccessibilityNodeInfo#recycle() to minimize object creation. Unit createContextMenu(menu: ContextMenu!) Show the context menu for this view. It is not safe to hold on to the menu after returning from this method. You should normally not overload this method. Overload onCreateContextMenu(android.view.ContextMenu) or define an OnCreateContextMenuListener to add items to the context menu. Unit destroyDrawingCache() Frees the resources used by the drawing cache. If you call buildDrawingCache() manually without calling setDrawingCacheEnabled(true), you should cleanup the cache with this method afterwards. WindowInsets! dispatchApplyWindowInsets(insets: WindowInsets!) Request to apply the given window insets to this view or another view in its subtree. This method should be called by clients wishing to apply insets corresponding to areas obscured by window decorations or overlays. This can include the status and navigation bars, action bars, input methods and more. New inset categories may be added in the future. The method returns the insets provided minus any that were applied by this view or its children. Clients wishing to provide custom behavior should override the onApplyWindowInsets(android.view.WindowInsets) method or alternatively provide a OnApplyWindowInsetsListener via the setOnApplyWindowInsetsListener method. This method replaces the older fitSystemWindows method. Boolean dispatchCapturedPointerEvent(event: MotionEvent!) Pass a captured pointer event down to the focused view. Unit dispatchConfigurationChanged(newConfig: Configuration!) Dispatch a notification about a resource configuration change down the view hierarchy. ViewGroups should override to route to their children. Unit dispatchCreateViewTranslationRequest(viewIds: MutableMap<AutofillId!, LongArray!>, supportedFormats: IntArray, capability: TranslationCapability, requests: MutableList<ViewTranslationRequest!>) Dispatch to collect the ViewTranslationRequests for translation purpose by traversing the hierarchy when the app requests ui translation. Typically, this method should only be overridden by subclasses that provide a view hierarchy (such as ViewGroup). Other classes should override View#onCreateViewTranslationRequest for normal view or override View#onVirtualViewTranslationResponses for view contains virtual children. When requested to start the ui translation, the system will call this method to traverse the view hierarchy to collect ViewTranslationRequests and create a android.view.translation.Translator to translate the requests. All the ViewTranslationRequests must be added when the traversal is done. The default implementation calls View#onCreateViewTranslationRequest for normal view or calls View#onVirtualViewTranslationResponses for view contains virtual children to build ViewTranslationRequest if the view should be translated. The view is marked as having transient state so that recycling of views doesn't prevent the system from attaching the response to it. Therefore, if overriding this method, you should set or reset the transient state. Unit dispatchDisplayHint(hint: Int) Dispatch a hint about whether this view is displayed. For instance, when a View moves out of the screen, it might receives a display hint indicating the view is not displayed. Applications should not rely on this hint as there is no guarantee that they will receive one. Boolean dispatchDragEvent(event: DragEvent!) Detects if this View is enabled and has a drag event listener. If both are true, then it calls the drag event listener with the android.view.DragEvent it received. If the drag event listener returns true, then dispatchDragEvent() returns true. For all other cases, the method calls the onDragEvent() drag event handler method and returns its result. This ensures that a drag event is always consumed, even if the View does not have a drag event listener. However, if the View has a listener and the listener returns true, then onDragEvent() is not called. Unit dispatchDrawableHotspotChanged(x: Float, y: Float) Dispatches drawableHotspotChanged to all of this View's children. Unit dispatchFinishTemporaryDetach() Dispatch onFinishTemporaryDetach() to this View and its direct children if this is a container View. If you override this method you must call through to the superclass implementation. Boolean dispatchGenericFocusedEvent(event: MotionEvent!) Dispatch a generic motion event to the currently focused view. Do not call this method directly. Call dispatchGenericMotionEvent(android.view.MotionEvent) instead. Boolean dispatchGenericMotionEvent(event: MotionEvent!) Dispatch a generic motion event. Generic motion events with source class InputDevice#SOURCE_CLASS_POINTER are delivered to the view under the pointer. All other generic motion events are delivered to the focused view. Hover events are handled specially and are delivered to onHoverEvent(android.view.MotionEvent) first. Boolean dispatchGenericPointerEvent(event: MotionEvent!) Dispatch a generic motion event to the view under the first pointer. Do not call this method directly. Call dispatchGenericMotionEvent(android.view.MotionEvent) instead. Boolean dispatchHoverEvent(event: MotionEvent!) Dispatch a hover event. Do not call this method directly. Call dispatchGenericMotionEvent(android.view.MotionEvent) instead. Boolean dispatchKeyEvent(event: KeyEvent!) Dispatch a key event to the next view on the focus path. This path runs from the top of the view tree down to the currently focused view. If this view has focus, it will dispatch to itself. Otherwise it will dispatch the next node down the focus path. This method also fires any key listeners. Boolean dispatchKeyEventPreIme(event: KeyEvent!) Dispatch a key event before it is processed by any input method associated with the view hierarchy. This can be used to intercept key events in special situations before the IME consumes them; a typical example would be handling the BACK key to update the application's UI instead of allowing the IME to see it and close itself. Boolean dispatchKeyShortcutEvent(event: KeyEvent!) Dispatches a key shortcut event. Boolean dispatchNestedFling(velocityX: Float, velocityY: Float, consumed: Boolean) Dispatch a fling to a nested scrolling parent. This method should be used to indicate that a nested scrolling child has detected suitable conditions for a fling. Generally this means that a touch scroll has ended with a velocity in the direction of scrolling that meets or exceeds the minimum fling velocity along a scrollable axis. If a nested scrolling child view would normally fling but it is at the edge of its own content, it can use this method to delegate the fling to its nested scrolling parent instead. The parent may optionally consume the fling or observe a child fling. Boolean dispatchNestedPreFling(velocityX: Float, velocityY: Float) Dispatch a fling to a nested scrolling parent before it is processed by this view. Nested pre-fling events are to nested fling events what touch intercept is to touch and what nested pre-scroll is to nested scroll. dispatchNestedPreFling offsets an opportunity for the parent view in a nested fling to fully consume the fling before the child view consumes it. If this method returns true, a nested parent view consumed the fling and this view should not scroll as a result. For a better user experience, only one view in a nested scrolling chain should consume the fling at a time. If a parent view consumed the fling this method will return false. Custom view implementations should account for this in two ways: If a custom view is paged and needs to settle to a fixed page-point, do not call dispatchNestedPreFling; consume the fling and settle to a valid position regardless. If a nested parent does consume the fling, this view should not scroll at all, even to settle back to a valid idle position. Views should also not offer fling velocities to nested parent views along an axis where scrolling is not currently supported; a ScrollView should not offer a horizontal fling velocity to its parents since scrolling along that axis is not permitted and carrying velocity along that motion does not make sense. Boolean dispatchNestedPrePerformAccessibilityAction(action: Int, arguments: Bundle?) Report an accessibility action to this view's parents for delegated processing. Implementations of performAccessibilityAction(int,android.os.Bundle) may internally call this method to delegate an accessibility action to a supporting parent. If the parent returns true from its ViewParent#onNestedPrePerformAccessibilityAction(View, int, android.os.Bundle) method this method will return true to signify that the action was consumed. This method is useful for implementing nested scrolling child views. If isNestedScrollingEnabled() returns true and the action is a scrolling action a custom view implementation may invoke this method to allow a parent to consume the scroll first. If this method returns true the custom view should skip its own scrolling behavior. Boolean dispatchNestedPreScroll(dx: Int, dy: Int, consumed: IntArray?, offsetInWindow: IntArray?) Dispatch one step of a nested scroll in progress before this view consumes any portion of it. Nested pre-scroll events are to nested scroll events what touch intercept is to touch. dispatchNestedPreScroll offers an opportunity for the parent view in a nested scrolling operation to consume some or all of the scroll operation before the child view consumes it. Boolean dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, offsetInWindow: IntArray?) Dispatch one step of a nested scroll in progress. Implementations of views that support nested scrolling should call this to report info about a scroll in progress to the current nested scrolling parent. If a nested scroll is not currently in progress or nested scrolling is not enabled for this view this method does nothing. Compatible View implementations should also call dispatchNestedPreScroll before consuming a component of the scroll event themselves. Unit dispatchPointerCaptureChanged(hasCapture: Boolean) Boolean dispatchPopulateAccessibilityEvent(event: AccessibilityEvent!) Dispatches an AccessibilityEvent to the View to add the text content of the view and its children. Note: This method should only be used with event.setText(). Avoid mutating other event state in this method. In general, put UI metadata in the node for services to easily query. If you are modifying other event properties, you may be eliminating semantics accessibility services may want. Instead, send a separate event using sendAccessibilityEvent(int) and override onInitializeAccessibilityEvent(android.view.accessibility.AccessibilityEvent). If you are checking for type AccessibilityEvent#TYPE_WINDOW_STATE_CHANGED to generate window/title announcements, you may be causing disruptive announcements (or making no announcements at all). Instead, follow the practices described in View#announceForAccessibility(CharSequence). Note: this does not suggest calling announceForAccessibility(), but using the suggestions listed in its documentation. If you are making changes based on the state of accessibility, such as checking for an event type to trigger a UI update, while well-intentioned, you are creating brittle, less well-maintained code that works for some users but not others. Instead, leverage existing code for equitable experiences and less technical debt. See AccessibilityManager#isEnabled() for an example. Note that the event text is populated in a separate dispatch path (onPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent)) since we add to the event not only the text of the source but also the text of all its descendants. A typical implementation will call onPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent) on this view and then call the dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent) on each child or the first child that is visible. Override this method if custom population of the event text content is required. If an AccessibilityDelegate has been specified via calling setAccessibilityDelegate(android.view.View.AccessibilityDelegate) its AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent) is responsible for handling this call. If this view sets isAccessibilityDataSensitive() then this view should only append sensitive information to an event that also sets AccessibilityEvent#isAccessibilityDataSensitive(). Note: Accessibility events of certain types are not dispatched for populating the event text via this method. For details refer to AccessibilityEvent. Unit dispatchProvideAutofillStructure(structure: ViewStructure, flags: Int) Dispatches creation of a ViewStructures for autofill purposes down the hierarchy, when an Assist structure is being created as part of an autofill request. The default implementation does the following: Sets the AutofillId in the structure. Calls onProvideAutofillStructure(android.view.ViewStructure,int). Calls onProvideAutofillVirtualStructure(android.view.ViewStructure,int). Typically, this method should only be overridden by subclasses that provide a view hierarchy (such as ViewGroup) - other classes should override onProvideAutofillStructure(android.view.ViewStructure,int) or onProvideAutofillVirtualStructure(android.view.ViewStructure,int) instead. When overridden, it must: Either call super.dispatchProvideAutofillStructure(structure, flags) or explicitly set the AutofillId in the structure (for example, by calling structure.setAutofillId(getAutofillId())). Decide how to handle the AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS flag - when set, all views in the structure should be considered important for autofill, regardless of what isImportantForAutofill() returns. We encourage you to respect this flag to provide a better user experience - this flag is typically used when an user explicitly requested autofill. If the flag is not set, then only views marked as important for autofill should be included in the structure - skipping non-important views optimizes the overall autofill performance. Unit dispatchProvideStructure(structure: ViewStructure!) Dispatch creation of ViewStructure down the hierarchy. The default implementation calls onProvideStructure and onProvideVirtualStructure. Unit dispatchRestoreInstanceState(container: SparseArray<Parcelable!>!) Called by restoreHierarchyState(android.util.SparseArray) to retrieve the state for this view and its children. May be overridden to modify how restoring happens to a view's children; for example, some views may want to not store state for their children. Unit dispatchSaveInstanceState(container: SparseArray<Parcelable!>!) Called by saveHierarchyState(android.util.SparseArray) to store the state for this view and its children. May be overridden to modify how freezing happens to a view's children; for example, some views may want to not store state for their children. Unit dispatchScrollCaptureSearch(localVisibleRect: Rect, windowOffset: Point, targets: Consumer<ScrollCaptureTarget!>) Dispatch a scroll capture search request down the view hierarchy. Unit dispatchSetActivated(activated: Boolean) Dispatch setActivated to all of this View's children. Unit dispatchSetPressed(pressed: Boolean) Dispatch setPressed to all of this View's children. Unit dispatchSetSelected(selected: Boolean) Dispatch setSelected to all of this View's children. Unit dispatchStartTemporaryDetach() Dispatch onStartTemporaryDetach() to this View and its direct children if this is a container View. If you override this method you must call through to the superclass implementation. Unit dispatchSystemUiVisibilityChanged(visibility: Int) Dispatch callbacks to setOnSystemUiVisibilityChangeListener down the view hierarchy. Boolean dispatchTouchEvent(event: MotionEvent!) Pass the touch screen motion event down to the target view, or this view if it is the target. Boolean dispatchTrackballEvent(event: MotionEvent!) Pass a trackball motion event down to the focused view. Boolean dispatchUnhandledMove(focused: View!, direction: Int) This method is the last chance for the focused view and its ancestors to respond to an arrow key. This is called when the focused view did not consume the key internally, nor could the view system find a new view in the requested direction to give focus to. Unit dispatchVisibilityChanged(changedView: View, visibility: Int) Dispatch a view visibility change down the view hierarchy. ViewGroups should override to route to their children. Unit dispatchWindowFocusChanged(hasFocus: Boolean) Called when the window containing this view gains or loses window focus. ViewGroups should override to route to their children. Unit dispatchWindowInsetsAnimationEnd(animation: WindowInsetsAnimation) Dispatches WindowInsetsAnimation.Callback#onEnd(WindowInsetsAnimation) when Window Insets animation ends. Unit dispatchWindowInsetsAnimationPrepare(animation: WindowInsetsAnimation) Dispatches WindowInsetsAnimation.Callback#onPrepare(WindowInsetsAnimation) when Window Insets animation is being prepared. WindowInsets dispatchWindowInsetsAnimationProgress(insets: WindowInsets, runningAnimations: MutableList<WindowInsetsAnimation!>) Dispatches WindowInsetsAnimation.Callback#onProgress(WindowInsets, List) when Window Insets animation makes progress. WindowInsetsAnimation.Bounds dispatchWindowInsetsAnimationStart(animation: WindowInsetsAnimation, bounds: WindowInsetsAnimation.Bounds) Dispatches WindowInsetsAnimation.Callback#onStart(WindowInsetsAnimation, Bounds) when Window Insets animation is started. Unit dispatchWindowSystemUiVisiblityChanged(visible: Int) Dispatch callbacks to onWindowSystemUiVisibilityChanged(int) down the view hierarchy. Unit dispatchWindowVisibilityChanged(visibility: Int) Dispatch a window visibility change down the view hierarchy. ViewGroups should override to route to their children. Unit drawableHotspotChanged(x: Float, y: Float) This function is called whenever the view hotspot changes and needs to be propagated to drawables or child views managed by the view. Dispatching to child views is handled by dispatchDrawableHotspotChanged(float,float). Be sure to call through to the superclass when overriding this function. If you override this method you must call through to the superclass implementation. Unit drawableStateChanged() This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown. If the View has a StateListAnimator, it will also be called to run necessary state change animations. Be sure to call through to the superclass when overriding this function. If you override this method you must call through to the superclass implementation. View! findFocus() Find the view in the hierarchy rooted at this view that currently has focus. OnBackInvokedDispatcher? findOnBackInvokedDispatcher() Walk up the View hierarchy to find the nearest OnBackInvokedDispatcher. T findViewById(id: Int) Finds the first descendant view with the given ID, the view itself if the ID matches getId(), or null if the ID is invalid (< 0) or there is no matching view in the hierarchy. Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary. T findViewWithTag(tag: Any!) Look for a child view with the given tag. If this view has the given tag, return this view. Unit findViewsWithText(outViews: ArrayList<View!>!, searched: CharSequence!, flags: Int) Finds the Views that contain given text. The containment is case insensitive. The search is performed by either the text that the View renders or the content description that describes the view for accessibility purposes and the view does not render or both. Clients can specify how the search is to be performed via passing the FIND_VIEWS_WITH_TEXT and FIND_VIEWS_WITH_CONTENT_DESCRIPTION flags. Boolean fitSystemWindows(insets: Rect!) Called by the view hierarchy when the content insets for a window have changed, to allow it to adjust its content to fit within those windows. The content insets tell you the space that the status bar, input method, and other system windows infringe on the application's window. You do not normally need to deal with this function, since the default window decoration given to applications takes care of applying it to the content of the window. If you use SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION this will not be the case, and your content can be placed under those system elements. You can then use this method within your view hierarchy if you have parts of your UI which you would like to ensure are not being covered. The default implementation of this method simply applies the content insets to the view's padding, consuming that content (modifying the insets to be 0), and returning true. This behavior is off by default, but can be enabled through setFitsSystemWindows(boolean). This function's traversal down the hierarchy is depth-first. The same content insets object is propagated down the hierarchy, so any changes made to it will be seen by all following views (including potentially ones above in the hierarchy since this is a depth-first traversal). The first view that returns true will abort the entire traversal. The default implementation works well for a situation where it is used with a container that covers the entire window, allowing it to apply the appropriate insets to its content on all edges. If you need a more complicated layout (such as two different views fitting system windows, one on the top of the window, and one on the bottom), you can override the method and handle the insets however you would like. Note that the insets provided by the framework are always relative to the far edges of the window, not accounting for the location of the called view within that window. (In fact when this method is called you do not yet know where the layout will place the view, as it is done before layout happens.) Note: unlike many View methods, there is no dispatch phase to this call. If you are overriding it in a ViewGroup and want to allow the call to continue to your children, you must be sure to call the super implementation. Here is a sample layout that makes use of fitting system windows to have controls for a video view placed inside of the window decorations that it hides and shows. This can be used with code like the second sample (video player) shown in setSystemUiVisibility(int). View! focusSearch(direction: Int) Find the nearest view in the specified direction that can take focus. This does not actually give focus to that view. Unit forceHasOverlappingRendering(hasOverlappingRendering: Boolean) Sets the behavior for overlapping rendering for this view (see hasOverlappingRendering() for more details on this behavior). Calling this method is an alternative to overriding hasOverlappingRendering() in a subclass, providing the value which is then used internally. That is, when forceHasOverlappingRendering(boolean) is called, the value of hasOverlappingRendering() is ignored and the value passed into this method is used instead. Unit forceLayout() Forces this view to be laid out during the next layout pass. This method does not call requestLayout() or forceLayout() on the parent. Unit generateDisplayHash(hashAlgorithm: String, bounds: Rect?, executor: Executor, callback: DisplayHashResultCallback) Called to generate a DisplayHash for this view. Int generateViewId() Generate a value suitable for use in setId(int). This value will not collide with ID values generated at build time by aapt for R.id. CharSequence! getAccessibilityClassName() Return the class name of this object to be used for accessibility purposes. Subclasses should only override this if they are implementing something that should be seen as a completely new class of view when used by accessibility, unrelated to the class it is deriving from. This is used to fill in AccessibilityNodeInfo.setClassName. View.AccessibilityDelegate! getAccessibilityDelegate() Returns the delegate for implementing accessibility support via composition. For more details see AccessibilityDelegate. Int getAccessibilityLiveRegion() Gets the live region mode for this View. AccessibilityNodeProvider! getAccessibilityNodeProvider() Gets the provider for managing a virtual view hierarchy rooted at this View and reported to android.accessibilityservice.AccessibilityServices that explore the window content. If this method returns an instance, this instance is responsible for managing AccessibilityNodeInfos describing the virtual sub-tree rooted at this View including the one representing the View itself. Similarly the returned instance is responsible for performing accessibility actions on any virtual view or the root view itself. If an AccessibilityDelegate has been specified via calling setAccessibilityDelegate(android.view.View.AccessibilityDelegate) its AccessibilityDelegate#getAccessibilityNodeProvider(View) is responsible for handling this call. CharSequence? getAccessibilityPaneTitle() Get the title of the pane for purposes of accessibility. Int getAccessibilityTraversalAfter() Gets the id of a view after which this one is visited in accessibility traversal. Int getAccessibilityTraversalBefore() Gets the id of a view before which this one is visited in accessibility traversal. String? getAllowedHandwritingDelegatePackageName() Returns the allowed package for delegate editor views for which this view may act as a handwriting delegator, as set by setAllowedHandwritingDelegatePackage. If setAllowedHandwritingDelegatePackage has not been called, or called with null argument, this will return null, meaning that this delegator view may only be used to initiate handwriting mode for a delegate editor view from the same package as this delegator view. String? getAllowedHandwritingDelegatorPackageName() Returns the allowed package for views which may act as a handwriting delegator for this delegate editor view, as set by setAllowedHandwritingDelegatorPackage. If setAllowedHandwritingDelegatorPackage has not been called, or called with null argument, this will return null, meaning that only views from the same package as this delegator editor view may act as a handwriting delegator. Float getAlpha() The opacity of the view. This is a value from 0 to 1, where 0 means the view is completely transparent and 1 means the view is completely opaque. By default this is 1.0f. Animation! getAnimation() Get the animation currently associated with this view. Matrix? getAnimationMatrix() Return the current transformation matrix of the view. This is used in animation frameworks, such as android.transition.Transition. Returns null when there is no transformation provided by setAnimationMatrix(android.graphics.Matrix). Application developers should use transformation methods like setRotation(float), setScaleX(float), setScaleX(float), setTranslationX(float)} and setTranslationY(float) (float)}} instead. IBinder! getApplicationWindowToken() Retrieve a unique token identifying the top-level "real" window of the window that this view is attached to. That is, this is like getWindowToken, except if the window this view in is a panel window (attached to another containing window), then the token of the containing window is returned instead. IntArray getAttributeResolutionStack(attribute: Int) Returns the ordered list of resource ID that are considered when resolving attribute values for this View. The list will include layout resource ID if the View is inflated from XML. It will also include a set of explicit styles if specified in XML using style="...". Finally, it will include the default styles resolved from the theme. Note: this method will only return actual values if the view attribute debugging is enabled in Android developer options. MutableMap<Int!, Int!> getAttributeSourceResourceMap() Returns the mapping of attribute resource ID to source resource ID where the attribute value was set. Source resource ID can either be a layout resource ID, if the value was set in XML within the View tag, or a style resource ID, if the attribute was set in a style. The source resource value will be one of the resource IDs from getAttributeSourceResourceMap(). Note: this method will only return actual values if the view attribute debugging is enabled in Android developer options. Array<String!>? getAutofillHints() Gets the hints that help an android.service.autofill.AutofillService determine how to autofill the view with the user's data. See setAutofillHints(java.lang.String...) for more info about these hints. AutofillId! getAutofillId() Gets the unique, logical identifier of this view in the activity, for autofill purposes. The autofill id is created on demand, unless it is explicitly set by setAutofillId(android.view.autofill.AutofillId). See setAutofillId(android.view.autofill.AutofillId) for more info. Int getAutofillType() Describes the autofill type of this view, so an android.service.autofill.AutofillService can create the proper AutofillValue when autofilling the view. By default returns AUTOFILL_TYPE_NONE, but views should override it to properly support the Autofill Framework. AutofillValue? getAutofillValue() Gets the View's current autofill value. By default returns null, but subclasses should override it and return an appropriate value to properly support the Autofill Framework. Drawable! getBackground() Gets the background drawable BlendMode? getBackgroundTintBlendMode() Return the blending mode used to apply the tint to the background drawable, if specified. ColorStateList? getBackgroundTintList() Return the tint applied to the background drawable, if specified. PorterDuff.Mode? getBackgroundTintMode() Return the blending mode used to apply the tint to the background drawable, if specified. Int getBaseline() Return the offset of the widget's text baseline from the widget's top boundary. If this widget does not support baseline alignment, this method returns -1. Int getBottom() Bottom position of this view relative to its parent. Float getBottomFadingEdgeStrength() Returns the strength, or intensity, of the bottom faded edge. The strength is a value between 0.0 (no fade) and 1.0 (full fade). The default implementation returns 0.0 or 1.0 but no value in between. Subclasses should override this method to provide a smoother fade transition when scrolling occurs. Int getBottomPaddingOffset() Amount by which to extend the bottom fading region. Called only when isPaddingOffsetRequired() returns true. Float getCameraDistance() Gets the distance along the Z axis from the camera to this view. Rect! getClipBounds() Returns a copy of the current clipBounds. Boolean getClipBounds(outRect: Rect!) Populates an output rectangle with the clip bounds of the view, returning true if successful or false if the view's clip bounds are null. Boolean getClipToOutline() Returns whether the Outline should be used to clip the contents of the View. Note that this flag will only be respected if the View's Outline returns true from Outline#canClip(). ContentCaptureSession? getContentCaptureSession() Gets the session used to notify content capture events. CharSequence! getContentDescription() Returns the View's content description. Note: Do not override this method, as it will have no effect on the content description presented to accessibility services. You must call setContentDescription(java.lang.CharSequence) to modify the content description. Int getContentSensitivity() Gets content sensitivity mode to determine whether this view displays sensitive content. See setContentSensitivity(int) and isContentSensitive() for more info about this mode. Context! getContext() Returns the context the view is running in, through which it can access the current theme, resources, etc. ContextMenu.ContextMenuInfo! getContextMenuInfo() Views should implement this if they have extra information to associate with the context menu. The return result is supplied as a parameter to the OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo) callback. Boolean getDefaultFocusHighlightEnabled() Returns whether this View should use a default focus highlight when it gets focused but doesn't have android.R.attr#state_focused defined in its background. Int getDefaultSize(size: Int, measureSpec: Int) Utility to return a default size. Uses the supplied size if the MeasureSpec imposed no constraints. Will get larger if allowed by the MeasureSpec. Display! getDisplay() Gets the logical display to which the view's window has been attached. IntArray! getDrawableState() Return an array of resource IDs of the drawable states representing the current state of the view. Bitmap! getDrawingCache() Calling this method is equivalent to calling getDrawingCache(false). Bitmap! getDrawingCache(autoScale: Boolean) Returns the bitmap in which this view drawing is cached. The returned bitmap is null when caching is disabled. If caching is enabled and the cache is not ready, this method will create it. Calling draw(android.graphics.Canvas) will not draw from the cache when the cache is enabled. To benefit from the cache, you must request the drawing cache by calling this method and draw it on screen if the returned bitmap is not null. Note about auto scaling in compatibility mode: When auto scaling is not enabled, this method will create a bitmap of the same size as this view. Because this bitmap will be drawn scaled by the parent ViewGroup, the result on screen might show scaling artifacts. To avoid such artifacts, you should call this method by setting the auto scaling to true. Doing so, however, will generate a bitmap of a different size than the view. This implies that your application must be able to handle this size. Int getDrawingCacheBackgroundColor() Int getDrawingCacheQuality() Returns the quality of the drawing cache. Unit getDrawingRect(outRect: Rect!) Return the visible drawing bounds of your view. Fills in the output rectangle with the values from getScrollX(), getScrollY(), getWidth(), and getHeight(). These bounds do not account for any transformation properties currently set on the view, such as setScaleX(float) or setRotation(float). Long getDrawingTime() Return the time at which the drawing of the view hierarchy started. Float getElevation() The base elevation of this view relative to its parent, in pixels. Int getExplicitStyle() Returns the resource ID for the style specified using style="..." in the AttributeSet's backing XML element or Resources#ID_NULL otherwise if not specified or otherwise not applicable. Each View can have an explicit style specified in the layout file. This style is used first during the View attribute resolution, then if an attribute is not defined there the resource system looks at default style and theme as fallbacks. Note: this method will only return actual values if the view attribute debugging is enabled in Android developer options. Boolean getFilterTouchesWhenObscured() Gets whether the framework should discard touches when the view's window is obscured by another visible window at the touched location. Refer to the View security documentation for more details. Boolean getFitsSystemWindows() Check for state of setFitsSystemWindows(boolean). If this method returns true, the default implementation of fitSystemWindows(android.graphics.Rect) will be executed. Int getFocusable() Returns the focusable setting for this view. ArrayList<View!>! getFocusables(direction: Int) Find and return all focusable views that are descendants of this view, possibly including this view if it is focusable itself. Unit getFocusedRect(r: Rect!) When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method. By default, the rectangle is the getDrawingRect(android.graphics.Rect)) of the view. However, if your view maintains some idea of internal selection, such as a cursor, or a selected row or column, you should override this method and fill in a more specific rectangle. Drawable! getForeground() Returns the drawable used as the foreground of this View. The foreground drawable, if non-null, is always drawn on top of the view's content. Int getForegroundGravity() Describes how the foreground is positioned. BlendMode? getForegroundTintBlendMode() Return the blending mode used to apply the tint to the foreground drawable, if specified. ColorStateList? getForegroundTintList() Return the tint applied to the foreground drawable, if specified. PorterDuff.Mode? getForegroundTintMode() Return the blending mode used to apply the tint to the foreground drawable, if specified. Float getFrameContentVelocity() Get the current velocity of the View. The value should always be greater than or equal to 0. Note that this is only valid till the next drawn frame. Boolean getGlobalVisibleRect(r: Rect!, globalOffset: Point!) Sets r to the coordinates of the non-clipped area of this view in the coordinate space of the view's root view. Sets globalOffset to the offset of the view's x and y coordinates from the coordinate space origin, which is the top left corner of the root view irrespective of screen decorations and system UI elements. To convert r to coordinates relative to the top left corner of this view (without taking view rotations into account), offset r by the inverse values of globalOffset—r.offset(-globalOffset.x, -globalOffset.y)—which is equivalent to calling getLocalVisibleRect(Rect). Note: Do not use this method to determine the size of a window in multi-window mode; use WindowManager#getCurrentWindowMetrics(). Boolean getGlobalVisibleRect(r: Rect!) Sets r to the coordinates of the non-clipped area of this view in the coordinate space of the view's root view. See getGlobalVisibleRect(Rect, Point) for more information. Handler! getHandler() Float getHandwritingBoundsOffsetBottom() Return the amount of offset applied to the bottom edge of this view's handwriting bounds, in the unit of pixel. Float getHandwritingBoundsOffsetLeft() Return the amount of offset applied to the left edge of this view's handwriting bounds, in the unit of pixel. Float getHandwritingBoundsOffsetRight() Return the amount of offset applied to the right edge of this view's handwriting bounds, in the unit of pixel. Float getHandwritingBoundsOffsetTop() Return the amount of offset applied to the top edge of this view's handwriting bounds, in the unit of pixel. Int getHandwritingDelegateFlags() Returns flags configuring the handwriting delegation behavior for this delegate editor view, as set by setHandwritingDelegateFlags. Runnable? getHandwritingDelegatorCallback() Returns the callback set by setHandwritingDelegatorCallback which should be called when a stylus MotionEvent occurs within this view's bounds. The callback should only be called from the UI thread. Boolean getHasOverlappingRendering() Returns the value for overlapping rendering that is used internally. This is either the value passed into forceHasOverlappingRendering(boolean), if called, or the return value of hasOverlappingRendering(), otherwise. Int getHeight() Return the height of your view. Unit getHitRect(outRect: Rect!) Hit rectangle in parent's coordinates Int getHorizontalFadingEdgeLength() Returns the size of the horizontal faded edges used to indicate that more content in this view is visible. Int getHorizontalScrollbarHeight() Returns the height of the horizontal scrollbar. Drawable? getHorizontalScrollbarThumbDrawable() Returns the currently configured Drawable for the thumb of the horizontal scroll bar if it exists, null otherwise. Drawable? getHorizontalScrollbarTrackDrawable() Returns the currently configured Drawable for the track of the horizontal scroll bar if it exists, null otherwise. Int getId() Returns this view's identifier. Int getImportantForAutofill() Gets the mode for determining whether this view is important for autofill. See setImportantForAutofill(int) and isImportantForAutofill() for more info about this mode. Int getImportantForContentCapture() Gets the mode for determining whether this view is important for content capture. See setImportantForContentCapture(int) and isImportantForContentCapture() for more info about this mode. Boolean getKeepScreenOn() Returns whether the screen should remain on, corresponding to the current value of KEEP_SCREEN_ON. KeyEvent.DispatcherState! getKeyDispatcherState() Return the global KeyEvent.DispatcherState for this view's window. Returns null if the view is not currently attached to the window. Normally you will not need to use this directly, but just use the standard high-level event callbacks like onKeyDown(int,android.view.KeyEvent). Int getLabelFor() Gets the id of a view for which this view serves as a label for accessibility purposes. Int getLayerType() Indicates what type of layer is currently associated with this view. By default a view does not have a layer, and the layer type is LAYER_TYPE_NONE. Refer to the documentation of setLayerType(int,android.graphics.Paint) for more information on the different types of layers. Int getLayoutDirection() Returns the resolved layout direction for this view. ViewGroup.LayoutParams! getLayoutParams() Get the LayoutParams associated with this view. All views should have layout parameters. These supply parameters to the parent of this view specifying how it should be arranged. There are many subclasses of ViewGroup.LayoutParams, and these correspond to the different subclasses of ViewGroup that are responsible for arranging their children. This method may return null if this View is not attached to a parent ViewGroup or setLayoutParams(android.view.ViewGroup.LayoutParams) was not invoked successfully. When a View is attached to a parent ViewGroup, this method must not return null. Int getLeft() Left position of this view relative to its parent. Float getLeftFadingEdgeStrength() Returns the strength, or intensity, of the left faded edge. The strength is a value between 0.0 (no fade) and 1.0 (full fade). The default implementation returns 0.0 or 1.0 but no value in between. Subclasses should override this method to provide a smoother fade transition when scrolling occurs. Int getLeftPaddingOffset() Amount by which to extend the left fading region. Called only when isPaddingOffsetRequired() returns true. Boolean getLocalVisibleRect(r: Rect!) Sets r to the coordinates of the non-clipped area of this view relative to the top left corner of the view. If the view is clipped on the left or top, the left and top coordinates are offset from 0 by the clipped amount. For example, if the view is off screen 50px on the left and 30px at the top, the left and top coordinates are 50 and 30 respectively. If the view is clipped on the right or bottom, the right and bottom coordinates are reduced by the clipped amount. For example, if the view is off screen 40px on the right and 20px at the bottom, the right coordinate is the view width - 40, and the bottom coordinate is the view height - 20. Unit getLocationInSurface(location: IntArray) Gets the coordinates of this view in the coordinate space of the Surface that contains the view. In multiple-screen scenarios, if the surface spans multiple screens, the coordinate space of the surface also spans multiple screens. After the method returns, the argument array contains the x and y coordinates of the view relative to the view's left and top edges, respectively. Unit getLocationInWindow(outLocation: IntArray!) Gets the coordinates of this view in the coordinate space of the window that contains the view, irrespective of system decorations. In multi-window mode, the origin of the coordinate space is the top left corner of the window that contains the view. In full screen mode, the origin is the top left corner of the device screen. In multiple-screen scenarios, if the app spans multiple screens, the coordinate space also spans multiple screens. But if the app is restricted to a single screen, the coordinate space includes only the screen on which the app is running. After the method returns, the argument array contains the x and y coordinates of the view relative to the view's left and top edges, respectively. Unit getLocationOnScreen(outLocation: IntArray!) Gets the coordinates of this view in the coordinate space of the device screen, irrespective of system decorations and whether the system is in multi-window mode. In multi-window mode, the coordinate space encompasses the entire device screen, ignoring the bounds of the app window. For example, if the view is in the bottom portion of a horizontal split screen, the top edge of the screen—not the top edge of the window—is the origin from which the y-coordinate is calculated. In multiple-screen scenarios, the coordinate space can span screens. For example, if the app is spanning both screens of a dual-screen device and the view is located on the right-hand screen, the x-coordinate is calculated from the left edge of the left-hand screen to the left edge of the view. When the app is restricted to a single screen in a multiple-screen environment, the coordinate space includes only the screen on which the app is running. After the method returns, the argument array contains the x and y coordinates of the view relative to the view's left and top edges, respectively. Matrix! getMatrix() The transform matrix of this view, which is calculated based on the current rotation, scale, and pivot properties. Int getMeasuredHeight() Like getMeasuredHeightAndState(), but only returns the raw height component (that is the result is masked by MEASURED_SIZE_MASK). Int getMeasuredHeightAndState() Return the full height measurement information for this view as computed by the most recent call to measure(int,int). This result is a bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL. This should be used during measurement and layout calculations only. Use getHeight() to see how high a view is after layout. Int getMeasuredState() Return only the state bits of getMeasuredWidthAndState() and getMeasuredHeightAndState(), combined into one integer. The width component is in the regular bits MEASURED_STATE_MASK and the height component is at the shifted bits MEASURED_HEIGHT_STATE_SHIFT>>MEASURED_STATE_MASK. Int getMeasuredWidth() Like getMeasuredWidthAndState(), but only returns the raw width component (that is the result is masked by MEASURED_SIZE_MASK). Int getMeasuredWidthAndState() Return the full width measurement information for this view as computed by the most recent call to measure(int,int). This result is a bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL. This should be used during measurement and layout calculations only. Use getWidth() to see how wide a view is after layout. Int getMinimumHeight() Returns the minimum height of the view. Int getMinimumWidth() Returns the minimum width of the view. Int getNextClusterForwardId() Gets the id of the root of the next keyboard navigation cluster. Int getNextFocusDownId() Gets the id of the view to use when the next focus is FOCUS_DOWN. Int getNextFocusForwardId() Gets the id of the view to use when the next focus is FOCUS_FORWARD. Int getNextFocusLeftId() Gets the id of the view to use when the next focus is FOCUS_LEFT. Int getNextFocusRightId() Gets the id of the view to use when the next focus is FOCUS_RIGHT. Int getNextFocusUpId() Gets the id of the view to use when the next focus is FOCUS_UP. View.OnFocusChangeListener! getOnFocusChangeListener() Returns the focus-change callback registered for this view. Int getOutlineAmbientShadowColor() ViewOutlineProvider! getOutlineProvider() Returns the current ViewOutlineProvider of the view, which generates the Outline that defines the shape of the shadow it casts, and enables outline clipping. Int getOutlineSpotShadowColor() Int getOverScrollMode() Returns the over-scroll mode for this view. The result will be one of OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS (allow over-scrolling only if the view content is larger than the container), or OVER_SCROLL_NEVER. ViewOverlay! getOverlay() Returns the overlay for this view, creating it if it does not yet exist. Adding drawables to the overlay will cause them to be displayed whenever the view itself is redrawn. Objects in the overlay should be actively managed: remove them when they should not be displayed anymore. The overlay will always have the same size as its host view. Note: Overlays do not currently work correctly with SurfaceView or TextureView; contents in overlays for these types of views may not display correctly. Int getPaddingBottom() Returns the bottom padding of this view. If there are inset and enabled scrollbars, this value may include the space required to display the scrollbars as well. Int getPaddingEnd() Returns the end padding of this view depending on its resolved layout direction. If there are inset and enabled scrollbars, this value may include the space required to display the scrollbars as well. Int getPaddingLeft() Returns the left padding of this view. If there are inset and enabled scrollbars, this value may include the space required to display the scrollbars as well. Int getPaddingRight() Returns the right padding of this view. If there are inset and enabled scrollbars, this value may include the space required to display the scrollbars as well. Int getPaddingStart() Returns the start padding of this view depending on its resolved layout direction. If there are inset and enabled scrollbars, this value may include the space required to display the scrollbars as well. Int getPaddingTop() Returns the top padding of this view. ViewParent! getParent() Gets the parent of this view. Note that the parent is a ViewParent and not necessarily a View. ViewParent! getParentForAccessibility() Gets the parent for accessibility purposes. Note that the parent for accessibility is not necessary the immediate parent. It is the first predecessor that is important for accessibility. OutcomeReceiver<GetCredentialResponse!, GetCredentialException!>? getPendingCredentialCallback() Returns the callback that has previously been set up on this view through the setPendingCredentialRequest API. If the return value is null, that means no callback, or request, has been set on the view and no CredentialManager flow will be invoked when this view is focused. Traditioanl autofill flows will still work, and autofillable content will still be returned through the autofill(android.view.autofill.AutofillValue) )} API. See setPendingCredentialRequest for more info. GetCredentialRequest? getPendingCredentialRequest() Returns the GetCredentialRequest associated with the view. If the return value is null, that means no request has been set on the view and no CredentialManager flow will be invoked when this view is focused. Traditioanl autofill flows will still work, autofilling content if applicable, from the active android.service.autofill.AutofillService on the device. See setPendingCredentialRequest for more info. Float getPivotX() The x location of the point around which the view is rotated and scaled. Float getPivotY() The y location of the point around which the view is rotated and scaled. PointerIcon! getPointerIcon() Gets the mouse pointer icon for the current view. MutableList<Rect!> getPreferKeepClearRects() Array<String!>? getReceiveContentMimeTypes() Returns the MIME types accepted by performReceiveContent for this view, as configured via setOnReceiveContentListener. By default returns null. Different features (e.g. pasting from the clipboard, inserting stickers from the soft keyboard, etc) may optionally use this metadata to conditionally alter their behavior. For example, a soft keyboard may choose to hide its UI for inserting GIFs for a particular input field if the MIME types returned here for that field don't include "image/gif" or "image/*". Note: Comparisons of MIME types should be performed using utilities such as ClipDescription#compareMimeTypes rather than simple string equality, in order to correctly handle patterns such as "text/*", "image/*", etc. Note that MIME type matching in the Android framework is case-sensitive, unlike formal RFC MIME types. As a result, you should always write your MIME types with lowercase letters, or use android.content.Intent#normalizeMimeType to ensure that it is converted to lowercase. Float getRequestedFrameRate() Get the current preferred frame rate of the View. The value could be negative when preferred frame rate category is set instead of perferred frame rate. The frame rate category includes REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE, REQUESTED_FRAME_RATE_CATEGORY_LOW, REQUESTED_FRAME_RATE_CATEGORY_NORMAL, and REQUESTED_FRAME_RATE_CATEGORY_HIGH. Note that the frame rate value is valid as long as the View is invalidated. Resources! getResources() Returns the resources associated with this view. Boolean getRevealOnFocusHint() Returns this view's preference for reveal behavior when it gains focus. When this method returns true for a child view requesting focus, ancestor views responding to a focus change in ViewParent#requestChildFocus(View, View) should make a best effort to make the newly focused child fully visible to the user. When it returns false, ancestor views should preferably not disrupt scroll positioning or other properties affecting visibility to the user as part of the focus change. Int getRight() Right position of this view relative to its parent. Float getRightFadingEdgeStrength() Returns the strength, or intensity, of the right faded edge. The strength is a value between 0.0 (no fade) and 1.0 (full fade). The default implementation returns 0.0 or 1.0 but no value in between. Subclasses should override this method to provide a smoother fade transition when scrolling occurs. Int getRightPaddingOffset() Amount by which to extend the right fading region. Called only when isPaddingOffsetRequired() returns true. AttachedSurfaceControl? getRootSurfaceControl() The AttachedSurfaceControl itself is not a View, it is just the interface to the windowing-system object that contains the entire view hierarchy. For the root View of a given hierarchy see getRootView. View! getRootView() Finds the topmost view in the current view hierarchy. WindowInsets! getRootWindowInsets() Provide original WindowInsets that are dispatched to the view hierarchy. The insets are only available if the view is attached. Float getRotation() The degrees that the view is rotated around the pivot point. Float getRotationX() The degrees that the view is rotated around the horizontal axis through the pivot point. Float getRotationY() The degrees that the view is rotated around the vertical axis through the pivot point. Float getScaleX() The amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width. A value of 1, the default, means that no scaling is applied. By default, this is 1.0f. Float getScaleY() The amount that the view is scaled in y around the pivot point, as a proportion of the view's unscaled height. A value of 1, the default, means that no scaling is applied. By default, this is 1.0f. Int getScrollBarDefaultDelayBeforeFade() Returns the delay before scrollbars fade. Int getScrollBarFadeDuration() Returns the scrollbar fade duration. Int getScrollBarSize() Returns the scrollbar size. Int getScrollBarStyle() Returns the current scrollbar style. Int getScrollCaptureHint() Returns the current scroll capture hint for this view. Int getScrollIndicators() Returns a bitmask representing the enabled scroll indicators. For example, if the top and left scroll indicators are enabled and all other indicators are disabled, the return value will be View.SCROLL_INDICATOR_TOP | View.SCROLL_INDICATOR_LEFT. To check whether the bottom scroll indicator is enabled, use the value of (getScrollIndicators() & View.SCROLL_INDICATOR_BOTTOM) != 0. Int getScrollX() Return the scrolled left position of this view. This is the left edge of the displayed part of your view. You do not need to draw any pixels farther left, since those are outside of the frame of your view on screen. Int getScrollY() Return the scrolled top position of this view. This is the top edge of the displayed part of your view. You do not need to draw any pixels above it, since those are outside of the frame of your view on screen. Int getSolidColor() Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges. Returning a non-zero color enables the view system to optimize the drawing of the fading edges. If you do return a non-zero color, the alpha should be set to 0xFF. Int getSourceLayoutResId() A View can be inflated from an XML layout. For such Views this method returns the resource ID of the source layout. CharSequence? getStateDescription() Returns the View's state description. Note: Do not override this method, as it will have no effect on the state description presented to accessibility services. You must call setStateDescription(java.lang.CharSequence) to modify the state description. StateListAnimator! getStateListAnimator() Returns the current StateListAnimator if exists. Int getSuggestedMinimumHeight() Returns the suggested minimum height that the view should use. This returns the maximum of the view's minimum height and the background's minimum height (android.graphics.drawable.Drawable#getMinimumHeight()). When being used in onMeasure(int,int), the caller should still ensure the returned height is within the requirements of the parent. Int getSuggestedMinimumWidth() Returns the suggested minimum width that the view should use. This returns the maximum of the view's minimum width and the background's minimum width (android.graphics.drawable.Drawable#getMinimumWidth()). When being used in onMeasure(int,int), the caller should still ensure the returned width is within the requirements of the parent. MutableList<Rect!> getSystemGestureExclusionRects() Retrieve the list of areas within this view's post-layout coordinate space where the system should not intercept touch or other pointing device gestures. Do not modify the returned list. Int getSystemUiVisibility() Returns the last setSystemUiVisibility(int) that this view has requested. Any! getTag() Returns this view's tag. Any! getTag(key: Int) Returns the tag associated with this view and the specified key. Int getTextAlignment() Return the resolved text alignment. Int getTextDirection() Return the resolved text direction. CharSequence? getTooltipText() Returns the view's tooltip text. Note: Do not override this method, as it will have no effect on the text displayed in the tooltip. You must call setTooltipText(java.lang.CharSequence) to modify the tooltip text. Int getTop() Top position of this view relative to its parent. Float getTopFadingEdgeStrength() Returns the strength, or intensity, of the top faded edge. The strength is a value between 0.0 (no fade) and 1.0 (full fade). The default implementation returns 0.0 or 1.0 but no value in between. Subclasses should override this method to provide a smoother fade transition when scrolling occurs. Int getTopPaddingOffset() Amount by which to extend the top fading region. Called only when isPaddingOffsetRequired() returns true. TouchDelegate! getTouchDelegate() Gets the TouchDelegate for this View. ArrayList<View!>! getTouchables() Find and return all touchable views that are descendants of this view, possibly including this view if it is touchable itself. Float getTransitionAlpha() This property is intended only for use by the Fade transition, which animates it to produce a visual translucency that does not side-effect (or get affected by) the real alpha property. This value is composited with the other alpha value (and the AlphaAnimation value, when that is present) to produce a final visual translucency result, which is what is passed into the DisplayList. String! getTransitionName() Returns the name of the View to be used to identify Views in Transitions. Names should be unique in the View hierarchy. This returns null if the View has not been given a name. Float getTranslationX() The horizontal location of this view relative to its left position. This position is post-layout, in addition to wherever the object's layout placed it. Float getTranslationY() The vertical location of this view relative to its top position. This position is post-layout, in addition to wherever the object's layout placed it. Float getTranslationZ() The depth location of this view relative to its elevation. Long getUniqueDrawingId() Get the identifier used for this view by the drawing system. Int getVerticalFadingEdgeLength() Returns the size of the vertical faded edges used to indicate that more content in this view is visible. Int getVerticalScrollbarPosition() Drawable? getVerticalScrollbarThumbDrawable() Returns the currently configured Drawable for the thumb of the vertical scroll bar if it exists, null otherwise. Drawable? getVerticalScrollbarTrackDrawable() Returns the currently configured Drawable for the track of the vertical scroll bar if it exists, null otherwise. Int getVerticalScrollbarWidth() Returns the width of the vertical scrollbar. ViewTranslationResponse? getViewTranslationResponse() Returns the ViewTranslationResponse associated with this view. The response will be set when the translation is done then onViewTranslationResponse is called. The ViewTranslationCallback can use to get ViewTranslationResponse to display the translated information. ViewTreeObserver! getViewTreeObserver() Returns the ViewTreeObserver for this view's hierarchy. The view tree observer can be used to get notifications when global events, like layout, happen. The returned ViewTreeObserver observer is not guaranteed to remain valid for the lifetime of this View. If the caller of this method keeps a long-lived reference to ViewTreeObserver, it should always check for the return value of ViewTreeObserver#isAlive(). Int getVisibility() Returns the visibility status for this view. Int getWidth() Return the width of your view. Int getWindowAttachCount() WindowId! getWindowId() Retrieve the WindowId for the window this view is currently attached to. WindowInsetsController? getWindowInsetsController() Retrieves the single WindowInsetsController of the window this view is attached to. Int getWindowSystemUiVisibility() Returns the current system UI visibility that is currently set for the entire window. This is the combination of the setSystemUiVisibility(int) values supplied by all of the views in the window. IBinder! getWindowToken() Retrieve a unique token identifying the window this view is attached to. Int getWindowVisibility() Returns the current visibility of the window this view is attached to (either GONE, INVISIBLE, or VISIBLE). Unit getWindowVisibleDisplayFrame(outRect: Rect!) Retrieve the overall visible display size in which the window this view is attached to has been positioned in. This takes into account screen decorations above the window, for both cases where the window itself is being position inside of them or the window is being placed under then and covered insets are used for the window to position its content inside. In effect, this tells you the available area where content can be placed and remain visible to users. Float getX() The visual x position of this view, in pixels. This is equivalent to the translationX property plus the current left property. Float getY() The visual y position of this view, in pixels. This is equivalent to the translationY property plus the current top property. Float getZ() The visual z position of this view, in pixels. This is equivalent to the translationZ property plus the current elevation property. Boolean hasExplicitFocusable() Returns true if this view is focusable or if it contains a reachable View for which hasExplicitFocusable() returns true. A "reachable hasExplicitFocusable()" is a view whose parents do not block descendants focus. Only VISIBLE views for which getFocusable() would return FOCUSABLE are considered focusable. This method preserves the pre-Build.VERSION_CODES#O behavior of hasFocusable() in that only views explicitly set focusable will cause this method to return true. A view set to FOCUSABLE_AUTO that resolves to focusable will not. Boolean hasFocus() Returns true if this view has focus itself, or is the ancestor of the view that has focus. Boolean hasFocusable() Returns true if this view is focusable or if it contains a reachable View for which hasFocusable() returns true. A "reachable hasFocusable()" is a view whose parents do not block descendants focus. Only VISIBLE views are considered focusable. As of Build.VERSION_CODES#O views that are determined to be focusable through FOCUSABLE_AUTO will also cause this method to return true. Apps that declare a android.content.pm.ApplicationInfo#targetSdkVersion of earlier than Build.VERSION_CODES#O will continue to see this method return false for views not explicitly marked as focusable. Use hasExplicitFocusable() if you require the pre-Build.VERSION_CODES#O behavior. Boolean hasNestedScrollingParent() Returns true if this view has a nested scrolling parent. The presence of a nested scrolling parent indicates that this view has initiated a nested scroll and it was accepted by an ancestor view further up the view hierarchy. Boolean hasOnClickListeners() Return whether this view has an attached OnClickListener. Returns true if there is a listener, false if there is none. Boolean hasOnLongClickListeners() Return whether this view has an attached OnLongClickListener. Returns true if there is a listener, false if there is none. Boolean hasPointerCapture() Checks pointer capture status. Boolean hasTransientState() Indicates whether the view is currently tracking transient state that the app should not need to concern itself with saving and restoring, but that the framework should take special note to preserve when possible. A view with transient state cannot be trivially rebound from an external data source, such as an adapter binding item views in a list. This may be because the view is performing an animation, tracking user selection of content, or similar. Boolean hasWindowFocus() Returns true if this view is in a window that currently has window focus. Note that this is not the same as the view itself having focus. View! inflate(context: Context!, resource: Int, root: ViewGroup!) Inflate a view from an XML resource. This convenience method wraps the LayoutInflater class, which provides a full range of options for view inflation. Unit invalidate(dirty: Rect!) Mark the area defined by dirty as needing to be drawn. If the view is visible, onDraw(android.graphics.Canvas) will be called at some point in the future. This must be called from a UI thread. To call from a non-UI thread, call postInvalidate(). WARNING: In API 19 and below, this method may be destructive to dirty. Unit invalidate(l: Int, t: Int, r: Int, b: Int) Mark the area defined by the rect (l,t,r,b) as needing to be drawn. The coordinates of the dirty rect are relative to the view. If the view is visible, onDraw(android.graphics.Canvas) will be called at some point in the future. This must be called from a UI thread. To call from a non-UI thread, call postInvalidate(). Unit invalidate() Invalidate the whole view. If the view is visible, onDraw(android.graphics.Canvas) will be called at some point in the future. This must be called from a UI thread. To call from a non-UI thread, call postInvalidate(). Unit invalidateDrawable(drawable: Drawable) Invalidates the specified Drawable. Unit invalidateOutline() Called to rebuild this View's Outline from its outline provider Boolean isAccessibilityDataSensitive() Whether this view should restrict accessibility service access only to services that have the android.accessibilityservice.AccessibilityServiceInfo#isAccessibilityTool property set to true. See default behavior provided by ACCESSIBILITY_DATA_SENSITIVE_AUTO. Otherwise, returns true for ACCESSIBILITY_DATA_SENSITIVE_YES or false for ACCESSIBILITY_DATA_SENSITIVE_NO. Boolean isAccessibilityFocused() Returns whether this View is accessibility focused. Boolean isAccessibilityHeading() Gets whether this view is a heading for accessibility purposes. Boolean isActivated() Indicates the activation state of this view. Boolean isAttachedToWindow() Returns true if this view is currently attached to a window. Boolean isAutoHandwritingEnabled() Return whether the View allows automatic handwriting initiation. Returns true if automatic handwriting initiation is enabled, and vice versa. Boolean isClickable() Indicates whether this view reacts to click events or not. Boolean isContentSensitive() Returns whether this view displays sensitive content, based on the value explicitly set by setContentSensitivity(int). Boolean isContextClickable() Indicates whether this view reacts to context clicks or not. Boolean isCredential() Gets the mode for determining whether this view is a credential. See setIsCredential(boolean). Boolean isDirty() True if this view has changed since the last time being drawn. Boolean isDrawingCacheEnabled() Indicates whether the drawing cache is enabled for this view. Boolean isDuplicateParentStateEnabled() Indicates whether this duplicates its drawable state from its parent. Boolean isEnabled() Returns the enabled status for this view. The interpretation of the enabled state varies by subclass. Boolean isFocusable() Returns whether this View is currently able to take focus. Boolean isFocusableInTouchMode() When a view is focusable, it may not want to take focus when in touch mode. For example, a button would like focus when the user is navigating via a D-pad so that the user can click on it, but once the user starts touching the screen, the button shouldn't take focus Boolean isFocused() Returns true if this view has focus Boolean isFocusedByDefault() Returns whether this View should receive focus when the focus is restored for the view hierarchy containing this view. Focus gets restored for a view hierarchy when the root of the hierarchy gets added to a window or serves as a target of cluster navigation. Boolean isForceDarkAllowed() See setForceDarkAllowed(boolean) Boolean isHandwritingDelegate() Returns whether this view has been set as a handwriting delegate by setIsHandwritingDelegate. Boolean isHapticFeedbackEnabled() Boolean isHardwareAccelerated() Indicates whether this view is attached to a hardware accelerated window or not. Even if this method returns true, it does not mean that every call to draw(android.graphics.Canvas) will be made with an hardware accelerated android.graphics.Canvas. For instance, if this view is drawn onto an offscreen android.graphics.Bitmap and its window is hardware accelerated, android.graphics.Canvas#isHardwareAccelerated() will likely return false, and this method will return true. Boolean isHorizontalFadingEdgeEnabled() Indicate whether the horizontal edges are faded when the view is scrolled horizontally. Boolean isHorizontalScrollBarEnabled() Indicate whether the horizontal scrollbar should be drawn or not. The scrollbar is not drawn by default. Boolean isHovered() Returns true if the view is currently hovered. Boolean isImportantForAccessibility() Computes whether this view should be exposed for accessibility. In general, views that are interactive or provide information are exposed while views that serve only as containers are hidden. If an ancestor of this view has importance IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, this method returns false. Otherwise, the value is computed according to the view's getImportantForAccessibility() value: IMPORTANT_FOR_ACCESSIBILITY_NO or IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, return false IMPORTANT_FOR_ACCESSIBILITY_YES, return true IMPORTANT_FOR_ACCESSIBILITY_AUTO, return true if view satisfies any of the following: Is actionable, e.g. isClickable(), isLongClickable(), isContextClickable(), isScreenReaderFocusable(), or isFocusable() Has an AccessibilityDelegate Has an AccessibilityNodeProvider Has an interaction listener, e.g. OnTouchListener, OnKeyListener, etc. Is an accessibility live region, e.g. getAccessibilityLiveRegion() is not ACCESSIBILITY_LIVE_REGION_NONE. Has an accessibility pane title, see setAccessibilityPaneTitle Is an accessibility heading, see setAccessibilityHeading(boolean). Boolean isImportantForAutofill() Hints the Android System whether the android.app.assist.AssistStructure.ViewNode associated with this view is considered important for autofill purposes. Generally speaking, a view is important for autofill if: The view can be autofilled by an android.service.autofill.AutofillService. The view contents can help an android.service.autofill.AutofillService determine how other views can be autofilled. For example, view containers should typically return false for performance reasons (since the important info is provided by their children), but if its properties have relevant information (for example, a resource id called credentials, it should return true. On the other hand, views representing labels or editable fields should typically return true, but in some cases they could return false (for example, if they're part of a "Captcha" mechanism). The value returned by this method depends on the value returned by getImportantForAutofill(): if it returns IMPORTANT_FOR_AUTOFILL_YES or IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, then it returns true if it returns IMPORTANT_FOR_AUTOFILL_NO or IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS, then it returns false if it returns IMPORTANT_FOR_AUTOFILL_AUTO, then it uses some simple heuristics that can return true in some cases (like a container with a resource id), but false in most. otherwise, it returns false. The behavior of importances depends on Android version: For android.os.Build.VERSION_CODES#TIRAMISU and below: When a view is considered important for autofill: The view might automatically trigger an autofill request when focused on. The contents of the view are included in the ViewStructure used in an autofill request. On the other hand, when a view is considered not important for autofill: The view never automatically triggers autofill requests, but it can trigger a manual request through AutofillManager#requestAutofill(View). The contents of the view are not included in the ViewStructure used in an autofill request, unless the request has the AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS flag. For android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE and above: The system uses importance, along with other view properties and other optimization factors, to determine if a view should trigger autofill on focus. The contents of IMPORTANT_FOR_AUTOFILL_AUTO, IMPORTANT_FOR_AUTOFILL_YES, IMPORTANT_FOR_AUTOFILL_NO, IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, and IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS views will be included in the ViewStructure used in an autofill request. Boolean isImportantForContentCapture() Hints the Android System whether this view is considered important for content capture, based on the value explicitly set by setImportantForContentCapture(int) and heuristics when it's IMPORTANT_FOR_CONTENT_CAPTURE_AUTO. See ContentCaptureManager for more info about content capture. Boolean isInEditMode() Indicates whether this View is currently in edit mode. A View is usually in edit mode when displayed within a developer tool. For instance, if this View is being drawn by a visual user interface builder, this method should return true. Subclasses should check the return value of this method to provide different behaviors if their normal behavior might interfere with the host environment. For instance: the class spawns a thread in its constructor, the drawing code relies on device-specific features, etc. This method is usually checked in the drawing code of custom widgets. Boolean isInLayout() Returns whether the view hierarchy is currently undergoing a layout pass. This information is useful to avoid situations such as calling requestLayout() during a layout pass. Boolean isInTouchMode() Returns the touch mode state associated with this view. Attached views return the touch mode state from the associated window's display. Detached views just return the default touch mode value defined in com.android.internal.R.bool.config_defaultInTouchMode. Touch mode is entered once the user begins interacting with the device by touch, and affects various things like whether focus highlight is always visible to the user. Boolean isKeyboardNavigationCluster() Returns whether this View is a root of a keyboard navigation cluster. Boolean isLaidOut() Returns true if this view has been through at least one layout since it was last attached to or detached from a window. Boolean isLayoutDirectionResolved() Boolean isLayoutRequested() Indicates whether or not this view's layout will be requested during the next hierarchy layout pass. Boolean isLongClickable() Indicates whether this view reacts to long click events or not. Boolean isNestedScrollingEnabled() Returns true if nested scrolling is enabled for this view. If nested scrolling is enabled and this View class implementation supports it, this view will act as a nested scrolling child view when applicable, forwarding data about the scroll operation in progress to a compatible and cooperating nested scrolling parent. Boolean isOpaque() Indicates whether this View is opaque. An opaque View guarantees that it will draw all the pixels overlapping its bounds using a fully opaque color. Subclasses of View should override this method whenever possible to indicate whether an instance is opaque. Opaque Views are treated in a special way by the View hierarchy, possibly allowing it to perform optimizations during invalidate/draw passes. Boolean isPaddingOffsetRequired() If the View draws content inside its padding and enables fading edges, it needs to support padding offsets. Padding offsets are added to the fading edges to extend the length of the fade so that it covers pixels drawn inside the padding. Subclasses of this class should override this method if they need to draw content inside the padding. Boolean isPaddingRelative() Return if the padding has been set through relative values setPaddingRelative(int,int,int,int) or through Boolean isPivotSet() Returns whether or not a pivot has been set by a call to setPivotX(float) or setPivotY(float). If no pivot has been set then the pivot will be the center of the view. Boolean isPreferKeepClear() Retrieve the preference for this view to be kept clear. This is set either by setPreferKeepClear or via the attribute android.R.styleable#View_preferKeepClear. If this is true, the system will ignore the Rects set by setPreferKeepClearRects and try to keep the whole view clear. Boolean isPressed() Indicates whether the view is currently in pressed state. Unless setPressed(boolean) is explicitly called, only clickable views can enter the pressed state. Boolean isSaveEnabled() Indicates whether this view will save its state (that is, whether its onSaveInstanceState method will be called). Boolean isSaveFromParentEnabled() Indicates whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent. The default is true; if false, these views will not be saved unless saveHierarchyState(android.util.SparseArray) is called directly on this view. Boolean isScreenReaderFocusable() Returns whether the view should be treated as a focusable unit by screen reader accessibility tools. Note: Use androidx.core.view.ViewCompat#setScreenReaderFocusable(View, boolean) for backwards-compatibility. Boolean isScrollContainer() Indicates whether this view is one of the set of scrollable containers in its window. Boolean isScrollbarFadingEnabled() Returns true if scrollbars will fade when this view is not scrolling Boolean isSelected() Indicates the selection state of this view. Boolean isShowingLayoutBounds() Returns true when the View is attached and the system developer setting to show the layout bounds is enabled or false otherwise. Boolean isShown() Returns the visibility of this view and all of its ancestors Boolean isSoundEffectsEnabled() Boolean isTemporarilyDetached() Tells whether the View is in the state between onStartTemporaryDetach() and onFinishTemporaryDetach(). This method always returns true when called directly or indirectly from onStartTemporaryDetach(). The return value when called directly or indirectly from onFinishTemporaryDetach(), however, depends on the OS version. true on API 24 false on API 25} and later Boolean isTextAlignmentResolved() Boolean isTextDirectionResolved() Boolean isVerticalFadingEdgeEnabled() Indicate whether the vertical edges are faded when the view is scrolled horizontally. Boolean isVerticalScrollBarEnabled() Indicate whether the vertical scrollbar should be drawn or not. The scrollbar is not drawn by default. Boolean isVisibleToUserForAutofill(virtualId: Int) Computes whether this virtual autofill view is visible to the user. Note: By default it returns true, but views providing a virtual hierarchy view must override it. Unit jumpDrawablesToCurrentState() Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view. Also calls StateListAnimator#jumpToCurrentState() if there is a StateListAnimator attached to this view. If you override this method you must call through to the superclass implementation. View! keyboardNavigationClusterSearch(currentCluster: View!, direction: Int) Find the nearest keyboard navigation cluster in the specified direction. This does not actually give focus to that cluster. Unit layout(l: Int, t: Int, r: Int, b: Int) Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism. (The first is measuring). In this phase, each parent calls layout on all of its children to position them. This is typically done using the child measurements that were stored in the measure pass(). Derived classes should not override this method. Derived classes with children should override onLayout. In that method, they should call layout on each of their children. Unit measure(widthMeasureSpec: Int, heightMeasureSpec: Int) This is called to find out how big a view should be. The parent supplies constraint information in the width and height parameters. The actual measurement work of a view is performed in onMeasure(int,int), called by this method. Therefore, only onMeasure(int,int) can and must be overridden by subclasses. IntArray! mergeDrawableStates(baseState: IntArray!, additionalState: IntArray!) Merge your own state values in additionalState into the base state values baseState that were returned by onCreateDrawableState(int). Unit offsetLeftAndRight(offset: Int) Offset this view's horizontal location by the specified amount of pixels. Unit offsetTopAndBottom(offset: Int) Offset this view's vertical location by the specified number of pixels. Unit onAnimationEnd() Invoked by a parent ViewGroup to notify the end of the animation currently associated with this view. If you override this method, always call super.onAnimationEnd(); If you override this method you must call through to the superclass implementation. Unit onAnimationStart() Invoked by a parent ViewGroup to notify the start of the animation currently associated with this view. If you override this method, always call super.onAnimationStart(); If you override this method you must call through to the superclass implementation. WindowInsets! onApplyWindowInsets(insets: WindowInsets!) Called when the view should apply WindowInsets according to its internal policy. This method should be overridden by views that wish to apply a policy different from or in addition to the default behavior. Clients that wish to force a view subtree to apply insets should call dispatchApplyWindowInsets(android.view.WindowInsets). Clients may supply an OnApplyWindowInsetsListener to a view. If one is set it will be called during dispatch instead of this method. The listener may optionally call this method from its own implementation if it wishes to apply the view's default insets policy in addition to its own. Implementations of this method should either return the insets parameter unchanged or a new WindowInsets cloned from the supplied insets with any insets consumed that this view applied itself. This allows new inset types added in future platform versions to pass through existing implementations unchanged without being erroneously consumed. By default if a view's fitsSystemWindows property is set then the view will consume the system window insets and apply them as padding for the view. Unit onCancelPendingInputEvents() Called as the result of a call to cancelPendingInputEvents() on this view or a parent view. This method is responsible for removing any pending high-level input events that were posted to the event queue to run later. Custom view classes that post their own deferred high-level events via post(java.lang.Runnable), postDelayed(java.lang.Runnable,long) or android.os.Handler should override this method, call super.onCancelPendingInputEvents() and remove those callbacks as appropriate. Boolean onCapturedPointerEvent(event: MotionEvent!) Implement this method to handle captured pointer events Boolean onCheckIsTextEditor() Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it. Subclasses should override this if they implement onCreateInputConnection(android.view.inputmethod.EditorInfo) to return true if a call on that method would return a non-null InputConnection, and they are really a first-class editor that the user would normally start typing on when the go into a window containing your view. The default implementation always returns false. This does not mean that its onCreateInputConnection(android.view.inputmethod.EditorInfo) will not be called or the user can not otherwise perform edits on your view; it is just a hint to the system that this is not the primary purpose of this view. Unit onConfigurationChanged(newConfig: Configuration!) Called when the current configuration of the resources being used by the application have changed. You can use this to decide when to reload resources that can changed based on orientation and other configuration characteristics. You only need to use this if you are not relying on the normal android.app.Activity mechanism of recreating the activity instance upon a configuration change. Unit onCreateContextMenu(menu: ContextMenu!) Views should implement this if the view itself is going to add items to the context menu. IntArray! onCreateDrawableState(extraSpace: Int) Generate the new android.graphics.drawable.Drawable state for this view. This is called by the view system when the cached Drawable state is determined to be invalid. To retrieve the current state, you should use getDrawableState. InputConnection! onCreateInputConnection(outAttrs: EditorInfo!) Create a new InputConnection for an InputMethod to interact with the view. The default implementation returns null, since it doesn't support input methods. You can override this to implement such support. This is only needed for views that take focus and text input. When implementing this, you probably also want to implement onCheckIsTextEditor() to indicate you will return a non-null InputConnection. Also, take good care to fill in the android.view.inputmethod.EditorInfo object correctly and in its entirety, so that the connected IME can rely on its values. For example, android.view.inputmethod.EditorInfo#initialSelStart and android.view.inputmethod.EditorInfo#initialSelEnd members must be filled in with the correct cursor position for IMEs to work correctly with your application. Unit onCreateViewTranslationRequest(supportedFormats: IntArray, requestsCollector: Consumer<ViewTranslationRequest!>) Collects a ViewTranslationRequest which represents the content to be translated in the view. The default implementation does nothing. Unit onCreateVirtualViewTranslationRequests(virtualIds: LongArray, supportedFormats: IntArray, requestsCollector: Consumer<ViewTranslationRequest!>) Collects ViewTranslationRequests which represents the content to be translated for the virtual views in the host view. This is called if this view returned a virtual view structure from onProvideContentCaptureStructure and the system determined that those virtual views were relevant for translation. The default implementation does nothing. Unit onDisplayHint(hint: Int) Gives this view a hint about whether is displayed or not. For instance, when a View moves out of the screen, it might receives a display hint indicating the view is not displayed. Applications should not rely on this hint as there is no guarantee that they will receive one. Boolean onDragEvent(event: DragEvent!) Handles drag events sent by the system following a call to startDragAndDrop(). The system calls this method and passes a DragEvent object in response to drag and drop events. This method can then call DragEvent#getAction() to determine the state of the drag and drop operation. The default implementation returns false unless an OnReceiveContentListener has been set for this view (see setOnReceiveContentListener), in which case the default implementation does the following: Returns true for an ACTION_DRAG_STARTED event Calls performReceiveContent for an ACTION_DROP event Returns true for an ACTION_DROP event if the OnReceiveContentListener consumed some or all of the content Unit onDraw(canvas: Canvas) Implement this to do your drawing. Unit onDrawForeground(canvas: Canvas) Draw any foreground content for this view. Foreground content may consist of scroll bars, a foreground drawable or other view-specific decorations. The foreground is drawn on top of the primary view content. Unit onDrawScrollBars(canvas: Canvas) Request the drawing of the horizontal and the vertical scrollbar. The scrollbars are painted only if they have been awakened first. Boolean onFilterTouchEventForSecurity(event: MotionEvent!) Filter the touch event to apply security policies. Unit onFinishInflate() Finalize inflating a view from XML. This is called as the last phase of inflation, after all child views have been added. Even if the subclass overrides onFinishInflate, they should always be sure to call the super method, so that we get called. If you override this method you must call through to the superclass implementation. Unit onFinishTemporaryDetach() Called after onStartTemporaryDetach when the container is done changing the view. Boolean onGenericMotionEvent(event: MotionEvent!) Implement this method to handle generic motion events. Generic motion events describe joystick movements, hover events from mouse or stylus devices, trackpad touches, scroll wheel movements and other motion events not handled by onTouchEvent(android.view.MotionEvent) or onTrackballEvent(android.view.MotionEvent). The source of the motion event specifies the class of input that was received. Implementations of this method must examine the bits in the source before processing the event. The following code example shows how this is done. Generic motion events with source class InputDevice#SOURCE_CLASS_POINTER are delivered to the view under the pointer. All other generic motion events are delivered to the focused view. public boolean onGenericMotionEvent(MotionEvent event) { if (event.isFromSource(InputDevice.SOURCE_CLASS_JOYSTICK)) { if (event.getAction() == MotionEvent.ACTION_MOVE) { // process the joystick movement... return true; } } if (event.isFromSource(InputDevice.SOURCE_CLASS_POINTER)) { switch (event.getAction()) { case MotionEvent.ACTION_HOVER_MOVE: // process the hover movement... return true; case MotionEvent.ACTION_SCROLL: // process the scroll wheel movement... return true; } } return super.onGenericMotionEvent(event); } Unit onHoverChanged(hovered: Boolean) Implement this method to handle hover state changes. This method is called whenever the hover state changes as a result of a call to setHovered. Boolean onHoverEvent(event: MotionEvent!) Implement this method to handle hover events. This method is called whenever a pointer is hovering into, over, or out of the bounds of a view and the view is not currently being touched. Hover events are represented as pointer events with action MotionEvent#ACTION_HOVER_ENTER, MotionEvent#ACTION_HOVER_MOVE, or MotionEvent#ACTION_HOVER_EXIT. The view receives a hover event with action MotionEvent#ACTION_HOVER_ENTER when the pointer enters the bounds of the view. The view receives a hover event with action MotionEvent#ACTION_HOVER_MOVE when the pointer has already entered the bounds of the view and has moved. The view receives a hover event with action MotionEvent#ACTION_HOVER_EXIT when the pointer has exited the bounds of the view or when the pointer is about to go down due to a button click, tap, or similar user action that causes the view to be touched. The view should implement this method to return true to indicate that it is handling the hover event, such as by changing its drawable state. The default implementation calls setHovered to update the hovered state of the view when a hover enter or hover exit event is received, if the view is enabled and is clickable. The default implementation also sends hover accessibility events. Unit onInitializeAccessibilityEvent(event: AccessibilityEvent!) Initializes an AccessibilityEvent with information about this View which is the event source. In other words, the source of an accessibility event is the view whose state change triggered firing the event. Example: Setting the password property of an event in addition to properties set by the super implementation: public void onInitializeAccessibilityEvent(AccessibilityEvent event) { super.onInitializeAccessibilityEvent(event); event.setPassword(true); } If an AccessibilityDelegate has been specified via calling setAccessibilityDelegate(android.view.View.AccessibilityDelegate) its AccessibilityDelegate#onInitializeAccessibilityEvent(View, AccessibilityEvent) is responsible for handling this call. Note: Always call the super implementation before adding information to the event, in case the default implementation has basic information to add. If you override this method you must call through to the superclass implementation. Unit onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo!) Initializes an AccessibilityNodeInfo with information about this view. The base implementation sets: AccessibilityNodeInfo#setParent(View), AccessibilityNodeInfo#setBoundsInParent(Rect), AccessibilityNodeInfo#setBoundsInScreen(Rect), AccessibilityNodeInfo#setPackageName(CharSequence), AccessibilityNodeInfo#setClassName(CharSequence), AccessibilityNodeInfo#setContentDescription(CharSequence), AccessibilityNodeInfo#setEnabled(boolean), AccessibilityNodeInfo#setClickable(boolean), AccessibilityNodeInfo#setFocusable(boolean), AccessibilityNodeInfo#setFocused(boolean), AccessibilityNodeInfo#setLongClickable(boolean), AccessibilityNodeInfo#setSelected(boolean), AccessibilityNodeInfo#setContextClickable(boolean) Subclasses should override this method, call the super implementation, and set additional attributes. If an AccessibilityDelegate has been specified via calling setAccessibilityDelegate(android.view.View.AccessibilityDelegate) its AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo) is responsible for handling this call. If you override this method you must call through to the superclass implementation. Boolean onKeyDown(keyCode: Int, event: KeyEvent!) Default implementation of KeyEvent.Callback.onKeyDown(): perform press of the view when KeyEvent#KEYCODE_DPAD_CENTER or KeyEvent#KEYCODE_ENTER is released, if the view is enabled and clickable. Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses. Boolean onKeyLongPress(keyCode: Int, event: KeyEvent!) Default implementation of KeyEvent.Callback.onKeyLongPress(): always returns false (doesn't handle the event). Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses. Boolean onKeyMultiple(keyCode: Int, repeatCount: Int, event: KeyEvent!) Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event). Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses. Boolean onKeyPreIme(keyCode: Int, event: KeyEvent!) Handle a key event before it is processed by any input method associated with the view hierarchy. This can be used to intercept key events in special situations before the IME consumes them; a typical example would be handling the BACK key to update the application's UI instead of allowing the IME to see it and close itself. Due to a bug, this function is not called for BACK key events on Android T and U, when the IME is shown. Boolean onKeyShortcut(keyCode: Int, event: KeyEvent!) Called on the focused view when a key shortcut event is not handled. Override this method to implement local key shortcuts for the View. Key shortcuts can also be implemented by setting the shortcut property of menu items. Boolean onKeyUp(keyCode: Int, event: KeyEvent!) Default implementation of KeyEvent.Callback.onKeyUp(): perform clicking of the view when KeyEvent#KEYCODE_DPAD_CENTER, KeyEvent#KEYCODE_ENTER or KeyEvent#KEYCODE_SPACE is released. Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses. Unit onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int) Called from layout when this view should assign a size and position to each of its children. Derived classes with children should override this method and call layout on each of their children. Unit onOverScrolled(scrollX: Int, scrollY: Int, clampedX: Boolean, clampedY: Boolean) Called by overScrollBy(int,int,int,int,int,int,int,int,boolean) to respond to the results of an over-scroll operation. Unit onPointerCaptureChange(hasCapture: Boolean) Called when the window has just acquired or lost pointer capture. If you override this method you must call through to the superclass implementation. Unit onPopulateAccessibilityEvent(event: AccessibilityEvent!) Called from dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent) giving a chance to this View to populate the accessibility event with its text content. Note: This method should only be used with event.setText(). Avoid mutating other event state in this method. Instead, follow the practices described in dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent). In general, put UI metadata in the node for services to easily query, than in transient events. Example: Adding formatted date string to an accessibility event in addition to the text added by the super implementation: public void onPopulateAccessibilityEvent(AccessibilityEvent event) { super.onPopulateAccessibilityEvent(event); final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY; String selectedDateUtterance = DateUtils.formatDateTime(mContext, mCurrentDate.getTimeInMillis(), flags); event.getText().add(selectedDateUtterance); } If an AccessibilityDelegate has been specified via calling setAccessibilityDelegate(android.view.View.AccessibilityDelegate) its AccessibilityDelegate#onPopulateAccessibilityEvent(View, AccessibilityEvent) is responsible for handling this call. Note: Always call the super implementation before adding information to the event, in case the default implementation has basic information to add. If you override this method you must call through to the superclass implementation. Unit onProvideAutofillStructure(structure: ViewStructure!, flags: Int) Populates a ViewStructure to fullfil an autofill request. The structure should contain at least the following properties: Autofill id (ViewStructure#setAutofillId(AutofillId, int)). Autofill type (ViewStructure#setAutofillType(int)). Autofill value (ViewStructure#setAutofillValue(AutofillValue)). Whether the data is sensitive (ViewStructure#setDataIsSensitive(boolean)). It's also recommended to set the following properties - the more properties the structure has, the higher the chances of an android.service.autofill.AutofillService properly using the structure: Autofill hints (ViewStructure#setAutofillHints(String[])). Autofill options (ViewStructure#setAutofillOptions(CharSequence[])) when the view can only be filled with predefined values (typically used when the autofill type is AUTOFILL_TYPE_LIST). Resource id (ViewStructure#setId(int, String, String, String)). Class name (ViewStructure#setClassName(String)). Content description (ViewStructure#setContentDescription(CharSequence)). Visual properties such as visibility (ViewStructure#setVisibility(int)), dimensions (ViewStructure#setDimens(int, int, int, int, int, int)), and opacity (ViewStructure#setOpaque(boolean)). For views representing text fields, text properties such as the text itself (ViewStructure#setText(CharSequence)), text hints (ViewStructure#setHint(CharSequence), input type (ViewStructure#setInputType(int)), For views representing HTML nodes, its web domain (ViewStructure#setWebDomain(String)) and HTML properties ((ViewStructure#setHtmlInfo(android.view.ViewStructure.HtmlInfo)). The default implementation of this method already sets most of these properties based on related View methods (for example, the autofill id is set using getAutofillId(), the autofill type set using getAutofillType(), etc.), and views in the standard Android widgets library also override it to set their relevant properties (for example, android.widget.TextView already sets the text properties), so it's recommended to only override this method (and call super.onProvideAutofillStructure()) when: The view contents does not include PII (Personally Identifiable Information), so it can call ViewStructure#setDataIsSensitive(boolean) passing false. The view can only be autofilled with predefined options, so it can call ViewStructure#setAutofillOptions(CharSequence[]). Note: The left and top values set in ViewStructure#setDimens(int, int, int, int, int, int) must be relative to the next ViewGroup#isImportantForAutofill() predecessor view included in the structure. Views support the Autofill Framework mainly by: Providing the metadata defining what the view means and how it can be autofilled. Notifying the Android System when the view value changed by calling AutofillManager#notifyValueChanged(View). Implementing the methods that autofill the view. This method is responsible for the former; autofill(android.view.autofill.AutofillValue) is responsible for the latter. Unit onProvideAutofillVirtualStructure(structure: ViewStructure!, flags: Int) Populates a ViewStructure containing virtual children to fullfil an autofill request. This method should be used when the view manages a virtual structure under this view. For example, a view that draws input fields using draw(android.graphics.Canvas). When implementing this method, subclasses must follow the rules below: Add virtual children by calling the ViewStructure#newChild(int) or ViewStructure#asyncNewChild(int) methods, where the id is an unique id identifying the children in the virtual structure. The children hierarchy can have multiple levels if necessary, but ideally it should exclude intermediate levels that are irrelevant for autofill; that would improve the autofill performance. Also implement autofill(android.util.SparseArray) to autofill the virtual children. Set the autofill properties of the child structure as defined by onProvideAutofillStructure(android.view.ViewStructure,int), using ViewStructure#setAutofillId(AutofillId, int) to set its autofill id. Call android.view.autofill.AutofillManager#notifyViewEntered(View, int, Rect) and/or android.view.autofill.AutofillManager#notifyViewExited(View, int) when the focused virtual child changed. Override isVisibleToUserForAutofill(int) to allow the platform to query whether a given virtual view is visible to the user in order to support triggering save when all views of interest go away. Call android.view.autofill.AutofillManager#notifyValueChanged(View, int, AutofillValue) when the value of a virtual child changed. Call android.view.autofill.AutofillManager#notifyViewVisibilityChanged(View, int, boolean) when the visibility of a virtual child changed. Call android.view.autofill.AutofillManager#notifyViewClicked(View, int) when a virtual child is clicked. Call AutofillManager#commit() when the autofill context of the view structure changed and the current context should be committed (for example, when the user tapped a SUBMIT button in an HTML page). Call AutofillManager#cancel() when the autofill context of the view structure changed and the current context should be canceled (for example, when the user tapped a CANCEL button in an HTML page). Provide ways for users to manually request autofill by calling AutofillManager#requestAutofill(View, int, Rect). The left and top values set in ViewStructure#setDimens(int, int, int, int, int, int) must be relative to the next ViewGroup#isImportantForAutofill() predecessor view included in the structure. Views with virtual children support the Autofill Framework mainly by: Providing the metadata defining what the virtual children mean and how they can be autofilled. Implementing the methods that autofill the virtual children. This method is responsible for the former; autofill(android.util.SparseArray) is responsible for the latter. Unit onProvideContentCaptureStructure(structure: ViewStructure, flags: Int) Populates a ViewStructure for content capture. This method is called after a view that is eligible for content capture (for example, if it 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 ContentCaptureSession#notifyViewAppeared(ViewStructure). The default implementation of this method sets the most relevant properties based on related 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 super.onProvideContentCaptureStructure(). Note: 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 changed by calling ContentCaptureSession#notifyViewAppeared(ViewStructure), ContentCaptureSession#notifyViewDisappeared(AutofillId), and ContentCaptureSession#notifyViewTextChanged(AutofillId, CharSequence) respectively. The structure for a child must be created using ContentCaptureSession#newVirtualViewStructure(AutofillId, long), and the autofillId for a child can be obtained either through childStructure.getAutofillId() or ContentCaptureSession#newAutofillId(AutofillId, long). When the virtual view hierarchy represents a web page, you should also: Call ContentCaptureManager#getContentCaptureConditions() to infer content capture events should be generate for that URL. Create a new ContentCaptureSession child for every HTML element that renders a new URL (like an IFRAME) and use that session to notify events from that subtree. Note: the following methods of the structure will be ignored: ViewStructure#setChildCount(int) ViewStructure#addChildCount(int) ViewStructure#getChildCount() ViewStructure#newChild(int) ViewStructure#asyncNewChild(int) ViewStructure#asyncCommit() ViewStructure#setWebDomain(String) ViewStructure#newHtmlInfoBuilder(String) ViewStructure#setHtmlInfo(android.view.ViewStructure.HtmlInfo) ViewStructure#setDataIsSensitive(boolean) ViewStructure#setAlpha(float) ViewStructure#setElevation(float) ViewStructure#setTransformation(Matrix) Unit onProvideStructure(structure: ViewStructure!) Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData. Unit onProvideVirtualStructure(structure: ViewStructure!) Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData to generate additional virtual structure under this view. The default implementation uses 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. ContentInfo? onReceiveContent(payload: ContentInfo) Implements the default behavior for receiving content for this type of view. The default view implementation is a no-op (returns the passed-in content without acting on it). Widgets should override this method to define their default behavior for receiving content. Apps should set a listener to provide app-specific handling for receiving content. See setOnReceiveContentListener and performReceiveContent for more info. PointerIcon! onResolvePointerIcon(event: MotionEvent!, pointerIndex: Int) Resolve the pointer icon that should be used for specified pointer in the motion event. The default implementation will resolve the pointer icon to one set using setPointerIcon(android.view.PointerIcon) for mouse devices. Subclasses may override this to customize the icon for the given pointer. For example, the pointer icon for a stylus pointer can be resolved in the following way: @Override public PointerIcon onResolvePointerIcon(MotionEvent event, int pointerIndex) { final int toolType = event.getToolType(pointerIndex); if (!event.isFromSource(InputDevice.SOURCE_MOUSE) && event.isFromSource(InputDevice.SOURCE_STYLUS) && (toolType == MotionEvent.TOOL_TYPE_STYLUS || toolType == MotionEvent.TOOL_TYPE_ERASER)) { // Show this pointer icon only if this pointer is a stylus. return PointerIcon.getSystemIcon(mContext, PointerIcon.TYPE_WAIT); } // Use the default logic for determining the pointer icon for other non-stylus pointers, // like for the mouse cursor. return super.onResolvePointerIcon(event, pointerIndex); } Unit onRestoreInstanceState(state: Parcelable!) Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState. This function will never be called with a null state. If you override this method you must call through to the superclass implementation. Unit onRtlPropertiesChanged(layoutDirection: Int) Called when any RTL property (layout direction or text direction or text alignment) has been changed. Subclasses need to override this method to take care of cached information that depends on the resolved layout direction, or to inform child views that inherit their layout direction. The default implementation does nothing. Parcelable? onSaveInstanceState() Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can not be reconstructed later. For example, you will never store your current position on screen because that will be computed again when a new instance of the view is placed in its view hierarchy. Some examples of things you may store here: the current cursor position in a text view (but usually not the text itself since that is stored in a content provider or other persistent storage), the currently selected item in a list view. If you override this method you must call through to the superclass implementation. Unit onScreenStateChanged(screenState: Int) This method is called whenever the state of the screen this view is attached to changes. A state change will usually occurs when the screen turns on or off (whether it happens automatically or the user does it manually.) Unit onScrollCaptureSearch(localVisibleRect: Rect, windowOffset: Point, targets: Consumer<ScrollCaptureTarget!>) Called when scroll capture is requested, to search for appropriate content to scroll. If applicable, this view adds itself to the provided list for consideration, subject to the flags set by setScrollCaptureHint. Unit onScrollChanged(l: Int, t: Int, oldl: Int, oldt: Int) This is called in response to an internal scroll in this view (i.e., the view scrolled its own contents). This is typically as a result of scrollBy(int,int) or scrollTo(int,int) having been called. Unit onSizeChanged(w: Int, h: Int, oldw: Int, oldh: Int) This is called during layout when the size of this view has changed. If you were just added to the view hierarchy, you're called with the old values of 0. Unit onStartTemporaryDetach() This is called when a container is going to temporarily detach a child, with ViewGroup.detachViewFromParent. It will either be followed by onFinishTemporaryDetach() or onDetachedFromWindow() when the container is done. Boolean onTouchEvent(event: MotionEvent!) Implement this method to handle touch screen motion events. If this method is used to detect click actions, it is recommended that the actions be performed by implementing and calling performClick(). This will ensure consistent system behavior, including: obeying click sound preferences dispatching OnClickListener calls handling ACTION_CLICK when accessibility features are enabled Boolean onTrackballEvent(event: MotionEvent!) Implement this method to handle trackball motion events. The relative movement of the trackball since the last event can be retrieve with android.view.MotionEvent#getX and android.view.MotionEvent#getY. These are normalized so that a movement of 1 corresponds to the user pressing one DPAD key (so they will often be fractional values, representing the more fine-grained movement information available from a trackball). Unit onViewTranslationResponse(response: ViewTranslationResponse) Called when the content from View#onCreateViewTranslationRequest had been translated by the TranslationService. The ViewTranslationResponse should be saved here so that the ViewTranslationResponse can be used to display the translation when the system calls ViewTranslationCallback#onShowTranslation. The default implementation will set the ViewTranslationResponse that can be get from View#getViewTranslationResponse. Unit onVirtualViewTranslationResponses(response: LongSparseArray<ViewTranslationResponse!>) Called when the content from View#onCreateVirtualViewTranslationRequests had been translated by the TranslationService. The default implementation does nothing. Unit onVisibilityAggregated(isVisible: Boolean) Called when the user-visibility of this View is potentially affected by a change to this view itself, an ancestor view or the window this view is attached to. If you override this method you must call through to the superclass implementation. Unit onVisibilityChanged(changedView: View, visibility: Int) Called when the visibility of the view or an ancestor of the view has changed. Unit onWindowFocusChanged(hasWindowFocus: Boolean) Called when the window containing this view gains or loses focus. Note that this is separate from view focus: to receive key events, both your view and its window must have focus. If a window is displayed on top of yours that takes input focus, then your own window will lose focus but the view focus will remain unchanged. Unit onWindowSystemUiVisibilityChanged(visible: Int) Override to find out when the window's requested system UI visibility has changed, that is the value returned by getWindowSystemUiVisibility(). This is different from the callbacks received through setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener) in that this is only telling you about the local request of the window, not the actual values applied by the system. Boolean overScrollBy(deltaX: Int, deltaY: Int, scrollX: Int, scrollY: Int, scrollRangeX: Int, scrollRangeY: Int, maxOverScrollX: Int, maxOverScrollY: Int, isTouchEvent: Boolean) Scroll the view with standard behavior for scrolling beyond the normal content boundaries. Views that call this method should override onOverScrolled(int,int,boolean,boolean) to respond to the results of an over-scroll operation. Views can use this method to handle any touch or fling-based scrolling. Boolean performAccessibilityAction(action: Int, arguments: Bundle?) Performs the specified accessibility action on the view. For possible accessibility actions look at AccessibilityNodeInfo. If an AccessibilityDelegate has been specified via calling setAccessibilityDelegate(android.view.View.AccessibilityDelegate) its AccessibilityDelegate#performAccessibilityAction(View, int, Bundle) is responsible for handling this call. The default implementation will delegate AccessibilityNodeInfo#ACTION_SCROLL_BACKWARD and AccessibilityNodeInfo#ACTION_SCROLL_FORWARD to nested scrolling parents if nested scrolling is enabled on this view. Note: Avoid setting accessibility focus with AccessibilityNodeInfo#ACTION_ACCESSIBILITY_FOCUS. This is intended to be controlled by screen readers. Apps changing focus can confuse screen readers, so the resulting behavior can vary by device and screen reader version. Boolean performClick() Call this view's OnClickListener, if it is defined. Performs all normal actions associated with clicking: reporting accessibility event, playing a sound, etc. Boolean performContextClick(x: Float, y: Float) Call this view's OnContextClickListener, if it is defined. Boolean performContextClick() Call this view's OnContextClickListener, if it is defined. Boolean performHapticFeedback(feedbackConstant: Int) BZZZTT!!1! Provide haptic feedback to the user for this view. The framework will provide haptic feedback for some built in actions, such as long presses, but you may wish to provide feedback for your own widget. The feedback will only be performed if isHapticFeedbackEnabled() is true. Boolean performHapticFeedback(feedbackConstant: Int, flags: Int) BZZZTT!!1! Like performHapticFeedback(int), with additional options. Boolean performLongClick() Calls this view's OnLongClickListener, if it is defined. Invokes the context menu if the OnLongClickListener did not consume the event. Boolean performLongClick(x: Float, y: Float) Calls this view's OnLongClickListener, if it is defined. Invokes the context menu if the OnLongClickListener did not consume the event, anchoring it to an (x,y) coordinate. ContentInfo? performReceiveContent(payload: ContentInfo) Receives the given content. If no listener is set, invokes onReceiveContent. If a listener is set, invokes the listener instead; if the listener returns a non-null result, invokes onReceiveContent to handle it. Unit playSoundEffect(soundConstant: Int) Play a sound effect for this view. The framework will play sound effects for some built in actions, such as clicking, but you may wish to play these effects in your widget, for instance, for internal navigation. The sound effect will only be played if sound effects are enabled by the user, and isSoundEffectsEnabled() is true. Boolean post(action: Runnable!) Causes the Runnable to be added to the message queue. The runnable will be run on the user interface thread. Boolean postDelayed(action: Runnable!, delayMillis: Long) Causes the Runnable to be added to the message queue, to be run after the specified amount of time elapses. The runnable will be run on the user interface thread. Unit postInvalidate() Cause an invalidate to happen on a subsequent cycle through the event loop. Use this to invalidate the View from a non-UI thread. This method can be invoked from outside of the UI thread only when this View is attached to a window. Unit postInvalidate(left: Int, top: Int, right: Int, bottom: Int) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop. Use this to invalidate the View from a non-UI thread. This method can be invoked from outside of the UI thread only when this View is attached to a window. Unit postInvalidateDelayed(delayMilliseconds: Long) Cause an invalidate to happen on a subsequent cycle through the event loop. Waits for the specified amount of time. This method can be invoked from outside of the UI thread only when this View is attached to a window. Unit postInvalidateDelayed(delayMilliseconds: Long, left: Int, top: Int, right: Int, bottom: Int) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop. Waits for the specified amount of time. This method can be invoked from outside of the UI thread only when this View is attached to a window. Unit postInvalidateOnAnimation() Cause an invalidate to happen on the next animation time step, typically the next display frame. This method can be invoked from outside of the UI thread only when this View is attached to a window. Unit postInvalidateOnAnimation(left: Int, top: Int, right: Int, bottom: Int) Cause an invalidate of the specified area to happen on the next animation time step, typically the next display frame. This method can be invoked from outside of the UI thread only when this View is attached to a window. Unit postOnAnimation(action: Runnable!) Causes the Runnable to execute on the next animation time step. The runnable will be run on the user interface thread. Unit postOnAnimationDelayed(action: Runnable!, delayMillis: Long) Causes the Runnable to execute on the next animation time step, after the specified amount of time elapses. The runnable will be run on the user interface thread. Unit refreshDrawableState() Call this to force a view to update its drawable state. This will cause drawableStateChanged to be called on this view. Views that are interested in the new state should call getDrawableState. Unit releasePointerCapture() Releases the pointer capture. If the window does not have pointer capture, this call will do nothing. Boolean removeCallbacks(action: Runnable!) Removes the specified Runnable from the message queue. Unit removeOnAttachStateChangeListener(listener: View.OnAttachStateChangeListener!) Remove a listener for attach state changes. The listener will receive no further notification of window attach/detach events. Unit removeOnLayoutChangeListener(listener: View.OnLayoutChangeListener!) Remove a listener for layout changes. Unit removeOnUnhandledKeyEventListener(listener: View.OnUnhandledKeyEventListener!) Removes a listener which will receive unhandled KeyEvents. This must be called on the UI thread. Unit requestApplyInsets() Ask that a new dispatch of onApplyWindowInsets(android.view.WindowInsets) be performed. Unit requestFitSystemWindows() Ask that a new dispatch of fitSystemWindows(android.graphics.Rect) be performed. Boolean requestFocus() Call this to try to give focus to a specific view or to one of its descendants. A view will not actually take focus if it is not focusable (isFocusable returns false), or if it can't be focused due to other conditions (not focusable in touch mode (isFocusableInTouchMode) while the device is in touch mode, not visible, not enabled, or has no size). See also focusSearch(int), which is what you call to say that you have focus, and you want your parent to look for the next one. This is equivalent to calling requestFocus(int,android.graphics.Rect) with arguments FOCUS_DOWN and null. Boolean requestFocus(direction: Int) Call this to try to give focus to a specific view or to one of its descendants and give it a hint about what direction focus is heading. A view will not actually take focus if it is not focusable (isFocusable returns false), or if it is focusable and it is not focusable in touch mode (isFocusableInTouchMode) while the device is in touch mode. See also focusSearch(int), which is what you call to say that you have focus, and you want your parent to look for the next one. This is equivalent to calling requestFocus(int,android.graphics.Rect) with null set for the previously focused rectangle. Boolean requestFocus(direction: Int, previouslyFocusedRect: Rect!) Call this to try to give focus to a specific view or to one of its descendants and give it hints about the direction and a specific rectangle that the focus is coming from. The rectangle can help give larger views a finer grained hint about where focus is coming from, and therefore, where to show selection, or forward focus change internally. A view will not actually take focus if it is not focusable (isFocusable returns false), or if it is focusable and it is not focusable in touch mode (isFocusableInTouchMode) while the device is in touch mode. A View will not take focus if it is not visible. A View will not take focus if one of its parents has android.view.ViewGroup#getDescendantFocusability() equal to ViewGroup#FOCUS_BLOCK_DESCENDANTS. See also focusSearch(int), which is what you call to say that you have focus, and you want your parent to look for the next one. You may wish to override this method if your custom View has an internal View that it wishes to forward the request to. Boolean requestFocusFromTouch() Call this to try to give focus to a specific view or to one of its descendants. This is a special variant of requestFocus() that will allow views that are not focusable in touch mode to request focus when they are touched. Unit requestLayout() Call this when something has changed which has invalidated the layout of this view. This will schedule a layout pass of the view tree. This should not be called while the view hierarchy is currently in a layout pass (isInLayout(). If layout is happening, the request may be honored at the end of the current layout pass (and then layout will run again) or after the current frame is drawn and the next layout occurs. Subclasses which override this method should call the superclass method to handle possible request-during-layout errors correctly. If you override this method you must call through to the superclass implementation. Unit requestPointerCapture() Requests pointer capture mode. When the window has pointer capture, the mouse pointer icon will disappear and will not change its position. Enabling pointer capture will change the behavior of input devices in the following ways: Events from a mouse will be delivered with the source InputDevice#SOURCE_MOUSE_RELATIVE, and relative position changes will be available through android.view.MotionEvent#getX and android.view.MotionEvent#getY. Events from a touchpad or trackpad will be delivered with the source InputDevice#SOURCE_TOUCHPAD, where the absolute position of each of the pointers on the touchpad will be available through MotionEvent#getX(int) and MotionEvent#getY(int), and their relative movements are stored in MotionEvent#AXIS_RELATIVE_X and MotionEvent#AXIS_RELATIVE_Y. Events from other types of devices, such as touchscreens, will not be affected. When pointer capture changes, connected mouse and trackpad devices may be reconfigured, and their properties (such as their sources or motion ranges) may change. Use an android.hardware.input.InputManager.InputDeviceListener to be notified when a device changes (which may happen after enabling or disabling pointer capture), and use InputDevice#getDevice(int) to get the updated InputDevice. Events captured through pointer capture will be dispatched to OnCapturedPointerListener#onCapturedPointer(View, MotionEvent) if an OnCapturedPointerListener is set, and otherwise to onCapturedPointerEvent(android.view.MotionEvent). If the window already has pointer capture, this call does nothing. The capture may be released through releasePointerCapture(), or will be lost automatically when the window loses focus. Boolean requestRectangleOnScreen(rectangle: Rect!) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough. A View should call this if it maintains some notion of which part of its content is interesting. For example, a text editing view should call this when its cursor moves. The Rectangle passed into this method should be in the View's content coordinate space. It should not be affected by which part of the View is currently visible or its scroll position. Boolean requestRectangleOnScreen(rectangle: Rect!, immediate: Boolean) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough. A View should call this if it maintains some notion of which part of its content is interesting. For example, a text editing view should call this when its cursor moves. The Rectangle passed into this method should be in the View's content coordinate space. It should not be affected by which part of the View is currently visible or its scroll position. When immediate is set to true, scrolling will not be animated. Unit requestUnbufferedDispatch(event: MotionEvent!) Request unbuffered dispatch of the given stream of MotionEvents to this View. Until this View receives a corresponding MotionEvent#ACTION_UP, ask that the input system not batch MotionEvents but instead deliver them as soon as they're available. This method should only be called for touch events. This API is not intended for most applications. Buffered dispatch provides many of benefits, and just requesting unbuffered dispatch on most MotionEvent streams will not improve your input latency. Side effects include: increased latency, jittery scrolls and inability to take advantage of system resampling. Talk to your input professional to see if requestUnbufferedDispatch(android.view.MotionEvent) is right for you. To receive unbuffered events for arbitrary input device source classes, use requestUnbufferedDispatch(int), Unit requestUnbufferedDispatch(source: Int) Request unbuffered dispatch of the given event source class to this view. This is similar to View#requestUnbufferedDispatch(MotionEvent), but does not automatically terminate, and allows the specification of arbitrary input source classes. Prior to android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, calling this method will not result in any behavioral changes when this View is not attached to a window. T requireViewById(id: Int) Finds the first descendant view with the given ID, the view itself if the ID matches getId(), or throws an IllegalArgumentException if the ID is invalid or there is no matching view in the hierarchy. Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary. Unit resetPivot() Clears any pivot previously set by a call to setPivotX(float) or setPivotY(float). After calling this isPivotSet() will be false and the pivot used for rotation will return to default of being centered on the view. Int resolveSize(size: Int, measureSpec: Int) Version of resolveSizeAndState(int,int,int) returning only the MEASURED_SIZE_MASK bits of the result. Int resolveSizeAndState(size: Int, measureSpec: Int, childMeasuredState: Int) Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec. Will take the desired size, unless a different size is imposed by the constraints. The returned value is a compound integer, with the resolved size in the MEASURED_SIZE_MASK bits and optionally the bit MEASURED_STATE_TOO_SMALL set if the resulting size is smaller than the size the view wants to be. Boolean restoreDefaultFocus() Gives focus to the default-focus view in the view hierarchy that has this view as a root. If the default-focus view cannot be found, falls back to calling requestFocus(int). Unit restoreHierarchyState(container: SparseArray<Parcelable!>!) Restore this view hierarchy's frozen state from the given container. Unit saveAttributeDataForStyleable(context: Context, styleable: IntArray, attrs: AttributeSet?, t: TypedArray, defStyleAttr: Int, defStyleRes: Int) Stores debugging information about attributes. This should be called in a constructor by every custom View that uses a custom styleable. If the custom view does not call it, then the custom attributes used by this view will not be visible in layout inspection tools. Unit saveHierarchyState(container: SparseArray<Parcelable!>!) Store this view hierarchy's frozen state into the given container. Unit scheduleDrawable(who: Drawable, what: Runnable, when: Long) Schedules an action on a drawable to occur at a specified time. Unit scrollBy(x: Int, y: Int) Move the scrolled position of your view. This will cause a call to onScrollChanged(int,int,int,int) and the view will be invalidated. Unit scrollTo(x: Int, y: Int) Set the scrolled position of your view. This will cause a call to onScrollChanged(int,int,int,int) and the view will be invalidated. Unit sendAccessibilityEvent(eventType: Int) Sends an accessibility event of the given type. If accessibility is not enabled this method has no effect. The default implementation calls onInitializeAccessibilityEvent(android.view.accessibility.AccessibilityEvent) first to populate information about the event source (this View), then calls dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent) to populate the text content of the event source including its descendants, then for events type AccessibilityEvent#TYPE_VIEW_SCROLLED and AccessibilityEvent#TYPE_WINDOW_CONTENT_CHANGED with subtype AccessibilityEvent#CONTENT_CHANGE_TYPE_STATE_DESCRIPTION, throttle the events, and last calls ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent) on its parent to request sending of the event to interested parties. If an AccessibilityDelegate has been specified via calling setAccessibilityDelegate(android.view.View.AccessibilityDelegate) its AccessibilityDelegate#sendAccessibilityEvent(View, int) is responsible for handling this call. If this view uses AccessibilityNodeProvider to provide virtual view hierarchy rooted at this view, this method should not be called to send events from virtual children because it will populate the events with wrong information and the events should be throttled per child instead at the virtual root level. To send events from virtual children, call ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent) on the view's parent to request sending of the event to interested parties. Unit sendAccessibilityEventUnchecked(event: AccessibilityEvent!) This method behaves exactly as sendAccessibilityEvent(int) but takes as an argument an empty AccessibilityEvent and does not perform a check whether accessibility is enabled. If an AccessibilityDelegate has been specified via calling setAccessibilityDelegate(android.view.View.AccessibilityDelegate) its AccessibilityDelegate#sendAccessibilityEventUnchecked(View, AccessibilityEvent) is responsible for handling this call. Unit setAccessibilityDataSensitive(accessibilityDataSensitive: Int) Specifies whether this view should only allow interactions from android.accessibilityservice.AccessibilityServices with the android.accessibilityservice.AccessibilityServiceInfo#isAccessibilityTool property set to true. Unit setAccessibilityDelegate(delegate: View.AccessibilityDelegate?) Sets a delegate for implementing accessibility support via composition (as opposed to inheritance). For more details, see AccessibilityDelegate. Note: On platform versions prior to API 23, delegate methods on views in the android.widget.* package are called before host methods. This prevents certain properties such as class name from being modified by overriding AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo), as any changes will be overwritten by the host class. Starting in API 23, delegate methods are called after host methods, which all properties to be modified without being overwritten by the host class. Unit setAccessibilityHeading(isHeading: Boolean) Set if view is a heading for a section of content for accessibility purposes. Users of some accessibility services can choose to navigate between headings instead of between paragraphs, words, etc. Apps that provide headings on sections of text can help the text navigation experience. Note: Use androidx.core.view.ViewCompat#setAccessibilityHeading(View, boolean) for backwards-compatibility. Unit setAccessibilityLiveRegion(mode: Int) Sets the live region mode for this view. This indicates to accessibility services whether they should automatically notify the user about changes to the view's content description or text, or to the content descriptions or text of the view's children (where applicable). Different priority levels are available: ACCESSIBILITY_LIVE_REGION_POLITE: Indicates that updates to the region should be presented to the user. Suitable in most cases for prominent updates within app content that don't require the user's immediate attention. ACCESSIBILITY_LIVE_REGION_ASSERTIVE: Indicates that updates to the region have the highest priority and should be presented to the user immediately. This may result in disruptive notifications from an accessibility service, which may potentially interrupt other feedback or user actions, so it should generally be used only for critical, time-sensitive information. ACCESSIBILITY_LIVE_REGION_NONE: Disables change announcements (the default for most views). Examples: Selecting an option in a dropdown menu updates a panel below with the updated content. This panel may be marked as a live region with ACCESSIBILITY_LIVE_REGION_POLITE to notify users of the change. A screen reader may queue changes as announcements that don't disrupt ongoing speech. An emergency alert may be marked with ACCESSIBILITY_LIVE_REGION_ASSERTIVE to immediately inform users of the emergency. For error notifications, like an "incorrect password" warning in a login screen, views should send a AccessibilityEvent#TYPE_WINDOW_CONTENT_CHANGED AccessibilityEvent with a content change type AccessibilityEvent#CONTENT_CHANGE_TYPE_ERROR and set AccessibilityNodeInfo#setError(CharSequence). Custom widgets should provide error-setting methods that support accessibility. For example, use android.widget.TextView#setError(CharSequence) instead of explicitly sending events. Don't use live regions for frequently-updating UI elements (e.g., progress bars), as this can overwhelm the user with feedback from accessibility services. If necessary, use AccessibilityNodeInfo#setMinDurationBetweenContentChanges(Duration) to throttle feedback and reduce disruptions. Note: Use androidx.core.view.ViewCompat#setAccessibilityLiveRegion(View, int) for backwards-compatibility. Unit setAccessibilityPaneTitle(accessibilityPaneTitle: CharSequence?) Visually distinct portion of a window with window-like semantics are considered panes for accessibility purposes. One example is the content view of a large fragment that is replaced. In order for accessibility services to understand a pane's window-like behavior, panes should have descriptive titles. Views with pane titles produce AccessibilityEvent#TYPE_WINDOW_STATE_CHANGEDs when they appear, disappear, or change title. When transitioning from one Activity to another, instead of using setAccessibilityPaneTitle(), set a descriptive title for its window by using android:label for the matching Activity entry in your application's manifest or updating the title at runtime with android.app.Activity#setTitle(CharSequence). Note: Use androidx.core.view.ViewCompat#setAccessibilityPaneTitle(View, CharSequence) for backwards-compatibility. Unit setAccessibilityTraversalAfter(afterId: Int) Sets the id of a view that screen readers are requested to visit before this view. For example, if view B should be visited after A, with B.setAccessibilityTraversalAfter(A), then this requests that screen readers visit and traverse view A before visiting view B. Note: Views are visited in the order determined by the screen reader. Avoid explicitly manipulating focus order, as this may result in inconsistent user experiences between apps. Instead, use other semantics, such as restructuring the view hierarchy layout, to communicate order. Setting this view to be after a view that is not important for accessibility, or if this view is not important for accessibility, means this method will have no effect if the service is not aware of unimportant views. To avoid a risk of loops, set clear relationships between views. For example, if focus order should be B -> A, and B.setAccessibilityTraversalBefore(A), then also call A.setAccessibilityTraversalAfter(B). Unit setAccessibilityTraversalBefore(beforeId: Int) Sets the id of a view that screen readers are requested to visit after this view. For example, if view B should be visited before view A, with B.setAccessibilityTraversalBefore(A), this requests that screen readers visit and traverse view B before visiting view A. Note: Views are visited in the order determined by the screen reader. Avoid explicitly manipulating focus order, as this may result in inconsistent user experiences between apps. Instead, use other semantics, such as restructuring the view hierarchy layout, to communicate order. Setting this view to be after a view that is not important for accessibility, or if this view is not important for accessibility, means this method will have no effect if the service is not aware of unimportant views. To avoid a risk of loops, set clear relationships between views. For example, if focus order should be B -> A, and B.setAccessibilityTraversalBefore(A), then also call A.setAccessibilityTraversalAfter(B). Unit setActivated(activated: Boolean) Changes the activated state of this view. A view can be activated or not. Note that activation is not the same as selection. Selection is a transient property, representing the view (hierarchy) the user is currently interacting with. Activation is a longer-term state that the user can move views in and out of. For example, in a list view with single or multiple selection enabled, the views in the current selection set are activated. (Um, yeah, we are deeply sorry about the terminology here.) The activated state is propagated down to children of the view it is set on. Unit setAllowClickWhenDisabled(clickableWhenDisabled: Boolean) Enables or disables click events for this view when disabled. Unit setAllowedHandwritingDelegatePackage(allowedPackageName: String?) Specifies that this view may act as a handwriting initiation delegator for a delegate editor view from the specified package. If this method is not called, delegators may only be used to initiate handwriting mode for a delegate editor view from the same package as the delegator view. This method allows specifying a different trusted package which may contain a delegate editor view linked to this delegator view. This method has no effect unless setHandwritingDelegatorCallback is also called to configure this view to act as a handwriting delegator. If this method is called on the delegator view, then setAllowedHandwritingDelegatorPackage should also be called on the delegate editor view. For example, to configure a delegator view in package 1: delegatorView.setHandwritingDelegatorCallback(callback); delegatorView.setAllowedHandwritingDelegatePackage(package2); Then to configure the corresponding delegate editor view in package 2: delegateEditorView.setIsHandwritingDelegate(true); delegateEditorView.setAllowedHandwritingDelegatorPackage(package1); Unit setAllowedHandwritingDelegatorPackage(allowedPackageName: String?) Specifies that a view from the specified package may act as a handwriting delegator for this delegate editor view. If this method is not called, only views from the same package as this delegate editor view may act as a handwriting delegator. This method allows specifying a different trusted package which may contain a delegator view linked to this delegate editor view. This method has no effect unless setIsHandwritingDelegate is also called to configure this view to act as a handwriting delegate. If this method is called on the delegate editor view, then setAllowedHandwritingDelegatePackage should also be called on the delegator view. Unit setAnimation(animation: Animation!) Sets the next animation to play for this view. If you want the animation to play immediately, use startAnimation(android.view.animation.Animation) instead. This method provides allows fine-grained control over the start time and invalidation, but you must make sure that 1) the animation has a start time set, and 2) the view's parent (which controls animations on its children) will be invalidated when the animation is supposed to start. Unit setAnimationMatrix(matrix: Matrix?) Changes the transformation matrix on the view. This is used in animation frameworks, such as android.transition.Transition. When the animation finishes, the matrix should be cleared by calling this method with null as the matrix parameter. Application developers should use transformation methods like setRotation(float), setScaleX(float), setScaleX(float), setTranslationX(float)} and setTranslationY(float) (float)}} instead. Unit setAutoHandwritingEnabled(enabled: Boolean) Set whether this view enables automatic handwriting initiation. For a view with an active InputConnection, if auto handwriting is enabled then stylus movement within its view boundary will automatically trigger the handwriting mode. Check android.view.inputmethod.InputMethodManager#startStylusHandwriting(View) for more details about handwriting mode. If the View wants to initiate handwriting mode by itself, it can set this field to false and call android.view.inputmethod.InputMethodManager#startStylusHandwriting(View) when there is stylus movement detected. Note that this attribute has no effect on the View's children. For example, if a ViewGroup disables auto handwriting but its children set auto handwriting to true, auto handwriting will still work for the children, and vice versa. Unit setAutofillHints(vararg autofillHints: String!) Sets the hints that help an android.service.autofill.AutofillService determine how to autofill the view with the user's data. Typically, there is only one way to autofill a view, but there could be more than one. For example, if the application accepts either an username or email address to identify an user. These hints are not validated by the Android System, but passed "as is" to the service. Hence, they can have any value, but it's recommended to use the AUTOFILL_HINT_ constants such as: AUTOFILL_HINT_USERNAME, AUTOFILL_HINT_PASSWORD, AUTOFILL_HINT_EMAIL_ADDRESS, AUTOFILL_HINT_NAME, AUTOFILL_HINT_PHONE, AUTOFILL_HINT_POSTAL_ADDRESS, AUTOFILL_HINT_POSTAL_CODE, AUTOFILL_HINT_CREDIT_CARD_NUMBER, AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH or AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR. Unit setAutofillId(id: AutofillId?) Sets the unique, logical identifier of this view in the activity, for autofill purposes. The autofill id is created on demand, and this method should only be called when a view is reused after dispatchProvideAutofillStructure(android.view.ViewStructure,int) is called, as that method creates a snapshot of the view that is passed along to the autofill service. This method is typically used when view subtrees are recycled to represent different content* —in this case, the autofill id can be saved before the view content is swapped out, and restored later when it's swapped back in. For example: EditText reusableView = ...; ViewGroup parentView = ...; AutofillManager afm = ...; // Swap out the view and change its contents AutofillId oldId = reusableView.getAutofillId(); CharSequence oldText = reusableView.getText(); parentView.removeView(reusableView); AutofillId newId = afm.getNextAutofillId(); reusableView.setText("New I am"); reusableView.setAutofillId(newId); parentView.addView(reusableView); // Later, swap the old content back in parentView.removeView(reusableView); reusableView.setAutofillId(oldId); reusableView.setText(oldText); parentView.addView(reusableView); NOTE: If this view is a descendant of an android.widget.AdapterView, the system may reset its autofill id when this view is recycled. If the autofill ids need to be stable, they should be set again in android.widget.Adapter#getView(int, android.view.View, android.view.ViewGroup). Unit setBackground(background: Drawable!) Set the background to a given Drawable, or remove the background. If the background has padding, this View's padding is set to the background's padding. However, when a background is removed, this View's padding isn't touched. If setting the padding is desired, please use setPadding(int,int,int,int). Unit setBackgroundColor(color: Int) Sets the background color for this view. Unit setBackgroundDrawable(background: Drawable!) Unit setBackgroundResource(resid: Int) Set the background to a given resource. The resource should refer to a Drawable object or 0 to remove the background. Unit setBackgroundTintBlendMode(blendMode: BlendMode?) Specifies the blending mode used to apply the tint specified by setBackgroundTintList(android.content.res.ColorStateList)} to the background drawable. The default mode is BlendMode#SRC_IN. Unit setBackgroundTintList(tint: ColorStateList?) Applies a tint to the background drawable. Does not modify the current tint mode, which is BlendMode#SRC_IN by default. Subsequent calls to setBackground(android.graphics.drawable.Drawable) will automatically mutate the drawable and apply the specified tint and tint mode using Drawable#setTintList(ColorStateList). Unit setBackgroundTintMode(tintMode: PorterDuff.Mode?) Specifies the blending mode used to apply the tint specified by setBackgroundTintList(android.content.res.ColorStateList)} to the background drawable. The default mode is PorterDuff.Mode#SRC_IN. Unit setBottom(bottom: Int) Sets the bottom position of this view relative to its parent. This method is meant to be called by the layout system and should not generally be called otherwise, because the property may be changed at any time by the layout. Unit setCameraDistance(distance: Float) Sets the distance along the Z axis (orthogonal to the X/Y plane on which views are drawn) from the camera to this view. The camera's distance affects 3D transformations, for instance rotations around the X and Y axis. If the rotationX or rotationY properties are changed and this view is large (more than half the size of the screen), it is recommended to always use a camera distance that's greater than the height (X axis rotation) or the width (Y axis rotation) of this view. The distance of the camera from the view plane can have an affect on the perspective distortion of the view when it is rotated around the x or y axis. For example, a large distance will result in a large viewing angle, and there will not be much perspective distortion of the view as it rotates. A short distance may cause much more perspective distortion upon rotation, and can also result in some drawing artifacts if the rotated view ends up partially behind the camera (which is why the recommendation is to use a distance at least as far as the size of the view, if the view is to be rotated.) The distance is expressed in "depth pixels." The default distance depends on the screen density. For instance, on a medium density display, the default distance is 1280. On a high density display, the default distance is 1920. If you want to specify a distance that leads to visually consistent results across various densities, use the following formula: float scale = context.getResources().getDisplayMetrics().density; view.setCameraDistance(distance * scale); The density scale factor of a high density display is 1.5, and 1920 = 1280 * 1.5. Unit setClickable(clickable: Boolean) Enables or disables click events for this view. When a view is clickable it will change its state to "pressed" on every click. Subclasses should set the view clickable to visually react to user's clicks. Unit setClipToOutline(clipToOutline: Boolean) Sets whether the View's Outline should be used to clip the contents of the View. Only a single non-rectangular clip can be applied on a View at any time. Circular clips from a circular reveal animation take priority over Outline clipping, and child Outline clipping takes priority over Outline clipping done by a parent. Note that this flag will only be respected if the View's Outline returns true from Outline#canClip(). Unit setContentCaptureSession(contentCaptureSession: ContentCaptureSession?) Sets the (optional) ContentCaptureSession associated with this view. This method should be called when you need to associate a ContentCaptureContext to the content capture events associated with this view or its view hierarchy (if it's a ViewGroup). For example, if your activity is associated with a web domain, first you would need to set the context for the main DOM: ContentCaptureSession mainSession = rootView.getContentCaptureSession(); mainSession.setContentCaptureContext(ContentCaptureContext.forLocusId(Uri.parse(myUrl)); Then if the page had an IFRAME, you would create a new session for it: ContentCaptureSession iframeSession = mainSession.createContentCaptureSession( ContentCaptureContext.forLocusId(Uri.parse(iframeUrl))); iframeView.setContentCaptureSession(iframeSession); Unit setContentDescription(contentDescription: CharSequence!) Sets the View's content description. A content description briefly describes the view and is primarily used for accessibility support to determine how a view should be presented to the user. In the case of a view with no textual representation, such as android.widget.ImageButton, a useful content description explains what the view does. For example, an image button with a phone icon that is used to place a call may use "Call" as its content description. An image of a floppy disk that is used to save a file may use "Save". This should omit role or state. Role refers to the kind of user-interface element the View is, such as a Button or Checkbox. State refers to a frequently changing property of the View, such as an On/Off state of a button or the audio level of a volume slider. Content description updates are not frequent, and are used when the semantic content - not the state - of the element changes. For example, a Play button might change to a Pause button during music playback. Unit setContentSensitivity(mode: Int) Sets content sensitivity mode to determine whether this view displays sensitive content (e.g. username, password etc.). The system will improve user privacy i.e. hide content drawn by a sensitive view from screen sharing and recording. The window hosting a sensitive view will be marked as secure during an active media projection session. This would be equivalent to applying android.view.WindowManager.LayoutParams#FLAG_SECURE to the window. Unit setContextClickable(contextClickable: Boolean) Enables or disables context clicking for this view. This event can launch the listener. Unit setDefaultFocusHighlightEnabled(defaultFocusHighlightEnabled: Boolean) Sets whether this View should use a default focus highlight when it gets focused but doesn't have android.R.attr#state_focused defined in its background. Unit setDrawingCacheBackgroundColor(color: Int) Setting a solid background color for the drawing cache's bitmaps will improve performance and memory usage. Note, though that this should only be used if this view will always be drawn on top of a solid color. Unit setDrawingCacheEnabled(enabled: Boolean) Enables or disables the drawing cache. When the drawing cache is enabled, the next call to getDrawingCache() or buildDrawingCache() will draw the view in a bitmap. Calling draw(android.graphics.Canvas) will not draw from the cache when the cache is enabled. To benefit from the cache, you must request the drawing cache by calling getDrawingCache() and draw it on screen if the returned bitmap is not null. Enabling the drawing cache is similar to setting a layer when hardware acceleration is turned off. When hardware acceleration is turned on, enabling the drawing cache has no effect on rendering because the system uses a different mechanism for acceleration which ignores the flag. If you want to use a Bitmap for the view, even when hardware acceleration is enabled, see setLayerType(int,android.graphics.Paint) for information on how to enable software and hardware layers. This API can be used to manually generate a bitmap copy of this view, by setting the flag to true and calling getDrawingCache(). Unit setDrawingCacheQuality(quality: Int) Set the drawing cache quality of this view. This value is used only when the drawing cache is enabled Unit setDuplicateParentStateEnabled(enabled: Boolean) Enables or disables the duplication of the parent's state into this view. When duplication is enabled, this view gets its drawable state from its parent rather than from its own internal properties. Note: in the current implementation, setting this property to true after the view was added to a ViewGroup might have no effect at all. This property should always be used from XML or set to true before adding this view to a ViewGroup. Note: if this view's parent addStateFromChildren property is enabled and this property is enabled, an exception will be thrown. Note: if the child view uses and updates additional states which are unknown to the parent, these states should not be affected by this method. Unit setElevation(elevation: Float) Sets the base elevation of this view, in pixels. Unit setEnabled(enabled: Boolean) Set the enabled state of this view. The interpretation of the enabled state varies by subclass. Unit setFadingEdgeLength(length: Int) Set the size of the faded edge used to indicate that more content in this view is available. Will not change whether the fading edge is enabled; use setVerticalFadingEdgeEnabled(boolean) or setHorizontalFadingEdgeEnabled(boolean) to enable the fading edge for the vertical or horizontal fading edges. Unit setFilterTouchesWhenObscured(enabled: Boolean) Sets whether the framework should discard touches when the view's window is obscured by another visible window at the touched location. Refer to the View security documentation for more details. Unit setFitsSystemWindows(fitSystemWindows: Boolean) Sets whether or not this view should account for system screen decorations such as the status bar and inset its content; that is, controlling whether the default implementation of fitSystemWindows(android.graphics.Rect) will be executed. See that method for more details. Note that if you are providing your own implementation of fitSystemWindows(android.graphics.Rect), then there is no need to set this flag to true -- your implementation will be overriding the default implementation that checks this flag. Unit setFocusable(focusable: Boolean) Set whether this view can receive the focus. Setting this to false will also ensure that this view is not focusable in touch mode. Unit setFocusable(focusable: Int) Sets whether this view can receive focus. Setting this to FOCUSABLE_AUTO tells the framework to determine focusability automatically based on the view's interactivity. This is the default. Setting this to NOT_FOCUSABLE will ensure that this view is also not focusable in touch mode. Unit setFocusableInTouchMode(focusableInTouchMode: Boolean) Set whether this view can receive focus while in touch mode. Setting this to true will also ensure that this view is focusable. Unit setFocusedByDefault(isFocusedByDefault: Boolean) Sets whether this View should receive focus when the focus is restored for the view hierarchy containing this view. Focus gets restored for a view hierarchy when the root of the hierarchy gets added to a window or serves as a target of cluster navigation. Unit setForceDarkAllowed(allow: Boolean) Sets whether or not to allow force dark to apply to this view. Setting this to false will disable the auto-dark feature on everything this view draws, including any descendants. Setting this to true will allow this view to be automatically made dark, however a value of 'true' will not override any 'false' value in its parent chain nor will it prevent any 'false' in any of its children. The default behavior of force dark is also influenced by the Theme's isLightTheme attribute. If a theme is isLightTheme="false", then force dark is globally disabled for that theme. Unit setForeground(foreground: Drawable!) Supply a Drawable that is to be rendered on top of all of the content in the view. Unit setForegroundGravity(gravity: Int) Describes how the foreground is positioned. Defaults to START and TOP. Unit setForegroundTintBlendMode(blendMode: BlendMode?) Specifies the blending mode used to apply the tint specified by setForegroundTintList(android.content.res.ColorStateList)} to the background drawable. The default mode is BlendMode#SRC_IN. Unit setForegroundTintList(tint: ColorStateList?) Applies a tint to the foreground drawable. Does not modify the current tint mode, which is PorterDuff.Mode#SRC_IN by default. Subsequent calls to setForeground(android.graphics.drawable.Drawable) will automatically mutate the drawable and apply the specified tint and tint mode using Drawable#setTintList(ColorStateList). Unit setForegroundTintMode(tintMode: PorterDuff.Mode?) Specifies the blending mode used to apply the tint specified by setForegroundTintList(android.content.res.ColorStateList)} to the background drawable. The default mode is PorterDuff.Mode#SRC_IN. Unit setFrameContentVelocity(pixelsPerSecond: Float) Set the current velocity of the View, we only track positive value. We will use the velocity information to adjust the frame rate when applicable. For example, we could potentially lower the frame rate when the velocity of a fling gesture becomes slower. Note that this is only valid till the next drawn frame. Unit setHandwritingBoundsOffsets(offsetLeft: Float, offsetTop: Float, offsetRight: Float, offsetBottom: Float) Set the amount of offset applied to this view's stylus handwriting bounds. A positive offset will offset the edge outwards.The base handwriting bounds of a view is its visible bounds. The handwriting bounds offsets are applied to the base handwriting bounds to determine the final handwriting bounds. This method is mainly used to enlarge the view's handwriting bounds for a better user experience. Note that when the view is clipped (e.g. the view is in a android.widget.ScrollView), the offsets are applied after the view's handwriting bounds is clipped. Unit setHandwritingDelegateFlags(flags: Int) Sets flags configuring the handwriting delegation behavior for this delegate editor view. This method has no effect unless setIsHandwritingDelegate is also called to configure this view to act as a handwriting delegate. Unit setHandwritingDelegatorCallback(callback: Runnable?) Sets a callback which should be called when a stylus MotionEvent occurs within this view's bounds. The callback will be called from the UI thread. Setting a callback allows this view to act as a handwriting delegator, so that handwriting mode for a delegate editor view can be initiated by stylus movement on this delegator view. The callback implementation is expected to show and focus the delegate editor view. If a view which returns true for isHandwritingDelegate() creates an input connection while the same stylus MotionEvent sequence is ongoing, handwriting mode will be initiated for that view. A common use case is a custom view which looks like a text editor but does not actually support text editing itself, and clicking on the custom view causes an EditText to be shown. To support handwriting initiation in this case, this method can be called on the custom view to configure it as a delegator. The EditText should call setIsHandwritingDelegate to set it as a delegate. The callback implementation is typically the same as the click listener implementation which shows the EditText. If null is passed, this view will no longer act as a handwriting initiation delegator. Unit setHapticFeedbackEnabled(hapticFeedbackEnabled: Boolean) Set whether this view should have haptic feedback for events such as long presses. You may wish to disable haptic feedback if your view already controls its own haptic feedback. Unit setHasTransientState(hasTransientState: Boolean) Set whether this view is currently tracking transient state that the framework should attempt to preserve when possible. This flag is reference counted, so every call to setHasTransientState(true) should be paired with a later call to setHasTransientState(false). A view with transient state cannot be trivially rebound from an external data source, such as an adapter binding item views in a list. This may be because the view is performing an animation, tracking user selection of content, or similar. Unit setHorizontalFadingEdgeEnabled(horizontalFadingEdgeEnabled: Boolean) Define whether the horizontal edges should be faded when this view is scrolled horizontally. Unit setHorizontalScrollBarEnabled(horizontalScrollBarEnabled: Boolean) Define whether the horizontal scrollbar should be drawn or not. The scrollbar is not drawn by default. Unit setHorizontalScrollbarThumbDrawable(drawable: Drawable?) Defines the horizontal thumb drawable Unit setHorizontalScrollbarTrackDrawable(drawable: Drawable?) Defines the horizontal track drawable Unit setHovered(hovered: Boolean) Sets whether the view is currently hovered. Calling this method also changes the drawable state of the view. This enables the view to react to hover by using different drawable resources to change its appearance. The onHoverChanged method is called when the hovered state changes. Unit setId(id: Int) Sets the identifier for this view. The identifier does not have to be unique in this view's hierarchy. The identifier should be a positive number. Unit setImportantForAccessibility(mode: Int) Sets how to determine whether this view is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen. Unit setImportantForAutofill(mode: Int) Sets the mode for determining whether this view is considered important for autofill. The platform determines the importance for autofill automatically but you can use this method to customize the behavior. For example: When the view contents is irrelevant for autofill (for example, a text field used in a "Captcha" challenge), it should be IMPORTANT_FOR_AUTOFILL_NO. When both the view and its children are irrelevant for autofill (for example, the root view of an activity containing a spreadhseet editor), it should be IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS. When the view content is relevant for autofill but its children aren't (for example, a credit card expiration date represented by a custom view that overrides the proper autofill methods and has 2 children representing the month and year), it should be IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS. Note: Setting the mode as IMPORTANT_FOR_AUTOFILL_NO or IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS does not guarantee the view (and its children) will not be used for autofill purpose; for example, when the user explicitly makes an autofill request, all views are included in the ViewStructure, and starting in android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE the system uses other factors along with importance to determine the autofill behavior. See isImportantForAutofill() for more details about how the View's importance for autofill is used. Unit setImportantForContentCapture(mode: Int) Sets the mode for determining whether this view is considered important for content capture. The platform determines the importance for autofill automatically but you can use this method to customize the behavior. Typically, a view that provides text should be marked as IMPORTANT_FOR_CONTENT_CAPTURE_YES. Unit setIsCredential(isCredential: Boolean) Sets whether this view is a credential for Credential Manager purposes. See isCredential(). Unit setIsHandwritingDelegate(isHandwritingDelegate: Boolean) Sets this view to be a handwriting delegate. If a delegate view creates an input connection while a stylus MotionEvent sequence from a delegator view is ongoing, handwriting mode will be initiated for the delegate view. Unit setKeepScreenOn(keepScreenOn: Boolean) Controls whether the screen should remain on, modifying the value of KEEP_SCREEN_ON. Unit setKeyboardNavigationCluster(isCluster: Boolean) Set whether this view is a root of a keyboard navigation cluster. Unit setLabelFor(id: Int) Sets the id of a view for which this view serves as a label for accessibility purposes. Unit setLayerPaint(paint: Paint?) Updates the Paint object used with the current layer (used only if the current layer type is not set to LAYER_TYPE_NONE). Changed properties of the Paint provided to setLayerType(int,android.graphics.Paint) will be used the next time the View is redrawn, but setLayerPaint(android.graphics.Paint) must be called to ensure that the view gets redrawn immediately. A layer is associated with an optional android.graphics.Paint instance that controls how the layer is composed on screen. The following properties of the paint are taken into account when composing the layer: Translucency (alpha) Blending mode Color filter If this view has an alpha value set to < 1.0 by calling setAlpha(float), the alpha value of the layer's paint is superseded by this view's alpha value. Unit setLayerType(layerType: Int, paint: Paint?) Specifies the type of layer backing this view. The layer can be LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE. A layer is associated with an optional android.graphics.Paint instance that controls how the layer is composed on screen. The following properties of the paint are taken into account when composing the layer: Translucency (alpha) Blending mode Color filter If this view has an alpha value set to < 1.0 by calling setAlpha(float), the alpha value of the layer's paint is superseded by this view's alpha value. Refer to the documentation of LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE and LAYER_TYPE_HARDWARE for more information on when and how to use layers. Unit setLayoutDirection(layoutDirection: Int) Set the layout direction for this view. This will propagate a reset of layout direction resolution to the view's children and resolve layout direction for this view. Unit setLayoutParams(params: ViewGroup.LayoutParams!) Set the layout parameters associated with this view. These supply parameters to the parent of this view specifying how it should be arranged. There are many subclasses of ViewGroup.LayoutParams, and these correspond to the different subclasses of ViewGroup that are responsible for arranging their children. Unit setLeft(left: Int) Sets the left position of this view relative to its parent. This method is meant to be called by the layout system and should not generally be called otherwise, because the property may be changed at any time by the layout. Unit setLeftTopRightBottom(left: Int, top: Int, right: Int, bottom: Int) Assign a size and position to this view. This method is meant to be used in animations only as it applies this position and size for the view only temporary and it can be changed back at any time by the layout. Unit setLongClickable(longClickable: Boolean) Enables or disables long click events for this view. When a view is long clickable it reacts to the user holding down the button for a longer duration than a tap. This event can either launch the listener or a context menu. Unit setMeasuredDimension(measuredWidth: Int, measuredHeight: Int) This method must be called by onMeasure(int,int) to store the measured width and measured height. Failing to do so will trigger an exception at measurement time. Unit setMinimumHeight(minHeight: Int) Sets the minimum height of the view. It is not guaranteed the view will be able to achieve this minimum height (for example, if its parent layout constrains it with less available height). Unit setMinimumWidth(minWidth: Int) Sets the minimum width of the view. It is not guaranteed the view will be able to achieve this minimum width (for example, if its parent layout constrains it with less available width). Unit setNestedScrollingEnabled(enabled: Boolean) Enable or disable nested scrolling for this view. If this property is set to true the view will be permitted to initiate nested scrolling operations with a compatible parent view in the current hierarchy. If this view does not implement nested scrolling this will have no effect. Disabling nested scrolling while a nested scroll is in progress has the effect of stopping the nested scroll. Unit setNextClusterForwardId(nextClusterForwardId: Int) Sets the id of the view to use as the root of the next keyboard navigation cluster. Unit setNextFocusDownId(nextFocusDownId: Int) Sets the id of the view to use when the next focus is FOCUS_DOWN. Unit setNextFocusForwardId(nextFocusForwardId: Int) Sets the id of the view to use when the next focus is FOCUS_FORWARD. Unit setNextFocusLeftId(nextFocusLeftId: Int) Sets the id of the view to use when the next focus is FOCUS_LEFT. Unit setNextFocusRightId(nextFocusRightId: Int) Sets the id of the view to use when the next focus is FOCUS_RIGHT. Unit setNextFocusUpId(nextFocusUpId: Int) Sets the id of the view to use when the next focus is FOCUS_UP. Unit setOnApplyWindowInsetsListener(listener: View.OnApplyWindowInsetsListener!) Set an OnApplyWindowInsetsListener to take over the policy for applying window insets to this view. The listener's onApplyWindowInsets method will be called instead of the view's onApplyWindowInsets method. Unit setOnCapturedPointerListener(l: View.OnCapturedPointerListener!) Set a listener to receive callbacks when the pointer capture state of a view changes. Unit setOnClickListener(l: View.OnClickListener?) Register a callback to be invoked when this view is clicked. If this view is not clickable, it becomes clickable. Unit setOnContextClickListener(l: View.OnContextClickListener?) Register a callback to be invoked when this view is context clicked. If the view is not context clickable, it becomes context clickable. Unit setOnCreateContextMenuListener(l: View.OnCreateContextMenuListener!) Register a callback to be invoked when the context menu for this view is being built. If this view is not long clickable, it becomes long clickable. Unit setOnDragListener(l: View.OnDragListener!) Register a drag event listener callback object for this View. The parameter is an implementation of android.view.View.OnDragListener. To send a drag event to a View, the system calls the android.view.View.OnDragListener#onDrag(View,DragEvent) method. Unit setOnFocusChangeListener(l: View.OnFocusChangeListener!) Register a callback to be invoked when focus of this view changed. Unit setOnGenericMotionListener(l: View.OnGenericMotionListener!) Register a callback to be invoked when a generic motion event is sent to this view. Unit setOnHoverListener(l: View.OnHoverListener!) Register a callback to be invoked when a hover event is sent to this view. Unit setOnKeyListener(l: View.OnKeyListener!) Register a callback to be invoked when a hardware key is pressed in this view. Key presses in software input methods will generally not trigger the methods of this listener. Unit setOnLongClickListener(l: View.OnLongClickListener?) Register a callback to be invoked when this view is clicked and held. If this view is not long clickable, it becomes long clickable. Unit setOnReceiveContentListener(mimeTypes: Array<String!>?, listener: OnReceiveContentListener?) Sets the listener to be used to handle insertion of content into this view. Depending on the type of view, this listener may be invoked for different scenarios. For example, for an editable android.widget.TextView, this listener will be invoked for the following scenarios: Paste from the clipboard (e.g. "Paste" or "Paste as plain text" action in the insertion/selection menu) Content insertion from the keyboard (from InputConnection#commitContent) Drag and drop (drop events from onDragEvent) Autofill Selection replacement via Intent#ACTION_PROCESS_TEXT When setting a listener, clients must also declare the accepted MIME types. The listener will still be invoked even if the MIME type of the content is not one of the declared MIME types (e.g. if the user pastes content whose type is not one of the declared MIME types). In that case, the listener may reject the content (defer to the default platform behavior) or execute some other fallback logic (e.g. show an appropriate message to the user). The declared MIME types serve as a hint to allow different features to optionally alter their behavior. For example, a soft keyboard may optionally choose to hide its UI for inserting GIFs for a particular input field if the MIME types set here for that field don't include "image/gif" or "image/*". Note: MIME type matching in the Android framework is case-sensitive, unlike formal RFC MIME types. As a result, you should always write your MIME types with lowercase letters, or use android.content.Intent#normalizeMimeType to ensure that it is converted to lowercase. Unit setOnScrollChangeListener(l: View.OnScrollChangeListener!) Register a callback to be invoked when the scroll X or Y positions of this view change. Note: Some views handle scrolling independently from View and may have their own separate listeners for scroll-type events. For example, ListView allows clients to register an AbsListView.OnScrollListener to listen for changes in list scroll position. Unit setOnSystemUiVisibilityChangeListener(l: View.OnSystemUiVisibilityChangeListener!) Set a listener to receive callbacks when the visibility of the system bar changes. Unit setOnTouchListener(l: View.OnTouchListener!) Register a callback to be invoked when a touch event is sent to this view. Unit setOutlineAmbientShadowColor(color: Int) Sets the color of the ambient shadow that is drawn when the view has a positive Z or elevation value. By default the shadow color is black. Generally, this color will be opaque so the intensity of the shadow is consistent between different views with different colors. The opacity of the final ambient shadow is a function of the shadow caster height, the alpha channel of the outlineAmbientShadowColor (typically opaque), and the android.R.attr#ambientShadowAlpha theme attribute. Unit setOutlineProvider(provider: ViewOutlineProvider!) Sets the ViewOutlineProvider of the view, which generates the Outline that defines the shape of the shadow it casts, and enables outline clipping. The default ViewOutlineProvider, ViewOutlineProvider#BACKGROUND, queries the Outline from the View's background drawable, via Drawable#getOutline(Outline). Changing the outline provider with this method allows this behavior to be overridden. If the ViewOutlineProvider is null, if querying it for an outline returns false, or if the produced Outline is Outline#isEmpty(), shadows will not be cast. Only outlines that return true from Outline#canClip() may be used for clipping. Unit setOutlineSpotShadowColor(color: Int) Sets the color of the spot shadow that is drawn when the view has a positive Z or elevation value. By default the shadow color is black. Generally, this color will be opaque so the intensity of the shadow is consistent between different views with different colors. The opacity of the final spot shadow is a function of the shadow caster height, the alpha channel of the outlineSpotShadowColor (typically opaque), and the android.R.attr#spotShadowAlpha theme attribute. Unit setOverScrollMode(overScrollMode: Int) Set the over-scroll mode for this view. Valid over-scroll modes are OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS (allow over-scrolling only if the view content is larger than the container), or OVER_SCROLL_NEVER. Setting the over-scroll mode of a view will have an effect only if the view is capable of scrolling. Unit setPadding(left: Int, top: Int, right: Int, bottom: Int) Sets the padding. The view may add on the space required to display the scrollbars, depending on the style and visibility of the scrollbars. So the values returned from getPaddingLeft, getPaddingTop, getPaddingRight and getPaddingBottom may be different from the values set in this call. Unit setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int) Sets the relative padding. The view may add on the space required to display the scrollbars, depending on the style and visibility of the scrollbars. So the values returned from getPaddingStart, getPaddingTop, getPaddingEnd and getPaddingBottom may be different from the values set in this call. Unit setPendingCredentialRequest(request: GetCredentialRequest, callback: OutcomeReceiver<GetCredentialResponse!, GetCredentialException!>) Sets a CredentialManager request to retrieve credentials, when the user focuses on this given view. When this view is focused, the given request will be fired to CredentialManager, which will fetch content from all android.service.credentials.CredentialProviderService services on the device, and then display credential options to the user on a relevant UI (dropdown, keyboard suggestions etc.). When the user selects a credential, the final GetCredentialResponse will be propagated to the given callback. Developers are expected to handle the response programmatically and perform a relevant action, e.g. signing in the user. For details on how to build a Credential Manager request, please see GetCredentialRequest. This API should be called at any point before the user focuses on the view, e.g. during onCreate of an Activity. Unit setPivotX(pivotX: Float) Sets the x location of the point around which the view is rotated and scaled. By default, the pivot point is centered on the object. Setting this property disables this behavior and causes the view to use only the explicitly set pivotX and pivotY values. Unit setPivotY(pivotY: Float) Sets the y location of the point around which the view is rotated and scaled. By default, the pivot point is centered on the object. Setting this property disables this behavior and causes the view to use only the explicitly set pivotX and pivotY values. Unit setPointerIcon(pointerIcon: PointerIcon!) Set the pointer icon to be used for a mouse pointer in the current view. Passing null will restore the pointer icon to its default value. Note that setting the pointer icon using this method will only set it for events coming from a mouse device (i.e. with source InputDevice#SOURCE_MOUSE). To resolve the pointer icon for other device types like styluses, override onResolvePointerIcon(android.view.MotionEvent,int). Unit setPreferKeepClear(preferKeepClear: Boolean) Set a preference to keep the bounds of this view clear from floating windows above this view's window. This informs the system that the view is considered a vital area for the user and that ideally it should not be covered. Setting this is only appropriate for UI where the user would likely take action to uncover it. The system will try to respect this preference, but when not possible will ignore it. Note: This is independent from setPreferKeepClearRects. If both are set, both will be taken into account. Unit setPreferKeepClearRects(rects: MutableList<Rect!>) Set a preference to keep the provided rects clear from floating windows above this view's window. This informs the system that these rects are considered vital areas for the user and that ideally they should not be covered. Setting this is only appropriate for UI where the user would likely take action to uncover it. The system will try to respect this preference, but when not possible will ignore it. Note: This is independent from setPreferKeepClear. If both are set, both will be taken into account. Unit setPressed(pressed: Boolean) Sets the pressed state for this view. Unit setRenderEffect(renderEffect: RenderEffect?) Configure the android.graphics.RenderEffect to apply to this View. This will apply a visual effect to the results of the View before it is drawn. For example if RenderEffect#createBlurEffect(float, float, RenderEffect, Shader.TileMode) is provided, the contents will be drawn in a separate layer, then this layer will be blurred when this View is drawn. Unit setRequestedFrameRate(frameRate: Float) You can set the preferred frame rate for a View using a positive number or by specifying the preferred frame rate category using constants, including REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE, REQUESTED_FRAME_RATE_CATEGORY_LOW, REQUESTED_FRAME_RATE_CATEGORY_NORMAL, REQUESTED_FRAME_RATE_CATEGORY_HIGH. Keep in mind that the preferred frame rate affects the frame rate for the next frame, so use this method carefully. It's important to note that the preference is valid as long as the View is invalidated. Unit setRevealOnFocusHint(revealOnFocus: Boolean) Sets this view's preference for reveal behavior when it gains focus. When set to true, this is a signal to ancestor views in the hierarchy that this view would prefer to be brought fully into view when it gains focus. For example, a text field that a user is meant to type into. Other views such as scrolling containers may prefer to opt-out of this behavior. The default value for views is true, though subclasses may change this based on their preferred behavior. Unit setRight(right: Int) Sets the right position of this view relative to its parent. This method is meant to be called by the layout system and should not generally be called otherwise, because the property may be changed at any time by the layout. Unit setRotation(rotation: Float) Sets the degrees that the view is rotated around the pivot point. Increasing values result in clockwise rotation. Unit setRotationX(rotationX: Float) Sets the degrees that the view is rotated around the horizontal axis through the pivot point. Increasing values result in clockwise rotation from the viewpoint of looking down the x axis. When rotating large views, it is recommended to adjust the camera distance accordingly. Refer to setCameraDistance(float) for more information. Unit setRotationY(rotationY: Float) Sets the degrees that the view is rotated around the vertical axis through the pivot point. Increasing values result in counter-clockwise rotation from the viewpoint of looking down the y axis. When rotating large views, it is recommended to adjust the camera distance accordingly. Refer to setCameraDistance(float) for more information. Unit setSaveEnabled(enabled: Boolean) Controls whether the saving of this view's state is enabled (that is, whether its onSaveInstanceState method will be called). Note that even if freezing is enabled, the view still must have an id assigned to it (via setId(int)) for its state to be saved. This flag can only disable the saving of this view; any child views may still have their state saved. Unit setSaveFromParentEnabled(enabled: Boolean) Controls whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent. The default is true; if false, these views will not be saved unless saveHierarchyState(android.util.SparseArray) is called directly on this view. Unit setScaleX(scaleX: Float) Sets the amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width. A value of 1 means that no scaling is applied. Unit setScaleY(scaleY: Float) Sets the amount that the view is scaled in Y around the pivot point, as a proportion of the view's unscaled width. A value of 1 means that no scaling is applied. Unit setScreenReaderFocusable(screenReaderFocusable: Boolean) Sets whether this View should be a focusable element for screen readers and include non-focusable Views from its subtree when providing feedback. Note: this is similar to using android:focusable, but does not impact input focus behavior. Unit setScrollBarDefaultDelayBeforeFade(scrollBarDefaultDelayBeforeFade: Int) Define the delay before scrollbars fade. Unit setScrollBarFadeDuration(scrollBarFadeDuration: Int) Define the scrollbar fade duration. Unit setScrollBarSize(scrollBarSize: Int) Define the scrollbar size. Unit setScrollBarStyle(style: Int) Specify the style of the scrollbars. The scrollbars can be overlaid or inset. When inset, they add to the padding of the view. And the scrollbars can be drawn inside the padding area or on the edge of the view. For example, if a view has a background drawable and you want to draw the scrollbars inside the padding specified by the drawable, you can use SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to appear at the edge of the view, ignoring the padding, then you can use SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. Unit setScrollCaptureCallback(callback: ScrollCaptureCallback?) Sets the callback to receive scroll capture requests. This component is the adapter between the scroll capture API and application UI code. If no callback is set, the system may provide an implementation. Any value provided here will take precedence over a system version. This view will be ignored when SCROLL_CAPTURE_HINT_EXCLUDE is set in its scrollCaptureHint, regardless whether a callback has been set. It is recommended to set the scroll capture hint SCROLL_CAPTURE_HINT_INCLUDE when setting a custom callback to help ensure it is selected as the target. Unit setScrollCaptureHint(hint: Int) Sets the scroll capture hint for this View. These flags affect the search for a potential scroll capture targets. Unit setScrollContainer(isScrollContainer: Boolean) Change whether this view is one of the set of scrollable containers in its window. This will be used to determine whether the window can resize or must pan when a soft input area is open -- scrollable containers allow the window to use resize mode since the container will appropriately shrink. Unit setScrollIndicators(indicators: Int) Sets the state of all scroll indicators. See setScrollIndicators(int,int) for usage information. Unit setScrollIndicators(indicators: Int, mask: Int) Sets the state of the scroll indicators specified by the mask. To change all scroll indicators at once, see setScrollIndicators(int). When a scroll indicator is enabled, it will be displayed if the view can scroll in the direction of the indicator. Multiple indicator types may be enabled or disabled by passing the logical OR of the desired types. If multiple types are specified, they will all be set to the same enabled state. For example, to enable the top scroll indicatorExample: setScrollIndicators indicators the indicator direction, or the logical OR of multiple indicator directions. One or more of: <ul> <li>{ #SCROLL_INDICATOR_TOP}</li> <li>{ #SCROLL_INDICATOR_BOTTOM}</li> <li>{ #SCROLL_INDICATOR_LEFT}</li> <li>{ #SCROLL_INDICATOR_RIGHT}</li> <li>{ #SCROLL_INDICATOR_START}</li> <li>{ #SCROLL_INDICATOR_END}</li> </ul> #setScrollIndicators(int) #getScrollIndicators() ref android.R.styleable#View_scrollIndicators indicators Value is either <code>0</code> or a combination of { android.view.View#SCROLL_INDICATOR_TOP}, { android.view.View#SCROLL_INDICATOR_BOTTOM}, { android.view.View#SCROLL_INDICATOR_LEFT}, { android.view.View#SCROLL_INDICATOR_RIGHT}, { android.view.View#SCROLL_INDICATOR_START}, and { android.view.View#SCROLL_INDICATOR_END} mask Value is either <code>0</code> or a combination of { android.view.View#SCROLL_INDICATOR_TOP}, { android.view.View#SCROLL_INDICATOR_BOTTOM}, { android.view.View#SCROLL_INDICATOR_LEFT}, { android.view.View#SCROLL_INDICATOR_RIGHT}, { android.view.View#SCROLL_INDICATOR_START}, and { android.view.View#SCROLL_INDICATOR_END} 23 Unit setScrollX(value: Int) Set the horizontal scrolled position of your view. This will cause a call to onScrollChanged(int,int,int,int) and the view will be invalidated. Unit setScrollY(value: Int) Set the vertical scrolled position of your view. This will cause a call to onScrollChanged(int,int,int,int) and the view will be invalidated. Unit setScrollbarFadingEnabled(fadeScrollbars: Boolean) Define whether scrollbars will fade when the view is not scrolling. Unit setSelected(selected: Boolean) Changes the selection state of this view. A view can be selected or not. Note that selection is not the same as focus. Views are typically selected in the context of an AdapterView like ListView or GridView; the selected view is the view that is highlighted. Unit setSoundEffectsEnabled(soundEffectsEnabled: Boolean) Set whether this view should have sound effects enabled for events such as clicking and touching. You may wish to disable sound effects for a view if you already play sounds, for instance, a dial key that plays dtmf tones. Unit setStateDescription(stateDescription: CharSequence?) Sets the View's state description. A state description briefly describes the states of the view and is primarily used for accessibility support to determine how the states of a view should be presented to the user. It is a supplement to the boolean states (for example, checked/unchecked) and it is used for customized state description (for example, "wifi, connected, three bars"). State description changes frequently while content description should change less often. State description should be localized. For android widgets which have default state descriptions, app developers can call this method to override the state descriptions. Setting state description to null restores the default behavior. Unit setStateListAnimator(stateListAnimator: StateListAnimator!) Attaches the provided StateListAnimator to this View. Any previously attached StateListAnimator will be detached. Unit setSystemGestureExclusionRects(rects: MutableList<Rect!>) Sets a list of areas within this view's post-layout coordinate space where the system should not intercept touch or other pointing device gestures. This method should be called by onLayout(boolean,int,int,int,int) or onDraw(android.graphics.Canvas). Use this to tell the system which specific sub-areas of a view need to receive gesture input in order to function correctly in the presence of global system gestures that may conflict. For example, if the system wishes to capture swipe-in-from-screen-edge gestures to provide system-level navigation functionality, a view such as a navigation drawer container can mark the left (or starting) edge of itself as requiring gesture capture priority using this API. The system may then choose to relax its own gesture recognition to allow the app to consume the user's gesture. It is not necessary for an app to register exclusion rects for broadly spanning regions such as the entirety of a ScrollView or for simple press and release click targets such as Button. Mark an exclusion rect when interacting with a view requires a precision touch gesture in a small area in either the X or Y dimension, such as an edge swipe or dragging a SeekBar thumb. Note: the system will put a limit of 200dp on the vertical extent of the exclusions it takes into account. The limit does not apply while the navigation bar is stickily hidden, nor to the input method and home activity. Unit setSystemUiVisibility(visibility: Int) Request that the visibility of the status bar or other screen/window decorations be changed. This method is used to put the over device UI into temporary modes where the user's attention is focused more on the application content, by dimming or hiding surrounding system affordances. This is typically used in conjunction with Window.FEATURE_ACTION_BAR_OVERLAY, allowing the applications content to be placed behind the action bar (and with these flags other system affordances) so that smooth transitions between hiding and showing them can be done. Two representative examples of the use of system UI visibility is implementing a content browsing application (like a magazine reader) and a video playing application. The first code shows a typical implementation of a View in a content browsing application. In this implementation, the application goes into a content-oriented mode by hiding the status bar and action bar, and putting the navigation elements into lights out mode. The user can then interact with content while in this mode. Such an application should provide an easy way for the user to toggle out of the mode (such as to check information in the status bar or access notifications). In the implementation here, this is done simply by tapping on the content. This second code sample shows a typical implementation of a View in a video playing application. In this situation, while the video is playing the application would like to go into a complete full-screen mode, to use as much of the display as possible for the video. When in this state the user can not interact with the application; the system intercepts touching on the screen to pop the UI out of full screen mode. See fitSystemWindows(android.graphics.Rect) for a sample layout that goes with this code. Unit setTag(tag: Any!) Sets the tag associated with this view. A tag can be used to mark a view in its hierarchy and does not have to be unique within the hierarchy. Tags can also be used to store data within a view without resorting to another data structure. Unit setTag(key: Int, tag: Any!) Sets a tag associated with this view and a key. A tag can be used to mark a view in its hierarchy and does not have to be unique within the hierarchy. Tags can also be used to store data within a view without resorting to another data structure. The specified key should be an id declared in the resources of the application to ensure it is unique (see the ID resource type). Keys identified as belonging to the Android framework or not associated with any package will cause an IllegalArgumentException to be thrown. Unit setTextAlignment(textAlignment: Int) Set the text alignment. Unit setTextDirection(textDirection: Int) Set the text direction. Unit setTooltipText(tooltipText: CharSequence?) Sets the tooltip text which will be displayed in a small popup next to the view. The tooltip will be displayed: On long click, unless it is handled otherwise (by OnLongClickListener or a context menu). On hover, after a brief delay since the pointer has stopped moving Note: Do not override this method, as it will have no effect on the text displayed in the tooltip. Unit setTop(top: Int) Sets the top position of this view relative to its parent. This method is meant to be called by the layout system and should not generally be called otherwise, because the property may be changed at any time by the layout. Unit setTouchDelegate(delegate: TouchDelegate!) Sets the TouchDelegate for this View. Unit setTransitionAlpha(alpha: Float) This property is intended only for use by the Fade transition, which animates it to produce a visual translucency that does not side-effect (or get affected by) the real alpha property. This value is composited with the other alpha value (and the AlphaAnimation value, when that is present) to produce a final visual translucency result, which is what is passed into the DisplayList. Unit setTransitionName(transitionName: String!) Sets the name of the View to be used to identify Views in Transitions. Names should be unique in the View hierarchy. Unit setTransitionVisibility(visibility: Int) Changes the visibility of this View without triggering any other changes. This should only be used by animation frameworks, such as android.transition.Transition, where visibility changes should not adjust focus or trigger a new layout. Application developers should use setVisibility instead to ensure that the hierarchy is correctly updated. Only call this method when a temporary visibility must be applied during an animation and the original visibility value is guaranteed to be reset after the animation completes. Use setVisibility in all other cases. Unit setTranslationX(translationX: Float) Sets the horizontal location of this view relative to its left position. This effectively positions the object post-layout, in addition to wherever the object's layout placed it. Unit setTranslationY(translationY: Float) Sets the vertical location of this view relative to its top position. This effectively positions the object post-layout, in addition to wherever the object's layout placed it. Unit setTranslationZ(translationZ: Float) Sets the depth location of this view relative to its elevation. Unit setVerticalFadingEdgeEnabled(verticalFadingEdgeEnabled: Boolean) Define whether the vertical edges should be faded when this view is scrolled vertically. Unit setVerticalScrollBarEnabled(verticalScrollBarEnabled: Boolean) Define whether the vertical scrollbar should be drawn or not. The scrollbar is not drawn by default. Unit setVerticalScrollbarPosition(position: Int) Set the position of the vertical scroll bar. Should be one of SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT or SCROLLBAR_POSITION_RIGHT. Unit setVerticalScrollbarThumbDrawable(drawable: Drawable?) Defines the vertical scrollbar thumb drawable Unit setVerticalScrollbarTrackDrawable(drawable: Drawable?) Defines the vertical scrollbar track drawable Unit setViewTranslationCallback(callback: ViewTranslationCallback) Sets a ViewTranslationCallback that is used to display/hide the translated information. Developers can provide the customized implementation for show/hide translated information. Unit setWillNotCacheDrawing(willNotCacheDrawing: Boolean) When a View's drawing cache is enabled, drawing is redirected to an offscreen bitmap. Some views, like an ImageView, must be able to bypass this mechanism if they already draw a single bitmap, to avoid unnecessary usage of the memory. Unit setWillNotDraw(willNotDraw: Boolean) If this view doesn't do any drawing on its own, set this flag to allow further optimizations. By default, this flag is not set on View, but could be set on some View subclasses such as ViewGroup. Typically, if you override onDraw(android.graphics.Canvas) you should clear this flag. Unit setWindowInsetsAnimationCallback(callback: WindowInsetsAnimation.Callback?) Sets a WindowInsetsAnimation.Callback to be notified about animations of windows that cause insets. The callback's dispatch mode will affect whether animation callbacks are dispatched to the children of this view. Unit setX(x: Float) Sets the visual x position of this view, in pixels. This is equivalent to setting the translationX property to be the difference between the x value passed in and the current left property. Unit setY(y: Float) Sets the visual y position of this view, in pixels. This is equivalent to setting the translationY property to be the difference between the y value passed in and the current top property. Unit setZ(z: Float) Sets the visual z position of this view, in pixels. This is equivalent to setting the translationZ property to be the difference between the z value passed in and the current elevation property. Boolean showContextMenu() Shows the context menu for this view. Boolean showContextMenu(x: Float, y: Float) Shows the context menu for this view anchored to the specified view-relative coordinate. ActionMode! startActionMode(callback: ActionMode.Callback!) Start an action mode with the default type ActionMode#TYPE_PRIMARY. ActionMode! startActionMode(callback: ActionMode.Callback!, type: Int) Start an action mode with the given type. Unit startAnimation(animation: Animation!) Start the specified animation now. Boolean startDrag(data: ClipData!, shadowBuilder: View.DragShadowBuilder!, myLocalState: Any!, flags: Int) Boolean startDragAndDrop(data: ClipData!, shadowBuilder: View.DragShadowBuilder!, myLocalState: Any!, flags: Int) Starts a drag and drop operation. When your application calls this method, it passes a android.view.View.DragShadowBuilder object to the system. The system calls this object's DragShadowBuilder#onProvideShadowMetrics(Point, Point) to get metrics for the drag shadow, and then calls the object's DragShadowBuilder#onDrawShadow(Canvas) to draw the drag shadow itself. Once the system has the drag shadow, it begins the drag and drop operation by sending drag events to all the View objects in your application that are currently visible. It does this either by calling the View object's drag listener (an implementation of onDrag() or by calling the View object's onDragEvent() method. Both are passed a android.view.DragEvent object that has a android.view.DragEvent#getAction() value of android.view.DragEvent#ACTION_DRAG_STARTED. Your application can invoke startDragAndDrop() on any attached View object. The View object does not need to be the one used in android.view.View.DragShadowBuilder, nor does it need to be related to the View the user selected for dragging. Boolean startNestedScroll(axes: Int) Begin a nestable scroll operation along the given axes. A view starting a nested scroll promises to abide by the following contract: The view will call startNestedScroll upon initiating a scroll operation. In the case of a touch scroll this corresponds to the initial MotionEvent#ACTION_DOWN. In the case of touch scrolling the nested scroll will be terminated automatically in the same manner as ViewParent#requestDisallowInterceptTouchEvent(boolean). In the event of programmatic scrolling the caller must explicitly call stopNestedScroll() to indicate the end of the nested scroll. If startNestedScroll returns true, a cooperative parent was found. If it returns false the caller may ignore the rest of this contract until the next scroll. Calling startNestedScroll while a nested scroll is already in progress will return true. At each incremental step of the scroll the caller should invoke dispatchNestedPreScroll once it has calculated the requested scrolling delta. If it returns true the nested scrolling parent at least partially consumed the scroll and the caller should adjust the amount it scrolls by. After applying the remainder of the scroll delta the caller should invoke dispatchNestedScroll, passing both the delta consumed and the delta unconsumed. A nested scrolling parent may treat these values differently. See ViewParent#onNestedScroll(View, int, int, int, int). Unit stopNestedScroll() Stop a nested scroll in progress. Calling this method when a nested scroll is not currently in progress is harmless. String toString() Unit transformMatrixToGlobal(matrix: Matrix) Modifies the input matrix such that it maps view-local coordinates to on-screen coordinates. Unit transformMatrixToLocal(matrix: Matrix) Modifies the input matrix such that it maps on-screen coordinates to view-local coordinates. Unit unscheduleDrawable(who: Drawable, what: Runnable) Cancels a scheduled action on a drawable. Unit unscheduleDrawable(who: Drawable!) Unschedule any events associated with the given Drawable. This can be used when selecting a new Drawable into a view, so that the previous one is completely unscheduled. Unit updateDragShadow(shadowBuilder: View.DragShadowBuilder!) Updates the drag shadow for the ongoing drag and drop operation. Boolean verifyDrawable(who: Drawable) If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying. This allows animations for those drawables to be scheduled. Be sure to call through to the super class when overriding this function. If you override this method you must call through to the superclass implementation. Boolean willNotCacheDrawing() Returns whether or not this View can cache its drawing or not. Boolean willNotDraw() Returns whether or not this View draws on its own.
From class SurfaceView Unit applyTransactionToFrame(transaction: SurfaceControl.Transaction) Adds a transaction that would be applied synchronously with displaying the SurfaceView's next frame. Note that the exact frame that the transaction is applied with is only well-defined when SurfaceView rendering is paused prior to calling applyTransactionToFrame(), so that the transaction is applied with the next frame rendered after applyTransactionToFrame() is called. If frames are continuously rendering to the SurfaceView when applyTransactionToFrame() is called, then it is undefined which frame the transaction is applied with. It is also possible for the transaction to not be applied if no new frames are rendered to the SurfaceView after this is called. Unit dispatchDraw(canvas: Canvas) Unit draw(canvas: Canvas) Boolean gatherTransparentRegion(region: Region?) SurfaceHolder! getHolder() Return the SurfaceHolder providing access and control over this SurfaceView's underlying surface. IBinder? getHostToken() A token used for constructing SurfaceControlViewHost. This token should be passed from the host process to the client process. Int getImportantForAccessibility() SurfaceControl! getSurfaceControl() Return a SurfaceControl which can be used for parenting Surfaces to this SurfaceView. Note that this SurfaceControl is effectively read-only. Its only well-defined usage is in using the SurfaceControl as a parent for an application's hierarchy of SurfaceControls. All other properties of the SurfaceControl, such as its position, may be mutated by the SurfaceView at any time which will override what the application is requesting. Do not apply any SurfaceControl.Transaction to this SurfaceControl except for reparenting child SurfaceControls. See: SurfaceControl.Transaction#reparent. Boolean hasOverlappingRendering() Unit onFocusChanged(gainFocus: Boolean, direction: Int, previouslyFocusedRect: Rect?) Called by the view system when the focus state of this view changes. When the focus change event is caused by directional navigation, direction and previouslyFocusedRect provide insight into where the focus is coming from. When overriding, be sure to call up through to the super class so that the standard focus handling will occur. If you override this method you must call through to the superclass implementation. Unit onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int) Boolean onSetAlpha(alpha: Int) Unit onWindowVisibilityChanged(visibility: Int) Unit setAlpha(alpha: Float) Unit setChildSurfacePackage(p: SurfaceControlViewHost.SurfacePackage) Display the view-hierarchy embedded within a SurfaceControlViewHost.SurfacePackage within this SurfaceView. This can be called independently of the SurfaceView lifetime callbacks. SurfaceView will internally manage reparenting the package to our Surface as it is created and destroyed. If this SurfaceView is above its host Surface (see setZOrderOnTop then the embedded Surface hierarchy will be able to receive input. This will take ownership of the SurfaceControl contained inside the SurfacePackage and free the caller of the obligation to call SurfaceControlViewHost.SurfacePackage#release. However, note that SurfaceControlViewHost.SurfacePackage#release and SurfaceControlViewHost#release are not the same. While the ownership of this particular SurfaceControlViewHost.SurfacePackage will be taken by the SurfaceView the underlying SurfaceControlViewHost remains managed by it's original remote-owner. Unit setClipBounds(clipBounds: Rect!) Unit setDesiredHdrHeadroom(desiredHeadroom: Float) Sets the desired amount of HDR headroom to be used when HDR content is presented on this SurfaceView. By default the system will choose an amount of HDR headroom that is appropriate for the underlying device capabilities & bit-depth of the panel. However, for some types of content this can end up being more headroom than necessary or desired. An example would be a messaging app or gallery thumbnail view where some amount of HDR pop is desired without overly influencing the perceived brightness of the majority SDR content. This can also be used to animate in/out of an HDR range for smoother transitions. Note: The actual amount of HDR headroom that will be given is subject to a variety of factors such as ambient conditions, display capabilities, or bit-depth limitations. See Display#getHdrSdrRatio() for more information as well as how to query the current value. Unit setSecure(isSecure: Boolean) Control whether the surface view's content should be treated as secure, preventing it from appearing in screenshots or from being viewed on non-secure displays. Note that this must be set before the surface view's containing window is attached to the window manager. See android.view.Display#FLAG_SECURE for details. Unit setSurfaceLifecycle(lifecycleStrategy: Int) Controls the lifecycle of the Surface owned by this SurfaceView. By default, the lifecycycle strategy employed by the SurfaceView is SURFACE_LIFECYCLE_DEFAULT. Unit setVisibility(visibility: Int) Unit setZOrderMediaOverlay(isMediaOverlay: Boolean) Control whether the surface view's surface is placed on top of another regular surface view in the window (but still behind the window itself). This is typically used to place overlays on top of an underlying media surface view. Note that this must be set before the surface view's containing window is attached to the window manager. Calling this overrides any previous call to setZOrderOnTop. Unit setZOrderOnTop(onTop: Boolean) Control whether the surface view's surface is placed on top of its window. Normally it is placed behind the window, to allow it to (for the most part) appear to composite with the views in the hierarchy. By setting this, you cause it to be placed above the window. This means that none of the contents of the window this SurfaceView is in will be visible on top of its surface. Note that this must be set before the surface view's containing window is attached to the window manager. If you target Build.VERSION_CODES#R the Z ordering can be changed dynamically if the backing surface is created, otherwise it would be applied at surface construction time. Calling this overrides any previous call to setZOrderMediaOverlay.

Inherited properties

From class View Property<View!, Float!>! ALPHA A Property wrapper around the alpha functionality handled by the View#setAlpha(float) and View#getAlpha() methods. IntArray! EMPTY_STATE_SET Indicates the view has no states set. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state. IntArray! ENABLED_FOCUSED_SELECTED_STATE_SET Indicates the view is enabled, focused and selected. IntArray! ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET Indicates the view is enabled, focused, selected and its window has the focus. IntArray! ENABLED_FOCUSED_STATE_SET Indicates the view is enabled and has the focus. IntArray! ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET Indicates the view is enabled, focused and its window has the focus. IntArray! ENABLED_SELECTED_STATE_SET Indicates the view is enabled and selected. IntArray! ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET Indicates the view is enabled, selected and its window has the focus. IntArray! ENABLED_STATE_SET Indicates the view is enabled. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state. IntArray! ENABLED_WINDOW_FOCUSED_STATE_SET Indicates the view is enabled and that its window has focus. IntArray! FOCUSED_SELECTED_STATE_SET Indicates the view is focused and selected. IntArray! FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET Indicates the view is focused, selected and its window has the focus. IntArray! FOCUSED_STATE_SET Indicates the view is focused. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state. IntArray! FOCUSED_WINDOW_FOCUSED_STATE_SET Indicates the view has the focus and that its window has the focus. IntArray! PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET Indicates the view is pressed, enabled, focused and selected. IntArray! PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET Indicates the view is pressed, enabled, focused, selected and its window has the focus. IntArray! PRESSED_ENABLED_FOCUSED_STATE_SET Indicates the view is pressed, enabled and focused. IntArray! PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET Indicates the view is pressed, enabled, focused and its window has the focus. IntArray! PRESSED_ENABLED_SELECTED_STATE_SET Indicates the view is pressed, enabled and selected. IntArray! PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET Indicates the view is pressed, enabled, selected and its window has the focus. IntArray! PRESSED_ENABLED_STATE_SET Indicates the view is pressed and enabled. IntArray! PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET Indicates the view is pressed, enabled and its window has the focus. IntArray! PRESSED_FOCUSED_SELECTED_STATE_SET Indicates the view is pressed, focused and selected. IntArray! PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET Indicates the view is pressed, focused, selected and its window has the focus. IntArray! PRESSED_FOCUSED_STATE_SET Indicates the view is pressed and focused. IntArray! PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET Indicates the view is pressed, focused and its window has the focus. IntArray! PRESSED_SELECTED_STATE_SET Indicates the view is pressed and selected. IntArray! PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET Indicates the view is pressed, selected and its window has the focus. IntArray! PRESSED_STATE_SET Indicates the view is pressed. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state. IntArray! PRESSED_WINDOW_FOCUSED_STATE_SET Indicates the view is pressed and its window has the focus. Property<View!, Float!>! ROTATION A Property wrapper around the rotation functionality handled by the View#setRotation(float) and View#getRotation() methods. Property<View!, Float!>! ROTATION_X A Property wrapper around the rotationX functionality handled by the View#setRotationX(float) and View#getRotationX() methods. Property<View!, Float!>! ROTATION_Y A Property wrapper around the rotationY functionality handled by the View#setRotationY(float) and View#getRotationY() methods. Property<View!, Float!>! SCALE_X A Property wrapper around the scaleX functionality handled by the View#setScaleX(float) and View#getScaleX() methods. Property<View!, Float!>! SCALE_Y A Property wrapper around the scaleY functionality handled by the View#setScaleY(float) and View#getScaleY() methods. IntArray! SELECTED_STATE_SET Indicates the view is selected. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state. IntArray! SELECTED_WINDOW_FOCUSED_STATE_SET Indicates the view is selected and that its window has the focus. Property<View!, Float!>! TRANSLATION_X A Property wrapper around the translationX functionality handled by the View#setTranslationX(float) and View#getTranslationX() methods. Property<View!, Float!>! TRANSLATION_Y A Property wrapper around the translationY functionality handled by the View#setTranslationY(float) and View#getTranslationY() methods. Property<View!, Float!>! TRANSLATION_Z A Property wrapper around the translationZ functionality handled by the View#setTranslationZ(float) and View#getTranslationZ() methods. IntArray! WINDOW_FOCUSED_STATE_SET Indicates the view's window has focus. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state. Property<View!, Float!>! X A Property wrapper around the x functionality handled by the View#setX(float) and View#getX() methods. Property<View!, Float!>! Y A Property wrapper around the y functionality handled by the View#setY(float) and View#getY() methods. Property<View!, Float!>! Z A Property wrapper around the z functionality handled by the View#setZ(float) and View#getZ() methods.

Constants

DEBUG_CHECK_GL_ERROR

Added in API level 3

static val DEBUG_CHECK_GL_ERROR: Int

Check glError() after every GL call and throw an exception if glError indicates that an error has occurred. This can be used to help track down which OpenGL ES call is causing an error.

Value: 1

See Also

• #getDebugFlags
• #setDebugFlags

DEBUG_LOG_GL_CALLS

Added in API level 3

static val DEBUG_LOG_GL_CALLS: Int

Log GL calls to the system log at "verbose" level with tag "GLSurfaceView".

Value: 2

See Also

• #getDebugFlags
• #setDebugFlags

RENDERMODE_CONTINUOUSLY

Added in API level 3

static val RENDERMODE_CONTINUOUSLY: Int

The renderer is called continuously to re-render the scene.

Value: 1

See Also

• #getRenderMode()
• #setRenderMode(int)

RENDERMODE_WHEN_DIRTY

Added in API level 3

static val RENDERMODE_WHEN_DIRTY: Int

The renderer only renders when the surface is created, or when requestRender is called.

Value: 0

See Also

• #getRenderMode()
• #setRenderMode(int)
• #requestRender()

Public constructors

GLSurfaceView

Added in API level 3

GLSurfaceView(context: Context!)

Standard View constructor. In order to render something, you must call setRenderer to register a renderer.

GLSurfaceView

Added in API level 3

GLSurfaceView(
    context: Context!, 
    attrs: AttributeSet!)

Standard View constructor. In order to render something, you must call setRenderer to register a renderer.

Public methods

getDebugFlags

Added in API level 3

open fun getDebugFlags(): Int

Get the current value of the debug flags.

Return
Int	the current value of the debug flags.

getPreserveEGLContextOnPause

Added in API level 11

open fun getPreserveEGLContextOnPause(): Boolean

Return
Boolean	true if the EGL context will be preserved when paused

getRenderMode

Added in API level 3

open fun getRenderMode(): Int

Get the current rendering mode. May be called from any thread. Must not be called before a renderer has been set.

Return
Int	the current rendering mode.

See Also

• #RENDERMODE_CONTINUOUSLY
• #RENDERMODE_WHEN_DIRTY

onPause

Added in API level 3

open fun onPause(): Unit

Pause the rendering thread, optionally tearing down the EGL context depending upon the value of setPreserveEGLContextOnPause(boolean). This method should be called when it is no longer desirable for the GLSurfaceView to continue rendering, such as in response to Activity.onStop. Must not be called before a renderer has been set.

onResume

Added in API level 3

open fun onResume(): Unit

Resumes the rendering thread, re-creating the OpenGL context if necessary. It is the counterpart to onPause(). This method should typically be called in Activity.onStart. Must not be called before a renderer has been set.

queueEvent

Added in API level 3

open fun queueEvent(r: Runnable!): Unit

Queue a runnable to be run on the GL rendering thread. This can be used to communicate with the Renderer on the rendering thread. Must not be called before a renderer has been set.

Parameters
r	Runnable!: the runnable to be run on the GL rendering thread.

requestRender

Added in API level 3

open fun requestRender(): Unit

Request that the renderer render a frame. This method is typically used when the render mode has been set to RENDERMODE_WHEN_DIRTY, so that frames are only rendered on demand. May be called from any thread. Must not be called before a renderer has been set.

setDebugFlags

Added in API level 3

open fun setDebugFlags(debugFlags: Int): Unit

Set the debug flags to a new value. The value is constructed by OR-together zero or more of the DEBUG_CHECK_* constants. The debug flags take effect whenever a surface is created. The default value is zero.

Parameters
debugFlags	Int: the new debug flags

See Also

• #DEBUG_CHECK_GL_ERROR
• #DEBUG_LOG_GL_CALLS

setEGLConfigChooser

Added in API level 3

open fun setEGLConfigChooser(configChooser: GLSurfaceView.EGLConfigChooser!): Unit

Install a custom EGLConfigChooser.

If this method is called, it must be called before setRenderer(android.opengl.GLSurfaceView.Renderer) is called.

If no setEGLConfigChooser method is called, then by default the view will choose an EGLConfig that is compatible with the current android.view.Surface, with a depth buffer depth of at least 16 bits.

Parameters
configChooser	GLSurfaceView.EGLConfigChooser!:

setEGLConfigChooser

Added in API level 3

open fun setEGLConfigChooser(needDepth: Boolean): Unit

Install a config chooser which will choose a config as close to 16-bit RGB as possible, with or without an optional depth buffer as close to 16-bits as possible.

If this method is called, it must be called before setRenderer(android.opengl.GLSurfaceView.Renderer) is called.

If no setEGLConfigChooser method is called, then by default the view will choose an RGB_888 surface with a depth buffer depth of at least 16 bits.

Parameters
needDepth	Boolean:

setEGLConfigChooser

Added in API level 3

open fun setEGLConfigChooser(
    redSize: Int, 
    greenSize: Int, 
    blueSize: Int, 
    alphaSize: Int, 
    depthSize: Int, 
    stencilSize: Int
): Unit

Install a config chooser which will choose a config with at least the specified depthSize and stencilSize, and exactly the specified redSize, greenSize, blueSize and alphaSize.

If this method is called, it must be called before setRenderer(android.opengl.GLSurfaceView.Renderer) is called.

If no setEGLConfigChooser method is called, then by default the view will choose an RGB_888 surface with a depth buffer depth of at least 16 bits.

setEGLContextClientVersion

Added in API level 8

open fun setEGLContextClientVersion(version: Int): Unit

Inform the default EGLContextFactory and default EGLConfigChooser which EGLContext client version to pick.

Use this method to create an OpenGL ES 2.0-compatible context. Example:

public MyView(Context context) {
          super(context);
          setEGLContextClientVersion(2); // Pick an OpenGL ES 2.0 context.
          setRenderer(new MyRenderer());
      }
  

Note: Activities which require OpenGL ES 2.0 should indicate this by setting @lt;uses-feature android:glEsVersion="0x00020000" /> in the activity's AndroidManifest.xml file.

If this method is called, it must be called before setRenderer(android.opengl.GLSurfaceView.Renderer) is called.

This method only affects the behavior of the default EGLContexFactory and the default EGLConfigChooser. If setEGLContextFactory(android.opengl.GLSurfaceView.EGLContextFactory) has been called, then the supplied EGLContextFactory is responsible for creating an OpenGL ES 2.0-compatible context. If setEGLConfigChooser(android.opengl.GLSurfaceView.EGLConfigChooser) has been called, then the supplied EGLConfigChooser is responsible for choosing an OpenGL ES 2.0-compatible config.

Parameters
version	Int: The EGLContext client version to choose. Use 2 for OpenGL ES 2.0

setEGLContextFactory

Added in API level 5

open fun setEGLContextFactory(factory: GLSurfaceView.EGLContextFactory!): Unit

Install a custom EGLContextFactory.

If this method is called, it must be called before setRenderer(android.opengl.GLSurfaceView.Renderer) is called.

If this method is not called, then by default a context will be created with no shared context and with a null attribute list.

setEGLWindowSurfaceFactory

Added in API level 5

open fun setEGLWindowSurfaceFactory(factory: GLSurfaceView.EGLWindowSurfaceFactory!): Unit

Install a custom EGLWindowSurfaceFactory.

If this method is called, it must be called before setRenderer(android.opengl.GLSurfaceView.Renderer) is called.

If this method is not called, then by default a window surface will be created with a null attribute list.

setGLWrapper

Added in API level 3

open fun setGLWrapper(glWrapper: GLSurfaceView.GLWrapper!): Unit

Set the glWrapper. If the glWrapper is not null, its GLWrapper#wrap(GL) method is called whenever a surface is created. A GLWrapper can be used to wrap the GL object that's passed to the renderer. Wrapping a GL object enables examining and modifying the behavior of the GL calls made by the renderer.

Wrapping is typically used for debugging purposes.

The default value is null.

Parameters
glWrapper	GLSurfaceView.GLWrapper!: the new GLWrapper

setPreserveEGLContextOnPause

Added in API level 11

open fun setPreserveEGLContextOnPause(preserveOnPause: Boolean): Unit

Control whether the EGL context is preserved when the GLSurfaceView is paused and resumed.

If set to true, then the EGL context may be preserved when the GLSurfaceView is paused.

Prior to API level 11, whether the EGL context is actually preserved or not depends upon whether the Android device can support an arbitrary number of EGL contexts or not. Devices that can only support a limited number of EGL contexts must release the EGL context in order to allow multiple applications to share the GPU.

If set to false, the EGL context will be released when the GLSurfaceView is paused, and recreated when the GLSurfaceView is resumed.

The default is false.

Parameters
preserveOnPause	Boolean: preserve the EGL context when paused

setRenderMode

Added in API level 3

open fun setRenderMode(renderMode: Int): Unit

Set the rendering mode. When renderMode is RENDERMODE_CONTINUOUSLY, the renderer is called repeatedly to re-render the scene. When renderMode is RENDERMODE_WHEN_DIRTY, the renderer only rendered when the surface is created, or when requestRender is called. Defaults to RENDERMODE_CONTINUOUSLY.

Using RENDERMODE_WHEN_DIRTY can improve battery life and overall system performance by allowing the GPU and CPU to idle when the view does not need to be updated.

This method can only be called after setRenderer(android.opengl.GLSurfaceView.Renderer)

Parameters
renderMode	Int: one of the RENDERMODE_X constants

See Also

• #RENDERMODE_CONTINUOUSLY
• #RENDERMODE_WHEN_DIRTY

setRenderer

Added in API level 3

open fun setRenderer(renderer: GLSurfaceView.Renderer!): Unit

Set the renderer associated with this view. Also starts the thread that will call the renderer, which in turn causes the rendering to start.

This method should be called once and only once in the life-cycle of a GLSurfaceView.

The following GLSurfaceView methods can only be called before setRenderer is called:

• setEGLConfigChooser(boolean)
• setEGLConfigChooser(android.opengl.GLSurfaceView.EGLConfigChooser)
• setEGLConfigChooser(int,int,int,int,int,int)

The following GLSurfaceView methods can only be called after setRenderer is called:

• getRenderMode()
• onPause()
• onResume()
• queueEvent(java.lang.Runnable)
• requestRender()
• setRenderMode(int)

Parameters
renderer	GLSurfaceView.Renderer!: the renderer to use to perform OpenGL drawing.

surfaceChanged

Added in API level 3

open fun surfaceChanged(
    holder: SurfaceHolder, 
    format: Int, 
    w: Int, 
    h: Int
): Unit

This method is part of the SurfaceHolder.Callback interface, and is not normally called or subclassed by clients of GLSurfaceView.

Parameters
holder	SurfaceHolder: The SurfaceHolder whose surface has changed. This value cannot be null.
format	Int: The new PixelFormat of the surface. Value is android.graphics.PixelFormat#RGBA_8888, android.graphics.PixelFormat#RGBX_8888, android.graphics.PixelFormat#RGBA_F16, android.graphics.PixelFormat#RGBA_1010102, android.graphics.PixelFormat#RGB_888, android.graphics.PixelFormat#RGB_565, or android.graphics.PixelFormat.R_8
width	The new width of the surface. Value is 0 or greater
height	The new height of the surface. Value is 0 or greater

surfaceCreated

Added in API level 3

open fun surfaceCreated(holder: SurfaceHolder): Unit

This method is part of the SurfaceHolder.Callback interface, and is not normally called or subclassed by clients of GLSurfaceView.

Parameters
holder	SurfaceHolder: The SurfaceHolder whose surface is being created. This value cannot be null.

surfaceDestroyed

Added in API level 3

open fun surfaceDestroyed(holder: SurfaceHolder): Unit

This method is part of the SurfaceHolder.Callback interface, and is not normally called or subclassed by clients of GLSurfaceView.

Parameters
holder	SurfaceHolder: The SurfaceHolder whose surface is being destroyed. This value cannot be null.

surfaceRedrawNeeded

Added in API level 24

open fun surfaceRedrawNeeded(holder: SurfaceHolder): Unit

Deprecated: Deprecated in Java.

This method is part of the SurfaceHolder.Callback2 interface, and is not normally called or subclassed by clients of GLSurfaceView.

Parameters
holder	SurfaceHolder: The SurfaceHolder whose surface has changed. This value cannot be null.

surfaceRedrawNeededAsync

Added in API level 26

open fun surfaceRedrawNeededAsync(
    holder: SurfaceHolder, 
    finishDrawing: Runnable
): Unit

This method is part of the SurfaceHolder.Callback2 interface, and is not normally called or subclassed by clients of GLSurfaceView.

Parameters
holder	SurfaceHolder: The SurfaceHolder which needs redrawing. This value cannot be null.
drawingFinished	A runnable to signal completion. This may be invoked from any thread. This value cannot be null.

Protected methods

finalize

Added in API level 3

protected open fun finalize(): Unit

Exceptions
java.lang.Throwable	the Exception raised by this method

onAttachedToWindow

Added in API level 3

protected open fun onAttachedToWindow(): Unit

This method is used as part of the View class and is not normally called or subclassed by clients of GLSurfaceView.

onDetachedFromWindow

Added in API level 3

protected open fun onDetachedFromWindow(): Unit