Google is committed to advancing racial equity for Black communities. See how.
Added in API level 1

View

open class View : Drawable.Callback, KeyEvent.Callback, AccessibilityEventSource
kotlin.Any
   ↳ android.view.View

This class represents the basic building block for user interface components. A View occupies a rectangular area on the screen and is responsible for drawing and event handling. View is the base class for widgets, which are used to create interactive UI components (buttons, text fields, etc.). The android.view.ViewGroup subclass is the base class for layouts, which are invisible containers that hold other Views (or other ViewGroups) and define their layout properties.

Using Views

All of the views in a window are arranged in a single tree. You can add views either from code or by specifying a tree of views in one or more XML layout files. There are many specialized subclasses of views that act as controls or are capable of displaying text, images, or other content.

Once you have created a tree of views, there are typically a few types of common operations you may wish to perform:

  • Set properties: for example setting the text of a android.widget.TextView. The available properties and the methods that set them will vary among the different subclasses of views. Note that properties that are known at build time can be set in the XML layout files.
  • Set focus: The framework will handle moving focus in response to user input. To force focus to a specific view, call requestFocus.
  • Set up listeners: Views allow clients to set listeners that will be notified when something interesting happens to the view. For example, all views will let you set a listener to be notified when the view gains or loses focus. You can register such a listener using setOnFocusChangeListener(android.view.View.OnFocusChangeListener). Other view subclasses offer more specialized listeners. For example, a Button exposes a listener to notify clients when the button is clicked.
  • Set visibility: You can hide or show views using setVisibility(int).

Note: The Android framework is responsible for measuring, laying out and drawing views. You should not call methods that perform these actions on views yourself unless you are actually implementing a android.view.ViewGroup.

Implementing a Custom View

To implement a custom view, you will usually begin by providing overrides for some of the standard methods that the framework calls on all views. You do not need to override all of these methods. In fact, you can start by just overriding onDraw(android.graphics.Canvas).

Category Methods Description
Creation Constructors There is a form of the constructor that are called when the view is created from code and a form that is called when the view is inflated from a layout file. The second form should parse and apply any attributes defined in the layout file.
onFinishInflate() Called after a view and all of its children has been inflated from XML.
Layout onMeasure(int,int) Called to determine the size requirements for this view and all of its children.
onLayout(boolean,int,int,int,int) Called when this view should assign a size and position to all of its children.
onSizeChanged(int,int,int,int) Called when the size of this view has changed.
Drawing onDraw(android.graphics.Canvas) Called when the view should render its content.
Event processing onKeyDown(int,android.view.KeyEvent) Called when a new hardware key event occurs.
onKeyUp(int,android.view.KeyEvent) Called when a hardware key up event occurs.
onTrackballEvent(android.view.MotionEvent) Called when a trackball motion event occurs.
onTouchEvent(android.view.MotionEvent) Called when a touch screen motion event occurs.
Focus onFocusChanged(boolean,int,android.graphics.Rect) Called when the view gains or loses focus.
onWindowFocusChanged(boolean) Called when the window containing the view gains or loses focus.
Attaching onAttachedToWindow() Called when the view is attached to a window.
onDetachedFromWindow Called when the view is detached from its window.
onWindowVisibilityChanged(int) Called when the visibility of the window containing the view has changed.

IDs

Views may have an integer id associated with them. These ids are typically assigned in the layout XML files, and are used to find specific views within the view tree. A common pattern is to:
  • Define a Button in the layout file and assign it a unique ID.
    <Button
          android:id="@+id/my_button"
          android:layout_width="wrap_content"
          android:layout_height="wrap_content"
          android:text="@string/my_button_text"/>
      
  • From the onCreate method of an Activity, find the Button
    Button myButton = findViewById(R.id.my_button);
      

View IDs need not be unique throughout the tree, but it is good practice to ensure that they are at least unique within the part of the tree you are searching.

Position

The geometry of a view is that of a rectangle. A view has a location, expressed as a pair of left and top coordinates, and two dimensions, expressed as a width and a height. The unit for location and dimensions is the pixel.

It is possible to retrieve the location of a view by invoking the methods getLeft() and getTop(). The former returns the left, or X, coordinate of the rectangle representing the view. The latter returns the top, or Y, coordinate of the rectangle representing the view. These methods both return the location of the view relative to its parent. For instance, when getLeft() returns 20, that means the view is located 20 pixels to the right of the left edge of its direct parent.

In addition, several convenience methods are offered to avoid unnecessary computations, namely getRight() and getBottom(). These methods return the coordinates of the right and bottom edges of the rectangle representing the view. For instance, calling getRight() is similar to the following computation: getLeft() + getWidth() (see Size for more information about the width.)

Size, padding and margins

The size of a view is expressed with a width and a height. A view actually possess two pairs of width and height values.

The first pair is known as measured width and measured height. These dimensions define how big a view wants to be within its parent (see Layout for more details.) The measured dimensions can be obtained by calling getMeasuredWidth() and getMeasuredHeight().

The second pair is simply known as width and height, or sometimes drawing width and drawing height. These dimensions define the actual size of the view on screen, at drawing time and after layout. These values may, but do not have to, be different from the measured width and height. The width and height can be obtained by calling getWidth() and getHeight().

To measure its dimensions, a view takes into account its padding. The padding is expressed in pixels for the left, top, right and bottom parts of the view. Padding can be used to offset the content of the view by a specific amount of pixels. For instance, a left padding of 2 will push the view's content by 2 pixels to the right of the left edge. Padding can be set using the setPadding(int,int,int,int) or setPaddingRelative(int,int,int,int) method and queried by calling getPaddingLeft(), getPaddingTop(), getPaddingRight(), getPaddingBottom(), getPaddingStart(), getPaddingEnd().

Even though a view can define a padding, it does not provide any support for margins. However, view groups provide such a support. Refer to android.view.ViewGroup and android.view.ViewGroup.MarginLayoutParams for further information.

Layout

Layout is a two pass process: a measure pass and a layout pass. The measuring pass is implemented in measure(int,int) and is a top-down traversal of the view tree. Each view pushes dimension specifications down the tree during the recursion. At the end of the measure pass, every view has stored its measurements. The second pass happens in layout(int,int,int,int) and is also top-down. During this pass each parent is responsible for positioning all of its children using the sizes computed in the measure pass.

When a view's measure() method returns, its getMeasuredWidth() and getMeasuredHeight() values must be set, along with those for all of that view's descendants. A view's measured width and measured height values must respect the constraints imposed by the view's parents. This guarantees that at the end of the measure pass, all parents accept all of their children's measurements. A parent view may call measure() more than once on its children. For example, the parent may measure each child once with unspecified dimensions to find out how big they want to be, then call measure() on them again with actual numbers if the sum of all the children's unconstrained sizes is too big or too small.

The measure pass uses two classes to communicate dimensions. The MeasureSpec class is used by views to tell their parents how they want to be measured and positioned. The base LayoutParams class just describes how big the view wants to be for both width and height. For each dimension, it can specify one of:

  • an exact number
  • MATCH_PARENT, which means the view wants to be as big as its parent (minus padding)
  • WRAP_CONTENT, which means that the view wants to be just big enough to enclose its content (plus padding).
There are subclasses of LayoutParams for different subclasses of ViewGroup. For example, AbsoluteLayout has its own subclass of LayoutParams which adds an X and Y value.

MeasureSpecs are used to push requirements down the tree from parent to child. A MeasureSpec can be in one of three modes:

  • UNSPECIFIED: This is used by a parent to determine the desired dimension of a child view. For example, a LinearLayout may call measure() on its child with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how tall the child view wants to be given a width of 240 pixels.
  • EXACTLY: This is used by the parent to impose an exact size on the child. The child must use this size, and guarantee that all of its descendants will fit within this size.
  • AT_MOST: This is used by the parent to impose a maximum size on the child. The child must guarantee that it and all of its descendants will fit within this size.

To initiate a layout, call requestLayout. This method is typically called by a view on itself when it believes that it can no longer fit within its current bounds.

Drawing

Drawing is handled by walking the tree and recording the drawing commands of any View that needs to update. After this, the drawing commands of the entire tree are issued to screen, clipped to the newly damaged area.

The tree is largely recorded and drawn in order, with parents drawn before (i.e., behind) their children, with siblings drawn in the order they appear in the tree. If you set a background drawable for a View, then the View will draw it before calling back to its onDraw() method. The child drawing order can be overridden with ViewGroup#setChildrenDrawingOrderEnabled(boolean) in a ViewGroup, and with setZ(float) custom Z values} set on Views.

To force a view to draw, call invalidate().

Event Handling and Threading

The basic cycle of a view is as follows:

  1. An event comes in and is dispatched to the appropriate view. The view handles the event and notifies any listeners.
  2. If in the course of processing the event, the view's bounds may need to be changed, the view will call requestLayout().
  3. Similarly, if in the course of processing the event the view's appearance may need to be changed, the view will call invalidate().
  4. If either requestLayout() or invalidate() were called, the framework will take care of measuring, laying out, and drawing the tree as appropriate.

Note: The entire view tree is single threaded. You must always be on the UI thread when calling any method on any view. If you are doing work on other threads and want to update the state of a view from that thread, you should use a Handler.

Focus Handling

The framework will handle routine focus movement in response to user input. This includes changing the focus as views are removed or hidden, or as new views become available. Views indicate their willingness to take focus through the isFocusable method. To change whether a view can take focus, call setFocusable(boolean). When in touch mode (see notes below) views indicate whether they still would like focus via isFocusableInTouchMode and can change this via setFocusableInTouchMode(boolean).

Focus movement is based on an algorithm which finds the nearest neighbor in a given direction. In rare cases, the default algorithm may not match the intended behavior of the developer. In these situations, you can provide explicit overrides by using these XML attributes in the layout file:

nextFocusDown
  nextFocusLeft
  nextFocusRight
  nextFocusUp
  

To get a particular view to take focus, call requestFocus().

Touch Mode

When a user is navigating a user interface via directional keys such as a D-pad, it is necessary to give focus to actionable items such as buttons so the user can see what will take input. If the device has touch capabilities, however, and the user begins interacting with the interface by touching it, it is no longer necessary to always highlight, or give focus to, a particular view. This motivates a mode for interaction named 'touch mode'.

For a touch capable device, once the user touches the screen, the device will enter touch mode. From this point onward, only views for which isFocusableInTouchMode is true will be focusable, such as text editing widgets. Other views that are touchable, like buttons, will not take focus when touched; they will only fire the on click listeners.

Any time a user hits a directional key, such as a D-pad direction, the view device will exit touch mode, and find a view to take focus, so that the user may resume interacting with the user interface without touching the screen again.

The touch mode state is maintained across android.app.Activitys. Call isInTouchMode to see whether the device is currently in touch mode.

Scrolling

The framework provides basic support for views that wish to internally scroll their content. This includes keeping track of the X and Y scroll offset as well as mechanisms for drawing scrollbars. See scrollBy(int,int), scrollTo(int,int), and awakenScrollBars() for more details.

Tags

Unlike IDs, tags are not used to identify views. Tags are essentially an extra piece of information that can be associated with a view. They are most often used as a convenience to store data related to views in the views themselves rather than by putting them in a separate structure.

Tags may be specified with character sequence values in layout XML as either a single tag using the android:tag attribute or multiple tags using the <tag> child element:

<View ...
            android:tag="@string/mytag_value" />
      <View ...>
          <tag android:id="@+id/mytag"
               android:value="@string/mytag_value" />
      </View>
  

Tags may also be specified with arbitrary objects from code using setTag(java.lang.Object) or setTag(int,java.lang.Object).

Themes

By default, Views are created using the theme of the Context object supplied to their constructor; however, a different theme may be specified by using the android:theme attribute in layout XML or by passing a ContextThemeWrapper to the constructor from code.

When the android:theme attribute is used in XML, the specified theme is applied on top of the inflation context's theme (see LayoutInflater) and used for the view itself as well as any child elements.

In the following example, both views will be created using the Material dark color scheme; however, because an overlay theme is used which only defines a subset of attributes, the value of android:colorAccent defined on the inflation context's theme (e.g. the Activity theme) will be preserved.

<LinearLayout
              ...
              android:theme="@android:theme/ThemeOverlay.Material.Dark">
          <View ...>
      </LinearLayout>
  

Properties

The View class exposes an ALPHA property, as well as several transform-related properties, such as TRANSLATION_X and TRANSLATION_Y. These properties are available both in the Property form as well as in similarly-named setter/getter methods (such as setAlpha(float) for ALPHA). These properties can be used to set persistent state associated with these rendering-related properties on the view. The properties and methods can also be used in conjunction with Animator-based animations, described more in the Animation section.

Animation

Starting with Android 3.0, the preferred way of animating views is to use the android.animation package APIs. These Animator-based classes change actual properties of the View object, such as alpha and translationX. This behavior is contrasted to that of the pre-3.0 Animation-based classes, which instead animate only how the view is drawn on the display. In particular, the ViewPropertyAnimator class makes animating these View properties particularly easy and efficient.

Alternatively, you can use the pre-3.0 animation classes to animate how Views are rendered. You can attach an Animation object to a view using setAnimation(android.view.animation.Animation) or startAnimation(android.view.animation.Animation). The animation can alter the scale, rotation, translation and alpha of a view over time. If the animation is attached to a view that has children, the animation will affect the entire subtree rooted by that node. When an animation is started, the framework will take care of redrawing the appropriate views until the animation completes.

Security

Sometimes it is essential that an application be able to verify that an action is being performed with the full knowledge and consent of the user, such as granting a permission request, making a purchase or clicking on an advertisement. Unfortunately, a malicious application could try to spoof the user into performing these actions, unaware, by concealing the intended purpose of the view. As a remedy, the framework offers a touch filtering mechanism that can be used to improve the security of views that provide access to sensitive functionality.

To enable touch filtering, call setFilterTouchesWhenObscured(boolean) or set the android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework will discard touches that are received whenever the view's window is obscured by another visible window. As a result, the view will not receive touches whenever a toast, dialog or other window appears above the view's window.

For more fine-grained control over security, consider overriding the onFilterTouchEventForSecurity(android.view.MotionEvent) method to implement your own security policy. See also MotionEvent#FLAG_WINDOW_IS_OBSCURED.

Summary

Nested classes

open

This class represents a delegate that can be registered in a View to enhance accessibility support via composition rather via inheritance.

open

Base class for derived classes that want to save and restore their own state in android.view.View#onSaveInstanceState().

open

Creates an image that the system displays during the drag and drop operation.

open

A MeasureSpec encapsulates the layout requirements passed from parent to child.

abstract

Listener for applying window insets on a view in a custom way.

abstract

Interface definition for a callback to be invoked when this view is attached or detached from its window.

abstract

Interface definition for a callback to be invoked when a captured pointer event is being dispatched this view.

abstract

Interface definition for a callback to be invoked when a view is clicked.

abstract

Interface definition for a callback to be invoked when a view is context clicked.

abstract

Interface definition for a callback to be invoked when the context menu for this view is being built.

abstract

Interface definition for a callback to be invoked when a drag is being dispatched to this view.

abstract

Interface definition for a callback to be invoked when the focus state of a view changed.

abstract

Interface definition for a callback to be invoked when a generic motion event is dispatched to this view.

abstract

Interface definition for a callback to be invoked when a hover event is dispatched to this view.

abstract

Interface definition for a callback to be invoked when a hardware key event is dispatched to this view.

abstract

Interface definition for a callback to be invoked when the layout bounds of a view changes due to layout processing.

abstract

Interface definition for a callback to be invoked when a view has been clicked and held.

abstract

Interface definition for a callback to be invoked when the scroll X or Y positions of a view change.

abstract

Interface definition for a callback to be invoked when the status bar changes visibility.

abstract

Interface definition for a callback to be invoked when a touch event is dispatched to this view.

abstract

Interface definition for a callback to be invoked when a hardware key event hasn't been handled by the view hierarchy.

XML attributes

android:accessibilityHeading Whether or not this view is a heading for accessibility purposes.
android:alpha alpha property of the view, as a value between 0 (completely transparent) and 1 (completely opaque).
android:background A drawable to use as the background.
android:clickable Defines whether this view reacts to click events.
android:contentDescription Defines text that briefly describes content of the view.
android:drawingCacheQuality Defines the quality of translucent drawing caches.
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.
android:fadeScrollbars Defines whether to fade out scrollbars when they are not in use.
android:fadingEdgeLength Defines the length of the fading edges.
android:filterTouchesWhenObscured Specifies whether to filter touches when the view's window is obscured by another visible window.
android:fitsSystemWindows Boolean internal attribute to adjust view layout based on system windows such as the status bar.
android:focusable Controls whether a view can take focus.
android:focusableInTouchMode Boolean that controls whether a view can take focus while in touch mode.
android:focusedByDefault Whether this view is a default-focus view.
android:hapticFeedbackEnabled Boolean that controls whether a view should have haptic feedback enabled for events such as long presses.
android:id Supply an identifier name for this view, to later retrieve it with View.
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.
android:keepScreenOn Controls whether the view's window should keep the screen on while visible.
android:keyboardNavigationCluster Whether this view is a root of a keyboard navigation cluster.
android:layerType Specifies the type of layer backing this view.
android:layoutDirection Defines the direction of layout drawing.
android:longClickable Defines whether this view reacts to long click events.
android:minHeight Defines the minimum height of the view.
android:minWidth Defines the minimum width of the view.
android:nextClusterForward Defines the next keyboard navigation cluster.
android:nextFocusDown Defines the next view to give focus to when the next focus is android.
android:nextFocusLeft Defines the next view to give focus to when the next focus is android.
android:nextFocusRight Defines the next view to give focus to when the next focus is android.
android:nextFocusUp Defines the next view to give focus to when the next focus is android.
android:onClick Name of the method in this View's context to invoke when the view is clicked.
android:outlineAmbientShadowColor Sets the color of the ambient shadow that is drawn when the view has a positive Z or elevation value.
android:outlineSpotShadowColor Sets the color of the spot shadow that is drawn when the view has a positive Z or elevation value.
android:padding Sets the padding, in pixels, of all four edges.
android:paddingBottom Sets the padding, in pixels, of the bottom edge; see android.
android:paddingEnd Sets the padding, in pixels, of the end edge; see android.
android:paddingHorizontal Sets the padding, in pixels, of the left and right edges; see android.
android:paddingLeft Sets the padding, in pixels, of the left edge; see android.
android:paddingRight Sets the padding, in pixels, of the right edge; see android.
android:paddingStart Sets the padding, in pixels, of the start edge; see android.
android:paddingTop Sets the padding, in pixels, of the top edge; see android.
android:paddingVertical Sets the padding, in pixels, of the top and bottom edges; see android.
android:requiresFadingEdge Defines which edges should be faded on scrolling.
android:rotation rotation of the view, in degrees.
android:rotationX rotation of the view around the x axis, in degrees.
android:rotationY rotation of the view around the y axis, in degrees.
android:saveEnabled If false, no state will be saved for this view when it is being frozen.
android:scaleX scale of the view in the x direction.
android:scaleY scale of the view in the y direction.
android:scrollX The initial horizontal scroll offset, in pixels.
android:scrollY The initial vertical scroll offset, in pixels.
android:scrollbarAlwaysDrawHorizontalTrack Defines whether the horizontal scrollbar track should always be drawn.
android:scrollbarAlwaysDrawVerticalTrack Defines whether the vertical scrollbar track should always be drawn.
android:scrollbarDefaultDelayBeforeFade Defines the delay in milliseconds that a scrollbar waits before fade out.
android:scrollbarFadeDuration Defines the delay in milliseconds that a scrollbar takes to fade out.
android:scrollbarSize Sets the width of vertical scrollbars and height of horizontal scrollbars.
android:scrollbarStyle Controls the scrollbar style and position.
android:scrollbarThumbHorizontal Defines the horizontal scrollbar thumb drawable.
android:scrollbarThumbVertical Defines the vertical scrollbar thumb drawable.
android:scrollbarTrackHorizontal Defines the horizontal scrollbar track drawable.
android:scrollbarTrackVertical Defines the vertical scrollbar track drawable.
android:scrollbars Defines which scrollbars should be displayed on scrolling or not.
android:soundEffectsEnabled Boolean that controls whether a view should have sound effects enabled for events such as clicking and touching.
android:stateListAnimator Sets the state-based animator for the View.
android:tag Supply a tag for this view containing a String, to be retrieved later with View.
android:textAlignment Defines the alignment of the text.
android:textDirection Defines the direction of the text.
android:theme Specifies a theme override for a view.
android:transformPivotX x location of the pivot point around which the view will rotate and scale.
android:transformPivotY y location of the pivot point around which the view will rotate and scale.
android:transitionName Names a View such that it can be identified for Transitions.
android:translationX translation in x of the view.
android:translationY translation in y of the view.
android:translationZ translation in z of the view.
android:visibility Controls the initial visibility of the view.

Constants

static Int

Live region mode specifying that accessibility services should interrupt ongoing speech to immediately announce changes to this view.

static Int

Live region mode specifying that accessibility services should not automatically announce changes to this view.

static Int

Live region mode specifying that accessibility services should announce changes to this view.

static Int

Flag requesting you to add views that are marked as not important for autofill (see setImportantForAutofill(int)) to a ViewStructure.

static String

Hint indicating that this view can be autofilled with a credit card expiration date.

static String

Hint indicating that this view can be autofilled with a credit card expiration day.

static String

Hint indicating that this view can be autofilled with a credit card expiration month.

static String

Hint indicating that this view can be autofilled with a credit card expiration year.

static String

Hint indicating that this view can be autofilled with a credit card number.

static String

Hint indicating that this view can be autofilled with a credit card security code.

static String

Hint indicating that this view can be autofilled with an email address.

static String

Hint indicating that this view can be autofilled with a user's real name.

static String

Hint indicating that this view can be autofilled with a password.

static String

Hint indicating that this view can be autofilled with a phone number.

static String

Hint indicating that this view can be autofilled with a postal address.

static String

Hint indicating that this view can be autofilled with a postal code.

static String

Hint indicating that this view can be autofilled with a username.

static Int

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().

static Int

Autofill type for a selection list field, which is filled by an int representing the element index inside the list (starting at 0).

static Int

Autofill type for views that cannot be autofilled.

static Int

Autofill type for a text field, which is filled by a CharSequence.

static Int

Autofill type for a togglable field, which is filled by a boolean.

static Int

Flag indicating that a drag can cross window boundaries.

static Int

When this flag is used with DRAG_FLAG_GLOBAL_URI_READ and/or , the URI permission grant can be persisted across device reboots until explicitly revoked with android.content.Context#revokeUriPermission(Uri, int) Context.

static Int

When this flag is used with DRAG_FLAG_GLOBAL_URI_READ and/or , the URI permission grant applies to any URI that is a prefix match against the original granted URI.

static Int

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.

static Int

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.

static Int

Flag indicating that the drag shadow will be opaque.

static Int

Enables automatic quality mode for the drawing cache.

static Int

Enables high quality mode for the drawing cache.

static Int

Enables low quality mode for the drawing cache.

static Int

Find find views that contain the specified content description.

static Int

Find views that render the specified text.

static Int

This view wants keystrokes.

static Int

View flag indicating whether addFocusables(java.util.ArrayList,int,int) should add all focusable Views regardless if they are focusable in touch mode.

static Int

View flag indicating whether addFocusables(java.util.ArrayList,int,int) should add only Views focusable in touch mode.

static Int

This view determines focusability automatically.

static Int

Use with focusSearch(int).

static Int

Use with focusSearch(int).

static Int

Use with focusSearch(int).

static Int

Use with focusSearch(int).

static Int

Use with focusSearch(int).

static Int

Use with focusSearch(int).

static Int

This view is invisible, and it doesn't take any space for layout purposes.

static Int

View flag indicating whether this view should have haptic feedback enabled for events such as long presses.

static Int

Automatically determine whether a view is important for accessibility.

static Int

The view is not important for accessibility.

static Int

The view is not important for accessibility, nor are any of its descendant views.

static Int

The view is important for accessibility.

static Int

Automatically determine whether a view is important for autofill.

static Int

The view is not important for autofill, but its children (if any) will be traversed.

static Int

The view is not important for autofill, and its children (if any) will not be traversed.

static Int

The view is important for autofill, and its children (if any) will be traversed.

static Int

The view is important for autofill, but its children (if any) will not be traversed.

static Int

Automatically determine whether a view is important for content capture.

static Int

The view is not important for content capture, but its children (if any) will be traversed.

static Int

The view is not important for content capture, and its children (if any) will not be traversed.

static Int

The view is important for content capture, and its children (if any) will be traversed.

static Int

The view is important for content capture, but its children (if any) will not be traversed.

static Int

This view is invisible, but it still takes up space for layout purposes.

static Int

View flag indicating that the screen should remain on while the window containing this view is visible to the user.

static Int

Indicates that the view has a hardware layer.

static Int

Indicates that the view does not have a layer.

static Int

Indicates that the view has a software layer.

static Int

Horizontal layout direction of this view is inherited from its parent.

static Int

Horizontal layout direction of this view is from deduced from the default language script for the locale.

static Int

Horizontal layout direction of this view is from Left to Right.

static Int

Horizontal layout direction of this view is from Right to Left.

static Int

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).

static Int

Bits of getMeasuredWidthAndState() and getMeasuredWidthAndState() that provide the actual measured size.

static Int

Bits of getMeasuredWidthAndState() and getMeasuredWidthAndState() that provide the additional state bits.

static Int

Bit of getMeasuredWidthAndState() and getMeasuredWidthAndState() that indicates the measured size is smaller that the space the view would like to have.

static Int

This view does not want keystrokes.

static Int

Used to mark a View that has no ID.

static Int

Always allow a user to over-scroll this view, provided it is a view that can scroll.

static Int

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.

static Int

Never allow a user to over-scroll this view.

static Int

Indicates that the screen has changed state and is now off.

static Int

Indicates that the screen has changed state and is now on.

static Int

The scrollbar style to display the scrollbars inside the padded area, increasing the padding of the view.

static Int

The scrollbar style to display the scrollbars inside the content area, without increasing the padding.

static Int

The scrollbar style to display the scrollbars at the edge of the view, increasing the padding of the view.

static Int

The scrollbar style to display the scrollbars at the edge of the view, without increasing the padding.

static Int

Position the scroll bar at the default position as determined by the system.

static Int

Position the scroll bar along the left edge.

static Int

Position the scroll bar along the right edge.

static Int

Indicates scrolling along the horizontal axis.

static Int

Indicates no axis of view scrolling.

static Int

Indicates scrolling along the vertical axis.

static Int

Scroll indicator direction for the bottom edge of the view.

static Int

Scroll indicator direction for the ending edge of the view.

static Int

Scroll indicator direction for the left edge of the view.

static Int

Scroll indicator direction for the right edge of the view.

static Int

Scroll indicator direction for the starting edge of the view.

static Int

Scroll indicator direction for the top edge of the view.

static Int

View flag indicating whether this view should have sound effects enabled for events such as clicking and touching.

static Int

static Int

static Int

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.

static Int

Flag for setSystemUiVisibility(int): View has requested that the system navigation be temporarily hidden.

static Int

Flag for setSystemUiVisibility(int): View would like to remain interactive when hiding the navigation bar with SYSTEM_UI_FLAG_HIDE_NAVIGATION.

static Int

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.

static Int

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.

static Int

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.

static Int

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).

static Int

Flag for setSystemUiVisibility(int): Requests the navigation bar to draw in a mode that is compatible with light navigation bar backgrounds.

static Int

Flag for setSystemUiVisibility(int): Requests the status bar to draw in a mode that is compatible with light status bar backgrounds.

static Int

Flag for setSystemUiVisibility(int): View has requested the system UI to enter an unobtrusive "low profile" mode.

static Int

Special constant for setSystemUiVisibility(int): View has requested the system UI (status bar) to be visible (the default).

static Int

Flags that can impact the layout in relation to system UI.

static Int

Center the paragraph, e.

static Int

Default for the root view.

static Int

Default text alignment.

static Int

Align to the end of the paragraph, e.

static Int

Align to the start of the paragraph, e.

static Int

Align to the end of the view, which is ALIGN_RIGHT if the view's resolved layoutDirection is LTR, and ALIGN_LEFT otherwise.

static Int

Align to the start of the view, which is ALIGN_LEFT if the view's resolved layoutDirection is LTR, and ALIGN_RIGHT otherwise.

static Int

Text direction is using "any-RTL" algorithm.

static Int

Text direction is using "first strong algorithm".

static Int

Text direction is using "first strong algorithm".

static Int

Text direction is using "first strong algorithm".

static Int

Text direction is inherited through ViewGroup

static Int

Text direction is coming from the system Locale.

static Int

Text direction is forced to LTR.

static Int

Text direction is forced to RTL.

static String

The logging tag used by this class with android.

static Int

This view is visible.

Public constructors

<init>(context: Context!)

Simple constructor to use when creating a view from code.

<init>(context: Context!, attrs: AttributeSet?)

Constructor that is called when inflating a view from XML.

<init>(context: Context!, attrs: AttributeSet?, defStyleAttr: Int)

Perform inflation from XML and apply a class-specific base style from a theme attribute.

<init>(context: Context!, attrs: AttributeSet?, defStyleAttr: Int, defStyleRes: Int)

Perform inflation from XML and apply a class-specific base style from a theme attribute or style resource.

Public methods

open Unit

Adds the children of this View relevant for accessibility to the given list as output.

open Unit

Adds extra data to an AccessibilityNodeInfo based on an explicit request for the additional data.

open 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.

open 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.

open Unit

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.

open Unit

Add a listener for attach state changes.

open Unit

Add a listener that will be called when the bounds of the view change due to layout processing.

open Unit

Adds a listener which will receive unhandled KeyEvents.

open Unit

Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views.

open ViewPropertyAnimator!

This method returns a ViewPropertyAnimator object, which can be used to animate specific properties on this View.

open Unit

Convenience method for sending a AccessibilityEvent#TYPE_ANNOUNCEMENT AccessibilityEvent to suggest that an accessibility service announce the specified text to its users.

open Unit

Automatically fills the content of this view with the value.

open Unit

Automatically fills the content of the virtual children within this view.

open Unit

Change the view's z order in the tree, so it's on top of other sibling views.

open Unit

Calling this method is equivalent to calling buildDrawingCache(false).

open Unit

Forces the drawing cache to be built if the drawing cache is invalid.

open Unit

Forces this view's layer to be created and this view to be rendered into its layer.

open Boolean

Directly call any attached OnClickListener.

open Boolean

Check if layout direction resolution can be done.

open Boolean

Check if text alignment resolution can be done.

open Boolean

Check if text direction resolution can be done.

open Boolean

Check if this view can be scrolled horizontally in a certain direction.

open Boolean

Check if this view can be scrolled vertically in a certain direction.

Unit

Cancels an ongoing drag and drop operation.

open Unit

Cancels a pending long press.

Unit

Cancel any deferred high-level input events that were previously posted to the event queue.

open Boolean

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.

open Unit

Cancels any animations for this view.

open Unit

Called when this view wants to give up focus.

open static Int
combineMeasuredStates(curState: Int, newState: Int)

Merge two states as returned by getMeasuredState().

open Unit

Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary.

open 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.

open AccessibilityNodeInfo!

Returns an AccessibilityNodeInfo representing this view from the point of view of an android.accessibilityservice.AccessibilityService.

open Unit

Show the context menu for this view.

open Unit

Frees the resources used by the drawing cache.

open WindowInsets!

Request to apply the given window insets to this view or another view in its subtree.

open Boolean

Pass a captured pointer event down to the focused view.

open Unit

Dispatch a notification about a resource configuration change down the view hierarchy.

open Unit

Dispatch a hint about whether this view is displayed.

open Boolean

Detects if this View is enabled and has a drag event listener.

open Unit

Dispatches drawableHotspotChanged to all of this View's children.

open Unit

Dispatch onFinishTemporaryDetach() to this View and its direct children if this is a container View.

open Boolean

Dispatch a generic motion event.

open Boolean

Dispatch a key event to the next view on the focus path.

open Boolean

Dispatch a key event before it is processed by any input method associated with the view hierarchy.

open Boolean

Dispatches a key shortcut event.

open Boolean
dispatchNestedFling(velocityX: Float, velocityY: Float, consumed: Boolean)

Dispatch a fling to a nested scrolling parent.

open Boolean
dispatchNestedPreFling(velocityX: Float, velocityY: Float)

Dispatch a fling to a nested scrolling parent before it is processed by this view.

open Boolean

Report an accessibility action to this view's parents for delegated processing.

open 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.

open Boolean
dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, offsetInWindow: IntArray?)

Dispatch one step of a nested scroll in progress.

open Unit

open Boolean

Dispatches an AccessibilityEvent to the View first and then to its children for adding their text content to the event.

open Unit

Dispatches creation of a ViewStructures for autofill purposes down the hierarchy, when an Assist structure is being created as part of an autofill request.

open Unit

Dispatch creation of ViewStructure down the hierarchy.

open Unit

Dispatch onStartTemporaryDetach() to this View and its direct children if this is a container View.

open Unit

Dispatch callbacks to setOnSystemUiVisibilityChangeListener down the view hierarchy.

open Boolean

Pass the touch screen motion event down to the target view, or this view if it is the target.

open Boolean

Pass a trackball motion event down to the focused view.

open 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.

open Unit

Called when the window containing this view gains or loses window focus.

open Unit

Dispatches WindowInsetsAnimation.Callback#onEnd(WindowInsetsAnimation) when Window Insets animation ends.

open Unit

Dispatches WindowInsetsAnimation.Callback#onPrepare(WindowInsetsAnimation) when Window Insets animation is being prepared.

open WindowInsets

Dispatches WindowInsetsAnimation.Callback#onProgress(WindowInsets, List) when Window Insets animation makes progress.

open WindowInsetsAnimation.Bounds

Dispatches WindowInsetsAnimation.Callback#onStart(WindowInsetsAnimation, Bounds) when Window Insets animation is started.

open Unit

Dispatch callbacks to onWindowSystemUiVisibilityChanged(int) down the view hierarchy.

open Unit

Dispatch a window visibility change down the view hierarchy.

open Unit
draw(canvas: Canvas!)

Manually render this view (and all of its children) to the given Canvas.

open Unit

This function is called whenever the view hotspot changes and needs to be propagated to drawables or child views managed by the view.

open View!

Find the view in the hierarchy rooted at this view that currently has focus.

T

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.

T

Look for a child view with the given tag.

open Unit
findViewsWithText(outViews: ArrayList<View!>!, searched: CharSequence!, flags: Int)

Finds the Views that contain given text.

open View!
focusSearch(direction: Int)

Find the nearest view in the specified direction that can take focus.

open Unit
forceHasOverlappingRendering(hasOverlappingRendering: Boolean)

Sets the behavior for overlapping rendering for this view (see for more details on this behavior).

open Unit

Forces this view to be laid out during the next layout pass.

open static Int

Generate a value suitable for use in setId(int).

open CharSequence!

Return the class name of this object to be used for accessibility purposes.

open View.AccessibilityDelegate!

Returns the delegate for implementing accessibility support via composition.

open Int

Gets the live region mode for this View.

open AccessibilityNodeProvider!

Gets the provider for managing a virtual view hierarchy rooted at this View and reported to android.accessibilityservice.AccessibilityServices that explore the window content.

open CharSequence?

Get the title of the pane for purposes of accessibility.

open Int

Gets the id of a view after which this one is visited in accessibility traversal.

open Int

Gets the id of a view before which this one is visited in accessibility traversal.

open Float

The opacity of the view.

open Animation!

Get the animation currently associated with this view.

open Matrix?

Return the current transformation matrix of the view.

open IBinder!

Retrieve a unique token identifying the top-level "real" window of the window that this view is attached to.

open IntArray

Returns the ordered list of resource ID that are considered when resolving attribute values for this View.

open MutableMap<Int!, Int!>

Returns the mapping of attribute resource ID to source resource ID where the attribute value was set.

open Array<String!>?

Gets the hints that help an android.service.autofill.AutofillService determine how to autofill the view with the user's data.

AutofillId!

Gets the unique, logical identifier of this view in the activity, for autofill purposes.

open Int

Describes the autofill type of this view, so an android.service.autofill.AutofillService can create the proper AutofillValue when autofilling the view.

open AutofillValue?

Gets the View's current autofill value.

open Drawable!

Gets the background drawable

open BlendMode?

Return the blending mode used to apply the tint to the background drawable, if specified.

open ColorStateList?

Return the tint applied to the background drawable, if specified.

open PorterDuff.Mode?

Return the blending mode used to apply the tint to the background drawable, if specified.

open Int

Return the offset of the widget's text baseline from the widget's top boundary.

Int

Bottom position of this view relative to its parent.

open Float

Gets the distance along the Z axis from the camera to this view.

open Rect!

Returns a copy of the current clipBounds.

open 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

Returns whether the Outline should be used to clip the contents of the View.

ContentCaptureSession?

Gets the session used to notify content capture events.

open CharSequence!

Returns the View's content description.

Context!

Returns the context the view is running in, through which it can access the current theme, resources, etc.

Boolean

/** 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.

open static Int
getDefaultSize(size: Int, measureSpec: Int)

Utility to return a default size.

open Display!

Gets the logical display to which the view's window has been attached.

IntArray!

Return an array of resource IDs of the drawable states representing the current state of the view.

open Bitmap!

Calling this method is equivalent to calling getDrawingCache(false).

open Bitmap!

Returns the bitmap in which this view drawing is cached.

open Int

open Int

Returns the quality of the drawing cache.

open Unit
getDrawingRect(outRect: Rect!)

Return the visible drawing bounds of your view.

open Long

Return the time at which the drawing of the view hierarchy started.

open Float

The base elevation of this view relative to its parent, in pixels.

open Int

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.

open Boolean

Gets whether the framework should discard touches when the view's window is obscured by another visible window.

open Boolean

Check for state of setFitsSystemWindows(boolean).

open Int

Returns the focusable setting for this view.

open 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.

open Unit

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.

open Drawable!

Returns the drawable used as the foreground of this View.

open Int

Describes how the foreground is positioned.

open BlendMode?

Return the blending mode used to apply the tint to the foreground drawable, if specified.

open ColorStateList?

Return the tint applied to the foreground drawable, if specified.

open PorterDuff.Mode?

Return the blending mode used to apply the tint to the foreground drawable, if specified.

open Boolean
getGlobalVisibleRect(r: Rect!, globalOffset: Point!)

If some part of this view is not clipped by any of its parents, then return that area in r in global (root) coordinates.

Boolean

open Handler!

Boolean

Returns the value for overlapping rendering that is used internally.

Int

Return the height of your view.

open Unit
getHitRect(outRect: Rect!)

Hit rectangle in parent's coordinates

open Int

Returns the size of the horizontal faded edges used to indicate that more content in this view is visible.

open Drawable?

Returns the currently configured Drawable for the thumb of the horizontal scroll bar if it exists, null otherwise.

open Drawable?

Returns the currently configured Drawable for the track of the horizontal scroll bar if it exists, null otherwise.

open Int

Returns this view's identifier.

open Int

Gets the mode for determining whether this View is important for accessibility.

open Int

Gets the mode for determining whether this view is important for autofill.

open Int

Gets the mode for determining whether this view is important for content capture.

open Boolean

Returns whether the screen should remain on, corresponding to the current value of KEEP_SCREEN_ON.

open KeyEvent.DispatcherState!

Return the global KeyEvent.DispatcherState for this view's window.

open Int

Gets the id of a view for which this view serves as a label for accessibility purposes.

open Int

Indicates what type of layer is currently associated with this view.

open Int

Returns the resolved layout direction for this view.

open ViewGroup.LayoutParams!

Get the LayoutParams associated with this view.

Int

Left position of this view relative to its parent.

Boolean

open Unit

Compute the view's coordinate within the surface.

open Unit

Computes the coordinates of this view in its window.

open Unit

Computes the coordinates of this view on the screen.

open Matrix!

The transform matrix of this view, which is calculated based on the current rotation, scale, and pivot properties.

Int

Like getMeasuredHeightAndState(), but only returns the raw height component (that is the result is masked by MEASURED_SIZE_MASK).

Int

Return the full height measurement information for this view as computed by the most recent call to measure(int,int).

Int

Return only the state bits of getMeasuredWidthAndState() and getMeasuredHeightAndState(), combined into one integer.

Int

Like getMeasuredWidthAndState(), but only returns the raw width component (that is the result is masked by MEASURED_SIZE_MASK).

Int

Return the full width measurement information for this view as computed by the most recent call to measure(int,int).

open Int

Returns the minimum height of the view.

open Int

Returns the minimum width of the view.

open Int

Gets the id of the root of the next keyboard navigation cluster.

open Int

Gets the id of the view to use when the next focus is FOCUS_DOWN.

open Int

Gets the id of the view to use when the next focus is FOCUS_FORWARD.

open Int

Gets the id of the view to use when the next focus is FOCUS_LEFT.

open Int

Gets the id of the view to use when the next focus is FOCUS_RIGHT.

open Int

Gets the id of the view to use when the next focus is FOCUS_UP.

open View.OnFocusChangeListener!

Returns the focus-change callback registered for this view.

open Int

open ViewOutlineProvider!

Returns the current ViewOutlineProvider of the view, which generates the Outline that defines the shape of the shadow it casts, and enables outline clipping.

open Int

open Int

Returns the over-scroll mode for this view.

open ViewOverlay!

Returns the overlay for this view, creating it if it does not yet exist.

open Int

Returns the bottom padding of this view.

open Int

Returns the end padding of this view depending on its resolved layout direction.

open Int

Returns the left padding of this view.

open Int

Returns the right padding of this view.

open Int

Returns the start padding of this view depending on its resolved layout direction.

open Int

Returns the top padding of this view.

ViewParent!

Gets the parent of this view.

open ViewParent!

Gets the parent for accessibility purposes.

open Float

The x location of the point around which the view is rotated and scaled.

open Float

The y location of the point around which the view is rotated and scaled.

open PointerIcon!

Gets the pointer icon for the current view.

open Resources!

Returns the resources associated with this view.

Boolean

Returns this view's preference for reveal behavior when it gains focus.

Int

Right position of this view relative to its parent.

open View!

Finds the topmost view in the current view hierarchy.

open WindowInsets!

Provide original WindowInsets that are dispatched to the view hierarchy.

open Float

The degrees that the view is rotated around the pivot point.

open Float

The degrees that the view is rotated around the horizontal axis through the pivot point.

open Float

The degrees that the view is rotated around the vertical axis through the pivot point.

open Float

The amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width.

open Float

The amount that the view is scaled in y around the pivot point, as a proportion of the view's unscaled height.

open Int

Returns the delay before scrollbars fade.

open Int

Returns the scrollbar fade duration.

open Int

Returns the scrollbar size.

open Int

Returns the current scrollbar style.

open Int

Returns a bitmask representing the enabled scroll indicators.

Int

Return the scrolled left position of this view.

Int

Return the scrolled top position of this view.

open Int

Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges.

open Int

A View can be inflated from an XML layout.

CharSequence?

Returns the View's state description.

open StateListAnimator!

Returns the current StateListAnimator if exists.

open MutableList<Rect!>

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.

open Int

Returns the last setSystemUiVisibility(int) that this view has requested.

open Any!

Returns this view's tag.

open Any!
getTag(key: Int)

Returns the tag associated with this view and the specified key.

open Int

Return the resolved text alignment.

open Int

Return the resolved text direction.

open CharSequence?

Returns the view's tooltip text.

Int

Top position of this view relative to its parent.

open TouchDelegate!

Gets the TouchDelegate for this View.

open ArrayList<View!>!

Find and return all touchable views that are descendants of this view, possibly including this view if it is touchable itself.

open 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.

open String!

Returns the name of the View to be used to identify Views in Transitions.

open Float

The horizontal location of this view relative to its left position.

open Float

The vertical location of this view relative to its top position.

open Float

The depth location of this view relative to its elevation.

open Long

Get the identifier used for this view by the drawing system.

open Int

Returns the size of the vertical faded edges used to indicate that more content in this view is visible.

open Int

open Drawable?

Returns the currently configured Drawable for the thumb of the vertical scroll bar if it exists, null otherwise.

open Drawable?

Returns the currently configured Drawable for the track of the vertical scroll bar if it exists, null otherwise.

open Int

Returns the width of the vertical scrollbar.

open ViewTreeObserver!

Returns the ViewTreeObserver for this view's hierarchy.

open Int

Returns the visibility status for this view.

Int

Return the width of your view.

open WindowId!

Retrieve the WindowId for the window this view is currently attached to.

open WindowInsetsController?

Retrieves the single WindowInsetsController of the window this view is attached to.

open Int

Returns the current system UI visibility that is currently set for the entire window.

open IBinder!

Retrieve a unique token identifying the window this view is attached to.

open Int

Returns the current visibility of the window this view is attached to (either GONE, INVISIBLE, or VISIBLE).

open Unit

Retrieve the overall visible display size in which the window this view is attached to has been positioned in.

open Float

The visual x position of this view, in pixels.

open Float

The visual y position of this view, in pixels.

open Float

The visual z position of this view, in pixels.

open Boolean

Returns true if this view is focusable or if it contains a reachable View for which hasExplicitFocusable() returns true.

open Boolean

Returns true if this view has focus itself, or is the ancestor of the view that has focus.

open Boolean

Returns true if this view is focusable or if it contains a reachable View for which hasFocusable() returns true.

open Boolean

Returns true if this view has a nested scrolling parent.

open Boolean

Return whether this view has an attached OnClickListener.

open Boolean

Return whether this view has an attached OnLongClickListener.

open Boolean

Returns whether this View has content which overlaps.

open Boolean

Checks pointer capture status.

open Boolean

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.

open Boolean

Returns true if this view is in a window that currently has window focus.

open static View!
inflate(context: Context!, resource: Int, root: ViewGroup!)

Inflate a view from an XML resource.

open Unit
invalidate(dirty: Rect!)

Mark the area defined by dirty as needing to be drawn.

open 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.

open Unit

Invalidate the whole view.

open Unit

Invalidates the specified Drawable.

open Unit

Called to rebuild this View's Outline from its ViewOutlineProvider

open Boolean

Returns whether this View is accessibility focused.

open Boolean

Gets whether this view is a heading for accessibility purposes.

open Boolean

Indicates the activation state of this view.

open Boolean

Returns true if this view is currently attached to a window.

open Boolean

Indicates whether this view reacts to click events or not.

open Boolean

Indicates whether this view reacts to context clicks or not.

open Boolean

True if this view has changed since the last time being drawn.

open Boolean

Indicates whether the drawing cache is enabled for this view.

open Boolean

Indicates whether this duplicates its drawable state from its parent.

open Boolean

Returns the enabled status for this view.

Boolean

Returns whether this View is currently able to take focus.

Boolean

When a view is focusable, it may not want to take focus when in touch mode.

open Boolean

Returns true if this view has focus

Boolean

Returns whether this View should receive focus when the focus is restored for the view hierarchy containing this view.

open Boolean

See setForceDarkAllowed(boolean)

open Boolean

open Boolean

Indicates whether this view is attached to a hardware accelerated window or not.

open Boolean

Indicate whether the horizontal edges are faded when the view is scrolled horizontally.

open Boolean

Indicate whether the horizontal scrollbar should be drawn or not.

open Boolean

Returns true if the view is currently hovered.

open Boolean

Computes whether this view should be exposed for accessibility.

Boolean

Hints the Android System whether the android.app.assist.AssistStructure.ViewNode associated with this view is considered important for autofill purposes.

Boolean

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.

open Boolean

Indicates whether this View is currently in edit mode.

open Boolean

Returns whether the view hierarchy is currently undergoing a layout pass.

open Boolean

Returns whether the device is currently in touch mode.

Boolean

Returns whether this View is a root of a keyboard navigation cluster.

open Boolean

Returns true if this view has been through at least one layout since it was last attached to or detached from a window.

open Boolean

open Boolean

Indicates whether or not this view's layout will be requested during the next hierarchy layout pass.

open Boolean

Indicates whether this view reacts to long click events or not.

open Boolean

Returns true if nested scrolling is enabled for this view.

open Boolean

Indicates whether this View is opaque.

open Boolean

Return if the padding has been set through relative values setPaddingRelative(int,int,int,int) or through

open Boolean

Returns whether or not a pivot has been set by a call to setPivotX(float) or setPivotY(float).

open Boolean

Indicates whether the view is currently in pressed state.

open Boolean

Indicates whether this view will save its state (that is, whether its onSaveInstanceState method will be called).

open Boolean

Indicates whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent.

open Boolean

Returns whether the view should be treated as a focusable unit by screen reader accessibility tools.

open Boolean

Indicates whether this view is one of the set of scrollable containers in its window.

open Boolean

Returns true if scrollbars will fade when this view is not scrolling

open Boolean

Indicates the selection state of this view.

Boolean

Returns true when the View is attached and the system developer setting to show the layout bounds is enabled or false otherwise.

open Boolean

Returns the visibility of this view and all of its ancestors

open Boolean

Boolean

Tells whether the View is in the state between onStartTemporaryDetach() and onFinishTemporaryDetach().

open Boolean

open Boolean

open Boolean

Indicate whether the vertical edges are faded when the view is scrolled horizontally.

open Boolean

Indicate whether the vertical scrollbar should be drawn or not.

open Boolean

Computes whether this virtual autofill view is visible to the user.

open Unit

Call Drawable#jumpToCurrentState() on all Drawable objects associated with this view.

open View!
keyboardNavigationClusterSearch(currentCluster: View!, direction: Int)

Find the nearest keyboard navigation cluster in the specified direction.

open Unit
layout(l: Int, t: Int, r: Int, b: Int)

Assign a size and position to a view and all of its descendants

Unit
measure(widthMeasureSpec: Int, heightMeasureSpec: Int)

This is called to find out how big a view should be.

open Unit

Offset this view's horizontal location by the specified amount of pixels.

open Unit

Offset this view's vertical location by the specified number of pixels.

open WindowInsets!

Called when the view should apply WindowInsets according to its internal policy.

open Unit

Called as the result of a call to cancelPendingInputEvents() on this view or a parent view.

open Boolean

Implement this method to handle captured pointer events

open Boolean

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.

open InputConnection!

Create a new InputConnection for an InputMethod to interact with the view.

open Boolean

Handles drag events sent by the system following a call to startDragAndDrop().

open Unit

Draw any foreground content for this view.

open Boolean

Filter the touch event to apply security policies.

open Unit

Called after onStartTemporaryDetach when the container is done changing the view.

open Boolean

Implement this method to handle generic motion events.

open Unit

Implement this method to handle hover state changes.

open Boolean

Implement this method to handle hover events.

open Unit

Initializes an AccessibilityEvent with information about this View which is the event source.

open Unit

Initializes an AccessibilityNodeInfo with information about this view.

open Boolean
onKeyDown(keyCode: Int, event: KeyEvent!)

Default implementation of KeyEvent.Callback#onKeyDown(int, KeyEvent): perform press of the view when KeyEvent#KEYCODE_DPAD_CENTER or KeyEvent#KEYCODE_ENTER is released, if the view is enabled and clickable.

open Boolean
onKeyLongPress(keyCode: Int, event: KeyEvent!)

Default implementation of KeyEvent.Callback#onKeyLongPress(int, KeyEvent): always returns false (doesn't handle the event).

open Boolean
onKeyMultiple(keyCode: Int, repeatCount: Int, event: KeyEvent!)

Default implementation of KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent): always returns false (doesn't handle the event).

open Boolean
onKeyPreIme(keyCode: Int, event: KeyEvent!)

Handle a key event before it is processed by any input method associated with the view hierarchy.

open Boolean
onKeyShortcut(keyCode: Int, event: KeyEvent!)

Called on the focused view when a key shortcut event is not handled.

open Boolean
onKeyUp(keyCode: Int, event: KeyEvent!)

Default implementation of KeyEvent.Callback#onKeyUp(int, KeyEvent): perform clicking of the view when KeyEvent#KEYCODE_DPAD_CENTER, KeyEvent#KEYCODE_ENTER or KeyEvent#KEYCODE_SPACE is released.

open Unit

Called when the window has just acquired or lost pointer capture.

open Unit

Called from dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent) giving a chance to this View to populate the accessibility event with its text content.

open Unit

Populates a ViewStructure to fullfil an autofill request.

open Unit

Populates a ViewStructure containing virtual children to fullfil an autofill request.

open Unit

Populates a ViewStructure for content capture.

open Unit

Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData.

open Unit

Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData to generate additional virtual structure under this view.

open PointerIcon!
onResolvePointerIcon(event: MotionEvent!, pointerIndex: Int)

Returns the pointer icon for the motion event, or null if it doesn't specify the icon.

open Unit
onRtlPropertiesChanged(layoutDirection: Int)

Called when any RTL property (layout direction or text direction or text alignment) has been changed.

open Unit
onScreenStateChanged(screenState: Int)

This method is called whenever the state of the screen this view is attached to changes.

open Unit

This is called when a container is going to temporarily detach a child, with ViewGroup#detachViewFromParent(View).

open Boolean

Implement this method to handle touch screen motion events.

open Boolean

Implement this method to handle trackball motion events.

open Unit

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.

open Unit
onWindowFocusChanged(hasWindowFocus: Boolean)

Called when the window containing this view gains or loses focus.

open Unit

Override to find out when the window's requested system UI visibility has changed, that is the value returned by getWindowSystemUiVisibility().

open Boolean
performAccessibilityAction(action: Int, arguments: Bundle!)

Performs the specified accessibility action on the view.

open Boolean

Call this view's OnClickListener, if it is defined.

open Boolean

Call this view's OnContextClickListener, if it is defined.

open Boolean

Call this view's OnContextClickListener, if it is defined.

open Boolean
performHapticFeedback(feedbackConstant: Int)

BZZZTT!!1!

open Boolean
performHapticFeedback(feedbackConstant: Int, flags: Int)

BZZZTT!!1!

open Boolean

Calls this view's OnLongClickListener, if it is defined.

open Boolean

Calls this view's OnLongClickListener, if it is defined.

open Unit
playSoundEffect(soundConstant: Int)

Play a sound effect for this view.

open Boolean
post(action: Runnable!)

Causes the Runnable to be added to the message queue.

open 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.

open Unit

Cause an invalidate to happen on a subsequent cycle through the event loop.

open 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.

open Unit
postInvalidateDelayed(delayMilliseconds: Long)

Cause an invalidate to happen on a subsequent cycle through the event loop.

open 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.

open Unit

Cause an invalidate to happen on the next animation time step, typically the next display frame.

open 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.

open Unit

Causes the Runnable to execute on the next animation time step.

open Unit
postOnAnimationDelayed(action: Runnable!, delayMillis: Long)

Causes the Runnable to execute on the next animation time step, after the specified amount of time elapses.

open Unit

Call this to force a view to update its drawable state.

open Unit

Releases the pointer capture.

open Boolean

Removes the specified Runnable from the message queue.

open Unit

Remove a listener for attach state changes.

open Unit

Remove a listener for layout changes.

open Unit

Removes a listener which will receive unhandled KeyEvents.

open Unit

Ask that a new dispatch of onApplyWindowInsets(android.view.WindowInsets) be performed.

open Unit

Ask that a new dispatch of fitSystemWindows(android.graphics.Rect) be performed.

Boolean

Call this to try to give focus to a specific view or to one of its descendants.

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.

open 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.

Boolean

Call this to try to give focus to a specific view or to one of its descendants.

open Unit

Call this when something has changed which has invalidated the layout of this view.

open Unit

Requests pointer capture mode.

open Boolean

Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.

open Boolean
requestRectangleOnScreen(rectangle: Rect!, immediate: Boolean)

Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.

Unit

Request unbuffered dispatch of the given stream of MotionEvents to this View.

Unit

Request unbuffered dispatch of the given event source class to this view.

T

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.

open Unit

Clears any pivot previously set by a call to setPivotX(float) or setPivotY(float).

open static Int
resolveSize(size: Int, measureSpec: Int)

Version of resolveSizeAndState(int,int,int) returning only the MEASURED_SIZE_MASK bits of the result.

open static Int
resolveSizeAndState(size: Int, measureSpec: Int, childMeasuredState: Int)

Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec.

open Boolean

Gives focus to the default-focus view in the view hierarchy that has this view as a root.

open Unit

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.

open Unit

Store this view hierarchy's frozen state into the given container.

open Unit
scheduleDrawable(who: Drawable, what: Runnable, when: Long)

Schedules an action on a drawable to occur at a specified time.

open Unit
scrollBy(x: Int, y: Int)

Move the scrolled position of your view.

open Unit
scrollTo(x: Int, y: Int)

Set the scrolled position of your view.

open Unit

Sends an accessibility event of the given type.

open Unit

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.

open Unit

Sets a delegate for implementing accessibility support via composition (as opposed to inheritance).

open Unit

Set if view is a heading for a section of content for accessibility purposes.

open Unit

Sets the live region mode for this view.

open Unit
setAccessibilityPaneTitle(accessibilityPaneTitle: CharSequence?)

Visually distinct portion of a window with window-like semantics are considered panes for accessibility purposes.

open Unit

Sets the id of a view after which this one is visited in accessibility traversal.

open Unit

Sets the id of a view before which this one is visited in accessibility traversal.

open Unit
setActivated(activated: Boolean)

Changes the activated state of this view.

open Unit
setAlpha(alpha: Float)

Sets the opacity of the view to a value from 0 to 1, where 0 means the view is completely transparent and 1 means the view is completely opaque.

open Unit
setAnimation(animation: Animation!)

Sets the next animation to play for this view.

open Unit

Changes the transformation matrix on the view.

open 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.

open Unit

Sets the unique, logical identifier of this view in the activity, for autofill purposes.

open Unit
setBackground(background: Drawable!)

Set the background to a given Drawable, or remove the background.

open Unit

Sets the background color for this view.

open Unit

open Unit

Set the background to a given resource.

open Unit

Specifies the blending mode used to apply the tint specified by setBackgroundTintList(android.content.res.ColorStateList)} to the background drawable.

open Unit

Applies a tint to the background drawable.

open Unit

Specifies the blending mode used to apply the tint specified by setBackgroundTintList(android.content.res.ColorStateList)} to the background drawable.

Unit
setBottom(bottom: Int)

Sets the bottom position of this view relative to its parent.

open Unit

Sets the distance along the Z axis (orthogonal to the X/Y plane on which views are drawn) from the camera to this view.

open Unit
setClickable(clickable: Boolean)

Enables or disables click events for this view.

open Unit
setClipBounds(clipBounds: Rect!)

Sets a rectangular area on this view to which the view will be clipped when it is drawn.

open Unit
setClipToOutline(clipToOutline: Boolean)

Sets whether the View's Outline should be used to clip the contents of the View.

open Unit

Sets the (optional) ContentCaptureSession associated with this view.

open Unit
setContentDescription(contentDescription: CharSequence!)

Sets the View's content description.

open Unit
setContextClickable(contextClickable: Boolean)

Enables or disables context clicking for this view.

open 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.

open Unit

Setting a solid background color for the drawing cache's bitmaps will improve performance and memory usage.

open Unit

Enables or disables the drawing cache.

open Unit

Set the drawing cache quality of this view.

open Unit

Enables or disables the duplication of the parent's state into this view.

open Unit
setElevation(elevation: Float)

Sets the base elevation of this view, in pixels.

open Unit
setEnabled(enabled: Boolean)

Set the enabled state of this view.

open Unit

Set the size of the faded edge used to indicate that more content in this view is available.

open Unit

Sets whether the framework should discard touches when the view's window is obscured by another visible window.

open 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.

open Unit
setFocusable(focusable: Boolean)

Set whether this view can receive the focus.

open Unit
setFocusable(focusable: Int)

Sets whether this view can receive focus.

open Unit
setFocusableInTouchMode(focusableInTouchMode: Boolean)

Set whether this view can receive focus while in touch mode.

open Unit
setFocusedByDefault(isFocusedByDefault: Boolean)

Sets whether this View should receive focus when the focus is restored for the view hierarchy containing this view.

open Unit

Sets whether or not to allow force dark to apply to this view.

open Unit
setForeground(foreground: Drawable!)

Supply a Drawable that is to be rendered on top of all of the content in the view.

open Unit

Describes how the foreground is positioned.

open Unit

Specifies the blending mode used to apply the tint specified by setForegroundTintList(android.content.res.ColorStateList)} to the background drawable.

open Unit

Applies a tint to the foreground drawable.

open Unit

Specifies the blending mode used to apply the tint specified by setForegroundTintList(android.content.res.ColorStateList)} to the background drawable.

open Unit
setHapticFeedbackEnabled(hapticFeedbackEnabled: Boolean)

Set whether this view should have haptic feedback for events such as long presses.

open Unit
setHasTransientState(hasTransientState: Boolean)

Set whether this view is currently tracking transient state that the framework should attempt to preserve when possible.

open Unit
setHorizontalFadingEdgeEnabled(horizontalFadingEdgeEnabled: Boolean)

Define whether the horizontal edges should be faded when this view is scrolled horizontally.

open Unit
setHorizontalScrollBarEnabled(horizontalScrollBarEnabled: Boolean)

Define whether the horizontal scrollbar should be drawn or not.

open Unit

Defines the horizontal thumb drawable

open Unit

Defines the horizontal track drawable

open Unit
setHovered(hovered: Boolean)

Sets whether the view is currently hovered.

open Unit
setId(id: Int)

Sets the identifier for this view.

open Unit

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.

open Unit

Sets the mode for determining whether this view is considered important for autofill.

open Unit

Sets the mode for determining whether this view is considered important for content capture.

open Unit
setKeepScreenOn(keepScreenOn: Boolean)

Controls whether the screen should remain on, modifying the value of KEEP_SCREEN_ON.

open Unit

Set whether this view is a root of a keyboard navigation cluster.

open Unit

Sets the id of a view for which this view serves as a label for accessibility purposes.

open Unit

Updates the Paint object used with the current layer (used only if the current layer type is not set to LAYER_TYPE_NONE).

open Unit
setLayerType(layerType: Int, paint: Paint?)

Specifies the type of layer backing this view.

open Unit
setLayoutDirection(layoutDirection: Int)

Set the layout direction for this view.

open Unit

Set the layout parameters associated with this view.

Unit
setLeft(left: Int)

Sets the left position of this view relative to its parent.

Unit
setLeftTopRightBottom(left: Int, top: Int, right: Int, bottom: Int)

Assign a size and position to this view.

open Unit
setLongClickable(longClickable: Boolean)

Enables or disables long click events for this view.

open Unit
setMinimumHeight(minHeight: Int)

Sets the minimum height of the view.

open Unit
setMinimumWidth(minWidth: Int)

Sets the minimum width of the view.

open Unit

Enable or disable nested scrolling for this view.

open Unit
setNextClusterForwardId(nextClusterForwardId: Int)

Sets the id of the view to use as the root of the next keyboard navigation cluster.

open Unit
setNextFocusDownId(nextFocusDownId: Int)

Sets the id of the view to use when the next focus is FOCUS_DOWN.

open Unit
setNextFocusForwardId(nextFocusForwardId: Int)

Sets the id of the view to use when the next focus is FOCUS_FORWARD.

open Unit
setNextFocusLeftId(nextFocusLeftId: Int)

Sets the id of the view to use when the next focus is FOCUS_LEFT.

open Unit
setNextFocusRightId(nextFocusRightId: Int)

Sets the id of the view to use when the next focus is FOCUS_RIGHT.

open Unit
setNextFocusUpId(nextFocusUpId: Int)

Sets the id of the view to use when the next focus is FOCUS_UP.

open Unit

Set an OnApplyWindowInsetsListener to take over the policy for applying window insets to this view.

open Unit

Set a listener to receive callbacks when the pointer capture state of a view changes.

open Unit

Register a callback to be invoked when this view is clicked.

open Unit

Register a callback to be invoked when this view is context clicked.

open Unit

Register a callback to be invoked when the context menu for this view is being built.

open Unit

Register a drag event listener callback object for this View.

open Unit

Register a callback to be invoked when focus of this view changed.

open Unit

Register a callback to be invoked when a generic motion event is sent to this view.

open Unit

Register a callback to be invoked when a hover event is sent to this view.

open Unit

Register a callback to be invoked when a hardware key is pressed in this view.

open Unit

Register a callback to be invoked when this view is clicked and held.

open Unit

Register a callback to be invoked when the scroll X or Y positions of this view change.

open Unit

Set a listener to receive callbacks when the visibility of the system bar changes.

open Unit

Register a callback to be invoked when a touch event is sent to this view.

open Unit

Sets the color of the ambient shadow that is drawn when the view has a positive Z or elevation value.

open Unit

Sets the ViewOutlineProvider of the view, which generates the Outline that defines the shape of the shadow it casts, and enables outline clipping.

open Unit

Sets the color of the spot shadow that is drawn when the view has a positive Z or elevation value.

open Unit
setOverScrollMode(overScrollMode: Int)

Set the over-scroll mode for this view.

open Unit
setPadding(left: Int, top: Int, right: Int, bottom: Int)

Sets the padding.

open Unit
setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int)

Sets the relative padding.

open Unit
setPivotX(pivotX: Float)

Sets the x location of the point around which the view is rotated and scaled.

open Unit
setPivotY(pivotY: Float)

Sets the y location of the point around which the view is rotated and scaled.

open Unit
setPointerIcon(pointerIcon: PointerIcon!)

Set the pointer icon for the current view.

open Unit
setPressed(pressed: Boolean)

Sets the pressed state for this view.

Unit
setRevealOnFocusHint(revealOnFocus: Boolean)

Sets this view's preference for reveal behavior when it gains focus.

Unit
setRight(right: Int)

Sets the right position of this view relative to its parent.

open Unit
setRotation(rotation: Float)

Sets the degrees that the view is rotated around the pivot point.

open Unit
setRotationX(rotationX: Float)

Sets the degrees that the view is rotated around the horizontal axis through the pivot point.

open Unit
setRotationY(rotationY: Float)

Sets the degrees that the view is rotated around the vertical axis through the pivot point.

open Unit

Controls whether the saving of this view's state is enabled (that is, whether its onSaveInstanceState method will be called).

open Unit

Controls whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent.

open 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.

open 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.

open 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.

open Unit
setScrollBarDefaultDelayBeforeFade(scrollBarDefaultDelayBeforeFade: Int)

Define the delay before scrollbars fade.

open Unit
setScrollBarFadeDuration(scrollBarFadeDuration: Int)

Define the scrollbar fade duration.

open Unit
setScrollBarSize(scrollBarSize: Int)

Define the scrollbar size.

open Unit

Specify the style of the scrollbars.

open Unit
setScrollContainer(isScrollContainer: Boolean)

Change whether this view is one of the set of scrollable containers in its window.

open Unit
setScrollIndicators(indicators: Int)

Sets the state of all scroll indicators.

open Unit
setScrollIndicators(indicators: Int, mask: Int)

Sets the state of the scroll indicators specified by the mask.

open Unit
setScrollX(value: Int)

Set the horizontal scrolled position of your view.

open Unit
setScrollY(value: Int)

Set the vertical scrolled position of your view.

open Unit

Define whether scrollbars will fade when the view is not scrolling.

open Unit
setSelected(selected: Boolean)

Changes the selection state of this view.

open Unit
setSoundEffectsEnabled(soundEffectsEnabled: Boolean)

Set whether this view should have sound effects enabled for events such as clicking and touching.

open Unit
setStateDescription(stateDescription: CharSequence?)

Sets the View's state description.

open Unit

Attaches the provided StateListAnimator to this View.

open Unit

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.

open Unit

Request that the visibility of the status bar or other screen/window decorations be changed.

open Unit
setTag(tag: Any!)

Sets the tag associated with this view.

open Unit
setTag(key: Int, tag: Any!)

Sets a tag associated with this view and a key.

open Unit
setTextAlignment(textAlignment: Int)

Set the text alignment.

open Unit
setTextDirection(textDirection: Int)

Set the text direction.

open Unit

Sets the tooltip text which will be displayed in a small popup next to the view.

Unit
setTop(top: Int)

Sets the top position of this view relative to its parent.

open Unit

Sets the TouchDelegate for this View.

open Unit

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.

Unit
setTransitionName(transitionName: String!)

Sets the name of the View to be used to identify Views in Transitions.

open Unit

Changes the visibility of this View without triggering any other changes.

open Unit
setTranslationX(translationX: Float)

Sets the horizontal location of this view relative to its left position.

open Unit
setTranslationY(translationY: Float)

Sets the vertical location of this view relative to its top position.

open Unit
setTranslationZ(translationZ: Float)

Sets the depth location of this view relative to its elevation.

open Unit
setVerticalFadingEdgeEnabled(verticalFadingEdgeEnabled: Boolean)

Define whether the vertical edges should be faded when this view is scrolled vertically.

open Unit
setVerticalScrollBarEnabled(verticalScrollBarEnabled: Boolean)

Define whether the vertical scrollbar should be drawn or not.

open Unit

Set the position of the vertical scroll bar.

open Unit

Defines the vertical scrollbar thumb drawable

open Unit

Defines the vertical scrollbar track drawable

open Unit
setVisibility(visibility: Int)

Set the visibility state of this view.

open Unit
setWillNotCacheDrawing(willNotCacheDrawing: Boolean)

When a View's drawing cache is enabled, drawing is redirected to an offscreen bitmap.

open Unit
setWillNotDraw(willNotDraw: Boolean)

If this view doesn't do any drawing on its own, set this flag to allow further optimizations.

open Unit

Sets a WindowInsetsAnimation.Callback to be notified about animations of windows that cause insets.

open Unit
setX(x: Float)

Sets the visual x position of this view, in pixels.

open Unit
setY(y: Float)

Sets the visual y position of this view, in pixels.

open Unit
setZ(z: Float)

Sets the visual z position of this view, in pixels.

open Boolean

Shows the context menu for this view.

open Boolean

Shows the context menu for this view anchored to the specified view-relative coordinate.

open ActionMode!

Start an action mode with the default type ActionMode#TYPE_PRIMARY.

open ActionMode!

Start an action mode with the given type.

open Unit

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.

open Boolean

Begin a nestable scroll operation along the given axes.

open Unit

Stop a nested scroll in progress.

open String

open Unit

Modifies the input matrix such that it maps view-local coordinates to on-screen coordinates.

open Unit

Modifies the input matrix such that it maps on-screen coordinates to view-local coordinates.

open Unit

Cancels a scheduled action on a drawable.

open Unit

Unschedule any events associated with the given Drawable.

Unit

Updates the drag shadow for the ongoing drag and drop operation.

open Boolean

Returns whether or not this View can cache its drawing or not.

open Boolean

Returns whether or not this View draws on its own.

Protected methods

open Boolean

Trigger the scrollbars to draw.

open Boolean
awakenScrollBars(startDelay: Int)

Trigger the scrollbars to draw.

open Boolean
awakenScrollBars(startDelay: Int, invalidate: Boolean)

Trigger the scrollbars to draw.

open Int

Compute the horizontal extent of the horizontal scrollbar's thumb within the horizontal range.

open Int

Compute the horizontal offset of the horizontal scrollbar's thumb within the horizontal range.

open Int

Compute the horizontal range that the horizontal scrollbar represents.

open Int

Compute the vertical extent of the vertical scrollbar's thumb within the vertical range.

open Int

Compute the vertical offset of the vertical scrollbar's thumb within the horizontal range.

open Int

Compute the vertical range that the vertical scrollbar represents.

open Unit
dispatchDraw(canvas: Canvas!)

Called by draw to draw the child views.

open Boolean

Dispatch a generic motion event to the currently focused view.

open Boolean

Dispatch a generic motion event to the view under the first pointer.

open Boolean

Dispatch a hover event.

open Unit

Called by restoreHierarchyState(android.util.SparseArray) to retrieve the state for this view and its children.

open Unit

Called by saveHierarchyState(android.util.SparseArray) to store the state for this view and its children.

open Unit

Dispatch setActivated to all of this View's children.

open Unit

Dispatch setPressed to all of this View's children.

open Unit

Dispatch setSelected to all of this View's children.

open Unit
dispatchVisibilityChanged(changedView: View, visibility: Int)

Dispatch a view visibility change down the view hierarchy.

open Unit

This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.

open Boolean

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.

open Float

Returns the strength, or intensity, of the bottom faded edge.

open Int

Amount by which to extend the bottom fading region.

open ContextMenu.ContextMenuInfo!

Views should implement this if they have extra information to associate with the context menu.

open Int

Returns the height of the horizontal scrollbar.

open Float

Returns the strength, or intensity, of the left faded edge.

open Int

Amount by which to extend the left fading region.

open Float

Returns the strength, or intensity, of the right faded edge.

open Int

Amount by which to extend the right fading region.

open Int

Returns the suggested minimum height that the view should use.

open Int

Returns the suggested minimum width that the view should use.

open Float

Returns the strength, or intensity, of the top faded edge.

open Int

Amount by which to extend the top fading region.

open Int

open Boolean

If the View draws content inside its padding and enables fading edges, it needs to support padding offsets.

open static 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).

open Unit

Invoked by a parent ViewGroup to notify the end of the animation currently associated with this view.

open Unit

Invoked by a parent ViewGroup to notify the start of the animation currently associated with this view.

open Unit

This is called when the view is attached to a window.

open Unit

Called when the current configuration of the resources being used by the application have changed.

open Unit

Views should implement this if the view itself is going to add items to the context menu.

open IntArray!

Generate the new android.graphics.drawable.Drawable state for this view.

open Unit

This is called when the view is detached from a window.

open Unit

Gives this view a hint about whether is displayed or not.

open Unit
onDraw(canvas: Canvas!)

Implement this to do your drawing.

Unit

Request the drawing of the horizontal and the vertical scrollbar.

open Unit

Finalize inflating a view from XML.

open Unit
onFocusChanged(gainFocus: Boolean, direction: Int, previouslyFocusedRect: Rect?)

Called by the view system when the focus state of this view changes.

open 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.

open Unit
onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)

Measure the view and its content to determine the measured width and the measured height.

open 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.

open Unit

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState.

open Parcelable?

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.

open 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).

open Boolean
onSetAlpha(alpha: Int)

Invoked if there is a Transform that involves alpha.

open Unit
onSizeChanged(w: Int, h: Int, oldw: Int, oldh: Int)

This is called during layout when the size of this view has changed.

open Unit
onVisibilityChanged(changedView: View, visibility: Int)

Called when the visibility of the view or an ancestor of the view has changed.

open Unit

Called when the window containing has change its visibility (between GONE, INVISIBLE, and VISIBLE).

open 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.

Unit
setMeasuredDimension(measuredWidth: Int, measuredHeight: Int)

This method must be called by onMeasure(int,int) to store the measured width and measured height.

open Boolean

If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying.

Properties

static Property<View!, Float!>!

A Property wrapper around the alpha functionality handled by the View#setAlpha(float) and View#getAlpha() methods.

static IntArray!

Indicates the view has no states set.

static IntArray!

Indicates the view is enabled, focused and selected.

static IntArray!

Indicates the view is enabled, focused, selected and its window has the focus.

static IntArray!

Indicates the view is enabled and has the focus.

static IntArray!

Indicates the view is enabled, focused and its window has the focus.

static IntArray!

Indicates the view is enabled and selected.

static IntArray!

Indicates the view is enabled, selected and its window has the focus.

static IntArray!

Indicates the view is enabled.

static IntArray!

Indicates the view is enabled and that its window has focus.

static IntArray!

Indicates the view is focused and selected.

static IntArray!

Indicates the view is focused, selected and its window has the focus.

static IntArray!

Indicates the view is focused.

static IntArray!

Indicates the view has the focus and that its window has the focus.

static IntArray!

Indicates the view is pressed, enabled, focused and selected.

static IntArray!

Indicates the view is pressed, enabled, focused, selected and its window has the focus.

static IntArray!

Indicates the view is pressed, enabled and focused.

static IntArray!

Indicates the view is pressed, enabled, focused and its window has the focus.

static IntArray!

Indicates the view is pressed, enabled and selected.

static IntArray!

Indicates the view is pressed, enabled, selected and its window has the focus.

static IntArray!

Indicates the view is pressed and enabled.

static IntArray!

Indicates the view is pressed, enabled and its window has the focus.

static IntArray!

Indicates the view is pressed, focused and selected.

static IntArray!

Indicates the view is pressed, focused, selected and its window has the focus.

static IntArray!

Indicates the view is pressed and focused.

static IntArray!

Indicates the view is pressed, focused and its window has the focus.

static IntArray!

Indicates the view is pressed and selected.

static IntArray!

Indicates the view is pressed, selected and its window has the focus.

static IntArray!

Indicates the view is pressed.

static IntArray!

Indicates the view is pressed and its window has the focus.

static Property<View!, Float!>!

A Property wrapper around the rotation functionality handled by the View#setRotation(float) and View#getRotation() methods.

static Property<View!, Float!>!

A Property wrapper around the rotationX functionality handled by the View#setRotationX(float) and View#getRotationX() methods.

static Property<View!, Float!>!

A Property wrapper around the rotationY functionality handled by the View#setRotationY(float) and View#getRotationY() methods.

static Property<View!, Float!>!

A Property wrapper around the scaleX functionality handled by the View#setScaleX(float) and View#getScaleX() methods.

static Property<View!, Float!>!

A Property wrapper around the scaleY functionality handled by the View#setScaleY(float) and View#getScaleY() methods.

static IntArray!

Indicates the view is selected.

static IntArray!

Indicates the view is selected and that its window has the focus.

static Property<View!, Float!>!

A Property wrapper around the translationX functionality handled by the View#setTranslationX(float) and View#getTranslationX() methods.

static Property<View!, Float!>!

A Property wrapper around the translationY functionality handled by the View#setTranslationY(float) and View#getTranslationY() methods.

static Property<View!, Float!>!

A Property wrapper around the translationZ functionality handled by the View#setTranslationZ(float) and View#getTranslationZ() methods.

static IntArray!

Indicates the view's window has focus.

static Property<View!, Float!>!

A Property wrapper around the x functionality handled by the View#setX(float) and View#getX() methods.

static Property<View!, Float!>!

A Property wrapper around the y functionality handled by the View#setY(float) and View#getY() methods.

static Property<View!, Float!>!

A Property wrapper around the z functionality handled by the View#setZ(float) and View#getZ() methods.

XML attributes

android:accessibilityHeading

android:accessibilityHeading
Whether or not this view is a heading for accessibility purposes.

May be a boolean value, such as "true" or "false".

android:alpha

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

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

android:clickable
Defines whether this view reacts to click events.

May be a boolean value, such as "true" or "false".

android:contentDescription

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

android:longClickable
Defines whether this view reacts to long click events.

May be a boolean value, such as "true" or "false".

android:minHeight

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

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

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

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

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

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

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

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).

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:outlineAmbientShadowColor

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

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

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

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

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

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

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

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

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

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

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

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

android:rotation
rotation of the view, in degrees.

May be a floating point value, such as "1.2".

android:rotationX

android:rotationX
rotation of the view around the x axis, in degrees.

May be a floating point value, such as "1.2".

android:rotationY

android:rotationY
rotation of the view around the y axis, in degrees.

May be a floating point value, such as "1.2".

android:saveEnabled

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

android:scaleX
scale of the view in the x direction.

May be a floating point value, such as "1.2".

android:scaleY

android:scaleY
scale of the view in the y direction.

May be a floating point value, such as "1.2".

android:scrollX

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

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

android:scrollbarAlwaysDrawHorizontalTrack
Defines whether the horizontal scrollbar track should always be drawn.

May be a boolean value, such as "true" or "false".

android:scrollbarAlwaysDrawVerticalTrack

android:scrollbarAlwaysDrawVerticalTrack
Defines whether the vertical scrollbar track should always be drawn.

May be a boolean value, such as "true" or "false".

android:scrollbarDefaultDelayBeforeFade

android:scrollbarDefaultDelayBeforeFade
Defines the delay in milliseconds that a scrollbar waits before fade out.

May be an integer value, such as "100".

android:scrollbarFadeDuration

android:scrollbarFadeDuration
Defines the delay in milliseconds that a scrollbar takes to fade out.

May be an integer value, such as "100".

android:scrollbarSize

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

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

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

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

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

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

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

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

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

android:tag
Supply a tag for this view containing a String, to be retrieved later with 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

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

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

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

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

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

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

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

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

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

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

ACCESSIBILITY_LIVE_REGION_ASSERTIVE

Added in API level 19
static val ACCESSIBILITY_LIVE_REGION_ASSERTIVE: Int

Live region mode specifying that accessibility services should interrupt ongoing speech to immediately announce changes to this view.

Use with setAccessibilityLiveRegion(int).

Value: 2

ACCESSIBILITY_LIVE_REGION_NONE

Added in API level 19
static val ACCESSIBILITY_LIVE_REGION_NONE: Int

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).

Value: 0

ACCESSIBILITY_LIVE_REGION_POLITE

Added in API level 19
static val ACCESSIBILITY_LIVE_REGION_POLITE: Int

Live region mode specifying that accessibility services should announce changes to this view.

Use with setAccessibilityLiveRegion(int).

Value: 1

AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS

Added in API level 26
static val AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS: Int

Flag requesting you to add views that are marked as not important for autofill (see setImportantForAutofill(int)) to a ViewStructure.

Value: 1

AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE

Added in API level 26
static val AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE: String

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:

  1. getAutofillType() to return AUTOFILL_TYPE_DATE.
  2. getAutofillValue() to return a AutofillValue#forDate(long).
  3. autofill(android.view.autofill.AutofillValue) to expect a data autofillvalue.

See setAutofillHints(java.lang.String...) for more info about autofill hints.

Value: "creditCardExpirationDate"

AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY

Added in API level 26
static val AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY: String

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.

Value: "creditCardExpirationDay"

AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH

Added in API level 26
static val AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH: String

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.

Value: "creditCardExpirationMonth"

AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR

Added in API level 26
static val AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR: String

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.

Value: "creditCardExpirationYear"

AUTOFILL_HINT_CREDIT_CARD_NUMBER

Added in API level 26
static val AUTOFILL_HINT_CREDIT_CARD_NUMBER: String

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.

Value: "creditCardNumber"

AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE

Added in API level 26
static val AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE: String

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.

Value: "creditCardSecurityCode"

AUTOFILL_HINT_EMAIL_ADDRESS

Added in API level 26
static val AUTOFILL_HINT_EMAIL_ADDRESS: String

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.

Value: "emailAddress"

AUTOFILL_HINT_NAME

Added in API level 26
static val AUTOFILL_HINT_NAME: String

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.

Value: "name"

AUTOFILL_HINT_PASSWORD

Added in API level 26
static val AUTOFILL_HINT_PASSWORD: String

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.

Value: "password"

AUTOFILL_HINT_PHONE

Added in API level 26
static val AUTOFILL_HINT_PHONE: String

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.

Value: "phone"

AUTOFILL_HINT_POSTAL_ADDRESS

Added in API level 26
static val AUTOFILL_HINT_POSTAL_ADDRESS: String

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.

Value: "postalAddress"

AUTOFILL_HINT_POSTAL_CODE

Added in API level 26
static val AUTOFILL_HINT_POSTAL_CODE: String

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.

Value: "postalCode"

AUTOFILL_HINT_USERNAME

Added in API level 26
static val AUTOFILL_HINT_USERNAME: String

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.

Value: "username"

AUTOFILL_TYPE_DATE

Added in API level 26
static val AUTOFILL_TYPE_DATE: Int

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().

Value: 4

AUTOFILL_TYPE_LIST

Added in API level 26
static val AUTOFILL_TYPE_LIST: Int

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().

Value: 3

AUTOFILL_TYPE_NONE

Added in API level 26
static val AUTOFILL_TYPE_NONE: Int

Autofill type for views that cannot be autofilled.

Typically used when the view is read-only; for example, a text label.

Value: 0

AUTOFILL_TYPE_TEXT

Added in API level 26
static val AUTOFILL_TYPE_TEXT: Int

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().

Value: 1

AUTOFILL_TYPE_TOGGLE

Added in API level 26
static val AUTOFILL_TYPE_TOGGLE: Int

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().

Value: 2

DRAG_FLAG_GLOBAL

Added in API level 24
static val DRAG_FLAG_GLOBAL: Int

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

Value: 256

DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION

Added in API level 24
static val DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION: Int

When this flag is used with DRAG_FLAG_GLOBAL_URI_READ and/or , the URI permission grant can be persisted across device reboots until explicitly revoked with android.content.Context#revokeUriPermission(Uri, int) Context.revokeUriPermission}.

Value: 64

DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION

Added in API level 24
static val DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION: Int

When this flag is used with DRAG_FLAG_GLOBAL_URI_READ and/or , the URI permission grant applies to any URI that is a prefix match against the original granted URI.

Value: 128

DRAG_FLAG_GLOBAL_URI_READ

Added in API level 24
static val DRAG_FLAG_GLOBAL_URI_READ: Int

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.

Value: 1

DRAG_FLAG_GLOBAL_URI_WRITE

Added in API level 24
static val DRAG_FLAG_GLOBAL_URI_WRITE: Int

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.

Value: 2

DRAG_FLAG_OPAQUE

Added in API level 24
static val DRAG_FLAG_OPAQUE: Int

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.

Value: 512

DRAWING_CACHE_QUALITY_AUTO

Added in API level 1
Deprecated in API level 28
static val DRAWING_CACHE_QUALITY_AUTO: Int

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Enables automatic quality mode for the drawing cache.

Value: 0

DRAWING_CACHE_QUALITY_HIGH

Added in API level 1
Deprecated in API level 28
static val DRAWING_CACHE_QUALITY_HIGH: Int

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Enables high quality mode for the drawing cache.

Value: 1048576

DRAWING_CACHE_QUALITY_LOW

Added in API level 1
Deprecated in API level 28
static val DRAWING_CACHE_QUALITY_LOW: Int

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Enables low quality mode for the drawing cache.

Value: 524288

FIND_VIEWS_WITH_CONTENT_DESCRIPTION

Added in API level 14
static val FIND_VIEWS_WITH_CONTENT_DESCRIPTION: Int

Find find views that contain the specified content description.

Value: 2

FIND_VIEWS_WITH_TEXT

Added in API level 14
static val FIND_VIEWS_WITH_TEXT: Int

Find views that render the specified text.

Value: 1

FOCUSABLE

Added in API level 26
static val FOCUSABLE: Int

This view wants keystrokes.

Use with setFocusable(int) and android:focusable.

Value: 1

FOCUSABLES_ALL

Added in API level 4
static val FOCUSABLES_ALL: Int

View flag indicating whether addFocusables(java.util.ArrayList,int,int) should add all focusable Views regardless if they are focusable in touch mode.

Value: 0

FOCUSABLES_TOUCH_MODE

Added in API level 4
static val FOCUSABLES_TOUCH_MODE: Int

View flag indicating whether addFocusables(java.util.ArrayList,int,int) should add only Views focusable in touch mode.

Value: 1

FOCUSABLE_AUTO

Added in API level 26
static val FOCUSABLE_AUTO: Int

This view determines focusability automatically. This is the default.

Use with setFocusable(int) and android:focusable.

Value: 16

FOCUS_BACKWARD

Added in API level 1
static val FOCUS_BACKWARD: Int

Use with focusSearch(int). Move focus to the previous selectable item.

Value: 1

FOCUS_DOWN

Added in API level 1
static val FOCUS_DOWN: Int

Use with focusSearch(int). Move focus down.

Value: 130

FOCUS_FORWARD

Added in API level 1
static val FOCUS_FORWARD: Int

Use with focusSearch(int). Move focus to the next selectable item.

Value: 2

FOCUS_LEFT

Added in API level 1
static val FOCUS_LEFT: Int

Use with focusSearch(int). Move focus to the left.

Value: 17

FOCUS_RIGHT

Added in API level 1
static val FOCUS_RIGHT: Int

Use with focusSearch(int). Move focus to the right.

Value: 66

FOCUS_UP

Added in API level 1
static val FOCUS_UP: Int

Use with focusSearch(int). Move focus up.

Value: 33

GONE

Added in API level 1
static val GONE: Int

This view is invisible, and it doesn't take any space for layout purposes. Use with setVisibility and android:visibility.

Value: 8

HAPTIC_FEEDBACK_ENABLED

Added in API level 3
static val HAPTIC_FEEDBACK_ENABLED: Int

View flag indicating whether this view should have haptic feedback enabled for events such as long presses.

Value: 268435456

IMPORTANT_FOR_ACCESSIBILITY_AUTO

Added in API level 16
static val IMPORTANT_FOR_ACCESSIBILITY_AUTO: Int

Automatically determine whether a view is important for accessibility.

Value: 0

IMPORTANT_FOR_ACCESSIBILITY_NO

Added in API level 16
static val IMPORTANT_FOR_ACCESSIBILITY_NO: Int

The view is not important for accessibility.

Value: 2

IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS

Added in API level 19
static val IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS: Int

The view is not important for accessibility, nor are any of its descendant views.

Value: 4

IMPORTANT_FOR_ACCESSIBILITY_YES

Added in API level 16
static val IMPORTANT_FOR_ACCESSIBILITY_YES: Int

The view is important for accessibility.

Value: 1

IMPORTANT_FOR_AUTOFILL_AUTO

Added in API level 26
static val IMPORTANT_FOR_AUTOFILL_AUTO: Int

Automatically determine whether a view is important for autofill.

Value: 0

IMPORTANT_FOR_AUTOFILL_NO

Added in API level 26
static val IMPORTANT_FOR_AUTOFILL_NO: Int

The view is not important for autofill, but its children (if any) will be traversed.

Value: 2

IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS

Added in API level 26
static val IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS: Int

The view is not important for autofill, and its children (if any) will not be traversed.

Value: 8

IMPORTANT_FOR_AUTOFILL_YES

Added in API level 26
static val IMPORTANT_FOR_AUTOFILL_YES: Int

The view is important for autofill, and its children (if any) will be traversed.

Value: 1

IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS

Added in API level 26
static val IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS: Int

The view is important for autofill, but its children (if any) will not be traversed.

Value: 4

IMPORTANT_FOR_CONTENT_CAPTURE_AUTO

Added in API level 30
static val IMPORTANT_FOR_CONTENT_CAPTURE_AUTO: Int

Automatically determine whether a view is important for content capture.

Value: 0

IMPORTANT_FOR_CONTENT_CAPTURE_NO

Added in API level 30
static val IMPORTANT_FOR_CONTENT_CAPTURE_NO: Int

The view is not important for content capture, but its children (if any) will be traversed.

Value: 2

IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS

Added in API level 30
static val IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS: Int

The view is not important for content capture, and its children (if any) will not be traversed.

Value: 8

IMPORTANT_FOR_CONTENT_CAPTURE_YES

Added in API level 30
static val IMPORTANT_FOR_CONTENT_CAPTURE_YES: Int

The view is important for content capture, and its children (if any) will be traversed.

Value: 1

IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS

Added in API level 30
static val IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS: Int

The view is important for content capture, but its children (if any) will not be traversed.

Value: 4

INVISIBLE

Added in API level 1
static val INVISIBLE: Int

This view is invisible, but it still takes up space for layout purposes. Use with setVisibility and android:visibility.

Value: 4

KEEP_SCREEN_ON

Added in API level 1
static val KEEP_SCREEN_ON: Int

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.

Value: 67108864

LAYER_TYPE_HARDWARE

Added in API level 11
static val LAYER_TYPE_HARDWARE: Int

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.

Value: 2

LAYER_TYPE_NONE

Added in API level 11
static val LAYER_TYPE_NONE: Int

Indicates that the view does not have a layer.

Value: 0

LAYER_TYPE_SOFTWARE

Added in API level 11
static val LAYER_TYPE_SOFTWARE: Int

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.)

Value: 1

LAYOUT_DIRECTION_INHERIT

Added in API level 17
static val LAYOUT_DIRECTION_INHERIT: Int

Horizontal layout direction of this view is inherited from its parent. Use with setLayoutDirection.

Value: 2

LAYOUT_DIRECTION_LOCALE

Added in API level 17
static val LAYOUT_DIRECTION_LOCALE: Int

Horizontal layout direction of this view is from deduced from the default language script for the locale. Use with setLayoutDirection.

Value: 3

LAYOUT_DIRECTION_LTR

Added in API level 17
static val LAYOUT_DIRECTION_LTR: Int

Horizontal layout direction of this view is from Left to Right. Use with setLayoutDirection.

Value: 0

LAYOUT_DIRECTION_RTL

Added in API level 17
static val LAYOUT_DIRECTION_RTL: Int

Horizontal layout direction of this view is from Right to Left. Use with setLayoutDirection.

Value: 1

MEASURED_HEIGHT_STATE_SHIFT

Added in API level 11
static val MEASURED_HEIGHT_STATE_SHIFT: Int

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).

Value: 16

MEASURED_SIZE_MASK

Added in API level 11
static val MEASURED_SIZE_MASK: Int

Bits of getMeasuredWidthAndState() and getMeasuredWidthAndState() that provide the actual measured size.

Value: 16777215

MEASURED_STATE_MASK

Added in API level 11
static val MEASURED_STATE_MASK: Int

Bits of getMeasuredWidthAndState() and getMeasuredWidthAndState() that provide the additional state bits.

Value: -16777216

MEASURED_STATE_TOO_SMALL

Added in API level 11
static val MEASURED_STATE_TOO_SMALL: Int

Bit of getMeasuredWidthAndState() and getMeasuredWidthAndState() that indicates the measured size is smaller that the space the view would like to have.

Value: 16777216

NOT_FOCUSABLE

Added in API level 26
static val NOT_FOCUSABLE: Int

This view does not want keystrokes.

Use with setFocusable(int) and android:focusable.

Value: 0

NO_ID

Added in API level 1
static val NO_ID: Int

Used to mark a View that has no ID.

Value: -1

OVER_SCROLL_ALWAYS

Added in API level 9
static val OVER_SCROLL_ALWAYS: Int

Always allow a user to over-scroll this view, provided it is a view that can scroll.

Value: 0

OVER_SCROLL_IF_CONTENT_SCROLLS

Added in API level 9
static val OVER_SCROLL_IF_CONTENT_SCROLLS: Int

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.

Value: 1

OVER_SCROLL_NEVER

Added in API level 9
static val OVER_SCROLL_NEVER: Int

Never allow a user to over-scroll this view.

Value: 2

SCREEN_STATE_OFF

Added in API level 16
static val SCREEN_STATE_OFF: Int

Indicates that the screen has changed state and is now off.

Value: 0

SCREEN_STATE_ON

Added in API level 16
static val SCREEN_STATE_ON: Int

Indicates that the screen has changed state and is now on.

Value: 1

SCROLLBARS_INSIDE_INSET

Added in API level 1
static val SCROLLBARS_INSIDE_INSET: Int

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.

Value: 16777216

SCROLLBARS_INSIDE_OVERLAY

Added in API level 1
static val SCROLLBARS_INSIDE_OVERLAY: Int

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.

Value: 0

SCROLLBARS_OUTSIDE_INSET

Added in API level 1
static val SCROLLBARS_OUTSIDE_INSET: Int

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.

Value: 50331648

SCROLLBARS_OUTSIDE_OVERLAY

Added in API level 1
static val SCROLLBARS_OUTSIDE_OVERLAY: Int

The scrollbar style to display the scrollbars at the edge of the view, without increasing the padding. The scrollbars will be overlaid with translucency.

Value: 33554432

SCROLLBAR_POSITION_DEFAULT

Added in API level 11
static val SCROLLBAR_POSITION_DEFAULT: Int

Position the scroll bar at the default position as determined by the system.

Value: 0

SCROLLBAR_POSITION_LEFT

Added in API level 11
static val SCROLLBAR_POSITION_LEFT: Int

Position the scroll bar along the left edge.

Value: 1

SCROLLBAR_POSITION_RIGHT

Added in API level 11
static val SCROLLBAR_POSITION_RIGHT: Int

Position the scroll bar along the right edge.

Value: 2

SCROLL_AXIS_HORIZONTAL

Added in API level 21
static val SCROLL_AXIS_HORIZONTAL: Int

Indicates scrolling along the horizontal axis.

Value: 1

SCROLL_AXIS_NONE

Added in API level 21
static val SCROLL_AXIS_NONE: Int

Indicates no axis of view scrolling.

Value: 0

SCROLL_AXIS_VERTICAL

Added in API level 21
static val SCROLL_AXIS_VERTICAL: Int

Indicates scrolling along the vertical axis.

Value: 2

SCROLL_INDICATOR_BOTTOM

Added in API level 23
static val SCROLL_INDICATOR_BOTTOM: Int

Scroll indicator direction for the bottom edge of the view.

Value: 2

SCROLL_INDICATOR_END

Added in API level 23
static val SCROLL_INDICATOR_END: Int

Scroll indicator direction for the ending edge of the view.

Resolved according to the view's layout direction, see getLayoutDirection() for more information.

Value: 32

SCROLL_INDICATOR_LEFT

Added in API level 23
static val SCROLL_INDICATOR_LEFT: Int

Scroll indicator direction for the left edge of the view.

Value: 4

SCROLL_INDICATOR_RIGHT

Added in API level 23
static val SCROLL_INDICATOR_RIGHT: Int

Scroll indicator direction for the right edge of the view.

Value: 8

SCROLL_INDICATOR_START

Added in API level 23
static val SCROLL_INDICATOR_START: Int

Scroll indicator direction for the starting edge of the view.

Resolved according to the view's layout direction, see getLayoutDirection() for more information.

Value: 16

SCROLL_INDICATOR_TOP

Added in API level 23
static val SCROLL_INDICATOR_TOP: Int

Scroll indicator direction for the top edge of the view.

Value: 1

SOUND_EFFECTS_ENABLED

Added in API level 1
static val SOUND_EFFECTS_ENABLED: Int

View flag indicating whether this view should have sound effects enabled for events such as clicking and touching.

Value: 134217728

STATUS_BAR_HIDDEN

Added in API level 11
Deprecated in API level 15
static val STATUS_BAR_HIDDEN: Int

Deprecated: Use SYSTEM_UI_FLAG_LOW_PROFILE instead.

Value: 1

STATUS_BAR_VISIBLE

Added in API level 11
Deprecated in API level 15
static val STATUS_BAR_VISIBLE: Int

Deprecated: Use SYSTEM_UI_FLAG_VISIBLE instead.

Value: 0

SYSTEM_UI_FLAG_FULLSCREEN

Added in API level 16
Deprecated in API level 30
static val SYSTEM_UI_FLAG_FULLSCREEN: Int

Deprecated: Use WindowInsetsController#hide(int) with Type#statusBars() instead.

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.

Value: 4

SYSTEM_UI_FLAG_HIDE_NAVIGATION

Added in API level 14
Deprecated in API level 30
static val SYSTEM_UI_FLAG_HIDE_NAVIGATION: Int

Deprecated: Use WindowInsetsController#hide(int) with Type#navigationBars() instead.

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.

Value: 2

SYSTEM_UI_FLAG_IMMERSIVE

Added in API level 19
Deprecated in API level 30
static val SYSTEM_UI_FLAG_IMMERSIVE: Int

Deprecated: Use WindowInsetsController#BEHAVIOR_SHOW_BARS_BY_SWIPE instead.

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.

Value: 2048

SYSTEM_UI_FLAG_IMMERSIVE_STICKY

Added in API level 19
Deprecated in API level 30
static val SYSTEM_UI_FLAG_IMMERSIVE_STICKY: Int

Deprecated: Use WindowInsetsController#BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE instead.

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.

Value: 4096

SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN

Added in API level 16
Deprecated in API level 30
static val SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN: Int

Deprecated: For floating windows, use LayoutParams#setFitInsetsTypes(int) with Type#statusBars() ()}. For non-floating windows that fill the screen, call Window#setDecorFitsSystemWindows(boolean) with false.

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 WindowManager.LayoutParams#layoutInDisplayCutoutMode is WindowManager.LayoutParams#LAYOUT_IN_DISPLAY_CUTOUT_MODE_DEFAULT. To avoid this, use either of the other modes.

Value: 1024

SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION

Added in API level 16
Deprecated in API level 30
static val SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION: Int

Deprecated: For floating windows, use LayoutParams#setFitInsetsTypes(int) with Type#navigationBars(). For non-floating windows that fill the screen, call Window#setDecorFitsSystemWindows(boolean) with false.

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.

Value: 512

SYSTEM_UI_FLAG_LAYOUT_STABLE

Added in API level 16
Deprecated in API level 30
static val SYSTEM_UI_FLAG_LAYOUT_STABLE: Int

Deprecated: Use WindowInsets#getInsetsIgnoringVisibility(int) instead to retrieve insets that don't change when system bars change visibility state.

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.

Value: 256

SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR

Added in API level 26
Deprecated in API level 30
static val SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR: Int

Deprecated: Use WindowInsetsController#APPEARANCE_LIGHT_NAVIGATION_BARS instead.

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.

Value: 16

SYSTEM_UI_FLAG_LIGHT_STATUS_BAR

Added in API level 23
Deprecated in API level 30
static val SYSTEM_UI_FLAG_LIGHT_STATUS_BAR: Int

Deprecated: Use WindowInsetsController#APPEARANCE_LIGHT_STATUS_BARS instead.

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.

Value: 8192

SYSTEM_UI_FLAG_LOW_PROFILE

Added in API level 14
Deprecated in API level 30
static val SYSTEM_UI_FLAG_LOW_PROFILE: Int

Deprecated: Low profile mode is deprecated. Hide the system bars instead if the application needs to be in a unobtrusive mode. Use WindowInsetsController#hide(int) with Type#systemBars().

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.

Value: 1

SYSTEM_UI_FLAG_VISIBLE

Added in API level 14
Deprecated in API level 30
static val SYSTEM_UI_FLAG_VISIBLE: Int

Deprecated: SystemUiVisibility flags are deprecated. Use WindowInsetsController instead.

Special constant for setSystemUiVisibility(int): View has requested the system UI (status bar) to be visible (the default).

Value: 0

SYSTEM_UI_LAYOUT_FLAGS

Added in API level 16
Deprecated in API level 30
static val SYSTEM_UI_LAYOUT_FLAGS: Int

Deprecated: System UI layout flags are deprecated.

Flags that can impact the layout in relation to system UI.

Value: 1536

TEXT_ALIGNMENT_CENTER

Added in API level 17
static val TEXT_ALIGNMENT_CENTER: Int

Center the paragraph, e.g. ALIGN_CENTER. Use with setTextAlignment(int)

Value: 4

TEXT_ALIGNMENT_GRAVITY

Added in API level 17
static val TEXT_ALIGNMENT_GRAVITY: Int

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)

Value: 1

TEXT_ALIGNMENT_INHERIT

Added in API level 16
static val TEXT_ALIGNMENT_INHERIT: Int

Default text alignment. The text alignment of this View is inherited from its parent. Use with setTextAlignment(int)

Value: 0

TEXT_ALIGNMENT_TEXT_END

Added in API level 17
static val TEXT_ALIGNMENT_TEXT_END: Int

Align to the end of the paragraph, e.g. ALIGN_OPPOSITE. Use with setTextAlignment(int)

Value: 3

TEXT_ALIGNMENT_TEXT_START

Added in API level 17
static val TEXT_ALIGNMENT_TEXT_START: Int

Align to the start of the paragraph, e.g. ALIGN_NORMAL. Use with setTextAlignment(int)

Value: 2

TEXT_ALIGNMENT_VIEW_END

Added in API level 17
static val TEXT_ALIGNMENT_VIEW_END: Int

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)

Value: 6

TEXT_ALIGNMENT_VIEW_START

Added in API level 17
static val TEXT_ALIGNMENT_VIEW_START: Int

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)

Value: 5

TEXT_DIRECTION_ANY_RTL

Added in API level 17
static val TEXT_DIRECTION_ANY_RTL: Int

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.

Value: 2

TEXT_DIRECTION_FIRST_STRONG

Added in API level 17
static val TEXT_DIRECTION_FIRST_STRONG: Int

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.

Value: 1

TEXT_DIRECTION_FIRST_STRONG_LTR

Added in API level 23
static val TEXT_DIRECTION_FIRST_STRONG_LTR: Int

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.

Value: 6

TEXT_DIRECTION_FIRST_STRONG_RTL

Added in API level 23
static val TEXT_DIRECTION_FIRST_STRONG_RTL: Int

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.

Value: 7

TEXT_DIRECTION_INHERIT

Added in API level 17
static val TEXT_DIRECTION_INHERIT: Int

Text direction is inherited through ViewGroup

Value: 0

TEXT_DIRECTION_LOCALE

Added in API level 17
static val TEXT_DIRECTION_LOCALE: Int

Text direction is coming from the system Locale.

Value: 5

TEXT_DIRECTION_LTR

Added in API level 17
static val TEXT_DIRECTION_LTR: Int

Text direction is forced to LTR.

Value: 3

TEXT_DIRECTION_RTL

Added in API level 17
static val TEXT_DIRECTION_RTL: Int

Text direction is forced to RTL.

Value: 4

VIEW_LOG_TAG

Added in API level 1
protected static val VIEW_LOG_TAG: String

The logging tag used by this class with android.util.Log.

Value: "View"

VISIBLE

Added in API level 1
static val VISIBLE: Int

This view is visible. Use with setVisibility and android:visibility.

Value: 0

Public constructors

<init>

Added in API level 1
View(context: Context!)

Simple constructor to use when creating a view from code.

Parameters
context Context!: The Context the view is running in, through which it can access the current theme, resources, etc.

<init>

Added in API level 1
View(
    context: Context!,
    attrs: AttributeSet?)

Constructor that is called when inflating a view from XML. This is called when a view is being constructed from an XML file, supplying attributes that were specified in the XML file. This version uses a default style of 0, so the only attribute values applied are those in the Context's Theme and the given AttributeSet.

The method onFinishInflate() will be called after all children have been added.

Parameters
context Context!: The Context the view is running in, through which it can access the current theme, resources, etc.
attrs AttributeSet?: The attributes of the XML tag that is inflating the view. This value may be null.

<init>

Added in API level 1
View(
    context: Context!,
    attrs: AttributeSet?,
    defStyleAttr: Int)

Perform inflation from XML and apply a class-specific base style from a theme attribute. This constructor of View allows subclasses to use their own base style when they are inflating. For example, a Button class's constructor would call this version of the super class constructor and supply R.attr.buttonStyle for defStyleAttr; this allows the theme's button style to modify all of the base view attributes (in particular its background) as well as the Button class's attributes.

Parameters
context Context!: The Context the view is running in, through which it can access the current theme, resources, etc.
attrs AttributeSet?: The attributes of the XML tag that is inflating the view. This value may be null.
defStyleAttr Int: An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults.

<init>

Added in API level 21
View(
    context: Context!,
    attrs: AttributeSet?,
    defStyleAttr: Int,
    defStyleRes: Int)

Perform inflation from XML and apply a class-specific base style from a theme attribute or style resource. This constructor of View allows subclasses to use their own base style when they are inflating.

When determining the final value of a particular attribute, there are four inputs that come into play:

  1. Any attribute values in the given AttributeSet.
  2. The style resource specified in the AttributeSet (named "style").
  3. The default style specified by defStyleAttr.
  4. The default style specified by defStyleRes.
  5. The base values in this theme.

Each of these inputs is considered in-order, with the first listed taking precedence over the following ones. In other words, if in the AttributeSet you have supplied <Button * textColor="#ff000000"> , then the button's text will always be black, regardless of what is specified in any of the styles.

Parameters
context Context!: The Context the view is running in, through which it can access the current theme, resources, etc.
attrs AttributeSet?: The attributes of the XML tag that is inflating the view. This value may be null.
defStyleAttr Int: An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults.
defStyleRes Int: A resource identifier of a style resource that supplies default values for the view, used only if defStyleAttr is 0 or can not be found in the theme. Can be 0 to not look for defaults.

Public methods

addChildrenForAccessibility

Added in API level 16
open fun addChildrenForAccessibility(outChildren: ArrayList<View!>!): Unit

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.

Parameters
outChildren ArrayList<View!>!: The output list that will receive children for accessibility.

addExtraDataToAccessibilityNodeInfo

Added in API level 26
open fun addExtraDataToAccessibilityNodeInfo(
    info: AccessibilityNodeInfo,
    extraDataKey: String,
    arguments: Bundle?
): Unit

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.

Parameters
info AccessibilityNodeInfo: The info to which to add the extra data. Never null. This value cannot be null.
extraDataKey String: A key specifying the type of extra data to add to the info. The extra data should be added to the Bundle returned by the info's AccessibilityNodeInfo#getExtras method. Never null. This value cannot be null.
arguments Bundle?: A Bundle holding any arguments relevant for this request. May be null if the service provided no arguments. This value may be null.

addFocusables

Added in API level 1
open fun addFocusables(
    views: ArrayList<View!>!,
    direction: Int
): Unit

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.

Parameters
views ArrayList<View!>!: Focusable views found so far
direction Int: The direction of the focus Value is android.view.View#FOCUS_BACKWARD, android.view.View#FOCUS_FORWARD, android.view.View#FOCUS_LEFT, android.view.View#FOCUS_UP, android.view.View#FOCUS_RIGHT, or android.view.View#FOCUS_DOWN

addFocusables

Added in API level 4
open fun addFocusables(
    views: ArrayList<View!>!,
    direction: Int,
    focusableMode: Int
): Unit

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.

Parameters
views ArrayList<View!>!: Focusable views found so far or null if all we are interested is the number of focusables.
direction Int: The direction of the focus. Value is android.view.View#FOCUS_BACKWARD, android.view.View#FOCUS_FORWARD, android.view.View#FOCUS_LEFT, android.view.View#FOCUS_UP, android.view.View#FOCUS_RIGHT, or android.view.View#FOCUS_DOWN
focusableMode Int: The type of focusables to be added. Value is either 0 or a combination of android.view.View#FOCUSABLES_ALL, and android.view.View#FOCUSABLES_TOUCH_MODE

addKeyboardNavigationClusters

Added in API level 26
open fun addKeyboardNavigationClusters(
    views: MutableCollection<View!>,
    direction: Int
): Unit

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.

Parameters
views MutableCollection<View!>: Keyboard navigation cluster roots found so far This value cannot be null.
direction Int: Direction to look

addOnAttachStateChangeListener

Added in API level 12
open fun addOnAttachStateChangeListener(listener: View.OnAttachStateChangeListener!): Unit

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).

Parameters
listener View.OnAttachStateChangeListener!: Listener to attach

addOnLayoutChangeListener

Added in API level 11
open fun addOnLayoutChangeListener(listener: View.OnLayoutChangeListener!): Unit

Add a listener that will be called when the bounds of the view change due to layout processing.

Parameters
listener View.OnLayoutChangeListener!: The listener that will be called when layout bounds change.

addOnUnhandledKeyEventListener

Added in API level 28
open fun addOnUnhandledKeyEventListener(listener: View.OnUnhandledKeyEventListener!): Unit

Adds a listener which will receive unhandled KeyEvents. This must be called on the UI thread.

Parameters
listener View.OnUnhandledKeyEventListener!: a receiver of unhandled KeyEvents.

addTouchables

Added in API level 1
open fun addTouchables(views: ArrayList<View!>!): Unit

Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views.

Parameters
views ArrayList<View!>!: Touchable views found so far

animate

Added in API level 12
open fun animate(): ViewPropertyAnimator!

This method returns a ViewPropertyAnimator object, which can be used to animate specific properties on this View.

Return
ViewPropertyAnimator! ViewPropertyAnimator The ViewPropertyAnimator associated with this View.

announceForAccessibility

Added in API level 16
open fun announceForAccessibility(text: CharSequence!): Unit

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.

Parameters
text CharSequence!: The announcement text.

autofill

Added in API level 26
open fun autofill(value: AutofillValue!): Unit

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:

  1. Checks if the provided value matches the expected type (which is defined by getAutofillType()).
  2. Checks if the view is editable - if it isn't, it should return right away.
  3. Call the proper getter method on AutofillValue to fetch the actual value.
  4. 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.

Parameters
value AutofillValue!: value to be autofilled.

autofill

Added in API level 26
open fun autofill(values: SparseArray<AutofillValue!>): Unit

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.

Parameters
values SparseArray<AutofillValue!>: map of values to be autofilled, keyed by virtual child id. This value cannot be null.

bringToFront

Added in API level 1
open fun bringToFront(): Unit

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.

buildDrawingCache

Added in API level 1
Deprecated in API level 28
open fun buildDrawingCache(): Unit

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Calling this method is equivalent to calling buildDrawingCache(false).

buildDrawingCache

Added in API level 4
Deprecated in API level 28
open fun buildDrawingCache(autoScale: Boolean): Unit

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

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.

buildLayer

Added in API level 12
open fun buildLayer(): Unit

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.

Exceptions
java.lang.IllegalStateException If this view is not attached to a window

callOnClick

Added in API level 15
open fun callOnClick(): Boolean

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.

Return
Boolean True there was an assigned OnClickListener that was called, false otherwise is returned.

canResolveLayoutDirection

Added in API level 19
open fun canResolveLayoutDirection(): Boolean

Check if layout direction resolution can be done.

Return
Boolean true if layout direction resolution can be done otherwise return false.

canResolveTextAlignment

Added in API level 19
open fun canResolveTextAlignment(): Boolean

Check if text alignment resolution can be done.

Return
Boolean true if text alignment resolution can be done otherwise return false.

canResolveTextDirection

Added in API level 19
open fun canResolveTextDirection(): Boolean

Check if text direction resolution can be done.

Return
Boolean true if text direction resolution can be done otherwise return false.

canScrollHorizontally

Added in API level 14
open fun canScrollHorizontally(direction: Int): Boolean

Check if this view can be scrolled horizontally in a certain direction.

Parameters
direction Int: Negative to check scrolling left, positive to check scrolling right.
Return
Boolean true if this view can be scrolled in the specified direction, false otherwise.

canScrollVertically

Added in API level 14
open fun canScrollVertically(direction: Int): Boolean

Check if this view can be scrolled vertically in a certain direction.

Parameters
direction Int: Negative to check scrolling up, positive to check scrolling down.
Return
Boolean true if this view can be scrolled in the specified direction, false otherwise.

cancelDragAndDrop

Added in API level 24
fun cancelDragAndDrop(): Unit

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.

cancelLongPress

Added in API level 1
open fun cancelLongPress(): Unit

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.

cancelPendingInputEvents

Added in API level 19
fun cancelPendingInputEvents(): Unit

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.

checkInputConnectionProxy

Added in API level 3
open fun checkInputConnectionProxy(view: View!): Boolean

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.

Parameters
view View!: The View that is making the InputMethodManager call.
Return
Boolean Return true to allow the call, false to reject.

clearAnimation

Added in API level 1
open fun clearAnimation(): Unit

Cancels any animations for this view.

clearFocus

Added in API level 1
open fun clearFocus(): Unit

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.

combineMeasuredStates

Added in API level 11
open static fun combineMeasuredStates(
    curState: Int,
    newState: Int
): Int

Merge two states as returned by getMeasuredState().

Parameters
curState Int: The current state as returned from a view or the result of combining multiple views.
newState Int: The new view state to combine.
Return
Int Returns a new integer reflecting the combination of the two states.

computeScroll

Added in API level 1
open fun computeScroll(): Unit

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.

computeSystemWindowInsets

Added in API level 21
open fun computeSystemWindowInsets(
    in: WindowInsets!,
    outLocalInsets: Rect!
): WindowInsets!

Compute insets that should be consumed by this view and the ones that should propagate to those under it.

Parameters
in WindowInsets!: Insets currently being processed by this View, likely received as a parameter to onApplyWindowInsets(android.view.WindowInsets).
outLocalInsets Rect!: A Rect that will receive the insets that should be consumed by this view
Return
WindowInsets! Insets that should be passed along to views under this one

createAccessibilityNodeInfo

Added in API level 14
open fun createAccessibilityNodeInfo(): AccessibilityNodeInfo!

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.

Return
AccessibilityNodeInfo! A populated AccessibilityNodeInfo.

createContextMenu

Added in API level 1
open fun createContextMenu(menu: ContextMenu!): Unit

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.

Parameters
menu ContextMenu!: The context menu to populate

destroyDrawingCache

Added in API level 1
Deprecated in API level 28
open fun destroyDrawingCache(): Unit

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

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.

dispatchApplyWindowInsets

Added in API level 20
open fun dispatchApplyWindowInsets(insets: WindowInsets!): 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.

Parameters
insets WindowInsets!: Insets to apply
Return
WindowInsets! The provided insets minus the insets that were consumed

dispatchCapturedPointerEvent

Added in API level 26
open fun dispatchCapturedPointerEvent(event: MotionEvent!): Boolean

Pass a captured pointer event down to the focused view.

Parameters
event MotionEvent!: The motion event to be dispatched.
Return
Boolean True if the event was handled by the view, false otherwise.

dispatchConfigurationChanged

Added in API level 8
open fun dispatchConfigurationChanged(newConfig: Configuration!): Unit

Dispatch a notification about a resource configuration change down the view hierarchy. ViewGroups should override to route to their children.

Parameters
newConfig Configuration!: The new resource configuration.

dispatchDisplayHint

Added in API level 8
open fun dispatchDisplayHint(hint: Int): Unit

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.

Parameters
hint Int: A hint about whether or not this view is displayed: VISIBLE or INVISIBLE. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

dispatchDragEvent

Added in API level 11
open fun dispatchDragEvent(event: DragEvent!): Boolean

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.

dispatchDrawableHotspotChanged

Added in API level 22
open fun dispatchDrawableHotspotChanged(
    x: Float,
    y: Float
): Unit

Dispatches drawableHotspotChanged to all of this View's children.

Parameters
x Float: hotspot x coordinate
y Float: hotspot y coordinate

dispatchFinishTemporaryDetach

Added in API level 24
open fun dispatchFinishTemporaryDetach(): Unit

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.

dispatchGenericMotionEvent

Added in API level 12
open fun dispatchGenericMotionEvent(event: MotionEvent!): Boolean

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).

Parameters
event MotionEvent!: The motion event to be dispatched.
Return
Boolean True if the event was handled by the view, false otherwise.

dispatchKeyEvent

Added in API level 1
open fun dispatchKeyEvent(event: KeyEvent!): Boolean

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.

Parameters
event KeyEvent!: The key event to be dispatched.
Return
Boolean True if the event was handled, false otherwise.

dispatchKeyEventPreIme

Added in API level 3
open fun dispatchKeyEventPreIme(event: KeyEvent!): Boolean

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.

Parameters
event KeyEvent!: The key event to be dispatched.
Return
Boolean True if the event was handled, false otherwise.

dispatchKeyShortcutEvent

Added in API level 1
open fun dispatchKeyShortcutEvent(event: KeyEvent!): Boolean

Dispatches a key shortcut event.

Parameters
event KeyEvent!: The key event to be dispatched.
Return
Boolean True if the event was handled by the view, false otherwise.

dispatchNestedFling

Added in API level 21
open fun dispatchNestedFling(
    velocityX: Float,
    velocityY: Float,
    consumed: Boolean
): 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 VelocityTracker in the direction of scrolling that meets or exceeds the ViewConfiguration#getScaledMinimumFlingVelocity() 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.

Parameters
velocityX Float: Horizontal fling velocity in pixels per second
velocityY Float: Vertical fling velocity in pixels per second
consumed Boolean: true if the child consumed the fling, false otherwise
Return
Boolean true if the nested scrolling parent consumed or otherwise reacted to the fling

dispatchNestedPreFling

Added in API level 21
open fun dispatchNestedPreFling(
    velocityX: Float,
    velocityY: Float
): Boolean

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.

Parameters
velocityX Float: Horizontal fling velocity in pixels per second
velocityY Float: Vertical fling velocity in pixels per second
Return
Boolean true if a nested scrolling parent consumed the fling

dispatchNestedPrePerformAccessibilityAction

Added in API level 22
open fun dispatchNestedPrePerformAccessibilityAction(
    action: Int,
    arguments: Bundle!
): Boolean

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.

Parameters
action Int: Accessibility action to delegate
arguments Bundle!: Optional action arguments
Return
Boolean true if the action was consumed by a parent

dispatchNestedPreScroll

Added in API level 21
open fun dispatchNestedPreScroll(
    dx: Int,
    dy: Int,
    consumed: IntArray?,
    offsetInWindow: IntArray?
): Boolean

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.

Parameters
dx Int: Horizontal scroll distance in pixels
dy Int: Vertical scroll distance in pixels
consumed IntArray?: Output. If not null, consumed[0] will contain the consumed component of dx and consumed[1] the consumed dy. This value may be null.
offsetInWindow IntArray?: Optional. If not null, on return this will contain the offset in local view coordinates of this view from before this operation to after it completes. View implementations may use this to adjust expected input coordinate tracking. This value may be null.
Return
Boolean true if the parent consumed some or all of the scroll delta

dispatchNestedScroll

Added in API level 21
open fun dispatchNestedScroll(
    dxConsumed: Int,
    dyConsumed: Int,
    dxUnconsumed: Int,
    dyUnconsumed: Int,
    offsetInWindow: IntArray?
): Boolean

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.

Parameters
dxConsumed Int: Horizontal distance in pixels consumed by this view during this scroll step
dyConsumed Int: Vertical distance in pixels consumed by this view during this scroll step
dxUnconsumed Int: Horizontal scroll distance in pixels not consumed by this view
dyUnconsumed Int: Horizontal scroll distance in pixels not consumed by this view
offsetInWindow IntArray?: Optional. If not null, on return this will contain the offset in local view coordinates of this view from before this operation to after it completes. View implementations may use this to adjust expected input coordinate tracking. This value may be null.
Return
Boolean true if the event was dispatched, false if it could not be dispatched.

dispatchPointerCaptureChanged

Added in API level 26
open fun dispatchPointerCaptureChanged(hasCapture: Boolean): Unit

dispatchPopulateAccessibilityEvent

Added in API level 4
open fun dispatchPopulateAccessibilityEvent(event: AccessibilityEvent!): Boolean

Dispatches an AccessibilityEvent to the View first and then to its children for adding their text content to the event. Note that the event text is populated in a separate dispatch path 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 the this view and then call the dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent) on each child. 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.

Note: Accessibility events of certain types are not dispatched for populating the event text via this method. For details refer to AccessibilityEvent.

Parameters
event AccessibilityEvent!: The event.
Return
Boolean True if the event population was completed.

dispatchProvideAutofillStructure

Added in API level 26
open fun dispatchProvideAutofillStructure(
    structure: ViewStructure,
    flags: Int
): Unit

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:

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.
Parameters
structure ViewStructure: fill in with structured view data for autofill purposes. This value cannot be null.
flags Int: optional flags. Value is either 0 or android.view.View#AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS

dispatchProvideStructure

Added in API level 23
open fun dispatchProvideStructure(structure: ViewStructure!): Unit

Dispatch creation of ViewStructure down the hierarchy. The default implementation calls onProvideStructure and onProvideVirtualStructure.

dispatchStartTemporaryDetach

Added in API level 24
open fun dispatchStartTemporaryDetach(): Unit

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.

dispatchSystemUiVisibilityChanged

Added in API level 11
Deprecated in API level 30
open fun dispatchSystemUiVisibilityChanged(visibility: Int): Unit

Deprecated: Use WindowInsets#isVisible(int) to find out about system bar visibilities by setting a OnApplyWindowInsetsListener on this view.

Dispatch callbacks to setOnSystemUiVisibilityChangeListener down the view hierarchy.

dispatchTouchEvent

Added in API level 1
open fun dispatchTouchEvent(event: MotionEvent!): Boolean

Pass the touch screen motion event down to the target view, or this view if it is the target.

Parameters
event MotionEvent!: The motion event to be dispatched.
Return
Boolean True if the event was handled by the view, false otherwise.

dispatchTrackballEvent

Added in API level 1
open fun dispatchTrackballEvent(event: MotionEvent!): Boolean

Pass a trackball motion event down to the focused view.

Parameters
event MotionEvent!: The motion event to be dispatched.
Return
Boolean True if the event was handled by the view, false otherwise.

dispatchUnhandledMove

Added in API level 1
open fun dispatchUnhandledMove(
    focused: View!,
    direction: Int
): Boolean

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.

Parameters
focused View!: The currently focused view.
direction Int: The direction focus wants to move. One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. Value is android.view.View#FOCUS_LEFT, android.view.View#FOCUS_UP, android.view.View#FOCUS_RIGHT, or android.view.View#FOCUS_DOWN
Return
Boolean True if the this view consumed this unhandled move.

dispatchWindowFocusChanged

Added in API level 1
open fun dispatchWindowFocusChanged(hasFocus: Boolean): Unit

Called when the window containing this view gains or loses window focus. ViewGroups should override to route to their children.

Parameters
hasFocus Boolean: True if the window containing this view now has focus, false otherwise.

dispatchWindowInsetsAnimationEnd

Added in API level 30
open fun dispatchWindowInsetsAnimationEnd(animation: WindowInsetsAnimation): Unit

Dispatches WindowInsetsAnimation.Callback#onEnd(WindowInsetsAnimation) when Window Insets animation ends.

Parameters
animation WindowInsetsAnimation: The current ongoing WindowInsetsAnimation. This value cannot be null.

dispatchWindowInsetsAnimationPrepare

Added in API level 30
open fun dispatchWindowInsetsAnimationPrepare(animation: WindowInsetsAnimation): Unit

Dispatches WindowInsetsAnimation.Callback#onPrepare(WindowInsetsAnimation) when Window Insets animation is being prepared.

Parameters
animation WindowInsetsAnimation: current animation This value cannot be null.

dispatchWindowInsetsAnimationProgress

Added in API level 30
open fun dispatchWindowInsetsAnimationProgress(
    insets: WindowInsets,
    runningAnimations: MutableList<WindowInsetsAnimation!>
): WindowInsets

Dispatches WindowInsetsAnimation.Callback#onProgress(WindowInsets, List) when Window Insets animation makes progress.

Parameters
insets WindowInsets: The current WindowInsets. This value cannot be null.
runningAnimations MutableList<WindowInsetsAnimation!>: The currently running WindowInsetsAnimations. This value cannot be null.
Return
WindowInsets current WindowInsets. This value cannot be null.

dispatchWindowInsetsAnimationStart

Added in API level 30
open fun dispatchWindowInsetsAnimationStart(
    animation: WindowInsetsAnimation,
    bounds: WindowInsetsAnimation.Bounds
): WindowInsetsAnimation.Bounds

Dispatches WindowInsetsAnimation.Callback#onStart(WindowInsetsAnimation, Bounds) when Window Insets animation is started.

Parameters
animation WindowInsetsAnimation: current animation This value cannot be null.
bounds WindowInsetsAnimation.Bounds: the upper and lower Bounds that provides range of WindowInsetsAnimation. This value cannot be null.
Return
WindowInsetsAnimation.Bounds the upper and lower Bounds. This value cannot be null.

dispatchWindowSystemUiVisiblityChanged

Added in API level 16
Deprecated in API level 30
open fun dispatchWindowSystemUiVisiblityChanged(visible: Int): Unit

Deprecated: SystemUiVisibility flags are deprecated. Use WindowInsetsController instead.

Dispatch callbacks to onWindowSystemUiVisibilityChanged(int) down the view hierarchy.

dispatchWindowVisibilityChanged

Added in API level 1
open fun dispatchWindowVisibilityChanged(visibility: Int): Unit

Dispatch a window visibility change down the view hierarchy. ViewGroups should override to route to their children.

Parameters
visibility Int: The new visibility of the window. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

draw

Added in API level 1
open fun draw(canvas: Canvas!): Unit

Manually render this view (and all of its children) to the given Canvas. The view must have already done a full layout before this function is called. When implementing a view, implement onDraw(android.graphics.Canvas) instead of overriding this method. If you do need to override this method, call the superclass version.
If you override this method you must call through to the superclass implementation.

Parameters
canvas Canvas!: The Canvas to which the View is rendered.

drawableHotspotChanged

Added in API level 21
open fun drawableHotspotChanged(
    x: Float,
    y: Float
): Unit

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.

Parameters
x Float: hotspot x coordinate
y Float: hotspot y coordinate

findFocus

Added in API level 1
open fun findFocus(): View!

Find the view in the hierarchy rooted at this view that currently has focus.

Return
View! The view that currently has focus, or null if no focused view can be found.

findViewById

Added in API level 1
fun <T : View!> findViewById(id: Int): T

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.

Parameters
id Int: the ID to search for
Return
T a view with given ID if found, or null otherwise

findViewWithTag

Added in API level 1
fun <T : View!> findViewWithTag(tag: Any!): T

Look for a child view with the given tag. If this view has the given tag, return this view.

Parameters
tag Any!: The tag to search for, using "tag.equals(getTag())".
Return
T The View that has the given tag in the hierarchy or null

findViewsWithText

Added in API level 14
open fun findViewsWithText(
    outViews: ArrayList<View!>!,
    searched: CharSequence!,
    flags: Int
): Unit

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.

Parameters
outViews ArrayList<View!>!: The output list of matching Views.
searched CharSequence!: The text to match against.
flags Int: Value is either 0 or a combination of android.view.View#FIND_VIEWS_WITH_TEXT, and android.view.View#FIND_VIEWS_WITH_CONTENT_DESCRIPTION

focusSearch

Added in API level 1
open fun focusSearch(direction: Int): View!

Find the nearest view in the specified direction that can take focus. This does not actually give focus to that view.

Parameters
direction Int: One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT Value is android.view.View#FOCUS_LEFT, android.view.View#FOCUS_UP, android.view.View#FOCUS_RIGHT, or android.view.View#FOCUS_DOWN
Return
View! The nearest focusable in the specified direction, or null if none can be found.

forceHasOverlappingRendering

Added in API level 24
open fun forceHasOverlappingRendering(hasOverlappingRendering: Boolean): Unit

Sets the behavior for overlapping rendering for this view (see 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 is called, the value of is ignored and the value passed into this method is used instead.

Parameters
hasOverlappingRendering Boolean: The value for overlapping rendering to be used internally instead of that returned by hasOverlappingRendering().

forceLayout

Added in API level 1
open fun forceLayout(): Unit

Forces this view to be laid out during the next layout pass. This method does not call requestLayout() or forceLayout() on the parent.

generateViewId

Added in API level 17
open static fun generateViewId(): Int

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.

Return
Int a generated ID value

getAccessibilityClassName

Added in API level 23
open fun getAccessibilityClassName(): CharSequence!

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.

getAccessibilityDelegate

Added in API level 29
open fun getAccessibilityDelegate(): View.AccessibilityDelegate!

Returns the delegate for implementing accessibility support via composition. For more details see AccessibilityDelegate.

Return
View.AccessibilityDelegate! The delegate, or null if none set.

getAccessibilityLiveRegion

Added in API level 19
open fun getAccessibilityLiveRegion(): Int

Gets the live region mode for this View.

Return
Int The live region mode for the view.

getAccessibilityNodeProvider

Added in API level 16
open fun getAccessibilityNodeProvider(): AccessibilityNodeProvider!

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.

Return
AccessibilityNodeProvider! The provider.

getAccessibilityPaneTitle

Added in API level 28
open fun getAccessibilityPaneTitle(): CharSequence?

Get the title of the pane for purposes of accessibility.

Return
CharSequence? The current pane title. {@see #setAccessibilityPaneTitle}. This value may be null.

getAccessibilityTraversalAfter

Added in API level 22
open fun getAccessibilityTraversalAfter(): Int

Gets the id of a view after which this one is visited in accessibility traversal.

Return
Int The id of a view this one succeedes in accessibility traversal if specified, otherwise NO_ID.

getAccessibilityTraversalBefore

Added in API level 22
open fun getAccessibilityTraversalBefore(): Int

Gets the id of a view before which this one is visited in accessibility traversal.

Return
Int The id of a view this one precedes in accessibility traversal if specified, otherwise NO_ID.

getAlpha

Added in API level 11
open fun getAlpha(): Float

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.

Return
Float The opacity of the view.

getAnimation

Added in API level 1
open fun getAnimation(): Animation!

Get the animation currently associated with this view.

Return
Animation! The animation that is currently playing or scheduled to play for this view.

getAnimationMatrix

Added in API level 29
open fun getAnimationMatrix(): Matrix?

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.

Return
Matrix? the Matrix, null indicates there is no transformation

getApplicationWindowToken

Added in API level 1
open fun getApplicationWindowToken(): IBinder!

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.

Return
IBinder! Returns the associated window token, either getWindowToken() or the containing window's token.

getAttributeResolutionStack

Added in API level 29
open fun getAttributeResolutionStack(attribute: Int): IntArray

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.

Parameters
attribute Int: Attribute resource ID for which the resolution stack should be returned.
Return
IntArray ordered list of resource ID that are considered when resolving attribute values for this View. This value cannot be null.

getAttributeSourceResourceMap

Added in API level 29
open fun getAttributeSourceResourceMap(): MutableMap<Int!, Int!>

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.

Return
MutableMap<Int!, Int!> mapping of attribute resource ID to source resource ID where the attribute value was set. This value cannot be null.

getAutofillHints

Added in API level 26
open fun getAutofillHints(): Array<String!>?

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.

Return
Array<String!>? The hints set via the attribute or setAutofillHints(java.lang.String...), or null if no hints were set.

getAutofillId

Added in API level 26
fun getAutofillId(): AutofillId!

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.

Return
AutofillId! The View's autofill id.

getAutofillType

Added in API level 26
open fun getAutofillType(): Int

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.

Return
Int either AUTOFILL_TYPE_NONE, AUTOFILL_TYPE_TEXT, AUTOFILL_TYPE_LIST, AUTOFILL_TYPE_DATE, or AUTOFILL_TYPE_TOGGLE. Value is android.view.View#AUTOFILL_TYPE_NONE, android.view.View#AUTOFILL_TYPE_TEXT, android.view.View#AUTOFILL_TYPE_TOGGLE, android.view.View#AUTOFILL_TYPE_LIST, or android.view.View#AUTOFILL_TYPE_DATE

getAutofillValue

Added in API level 26
open fun getAutofillValue(): AutofillValue?

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.

getBackground

Added in API level 1
open fun getBackground(): Drawable!

Gets the background drawable

Return
Drawable! The drawable used as the background for this view, if any.

getBackgroundTintBlendMode

Added in API level 29
open fun getBackgroundTintBlendMode(): BlendMode?

Return the blending mode used to apply the tint to the background drawable, if specified.

Return
BlendMode? the blending mode used to apply the tint to the background drawable, null if no blend has previously been configured

getBackgroundTintList

Added in API level 21
open fun getBackgroundTintList(): ColorStateList?

Return the tint applied to the background drawable, if specified.

Return
ColorStateList? the tint applied to the background drawable This value may be null.

getBackgroundTintMode

Added in API level 21
open fun getBackgroundTintMode(): PorterDuff.Mode?

Return the blending mode used to apply the tint to the background drawable, if specified.

Return
PorterDuff.Mode? the blending mode used to apply the tint to the background drawable This value may be null.

getBaseline

Added in API level 1
open fun getBaseline(): Int

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.

Return
Int the offset of the baseline within the widget's bounds or -1 if baseline alignment is not supported

getBottom

Added in API level 1
fun getBottom(): Int

Bottom position of this view relative to its parent.

Return
Int The bottom of this view, in pixels.

getCameraDistance

Added in API level 16
open fun getCameraDistance(): Float

Gets the distance along the Z axis from the camera to this view.

Return
Float The distance along the Z axis.

getClipBounds

Added in API level 18
open fun getClipBounds(): Rect!

Returns a copy of the current clipBounds.

Return
Rect! A copy of the current clip bounds if clip bounds are set, otherwise null.

getClipBounds

Added in API level 23
open fun getClipBounds(outRect: Rect!): Boolean

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.

Parameters
outRect Rect!: rectangle in which to place the clip bounds of the view
Return
Boolean true if successful or false if the view's clip bounds are null

getClipToOutline

Added in API level 21
fun getClipToOutline(): Boolean

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().

getContentCaptureSession

Added in API level 29
fun getContentCaptureSession(): ContentCaptureSession?

Gets the session used to notify content capture events.

Return
ContentCaptureSession? session explicitly set by setContentCaptureSession(android.view.contentcapture.ContentCaptureSession), inherited by ancestors, default session or null if content capture is disabled for this view.

getContentDescription

Added in API level 4
open fun getContentDescription(): CharSequence!

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.

Return
CharSequence! the content description

getContext

Added in API level 1
fun getContext(): Context!

Returns the context the view is running in, through which it can access the current theme, resources, etc.

Return
Context! The view's Context.

getDefaultFocusHighlightEnabled

Added in API level 26
fun getDefaultFocusHighlightEnabled(): Boolean

/** 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.

Return
Boolean True if this View should use a default focus highlight.

getDefaultSize

Added in API level 1
open static fun getDefaultSize(
    size: Int,
    measureSpec: Int
): 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.

Parameters
size Int: Default size for this view
measureSpec Int: Constraints imposed by the parent
Return
Int The size this view should be.

getDisplay

Added in API level 17
open fun getDisplay(): Display!

Gets the logical display to which the view's window has been attached.

Return
Display! The logical display, or null if the view is not currently attached to a window.

getDrawableState

Added in API level 1
fun getDrawableState(): IntArray!

Return an array of resource IDs of the drawable states representing the current state of the view.

Return
IntArray! The current drawable state

getDrawingCache

Added in API level 1
Deprecated in API level 28
open fun getDrawingCache(): Bitmap!

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Calling this method is equivalent to calling getDrawingCache(false).

Return
Bitmap! A non-scaled bitmap representing this view or null if cache is disabled.

getDrawingCache

Added in API level 4
Deprecated in API level 28
open fun getDrawingCache(autoScale: Boolean): Bitmap!

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

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.

Parameters
autoScale Boolean: Indicates whether the generated bitmap should be scaled based on the current density of the screen when the application is in compatibility mode.
Return
Bitmap! A bitmap representing this view or null if cache is disabled.

getDrawingCacheBackgroundColor

Added in API level 1
Deprecated in API level 28
open fun getDrawingCacheBackgroundColor(): Int

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Return
Int The background color to used for the drawing cache's bitmap

getDrawingCacheQuality

Added in API level 1
Deprecated in API level 28
open fun getDrawingCacheQuality(): Int

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Returns the quality of the drawing cache.

Return
Int One of DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, or DRAWING_CACHE_QUALITY_HIGH Value is android.view.View#DRAWING_CACHE_QUALITY_LOW, android.view.View#DRAWING_CACHE_QUALITY_HIGH, or android.view.View#DRAWING_CACHE_QUALITY_AUTO

getDrawingRect

Added in API level 1
open fun getDrawingRect(outRect: Rect!): Unit

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).

Parameters
outRect Rect!: The (scrolled) drawing bounds of the view.

getDrawingTime

Added in API level 1
open fun getDrawingTime(): Long

Return the time at which the drawing of the view hierarchy started.

Return
Long the drawing start time in milliseconds

getElevation

Added in API level 21
open fun getElevation(): Float

The base elevation of this view relative to its parent, in pixels.

Return
Float The base depth position of the view, in pixels.

getExplicitStyle

Added in API level 29
open fun getExplicitStyle(): Int

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.

Return
Int 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.

getFilterTouchesWhenObscured

Added in API level 9
open fun getFilterTouchesWhenObscured(): Boolean

Gets whether the framework should discard touches when the view's window is obscured by another visible window. Refer to the View security documentation for more details.

Return
Boolean True if touch filtering is enabled.

getFitsSystemWindows

Added in API level 16
open fun getFitsSystemWindows(): Boolean

Check for state of setFitsSystemWindows(boolean). If this method returns true, the default implementation of fitSystemWindows(android.graphics.Rect) will be executed.

Return
Boolean true if the default implementation of fitSystemWindows(android.graphics.Rect) will be executed.

getFocusable

Added in API level 26
open fun getFocusable(): Int

Returns the focusable setting for this view.

Return
Int One of NOT_FOCUSABLE, FOCUSABLE, or FOCUSABLE_AUTO. Value is android.view.View#NOT_FOCUSABLE, android.view.View#FOCUSABLE, or android.view.View#FOCUSABLE_AUTO

getFocusables

Added in API level 1
open fun getFocusables(direction: Int): ArrayList<View!>!

Find and return all focusable views that are descendants of this view, possibly including this view if it is focusable itself.

Parameters
direction Int: The direction of the focus Value is android.view.View#FOCUS_BACKWARD, android.view.View#FOCUS_FORWARD, android.view.View#FOCUS_LEFT, android.view.View#FOCUS_UP, android.view.View#FOCUS_RIGHT, or android.view.View#FOCUS_DOWN
Return
ArrayList<View!>! A list of focusable views

getFocusedRect

Added in API level 1
open fun getFocusedRect(r: Rect!): Unit

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.

Parameters
r Rect!: The rectangle to fill in, in this view's coordinates.

getForeground

Added in API level 23
open fun getForeground(): Drawable!

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.

Return
Drawable! a Drawable or null if no foreground was set

getForegroundGravity

Added in API level 23
open fun getForegroundGravity(): Int

Describes how the foreground is positioned.

Return
Int foreground gravity.

getForegroundTintBlendMode

Added in API level 29
open fun getForegroundTintBlendMode(): BlendMode?

Return the blending mode used to apply the tint to the foreground drawable, if specified.

Return
BlendMode? the blending mode used to apply the tint to the foreground drawable This value may be null.

getForegroundTintList

Added in API level 23
open fun getForegroundTintList(): ColorStateList?

Return the tint applied to the foreground drawable, if specified.

Return
ColorStateList? the tint applied to the foreground drawable This value may be null.

getForegroundTintMode

Added in API level 23
open fun getForegroundTintMode(): PorterDuff.Mode?

Return the blending mode used to apply the tint to the foreground drawable, if specified.

Return
PorterDuff.Mode? the blending mode used to apply the tint to the foreground drawable This value may be null.

getGlobalVisibleRect

Added in API level 1
open fun getGlobalVisibleRect(
    r: Rect!,
    globalOffset: Point!
): Boolean

If some part of this view is not clipped by any of its parents, then return that area in r in global (root) coordinates. To convert r to local coordinates (without taking possible View rotations into account), offset it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)). If the view is completely clipped or translated out, return false.

Parameters
r Rect!: If true is returned, r holds the global coordinates of the visible portion of this view.
globalOffset Point!: If true is returned, globalOffset holds the dx,dy between this view and its root. globalOffet may be null.
Return
Boolean true if r is non-empty (i.e. part of the view is visible at the root level.

getGlobalVisibleRect

Added in API level 1
fun getGlobalVisibleRect(r: Rect!): Boolean

getHandler

Added in API level 1
open fun getHandler(): Handler!
Return
Handler! A handler associated with the thread running the View. This handler can be used to pump events in the UI events queue.

getHasOverlappingRendering

Added in API level 24
fun getHasOverlappingRendering(): Boolean

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.

Return
Boolean The value for overlapping rendering being used internally.

getHeight

Added in API level 1
fun getHeight(): Int

Return the height of your view.

Return
Int The height of your view, in pixels.

getHitRect

Added in API level 1
open fun getHitRect(outRect: Rect!): Unit

Hit rectangle in parent's coordinates

Parameters
outRect Rect!: The hit rectangle of the view.

getHorizontalFadingEdgeLength

Added in API level 1
open fun getHorizontalFadingEdgeLength(): Int

Returns the size of the horizontal faded edges used to indicate that more content in this view is visible.

Return
Int The size in pixels of the horizontal faded edge or 0 if horizontal faded edges are not enabled for this view.

getHorizontalScrollbarThumbDrawable

Added in API level 29
open fun getHorizontalScrollbarThumbDrawable(): Drawable?

Returns the currently configured Drawable for the thumb of the horizontal scroll bar if it exists, null otherwise.

getHorizontalScrollbarTrackDrawable

Added in API level 29
open fun getHorizontalScrollbarTrackDrawable(): Drawable?

Returns the currently configured Drawable for the track of the horizontal scroll bar if it exists, null otherwise.

getId

Added in API level 1
open fun getId(): Int

Returns this view's identifier.

Return
Int a positive integer used to identify the view or NO_ID if the view has no ID

getImportantForAccessibility

Added in API level 16
open fun getImportantForAccessibility(): Int

Gets the mode for determining whether this View is important for accessibility. A view is important for accessibility if it fires accessibility events and if it is reported to accessibility services that query the screen.

Return
Int The mode for determining whether a view is important for accessibility, one of IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_YES, IMPORTANT_FOR_ACCESSIBILITY_NO, or IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS.

getKeepScreenOn

Added in API level 1
open fun getKeepScreenOn(): Boolean

Returns whether the screen should remain on, corresponding to the current value of KEEP_SCREEN_ON.

Return
Boolean Returns true if KEEP_SCREEN_ON is set.

getKeyDispatcherState

Added in API level 5
open fun getKeyDispatcherState(): KeyEvent.DispatcherState!

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).

getLabelFor

Added in API level 17
open fun getLabelFor(): Int

Gets the id of a view for which this view serves as a label for accessibility purposes.

Return
Int The labeled view id.

getLayerType

Added in API level 11
open fun getLayerType(): Int

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.

Return
Int LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE Value is android.view.View#LAYER_TYPE_NONE, android.view.View#LAYER_TYPE_SOFTWARE, or android.view.View#LAYER_TYPE_HARDWARE

getLayoutDirection

Added in API level 17
open fun getLayoutDirection(): Int

Returns the resolved layout direction for this view.

Return
Int LAYOUT_DIRECTION_RTL if the layout direction is RTL or returns LAYOUT_DIRECTION_LTR if the layout direction is not RTL. For compatibility, this will return LAYOUT_DIRECTION_LTR if API version is lower than android.os.Build.VERSION_CODES#JELLY_BEAN_MR1. Value is android.view.View#LAYOUT_DIRECTION_LTR, or android.view.View#LAYOUT_DIRECTION_RTL

getLayoutParams

Added in API level 1
open fun getLayoutParams(): ViewGroup.LayoutParams!

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.

Return
ViewGroup.LayoutParams! The LayoutParams associated with this view, or null if no parameters have been set yet

getLeft

Added in API level 1
fun getLeft(): Int

Left position of this view relative to its parent.

Return
Int The left edge of this view, in pixels.

getLocalVisibleRect

Added in API level 1
fun getLocalVisibleRect(r: Rect!): Boolean

getLocationInSurface

Added in API level 29
open fun getLocationInSurface(location: IntArray): Unit

Compute the view's coordinate within the surface.

Computes the coordinates of this view in its surface. The argument must be an array of two integers. After the method returns, the array contains the x and y location in that order.

Parameters
location IntArray: an array of two integers in which to hold the coordinates This value cannot be null.

getLocationInWindow

Added in API level 1
open fun getLocationInWindow(outLocation: IntArray!): Unit

Computes the coordinates of this view in its window. The argument must be an array of two integers. After the method returns, the array contains the x and y location in that order.

Parameters
outLocation IntArray!: an array of two integers in which to hold the coordinates

getLocationOnScreen

Added in API level 1
open fun getLocationOnScreen(outLocation: IntArray!): Unit

Computes the coordinates of this view on the screen. The argument must be an array of two integers. After the method returns, the array contains the x and y location in that order.

Parameters
outLocation IntArray!: an array of two integers in which to hold the coordinates

getMatrix

Added in API level 11
open fun getMatrix(): Matrix!

The transform matrix of this view, which is calculated based on the current rotation, scale, and pivot properties.

Return
Matrix! The current transform matrix for the view

getMeasuredHeight

Added in API level 1
fun getMeasuredHeight(): Int

Like getMeasuredHeightAndState(), but only returns the raw height component (that is the result is masked by MEASURED_SIZE_MASK).

Return
Int The raw measured height of this view.

getMeasuredHeightAndState

Added in API level 11
fun getMeasuredHeightAndState(): Int

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.

Return
Int The measured height of this view as a bit mask.

getMeasuredState

Added in API level 11
fun getMeasuredState(): Int

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.

getMeasuredWidth

Added in API level 1
fun getMeasuredWidth(): Int

Like getMeasuredWidthAndState(), but only returns the raw width component (that is the result is masked by MEASURED_SIZE_MASK).

Return
Int The raw measured width of this view.

getMeasuredWidthAndState

Added in API level 11
fun getMeasuredWidthAndState(): Int

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.

Return
Int The measured width of this view as a bit mask.

getMinimumHeight

Added in API level 16
open fun getMinimumHeight(): Int

Returns the minimum height of the view.

Return
Int the minimum height the view will try to be, in pixels

getMinimumWidth

Added in API level 16
open fun getMinimumWidth(): Int

Returns the minimum width of the view.

Return
Int the minimum width the view will try to be, in pixels

getNextClusterForwardId

Added in API level 26
open fun getNextClusterForwardId(): Int

Gets the id of the root of the next keyboard navigation cluster.

Return
Int The next keyboard navigation cluster ID, or NO_ID if the framework should decide automatically.

getNextFocusDownId

Added in API level 1
open fun getNextFocusDownId(): Int

Gets the id of the view to use when the next focus is FOCUS_DOWN.

Return
Int The next focus ID, or NO_ID if the framework should decide automatically.

getNextFocusForwardId

Added in API level 11
open fun getNextFocusForwardId(): Int

Gets the id of the view to use when the next focus is FOCUS_FORWARD.

Return
Int The next focus ID, or NO_ID if the framework should decide automatically.

getNextFocusLeftId

Added in API level 1
open fun getNextFocusLeftId(): Int

Gets the id of the view to use when the next focus is FOCUS_LEFT.

Return
Int The next focus ID, or NO_ID if the framework should decide automatically.

getNextFocusRightId

Added in API level 1
open fun getNextFocusRightId(): Int

Gets the id of the view to use when the next focus is FOCUS_RIGHT.

Return
Int The next focus ID, or NO_ID if the framework should decide automatically.

getNextFocusUpId

Added in API level 1
open fun getNextFocusUpId(): Int

Gets the id of the view to use when the next focus is FOCUS_UP.

Return
Int The next focus ID, or NO_ID if the framework should decide automatically.

getOnFocusChangeListener

Added in API level 1
open fun getOnFocusChangeListener(): View.OnFocusChangeListener!

Returns the focus-change callback registered for this view.

Return
View.OnFocusChangeListener! The callback, or null if one is not registered.

getOutlineAmbientShadowColor

Added in API level 28
open fun getOutlineAmbientShadowColor(): Int
Return
Int The shadow color set by setOutlineAmbientShadowColor(int), or black if nothing was set

getOutlineProvider

Added in API level 21
open fun getOutlineProvider(): ViewOutlineProvider!

Returns the current ViewOutlineProvider of the view, which generates the Outline that defines the shape of the shadow it casts, and enables outline clipping.

getOutlineSpotShadowColor

Added in API level 28
open fun getOutlineSpotShadowColor(): Int
Return
Int The shadow color set by setOutlineSpotShadowColor(int), or black if nothing was set

getOverScrollMode

Added in API level 9
open fun getOverScrollMode(): Int

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.

Return
Int This view's over-scroll mode.

getOverlay

Added in API level 18
open fun getOverlay(): ViewOverlay!

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.

Return
ViewOverlay! The ViewOverlay object for this view.

getPaddingBottom

Added in API level 1
open fun getPaddingBottom(): Int

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.

Return
Int the bottom padding in pixels

getPaddingEnd

Added in API level 17
open fun getPaddingEnd(): Int

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.

Return
Int the end padding in pixels

getPaddingLeft

Added in API level 1
open fun getPaddingLeft(): Int

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.

Return
Int the left padding in pixels

getPaddingRight

Added in API level 1
open fun getPaddingRight(): Int

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.

Return
Int the right padding in pixels

getPaddingStart

Added in API level 17
open fun getPaddingStart(): Int

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.

Return
Int the start padding in pixels

getPaddingTop

Added in API level 1
open fun getPaddingTop(): Int

Returns the top padding of this view.

Return
Int the top padding in pixels

getParent

Added in API level 1
fun getParent(): ViewParent!

Gets the parent of this view. Note that the parent is a ViewParent and not necessarily a View.

Return
ViewParent! Parent of this view.

getParentForAccessibility

Added in API level 16
open fun getParentForAccessibility(): ViewParent!

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.

Return
ViewParent! The parent for accessibility purposes.

getPivotX

Added in API level 11
open fun getPivotX(): Float

The x location of the point around which the view is rotated and scaled.

Return
Float The x location of the pivot point.

getPivotY

Added in API level 11
open fun getPivotY(): Float

The y location of the point around which the view is rotated and scaled.

Return
Float The y location of the pivot point.

getPointerIcon

Added in API level 24
open fun getPointerIcon(): PointerIcon!

Gets the pointer icon for the current view.

getResources

Added in API level 1
open fun getResources(): Resources!

Returns the resources associated with this view.

Return
Resources! Resources object.

getRevealOnFocusHint

Added in API level 25
fun getRevealOnFocusHint(): Boolean

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.

Return
Boolean true if this view would prefer to become fully visible when it gains focus, false if it would prefer not to disrupt scroll positioning

getRight

Added in API level 1
fun getRight(): Int

Right position of this view relative to its parent.

Return
Int The right edge of this view, in pixels.

getRootView

Added in API level 1
open fun getRootView(): View!

Finds the topmost view in the current view hierarchy.

Return
View! the topmost view containing this view

getRootWindowInsets

Added in API level 23
open fun getRootWindowInsets(): WindowInsets!

Provide original WindowInsets that are dispatched to the view hierarchy. The insets are only available if the view is attached.

Return
WindowInsets! WindowInsets from the top of the view hierarchy or null if View is detached

getRotation

Added in API level 11
open fun getRotation(): Float

The degrees that the view is rotated around the pivot point.

Return
Float The degrees of rotation.

getRotationX

Added in API level 11
open fun getRotationX(): Float

The degrees that the view is rotated around the horizontal axis through the pivot point.

Return
Float The degrees of X rotation.

getRotationY

Added in API level 11
open fun getRotationY(): Float

The degrees that the view is rotated around the vertical axis through the pivot point.

Return
Float The degrees of Y rotation.

getScaleX

Added in API level 11
open fun getScaleX(): Float

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.

Return
Float The scaling factor.

getScaleY

Added in API level 11
open fun getScaleY(): Float

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.

Return
Float The scaling factor.

getScrollBarDefaultDelayBeforeFade

Added in API level 16
open fun getScrollBarDefaultDelayBeforeFade(): Int

Returns the delay before scrollbars fade.

Return
Int the delay before scrollbars fade

getScrollBarFadeDuration

Added in API level 16
open fun getScrollBarFadeDuration(): Int

Returns the scrollbar fade duration.

Return
Int the scrollbar fade duration, in milliseconds

getScrollBarSize

Added in API level 16
open fun getScrollBarSize(): Int

Returns the scrollbar size.

Return
Int the scrollbar size

getScrollIndicators

Added in API level 23
open fun getScrollIndicators(): Int

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.

Return
Int a bitmask representing the enabled scroll indicators Value is either 0 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

getScrollX

Added in API level 1
fun getScrollX(): Int

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.

Return
Int The left edge of the displayed part of your view, in pixels.

getScrollY

Added in API level 1
fun getScrollY(): Int

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.

Return
Int The top edge of the displayed part of your view, in pixels.

getSolidColor

Added in API level 1
open fun getSolidColor(): Int

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.

Return
Int The known solid color background for this view, or 0 if the color may vary

getSourceLayoutResId

Added in API level 29
open fun getSourceLayoutResId(): Int

A View can be inflated from an XML layout. For such Views this method returns the resource ID of the source layout.

Return
Int The layout resource id if this view was inflated from XML, otherwise Resources#ID_NULL.

getStateDescription

Added in API level 30
fun getStateDescription(): CharSequence?

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.

Return
CharSequence? the state description This value may be null.

getStateListAnimator

Added in API level 21
open fun getStateListAnimator(): StateListAnimator!

Returns the current StateListAnimator if exists.

Return
StateListAnimator! StateListAnimator or null if it does not exists

getSystemGestureExclusionRects

Added in API level 29
open fun getSystemGestureExclusionRects(): MutableList<Rect!>

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.

Return
MutableList<Rect!> the list set by setSystemGestureExclusionRects(java.util.List) This value cannot be null.

getSystemUiVisibility

Added in API level 11
Deprecated in API level 30
open fun getSystemUiVisibility(): Int

Deprecated: SystemUiVisibility flags are deprecated. Use WindowInsetsController instead.

Returns the last setSystemUiVisibility(int) that this view has requested.

Return
Int Bitwise-or of flags SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_IMMERSIVE, and SYSTEM_UI_FLAG_IMMERSIVE_STICKY.

getTag

Added in API level 1
open fun getTag(): Any!

Returns this view's tag.

Return
Any! the Object stored in this view as a tag, or null if not set

getTag

Added in API level 4
open fun getTag(key: Int): Any!

Returns the tag associated with this view and the specified key.

Parameters
key Int: The key identifying the tag
Return
Any! the Object stored in this view as a tag, or null if not set

getTextDirection

Added in API level 17
open fun getTextDirection(): Int

Return the resolved text direction.

Return
Int the resolved text direction. Returns one of: TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL

getTooltipText

Added in API level 26
open fun getTooltipText(): CharSequence?

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.

Return
CharSequence? the tooltip text This value may be null.

getTop

Added in API level 1
fun getTop(): Int

Top position of this view relative to its parent.

Return
Int The top of this view, in pixels.

getTouchDelegate

Added in API level 1
open fun getTouchDelegate(): TouchDelegate!

Gets the TouchDelegate for this View.

getTouchables

Added in API level 1
open fun getTouchables(): ArrayList<View!>!

Find and return all touchable views that are descendants of this view, possibly including this view if it is touchable itself.

Return
ArrayList<View!>! A list of touchable views

getTransitionAlpha

Added in API level 29
open fun getTransitionAlpha(): 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.

getTransitionName

Added in API level 21
open fun getTransitionName(): String!

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.

Return
String! The name used of the View to be used to identify Views in Transitions or null if no name has been given.

getTranslationX

Added in API level 11
open fun getTranslationX(): Float

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.

Return
Float The horizontal position of this view relative to its left position, in pixels.

getTranslationY

Added in API level 11
open fun getTranslationY(): Float

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.

Return
Float The vertical position of this view relative to its top position, in pixels.

getTranslationZ

Added in API level 21
open fun getTranslationZ(): Float

The depth location of this view relative to its elevation.

Return
Float The depth of this view relative to its elevation.

getUniqueDrawingId

Added in API level 29
open fun getUniqueDrawingId(): Long

Get the identifier used for this view by the drawing system.

Return
Long A long that uniquely identifies this view's drawing component

getVerticalFadingEdgeLength

Added in API level 1
open fun getVerticalFadingEdgeLength(): Int

Returns the size of the vertical faded edges used to indicate that more content in this view is visible.

Return
Int The size in pixels of the vertical faded edge or 0 if vertical faded edges are not enabled for this view.

getVerticalScrollbarPosition

Added in API level 11
open fun getVerticalScrollbarPosition(): Int
Return
Int The position where the vertical scroll bar will show, if applicable.

getVerticalScrollbarThumbDrawable

Added in API level 29
open fun getVerticalScrollbarThumbDrawable(): Drawable?

Returns the currently configured Drawable for the thumb of the vertical scroll bar if it exists, null otherwise.

getVerticalScrollbarTrackDrawable

Added in API level 29
open fun getVerticalScrollbarTrackDrawable(): Drawable?

Returns the currently configured Drawable for the track of the vertical scroll bar if it exists, null otherwise.

getVerticalScrollbarWidth

Added in API level 1
open fun getVerticalScrollbarWidth(): Int

Returns the width of the vertical scrollbar.

Return
Int The width in pixels of the vertical scrollbar or 0 if there is no vertical scrollbar.

getViewTreeObserver

Added in API level 1
open fun getViewTreeObserver(): ViewTreeObserver!

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().

Return
ViewTreeObserver! The ViewTreeObserver for this view's hierarchy.

getVisibility

Added in API level 1
open fun getVisibility(): Int

Returns the visibility status for this view.

Return
Int One of VISIBLE, INVISIBLE, or GONE. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

getWidth

Added in API level 1
fun getWidth(): Int

Return the width of your view.

Return
Int The width of your view, in pixels.

getWindowId

Added in API level 18
open fun getWindowId(): WindowId!

Retrieve the WindowId for the window this view is currently attached to.

getWindowInsetsController

Added in API level 30
open fun getWindowInsetsController(): WindowInsetsController?

Retrieves the single WindowInsetsController of the window this view is attached to.

Return
WindowInsetsController? The WindowInsetsController or null if the view is neither attached to a window nor a view tree with a decor.

getWindowSystemUiVisibility

Added in API level 16
Deprecated in API level 30
open fun getWindowSystemUiVisibility(): Int

Deprecated: SystemUiVisibility flags are deprecated. Use WindowInsetsController instead.

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.

getWindowToken

Added in API level 1
open fun getWindowToken(): IBinder!

Retrieve a unique token identifying the window this view is attached to.

Return
IBinder! Return the window's token for use in WindowManager.LayoutParams#token.

getWindowVisibility

Added in API level 1
open fun getWindowVisibility(): Int

Returns the current visibility of the window this view is attached to (either GONE, INVISIBLE, or VISIBLE).

Return
Int Returns the current visibility of the view's window. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

getWindowVisibleDisplayFrame

Added in API level 3
open fun getWindowVisibleDisplayFrame(outRect: Rect!): Unit

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.

This function requires an IPC back to the window manager to retrieve the requested information, so should not be used in performance critical code like drawing.

Parameters
outRect Rect!: Filled in with the visible display frame. If the view is not attached to a window, this is simply the raw display size.

getX

Added in API level 11
open fun getX(): Float

The visual x position of this view, in pixels. This is equivalent to the translationX property plus the current left property.

Return
Float The visual x position of this view, in pixels.

getY

Added in API level 11
open fun getY(): Float

The visual y position of this view, in pixels. This is equivalent to the translationY property plus the current top property.

Return
Float The visual y position of this view, in pixels.

getZ

Added in API level 21
open fun getZ(): Float

The visual z position of this view, in pixels. This is equivalent to the translationZ property plus the current elevation property.

Return
Float The visual z position of this view, in pixels.

hasExplicitFocusable

Added in API level 26
open fun hasExplicitFocusable(): Boolean

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.

Return
Boolean true if the view is focusable or if the view contains a focusable view, false otherwise

See Also

hasFocus

Added in API level 1
open fun hasFocus(): Boolean

Returns true if this view has focus itself, or is the ancestor of the view that has focus.

Return
Boolean True if this view has or contains focus, false otherwise.

hasFocusable

Added in API level 1
open fun hasFocusable(): Boolean

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.

Return
Boolean true if the view is focusable or if the view contains a focusable view, false otherwise

hasNestedScrollingParent

Added in API level 21
open fun hasNestedScrollingParent(): Boolean

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.

Return
Boolean whether this view has a nested scrolling parent

hasOnClickListeners

Added in API level 15
open fun hasOnClickListeners(): Boolean

Return whether this view has an attached OnClickListener. Returns true if there is a listener, false if there is none.

hasOnLongClickListeners

Added in API level 30
open fun hasOnLongClickListeners(): Boolean

Return whether this view has an attached OnLongClickListener. Returns true if there is a listener, false if there is none.

hasOverlappingRendering

Added in API level 16
open fun hasOverlappingRendering(): Boolean

Returns whether this View has content which overlaps.

This function, intended to be overridden by specific View types, is an optimization when alpha is set on a view. If rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer and then composited into place, which can be expensive. If the view has no overlapping rendering, the view can draw each primitive with the appropriate alpha value directly. An example of overlapping rendering is a TextView with a background image, such as a Button. An example of non-overlapping rendering is a TextView with no background, or an ImageView with only the foreground image. The default implementation returns true; subclasses should override if they have cases which can be optimized.

Note: The return value of this method is ignored if has been called on this view.

Return
Boolean true if the content in this view might overlap, false otherwise.

hasPointerCapture

Added in API level 26
open fun hasPointerCapture(): Boolean

Checks pointer capture status.

Return
Boolean true if the view has pointer capture.

hasTransientState

Added in API level 16
open fun hasTransientState(): Boolean

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.

Return
Boolean true if the view has transient state

hasWindowFocus

Added in API level 1
open fun hasWindowFocus(): Boolean

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.

Return
Boolean True if this view is in a window that currently has window focus.

inflate

Added in API level 1
open static fun inflate(
    context: Context!,
    resource: Int,
    root: ViewGroup!
): View!

Inflate a view from an XML resource. This convenience method wraps the LayoutInflater class, which provides a full range of options for view inflation.

Parameters
context Context!: The Context object for your activity or application.
resource Int: The resource ID to inflate
root ViewGroup!: A view group that will be the parent. Used to properly inflate the layout_* parameters.

invalidate

Added in API level 1
Deprecated in API level 28
open fun invalidate(dirty: Rect!): Unit

Deprecated: The switch to hardware accelerated rendering in API 14 reduced the importance of the dirty rectangle. In API 21 the given rectangle is ignored entirely in favor of an internally-calculated area instead. Because of this, clients are encouraged to just call invalidate().

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.

Parameters
dirty Rect!: the rectangle representing the bounds of the dirty region

invalidate

Added in API level 1
Deprecated in API level 28
open fun invalidate(
    l: Int,
    t: Int,
    r: Int,
    b: Int
): Unit

Deprecated: The switch to hardware accelerated rendering in API 14 reduced the importance of the dirty rectangle. In API 21 the given rectangle is ignored entirely in favor of an internally-calculated area instead. Because of this, clients are encouraged to just call invalidate().

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().

Parameters
l Int: the left position of the dirty region
t Int: the top position of the dirty region
r Int: the right position of the dirty region
b Int: the bottom position of the dirty region

invalidate

Added in API level 1
open fun invalidate(): Unit

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().

invalidateDrawable

Added in API level 1
open fun invalidateDrawable(drawable: Drawable): Unit

Invalidates the specified Drawable.

Parameters
who The drawable that is requesting the update. This value cannot be null.
drawable Drawable: the drawable to invalidate This value cannot be null.

invalidateOutline

Added in API level 21
open fun invalidateOutline(): Unit

Called to rebuild this View's Outline from its ViewOutlineProvider

isAccessibilityFocused

Added in API level 21
open fun isAccessibilityFocused(): Boolean

Returns whether this View is accessibility focused.

Return
Boolean True if this View is accessibility focused.

isAccessibilityHeading

Added in API level 28
open fun isAccessibilityHeading(): Boolean

Gets whether this view is a heading for accessibility purposes.

Return
Boolean true if the view is a heading, false otherwise.

isActivated

Added in API level 11
open fun isActivated(): Boolean

Indicates the activation state of this view.

Return
Boolean true if the view is activated, false otherwise

isAttachedToWindow

Added in API level 19
open fun isAttachedToWindow(): Boolean

Returns true if this view is currently attached to a window.

isClickable

Added in API level 1
open fun isClickable(): Boolean

Indicates whether this view reacts to click events or not.

Return
Boolean true if the view is clickable, false otherwise

isContextClickable

Added in API level 23
open fun isContextClickable(): Boolean

Indicates whether this view reacts to context clicks or not.

Return
Boolean true if the view is context clickable, false otherwise

isDirty

Added in API level 11
open fun isDirty(): Boolean

True if this view has changed since the last time being drawn.

Return
Boolean The dirty state of this view.

isDrawingCacheEnabled

Added in API level 1
Deprecated in API level 28
open fun isDrawingCacheEnabled(): Boolean

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Indicates whether the drawing cache is enabled for this view.

Return
Boolean true if the drawing cache is enabled

isDuplicateParentStateEnabled

Added in API level 1
open fun isDuplicateParentStateEnabled(): Boolean

Indicates whether this duplicates its drawable state from its parent.

Return
Boolean True if this view's drawable state is duplicated from the parent, false otherwise

isEnabled

Added in API level 1
open fun isEnabled(): Boolean

Returns the enabled status for this view. The interpretation of the enabled state varies by subclass.

Return
Boolean True if this view is enabled, false otherwise.

isFocusable

Added in API level 1
fun isFocusable(): Boolean

Returns whether this View is currently able to take focus.

Return
Boolean True if this view can take focus, or false otherwise.

isFocusableInTouchMode

Added in API level 1
fun isFocusableInTouchMode(): Boolean

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

Return
Boolean Whether the view is focusable in touch mode.

isFocused

Added in API level 1
open fun isFocused(): Boolean

Returns true if this view has focus

Return
Boolean True if this view has focus, false otherwise.

isFocusedByDefault

Added in API level 26
fun isFocusedByDefault(): Boolean

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.

Return
Boolean true if this view is the default-focus view, false otherwise

isForceDarkAllowed

Added in API level 29
open fun isForceDarkAllowed(): Boolean

See setForceDarkAllowed(boolean)

Return
Boolean true if force dark is allowed (default), false if it is disabled

isHapticFeedbackEnabled

Added in API level 3
open fun isHapticFeedbackEnabled(): Boolean
Return
Boolean whether this view should have haptic feedback enabled for events long presses.

isHardwareAccelerated

Added in API level 11
open fun isHardwareAccelerated(): Boolean

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.

Return
Boolean True if the view is attached to a window and the window is hardware accelerated; false in any other case.

isHorizontalFadingEdgeEnabled

Added in API level 1
open fun isHorizontalFadingEdgeEnabled(): Boolean

Indicate whether the horizontal edges are faded when the view is scrolled horizontally.

Return
Boolean true if the horizontal edges should are faded on scroll, false otherwise

isHorizontalScrollBarEnabled

Added in API level 1
open fun isHorizontalScrollBarEnabled(): Boolean

Indicate whether the horizontal scrollbar should be drawn or not. The scrollbar is not drawn by default.

Return
Boolean true if the horizontal scrollbar should be painted, false otherwise

isHovered

Added in API level 14
open fun isHovered(): Boolean

Returns true if the view is currently hovered.

Return
Boolean True if the view is currently hovered.

isImportantForAccessibility

Added in API level 21
open fun isImportantForAccessibility(): Boolean

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:

  1. IMPORTANT_FOR_ACCESSIBILITY_NO or IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, return false
  2. IMPORTANT_FOR_ACCESSIBILITY_YES, return true
  3. IMPORTANT_FOR_ACCESSIBILITY_AUTO, return true if view satisfies any of the following:
  4. Has an accessibility pane title, see setAccessibilityPaneTitle
Return
Boolean Whether the view is exposed for accessibility.

isImportantForAutofill

Added in API level 26
fun isImportantForAutofill(): Boolean

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:

  1. The view can be autofilled by an android.service.autofill.AutofillService.
  2. 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():

      1. if it returns IMPORTANT_FOR_AUTOFILL_YES or IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, then it returns true
      2. if it returns IMPORTANT_FOR_AUTOFILL_NO or IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS, then it returns false
      3. 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.
      4. otherwise, it returns false.

      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:

Return
Boolean whether the view is considered important for autofill.

isImportantForContentCapture

Added in API level 30
fun isImportantForContentCapture(): Boolean

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.

Return
Boolean whether the view is considered important for content capture.

isInEditMode

Added in API level 3
open fun isInEditMode(): Boolean

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.

Return
Boolean True if this View is in edit mode, false otherwise.

isInLayout

Added in API level 18
open fun isInLayout(): Boolean

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.

Return
Boolean whether the view hierarchy is currently undergoing a layout pass

isInTouchMode

Added in API level 1
open fun isInTouchMode(): Boolean

Returns whether the device is currently in touch mode. Touch mode is entered once the user begins interacting with the device by touch, and affects various things like whether focus is always visible to the user.

Return
Boolean Whether the device is in touch mode.

isKeyboardNavigationCluster

Added in API level 26
fun isKeyboardNavigationCluster(): Boolean

Returns whether this View is a root of a keyboard navigation cluster.

Return
Boolean True if this view is a root of a cluster, or false otherwise.

isLaidOut

Added in API level 19
open fun isLaidOut(): Boolean

Returns true if this view has been through at least one layout since it was last attached to or detached from a window.

isLayoutDirectionResolved

Added in API level 19
open fun isLayoutDirectionResolved(): Boolean
Return
Boolean true if layout direction has been resolved.

isLayoutRequested

Added in API level 1
open fun isLayoutRequested(): Boolean

Indicates whether or not this view's layout will be requested during the next hierarchy layout pass.

Return
Boolean true if the layout will be forced during next layout pass

isLongClickable

Added in API level 1
open fun isLongClickable(): Boolean

Indicates whether this view reacts to long click events or not.

Return
Boolean true if the view is long clickable, false otherwise

isNestedScrollingEnabled

Added in API level 21
open fun isNestedScrollingEnabled(): Boolean

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.

Return
Boolean true if nested scrolling is enabled

isOpaque

Added in API level 7
open fun isOpaque(): Boolean

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.

Return
Boolean True if this View is guaranteed to be fully opaque, false otherwise.

isPaddingRelative

Added in API level 17
open fun isPaddingRelative(): Boolean

Return if the padding has been set through relative values setPaddingRelative(int,int,int,int) or through

Return
Boolean true if the padding is relative or false if it is not.

isPivotSet

Added in API level 28
open fun isPivotSet(): Boolean

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.

Return
Boolean True if a pivot has been set, false if the default pivot is being used

isPressed

Added in API level 1
open fun isPressed(): Boolean

Indicates whether the view is currently in pressed state. Unless setPressed(boolean) is explicitly called, only clickable views can enter the pressed state.

Return
Boolean true if the view is currently pressed, false otherwise

isSaveEnabled

Added in API level 1
open fun isSaveEnabled(): Boolean

Indicates whether this view will save its state (that is, whether its onSaveInstanceState method will be called).

Return
Boolean Returns true if the view state saving is enabled, else false.

isSaveFromParentEnabled

Added in API level 11
open fun isSaveFromParentEnabled(): Boolean

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.

Return
Boolean Returns true if the view state saving from parent is enabled, else false.

isScreenReaderFocusable

Added in API level 28
open fun isScreenReaderFocusable(): Boolean

Returns whether the view should be treated as a focusable unit by screen reader accessibility tools.

Return
Boolean Whether the view should be treated as a focusable unit by screen reader.

isScrollContainer

Added in API level 16
open fun isScrollContainer(): Boolean

Indicates whether this view is one of the set of scrollable containers in its window.

Return
Boolean whether this view is one of the set of scrollable containers in its window

isScrollbarFadingEnabled

Added in API level 5
open fun isScrollbarFadingEnabled(): Boolean

Returns true if scrollbars will fade when this view is not scrolling

Return
Boolean true if scrollbar fading is enabled

isSelected

Added in API level 1
open fun isSelected(): Boolean

Indicates the selection state of this view.

Return
Boolean true if the view is selected, false otherwise

isShowingLayoutBounds

Added in API level 30
fun isShowingLayoutBounds(): Boolean

Returns true when the View is attached and the system developer setting to show the layout bounds is enabled or false otherwise.

isShown

Added in API level 1
open fun isShown(): Boolean

Returns the visibility of this view and all of its ancestors

Return
Boolean True if this view and all of its ancestors are VISIBLE

isSoundEffectsEnabled

Added in API level 1
open fun isSoundEffectsEnabled(): Boolean
Return
Boolean whether this view should have sound effects enabled for events such as clicking and touching.

isTemporarilyDetached

Added in API level 24
fun isTemporarilyDetached(): Boolean

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.

Return
Boolean true when the View is in the state between onStartTemporaryDetach() and onFinishTemporaryDetach().

isTextAlignmentResolved

Added in API level 19
open fun isTextAlignmentResolved(): Boolean
Return
Boolean true if text alignment is resolved.

isTextDirectionResolved

Added in API level 19
open fun isTextDirectionResolved(): Boolean
Return
Boolean true if text direction is resolved.

isVerticalFadingEdgeEnabled

Added in API level 1
open fun isVerticalFadingEdgeEnabled(): Boolean

Indicate whether the vertical edges are faded when the view is scrolled horizontally.

Return
Boolean true if the vertical edges should are faded on scroll, false otherwise

isVerticalScrollBarEnabled

Added in API level 1
open fun isVerticalScrollBarEnabled(): Boolean

Indicate whether the vertical scrollbar should be drawn or not. The scrollbar is not drawn by default.

Return
Boolean true if the vertical scrollbar should be painted, false otherwise

isVisibleToUserForAutofill

Added in API level 28
open fun isVisibleToUserForAutofill(virtualId: Int): Boolean

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.

Return
Boolean Whether the view is visible on the screen.

jumpDrawablesToCurrentState

Added in API level 11
open fun jumpDrawablesToCurrentState(): Unit

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.

keyboardNavigationClusterSearch

Added in API level 26
open fun keyboardNavigationClusterSearch(
    currentCluster: View!,
    direction: Int
): View!

Find the nearest keyboard navigation cluster in the specified direction. This does not actually give focus to that cluster.

Parameters
currentCluster View!: The starting point of the search. Null means the current cluster is not found yet
direction Int: Direction to look Value is android.view.View#FOCUS_BACKWARD, android.view.View#FOCUS_FORWARD, android.view.View#FOCUS_LEFT, android.view.View#FOCUS_UP, android.view.View#FOCUS_RIGHT, or android.view.View#FOCUS_DOWN
Return
View! The nearest keyboard navigation cluster in the specified direction, or null if none can be found

layout

Added in API level 1
open fun layout(
    l: Int,
    t: Int,
    r: Int,
    b: Int
): Unit

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.

Parameters
l Int: Left position, relative to parent
t Int: Top position, relative to parent
r Int: Right position, relative to parent
b Int: Bottom position, relative to parent

measure

Added in API level 1
fun measure(
    widthMeasureSpec: Int,
    heightMeasureSpec: Int
): Unit

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.

Parameters
widthMeasureSpec Int: Horizontal space requirements as imposed by the parent
heightMeasureSpec Int: Vertical space requirements as imposed by the parent

offsetLeftAndRight

Added in API level 1
open fun offsetLeftAndRight(offset: Int): Unit

Offset this view's horizontal location by the specified amount of pixels.

Parameters
offset Int: the number of pixels to offset the view by

offsetTopAndBottom

Added in API level 1
open fun offsetTopAndBottom(offset: Int): Unit

Offset this view's vertical location by the specified number of pixels.

Parameters
offset Int: the number of pixels to offset the view by

onApplyWindowInsets

Added in API level 20
open fun onApplyWindowInsets(insets: WindowInsets!): 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.

Parameters
insets WindowInsets!: Insets to apply
Return
WindowInsets! The supplied insets with any applied insets consumed

onCancelPendingInputEvents

Added in API level 19
open fun onCancelPendingInputEvents(): Unit

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.

onCapturedPointerEvent

Added in API level 26
open fun onCapturedPointerEvent(event: MotionEvent!): Boolean

Implement this method to handle captured pointer events

Parameters
event MotionEvent!: The captured pointer event.
Return
Boolean True if the event was handled, false otherwise.

onCheckIsTextEditor

Added in API level 3
open fun onCheckIsTextEditor(): Boolean

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.

Return
Boolean Returns true if this view is a text editor, else false.

onCreateInputConnection

Added in API level 3
open fun onCreateInputConnection(outAttrs: EditorInfo!): InputConnection!

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.

Parameters
outAttrs EditorInfo!: Fill in with attribute information about the connection.

onDragEvent

Added in API level 11
open fun onDragEvent(event: DragEvent!): Boolean

Handles drag events sent by the system following a call to startDragAndDrop().

When the system calls this method, it passes a android.view.DragEvent object. A call to android.view.DragEvent#getAction() returns one of the action type constants defined in DragEvent. The method uses these to determine what is happening in the drag and drop operation.

Parameters
event DragEvent!: The android.view.DragEvent sent by the system. The android.view.DragEvent#getAction() method returns an action type constant defined in DragEvent, indicating the type of drag event represented by this object.
Return
Boolean true if the method was successful, otherwise false.

The method should return true in response to an action type of android.view.DragEvent#ACTION_DRAG_STARTED to receive drag events for the current operation.

The method should also return true in response to an action type of android.view.DragEvent#ACTION_DROP if it consumed the drop, or false if it didn't.

For all other events, the return value is ignored.

onDrawForeground

Added in API level 23
open fun onDrawForeground(canvas: Canvas!): Unit

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.

Parameters
canvas Canvas!: canvas to draw into

onFilterTouchEventForSecurity

Added in API level 9
open fun onFilterTouchEventForSecurity(event: MotionEvent!): Boolean

Filter the touch event to apply security policies.

Parameters
event MotionEvent!: The motion event to be filtered.
Return
Boolean True if the event should be dispatched, false if the event should be dropped.

onFinishTemporaryDetach

Added in API level 3
open fun onFinishTemporaryDetach(): Unit

Called after onStartTemporaryDetach when the container is done changing the view.

onGenericMotionEvent

Added in API level 12
open fun onGenericMotionEvent(event: MotionEvent!): Boolean

Implement this method to handle generic motion events.

Generic motion events describe joystick movements, mouse hovers, track pad touches, scroll wheel movements and other input events. The MotionEvent#getSource() 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 mouse hover movement...
                  return true;
              case MotionEvent.ACTION_SCROLL:
                  // process the scroll wheel movement...
                  return true;
          }
      }
      return super.onGenericMotionEvent(event);
  }
Parameters
event MotionEvent!: The generic motion event being processed.
Return
Boolean True if the event was handled, false otherwise.

onHoverChanged

Added in API level 14
open fun onHoverChanged(hovered: Boolean): Unit

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.

Parameters
hovered Boolean: The current hover state, as returned by isHovered.

onHoverEvent

Added in API level 14
open fun onHoverEvent(event: MotionEvent!): Boolean

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.

Parameters
event MotionEvent!: The motion event that describes the hover.
Return
Boolean True if the view handled the hover event.

onInitializeAccessibilityEvent

Added in API level 14
open fun onInitializeAccessibilityEvent(event: AccessibilityEvent!): Unit

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.
Parameters
event AccessibilityEvent!: The event to initialize.

onKeyDown

Added in API level 1
open fun onKeyDown(
    keyCode: Int,
    event: KeyEvent!
): Boolean

Default implementation of KeyEvent.Callback#onKeyDown(int, KeyEvent): 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.

Parameters
keyCode Int: a key code that represents the button pressed, from android.view.KeyEvent
event KeyEvent!: the KeyEvent object that defines the button action
Return
Boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyLongPress

Added in API level 5
open fun onKeyLongPress(
    keyCode: Int,
    event: KeyEvent!
): Boolean

Default implementation of KeyEvent.Callback#onKeyLongPress(int, KeyEvent): 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.

Parameters
keyCode Int: The value in event.getKeyCode().
event KeyEvent!: Description of the key event.
Return
Boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyMultiple

Added in API level 1
open fun onKeyMultiple(
    keyCode: Int,
    repeatCount: Int,
    event: KeyEvent!
): Boolean

Default implementation of KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent): 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.

Parameters
keyCode Int: A key code that represents the button pressed, from android.view.KeyEvent.
count Number of pairs as returned by event.getRepeatCount().
event KeyEvent!: The KeyEvent object that defines the button action.
repeatCount Int: The number of times the action was made.
Return
Boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyPreIme

Added in API level 3
open fun onKeyPreIme(
    keyCode: Int,
    event: KeyEvent!
): Boolean

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.

Parameters
keyCode Int: The value in event.getKeyCode().
event KeyEvent!: Description of the key event.
Return
Boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyShortcut

Added in API level 1
open fun onKeyShortcut(
    keyCode: Int,
    event: KeyEvent!
): Boolean

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 MenuItem#setShortcut(char, char) property of menu items.

Parameters
keyCode Int: The value in event.getKeyCode().
event KeyEvent!: Description of the key event.
Return
Boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyUp

Added in API level 1
open fun onKeyUp(
    keyCode: Int,
    event: KeyEvent!
): Boolean

Default implementation of KeyEvent.Callback#onKeyUp(int, KeyEvent): 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.

Parameters
keyCode Int: A key code that represents the button pressed, from android.view.KeyEvent.
event KeyEvent!: The KeyEvent object that defines the button action.
Return
Boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onPointerCaptureChange

Added in API level 26
open fun onPointerCaptureChange(hasCapture: Boolean): Unit

Called when the window has just acquired or lost pointer capture.
If you override this method you must call through to the superclass implementation.

Parameters
hasCapture Boolean: True if the view now has pointerCapture, false otherwise.

onPopulateAccessibilityEvent

Added in API level 14
open fun onPopulateAccessibilityEvent(event: AccessibilityEvent!): Unit

Called from dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent) giving a chance to this View to populate the accessibility event with its text content. While this method is free to modify event attributes other than text content, doing so should normally be performed in onInitializeAccessibilityEvent(android.view.accessibility.AccessibilityEvent).

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.
Parameters
event AccessibilityEvent!: The accessibility event which to populate.

onProvideAutofillStructure

Added in API level 26
open fun onProvideAutofillStructure(
    structure: ViewStructure!,
    flags: Int
): Unit

Populates a ViewStructure to fullfil an autofill request.

The structure should contain at least the following properties:

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:

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:

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.

Parameters
structure ViewStructure!: fill in with structured view data for autofill purposes.
flags Int: optional flags. Value is either 0 or android.view.View#AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS

onProvideAutofillVirtualStructure

Added in API level 26
open fun onProvideAutofillVirtualStructure(
    structure: ViewStructure!,
    flags: Int
): Unit

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:

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.

Parameters
structure ViewStructure!: fill in with virtual children data for autofill purposes.
flags Int: optional flags.

onProvideContentCaptureStructure

Added in API level 30
open fun onProvideContentCaptureStructure(
    structure: ViewStructure,
    flags: Int
): Unit

Populates a ViewStructure for content capture.

This method is called after a view is that is eligible for content capture (for example, if it isImportantForAutofill(), an intelligence service is enabled for the user, and the activity rendering the view is enabled for content capture) is laid out and is visible.

The populated structure is then passed to the service through ContentCaptureSession#notifyViewAppeared(ViewStructure).

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 the 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:

Note: the following methods of the structure will be ignored:

Parameters
structure ViewStructure: This value cannot be null.

onProvideStructure

Added in API level 23
open fun onProvideStructure(structure: ViewStructure!): Unit

Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData.

Parameters
structure ViewStructure!: Fill in with structured view data. The default implementation fills in all data that can be inferred from the view itself.

onProvideVirtualStructure

Added in API level 23
open fun onProvideVirtualStructure(structure: ViewStructure!): Unit

Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData to generate additional virtual structure under this view. The defaullt 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.

onResolvePointerIcon

Added in API level 24
open fun onResolvePointerIcon(
    event: MotionEvent!,
    pointerIndex: Int
): PointerIcon!

Returns the pointer icon for the motion event, or null if it doesn't specify the icon. The default implementation does not care the location or event types, but some subclasses may use it (such as WebViews).

Parameters
event MotionEvent!: The MotionEvent from a mouse
pointerIndex Int: The index of the pointer for which to retrieve the PointerIcon. This will be between 0 and MotionEvent#getPointerCount().

onRtlPropertiesChanged

Added in API level 17
open fun onRtlPropertiesChanged(layoutDirection: Int): Unit

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.

Parameters
layoutDirection Int: the direction of the layout Value is android.view.View#LAYOUT_DIRECTION_LTR, or android.view.View#LAYOUT_DIRECTION_RTL

onScreenStateChanged

Added in API level 16
open fun onScreenStateChanged(screenState: Int): Unit

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.)

Parameters
screenState Int: The new state of the screen. Can be either SCREEN_STATE_ON or SCREEN_STATE_OFF

onStartTemporaryDetach

Added in API level 3
open fun onStartTemporaryDetach(): Unit

This is called when a container is going to temporarily detach a child, with ViewGroup#detachViewFromParent(View). It will either be followed by onFinishTemporaryDetach() or onDetachedFromWindow() when the container is done.

onTouchEvent

Added in API level 1
open fun onTouchEvent(event: MotionEvent!): Boolean

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:

Parameters
event MotionEvent!: The motion event.
Return
Boolean True if the event was handled, false otherwise.

onTrackballEvent

Added in API level 1
open fun onTrackballEvent(event: MotionEvent!): Boolean

Implement this method to handle trackball motion events. The relative movement of the trackball since the last event can be retrieve with MotionEvent#getX and 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).

Parameters
event MotionEvent!: The motion event.
Return
Boolean True if the event was handled, false otherwise.

onVisibilityAggregated

Added in API level 24
open fun onVisibilityAggregated(isVisible: Boolean): Unit

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.

Parameters
isVisible Boolean: true if this view and all of its ancestors are VISIBLE and this view's window is also visible

onWindowFocusChanged

Added in API level 1
open fun onWindowFocusChanged(hasWindowFocus: Boolean): Unit

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.

Parameters
hasWindowFocus Boolean: True if the window containing this view now has focus, false otherwise.

onWindowSystemUiVisibilityChanged

Added in API level 16
Deprecated in API level 30
open fun onWindowSystemUiVisibilityChanged(visible: Int): Unit

Deprecated: SystemUiVisibility flags are deprecated. Use WindowInsetsController instead.

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.

performAccessibilityAction

Added in API level 16
open fun performAccessibilityAction(
    action: Int,
    arguments: Bundle!
): Boolean

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.

Parameters
action Int: The action to perform.
arguments Bundle!: Optional action arguments.
Return
Boolean Whether the action was performed.

performClick

Added in API level 1
open fun performClick(): Boolean

Call this view's OnClickListener, if it is defined. Performs all normal actions associated with clicking: reporting accessibility event, playing a sound, etc.

Return
Boolean True there was an assigned OnClickListener that was called, false otherwise is returned.

performContextClick

Added in API level 24
open fun performContextClick(
    x: Float,
    y: Float
): Boolean

Call this view's OnContextClickListener, if it is defined.

Parameters
x Float: the x coordinate of the context click
y Float: the y coordinate of the context click
Return
Boolean True if there was an assigned OnContextClickListener that consumed the event, false otherwise.

performContextClick

Added in API level 23
open fun performContextClick(): Boolean

Call this view's OnContextClickListener, if it is defined.

Return
Boolean True if there was an assigned OnContextClickListener that consumed the event, false otherwise.

performHapticFeedback

Added in API level 3
open fun performHapticFeedback(feedbackConstant: Int): Boolean

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.

Parameters
feedbackConstant Int: One of the constants defined in HapticFeedbackConstants

performHapticFeedback

Added in API level 3
open fun performHapticFeedback(
    feedbackConstant: Int,
    flags: Int
): Boolean

BZZZTT!!1!

Like performHapticFeedback(int), with additional options.

Parameters
feedbackConstant Int: One of the constants defined in HapticFeedbackConstants
flags Int: Additional flags as per HapticFeedbackConstants.

performLongClick

Added in API level 1
open fun performLongClick(): Boolean

Calls this view's OnLongClickListener, if it is defined. Invokes the context menu if the OnLongClickListener did not consume the event.

Return
Boolean true if one of the above receivers consumed the event, false otherwise

performLongClick

Added in API level 24
open fun performLongClick(
    x: Float,
    y: Float
): Boolean

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.

Parameters
x Float: x coordinate of the anchoring touch event, or Float#NaN to disable anchoring
y Float: y coordinate of the anchoring touch event, or Float#NaN to disable anchoring
Return
Boolean true if one of the above receivers consumed the event, false otherwise

playSoundEffect

Added in API level 1
open fun playSoundEffect(soundConstant: Int): Unit

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.

Parameters
soundConstant Int: One of the constants defined in SoundEffectConstants

post

Added in API level 1
open fun post(action: Runnable!): Boolean

Causes the Runnable to be added to the message queue. The runnable will be run on the user interface thread.

Parameters
action Runnable!: The Runnable that will be executed.
Return
Boolean Returns true if the Runnable was successfully placed in to the message queue. Returns false on failure, usually because the looper processing the message queue is exiting.

postDelayed

Added in API level 1
open fun postDelayed(
    action: Runnable!,
    delayMillis: Long
): Boolean

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.

Parameters
action Runnable!: The Runnable that will be executed.
delayMillis Long: The delay (in milliseconds) until the Runnable will be executed.
Return
Boolean true if the Runnable was successfully placed in to the message queue. Returns false on failure, usually because the looper processing the message queue is exiting. Note that a result of true does not mean the Runnable will be processed -- if the looper is quit before the delivery time of the message occurs then the message will be dropped.

postInvalidate

Added in API level 1
open fun postInvalidate(): Unit

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.

postInvalidate

Added in API level 1
open fun postInvalidate(
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Unit

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.

Parameters
left Int: The left coordinate of the rectangle to invalidate.
top Int: The top coordinate of the rectangle to invalidate.
right Int: The right coordinate of the rectangle to invalidate.
bottom Int: The bottom coordinate of the rectangle to invalidate.

postInvalidateDelayed

Added in API level 1
open fun postInvalidateDelayed(delayMilliseconds: Long): Unit

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.

Parameters
delayMilliseconds Long: the duration in milliseconds to delay the invalidation by

postInvalidateDelayed

Added in API level 1
open fun postInvalidateDelayed(
    delayMilliseconds: Long,
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Unit

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.

Parameters
delayMilliseconds Long: the duration in milliseconds to delay the invalidation by
left Int: The left coordinate of the rectangle to invalidate.
top Int: The top coordinate of the rectangle to invalidate.
right Int: The right coordinate of the rectangle to invalidate.
bottom Int: The bottom coordinate of the rectangle to invalidate.

postInvalidateOnAnimation

Added in API level 16
open fun postInvalidateOnAnimation(): Unit

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.

See Also

postInvalidateOnAnimation

Added in API level 16
open fun postInvalidateOnAnimation(
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Unit

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.

Parameters
left Int: The left coordinate of the rectangle to invalidate.
top Int: The top coordinate of the rectangle to invalidate.
right Int: The right coordinate of the rectangle to invalidate.
bottom Int: The bottom coordinate of the rectangle to invalidate.

postOnAnimation

Added in API level 16
open fun postOnAnimation(action: Runnable!): Unit

Causes the Runnable to execute on the next animation time step. The runnable will be run on the user interface thread.

Parameters
action Runnable!: The Runnable that will be executed.

postOnAnimationDelayed

Added in API level 16
open fun postOnAnimationDelayed(
    action: Runnable!,
    delayMillis: Long
): Unit

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.

Parameters
action Runnable!: The Runnable that will be executed.
delayMillis Long: The delay (in milliseconds) until the Runnable will be executed.

refreshDrawableState

Added in API level 1
open fun refreshDrawableState(): Unit

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.

releasePointerCapture

Added in API level 26
open fun releasePointerCapture(): Unit

Releases the pointer capture.

If the window does not have pointer capture, this call will do nothing.

removeCallbacks

Added in API level 1
open fun removeCallbacks(action: Runnable!): Boolean

Removes the specified Runnable from the message queue.

Parameters
action Runnable!: The Runnable to remove from the message handling queue
Return
Boolean true if this view could ask the Handler to remove the Runnable, false otherwise. When the returned value is true, the Runnable may or may not have been actually removed from the message queue (for instance, if the Runnable was not in the queue already.)

removeOnAttachStateChangeListener

Added in API level 12
open fun removeOnAttachStateChangeListener(listener: View.OnAttachStateChangeListener!): Unit

Remove a listener for attach state changes. The listener will receive no further notification of window attach/detach events.

Parameters
listener View.OnAttachStateChangeListener!: Listener to remove

removeOnLayoutChangeListener

Added in API level 11
open fun removeOnLayoutChangeListener(listener: View.OnLayoutChangeListener!): Unit

Remove a listener for layout changes.

Parameters
listener View.OnLayoutChangeListener!: The listener for layout bounds change.

removeOnUnhandledKeyEventListener

Added in API level 28
open fun removeOnUnhandledKeyEventListener(listener: View.OnUnhandledKeyEventListener!): Unit

Removes a listener which will receive unhandled KeyEvents. This must be called on the UI thread.

Parameters
listener View.OnUnhandledKeyEventListener!: a receiver of unhandled KeyEvents.

requestApplyInsets

Added in API level 20
open fun requestApplyInsets(): Unit

Ask that a new dispatch of onApplyWindowInsets(android.view.WindowInsets) be performed.

requestFitSystemWindows

Added in API level 16
Deprecated in API level 20
open fun requestFitSystemWindows(): Unit

Deprecated: Use requestApplyInsets() for newer platform versions.

Ask that a new dispatch of fitSystemWindows(android.graphics.Rect) be performed.

requestFocus

Added in API level 1
fun requestFocus(): Boolean

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.

Return
Boolean Whether this view or one of its descendants actually took focus.

requestFocus

Added in API level 1
fun requestFocus(direction: Int): Boolean

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.

Parameters
direction Int: One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
Return
Boolean Whether this view or one of its descendants actually took focus.

requestFocus

Added in API level 1
open fun requestFocus(
    direction: Int,
    previouslyFocusedRect: Rect!
): Boolean

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.

Parameters
direction Int: One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
previouslyFocusedRect Rect!: The rectangle (in this View's coordinate system) to give a finer grained hint about where focus is coming from. May be null if there is no hint.
Return
Boolean Whether this view or one of its descendants actually took focus.

requestFocusFromTouch

Added in API level 1
fun requestFocusFromTouch(): Boolean

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.

Return
Boolean Whether this view or one of its descendants actually took focus.

See Also

requestLayout

Added in API level 1
open fun requestLayout(): Unit

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.

requestPointerCapture

Added in API level 26
open fun requestPointerCapture(): Unit

Requests pointer capture mode.

When the window has pointer capture, the mouse pointer icon will disappear and will not change its position. Further mouse will be dispatched with the source InputDevice#SOURCE_MOUSE_RELATIVE, and relative position changes will be available through MotionEvent#getX and MotionEvent#getY. Non-mouse events (touchscreens, or stylus) will not be affected.

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.

requestRectangleOnScreen

Added in API level 1
open fun requestRectangleOnScreen(rectangle: Rect!): 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.

Parameters
rectangle Rect!: The rectangle in the View's content coordinate space
Return
Boolean Whether any parent scrolled.

requestRectangleOnScreen

Added in API level 1
open fun requestRectangleOnScreen(
    rectangle: Rect!,
    immediate: Boolean
): 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.

Parameters
rectangle Rect!: The rectangle in the View's content coordinate space
immediate Boolean: True to forbid animated scrolling, false otherwise
Return
Boolean Whether any parent scrolled.

requestUnbufferedDispatch

Added in API level 21
fun requestUnbufferedDispatch(event: MotionEvent!): Unit

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),

requestUnbufferedDispatch

Added in API level 30
fun requestUnbufferedDispatch(source: Int): Unit

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.

Parameters
source Int: The combined input source class to request unbuffered dispatch for. All events coming from these source classes will not be buffered. Set to InputDevice#SOURCE_CLASS_NONE in order to return to default behaviour. Value is either 0 or a combination of android.view.InputDevice#SOURCE_CLASS_NONE, android.view.InputDevice#SOURCE_CLASS_BUTTON, android.view.InputDevice#SOURCE_CLASS_POINTER, android.view.InputDevice#SOURCE_CLASS_POINTER, android.view.InputDevice#SOURCE_CLASS_TRACKBALL, android.view.InputDevice#SOURCE_CLASS_POSITION, and android.view.InputDevice#SOURCE_CLASS_JOYSTICK

requireViewById

Added in API level 28
fun <T : View!> requireViewById(id: Int): T

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.

Parameters
id Int: the ID to search for
Return
T a view with given ID This value cannot be null.

resetPivot

Added in API level 28
open fun resetPivot(): Unit

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.

resolveSize

Added in API level 1
open static fun resolveSize(
    size: Int,
    measureSpec: Int
): Int

Version of resolveSizeAndState(int,int,int) returning only the MEASURED_SIZE_MASK bits of the result.

resolveSizeAndState

Added in API level 11
open static fun resolveSizeAndState(
    size: Int,
    measureSpec: Int,
    childMeasuredState: Int
): 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.

Parameters
size Int: How big the view wants to be.
measureSpec Int: Constraints imposed by the parent.
childMeasuredState Int: Size information bit mask for the view's children.
Return
Int Size information bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.

restoreDefaultFocus

Added in API level 26
open fun restoreDefaultFocus(): Boolean

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).

Return
Boolean Whether this view or one of its descendants actually took focus

restoreHierarchyState

Added in API level 1
open fun restoreHierarchyState(container: SparseArray<Parcelable!>!): Unit

Restore this view hierarchy's frozen state from the given container.

Parameters
container SparseArray<Parcelable!>!: The SparseArray which holds previously frozen states.

saveAttributeDataForStyleable

Added in API level 29
fun saveAttributeDataForStyleable(
    context: Context,
    styleable: IntArray,
    attrs: AttributeSet?,
    t: TypedArray,
    defStyleAttr: Int,
    defStyleRes: Int
): Unit

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.

Parameters
context Context: Context under which this view is created. This value cannot be null.
styleable IntArray: A reference to styleable array R.styleable.Foo This value cannot be null.
attrs AttributeSet?: AttributeSet used to construct this view. This value may be null.
t TypedArray: Resolved TypedArray returned by a call to Resources#obtainAttributes(AttributeSet, int[]). This value cannot be null.
defStyleAttr Int: Default style attribute passed into the view constructor.
defStyleRes Int: Default style resource passed into the view constructor.

saveHierarchyState

Added in API level 1
open fun saveHierarchyState(container: SparseArray<Parcelable!>!): Unit

Store this view hierarchy's frozen state into the given container.

Parameters
container SparseArray<Parcelable!>!: The SparseArray in which to save the view's state.

scheduleDrawable

Added in API level 1
open fun scheduleDrawable(
    who: Drawable,
    what: Runnable,
    when: Long
): Unit

Schedules an action on a drawable to occur at a specified time.

Parameters
who Drawable: the recipient of the action This value cannot be null.
what Runnable: the action to run on the drawable This value cannot be null.
when Long: the time at which the action must occur. Uses the SystemClock#uptimeMillis timebase.

scrollBy

Added in API level 1
open fun scrollBy(
    x: Int,
    y: Int
): Unit

Move the scrolled position of your view. This will cause a call to onScrollChanged(int,int,int,int) and the view will be invalidated.

Parameters
x Int: the amount of pixels to scroll by horizontally
y Int: the amount of pixels to scroll by vertically

scrollTo

Added in API level 1
open fun scrollTo(
    x: Int,
    y: Int
): Unit

Set the scrolled position of your view. This will cause a call to onScrollChanged(int,int,int,int) and the view will be invalidated.

Parameters
x Int: the x position to scroll to
y Int: the y position to scroll to

sendAccessibilityEvent

Added in API level 4
open fun sendAccessibilityEvent(eventType: Int): Unit

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, 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.

Parameters
eventType Int: The type of the event to send, as defined by several types from android.view.accessibility.AccessibilityEvent, such as android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED or android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER.

sendAccessibilityEventUnchecked

Added in API level 4
open fun sendAccessibilityEventUnchecked(event: AccessibilityEvent!): Unit

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.

Parameters
event AccessibilityEvent!: The event to send.

setAccessibilityDelegate

Added in API level 14
open fun setAccessibilityDelegate(delegate: View.AccessibilityDelegate?): Unit

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.

Parameters
delegate View.AccessibilityDelegate?: the object to which accessibility method calls should be delegated This value may be null.

setAccessibilityHeading

Added in API level 28
open fun setAccessibilityHeading(isHeading: Boolean): Unit

Set if view is a heading for a section of content for accessibility purposes.

Parameters
isHeading Boolean: true if the view is a heading, false otherwise.

setAccessibilityLiveRegion

Added in API level 19
open fun setAccessibilityLiveRegion(mode: Int): Unit

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).

For example, in a login screen with a TextView that displays an "incorrect password" notification, that view should be marked as a live region with mode ACCESSIBILITY_LIVE_REGION_POLITE.

To disable change notifications for this view, use ACCESSIBILITY_LIVE_REGION_NONE. This is the default live region mode for most views.

To indicate that the user should be notified of changes, use ACCESSIBILITY_LIVE_REGION_POLITE.

If the view's changes should interrupt ongoing speech and notify the user immediately, use ACCESSIBILITY_LIVE_REGION_ASSERTIVE.

Parameters
mode Int: The live region mode for this view, one of:

setAccessibilityPaneTitle

Added in API level 28
open fun setAccessibilityPaneTitle(accessibilityPaneTitle: CharSequence?): Unit

Visually distinct portion of a window with window-like semantics are considered panes for accessibility purposes. One example is the content view of a 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 AccessibilityEvents when they appear, disappear, or change title.

Parameters
accessibilityPaneTitle CharSequence?: The pane's title. Setting to null indicates that this View is not a pane. {@see AccessibilityNodeInfo#setPaneTitle(CharSequence)} This value may be null.

setAccessibilityTraversalAfter

Added in API level 22
open fun setAccessibilityTraversalAfter(afterId: Int): Unit

Sets the id of a view after which this one is visited in accessibility traversal. A screen-reader must visit the content of the other view before the content of this one. For example, if view B is set to be after view A, then a screen-reader will traverse the entire content of A before traversing the entire content of B, regardles of what traversal strategy it is using.

Views that do not have specified before/after relationships are traversed in order determined by the screen-reader.

Setting that this view is after a view that is not important for accessibility or if this view is not important for accessibility will have no effect as the screen-reader is not aware of unimportant views.

Parameters
afterId Int: The id of a view this one succedees in accessibility traversal.

setAccessibilityTraversalBefore

Added in API level 22
open fun setAccessibilityTraversalBefore(beforeId: Int): Unit

Sets the id of a view before which this one is visited in accessibility traversal. A screen-reader must visit the content of this view before the content of the one it precedes. For example, if view B is set to be before view A, then a screen-reader will traverse the entire content of B before traversing the entire content of A, regardles of what traversal strategy it is using.

Views that do not have specified before/after relationships are traversed in order determined by the screen-reader.

Setting that this view is before a view that is not important for accessibility or if this view is not important for accessibility will have no effect as the screen-reader is not aware of unimportant views.

Parameters
beforeId Int: The id of a view this one precedes in accessibility traversal.

setActivated

Added in API level 11
open fun setActivated(activated: Boolean): Unit

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.

Parameters
activated Boolean: true if the view must be activated, false otherwise

setAlpha

Added in API level 11
open fun setAlpha(alpha: Float): Unit

Sets the opacity of the view to a value from 0 to 1, where 0 means the view is completely transparent and 1 means the view is completely opaque.

Note: setting alpha to a translucent value (0 < alpha < 1) can have significant performance implications, especially for large views. It is best to use the alpha property sparingly and transiently, as in the case of fading animations.

For a view with a frequently changing alpha, such as during a fading animation, it is strongly recommended for performance reasons to either override hasOverlappingRendering() to return false if appropriate, or setting a layer type on the view for the duration of the animation. On versions android.os.Build.VERSION_CODES#M and below, the default path for rendering an unlayered View with alpha could add multiple milliseconds of rendering cost, even for simple or small views. Starting with android.os.Build.VERSION_CODES#M, LAYER_TYPE_HARDWARE is automatically applied to the view at the rendering level.

If this view overrides onSetAlpha(int) to return true, then this view is responsible for applying the opacity itself.

On versions android.os.Build.VERSION_CODES#LOLLIPOP_MR1 and below, note that if the view is backed by a layer and is associated with a layer paint, setting an alpha value less than 1.0 will supersede the alpha of the layer paint.

Starting with android.os.Build.VERSION_CODES#M, setting a translucent alpha value will clip a View to its bounds, unless the View returns false from hasOverlappingRendering.

Parameters
alpha Float: The opacity of the view. Value is between 0.0 and 1.0 inclusive

setAnimation

Added in API level 1
open fun setAnimation(animation: Animation!): Unit

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.

Parameters
animation Animation!: The next animation, or null.

setAnimationMatrix

Added in API level 29
open fun setAnimationMatrix(matrix: Matrix?): Unit

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.

Parameters
matrix Matrix?: The matrix, null indicates that the matrix should be cleared. This value may be null.

setAutofillHints

Added in API level 26
open fun setAutofillHints(vararg autofillHints: String!): Unit

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.

Parameters
autofillHints String!: The autofill hints to set. If the array is emtpy, null is set. This value may be null.

setAutofillId

Added in API level 28
open fun setAutofillId(id: AutofillId?): Unit

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);
  
Parameters
id AutofillId?: an autofill ID that is unique in the android.app.Activity hosting the view, or null to reset it. Usually it's an id previously allocated to another view (and obtained through getAutofillId()), or a new value obtained through AutofillManager#getNextAutofillId(). This value may be null.
Exceptions
java.lang.IllegalStateException if the view is already attached to.
java.lang.IllegalArgumentException if the id is an autofill id associated with a virtual view.

setBackground

Added in API level 16
open fun setBackground(background: Drawable!): Unit

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).

Parameters
background Drawable!: The Drawable to use as the background, or null to remove the background

setBackgroundColor

Added in API level 1
open fun setBackgroundColor(color: Int): Unit

Sets the background color for this view.

Parameters
color Int: the color of the background

setBackgroundDrawable

Added in API level 1
Deprecated in API level 16
open fun setBackgroundDrawable(background: Drawable!): Unit

Deprecated: use setBackground(android.graphics.drawable.Drawable) instead

setBackgroundResource

Added in API level 1
open fun setBackgroundResource(resid: Int): Unit

Set the background to a given resource. The resource should refer to a Drawable object or 0 to remove the background.

Parameters
resid Int: The identifier of the resource.

setBackgroundTintBlendMode

Added in API level 29
open fun setBackgroundTintBlendMode(blendMode: BlendMode?): Unit

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.

Parameters
blendMode BlendMode?: the blending mode used to apply the tint, may be null to clear tint This value may be null.

setBackgroundTintList

Added in API level 21
open fun setBackgroundTintList(tint: ColorStateList?): Unit

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).

Parameters
tint ColorStateList?: the tint to apply, may be null to clear tint This value may be null.

setBackgroundTintMode

Added in API level 21
open fun setBackgroundTintMode(tintMode: PorterDuff.Mode?): Unit

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.

Parameters
tintMode PorterDuff.Mode?: the blending mode used to apply the tint, may be null to clear tint This value may be null.

setBottom

Added in API level 11
fun setBottom(bottom: Int): Unit

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.

Parameters
bottom Int: The bottom of this view, in pixels.

setCameraDistance

Added in API level 12
open fun setCameraDistance(distance: Float): Unit

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.

Parameters
distance Float: The distance in "depth pixels", if negative the opposite value is used

setClickable

Added in API level 1
open fun setClickable(clickable: Boolean): Unit

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.

Parameters
clickable Boolean: true to make the view clickable, false otherwise

See Also

setClipBounds

Added in API level 18
open fun setClipBounds(clipBounds: Rect!): Unit

Sets a rectangular area on this view to which the view will be clipped when it is drawn. Setting the value to null will remove the clip bounds and the view will draw normally, using its full bounds.

Parameters
clipBounds Rect!: The rectangular area, in the local coordinates of this view, to which future drawing operations will be clipped.

setClipToOutline

Added in API level 21
open fun setClipToOutline(clipToOutline: Boolean): Unit

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 ViewAnimationUtils#createCircularReveal(View, int, int, float, float) 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().

setContentCaptureSession

Added in API level 29
open fun setContentCaptureSession(contentCaptureSession: ContentCaptureSession?): Unit

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);
  
Parameters
contentCaptureSession ContentCaptureSession?: a session created by ContentCaptureSession#createContentCaptureSession(. This value may be null.

setContentDescription

Added in API level 4
open fun setContentDescription(contentDescription: CharSequence!): Unit

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".

Parameters
contentDescription CharSequence!: The content description.

setContextClickable

Added in API level 23
open fun setContextClickable(contextClickable: Boolean): Unit

Enables or disables context clicking for this view. This event can launch the listener.

Parameters
contextClickable Boolean: true to make the view react to a context click, false otherwise

setDefaultFocusHighlightEnabled

Added in API level 26
open fun setDefaultFocusHighlightEnabled(defaultFocusHighlightEnabled: Boolean): Unit

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.

Parameters
defaultFocusHighlightEnabled Boolean: true to set this view to use a default focus highlight, false otherwise.

setDrawingCacheBackgroundColor

Added in API level 1
Deprecated in API level 28
open fun setDrawingCacheBackgroundColor(color: Int): Unit

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

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.

Parameters
color Int: The background color to use for the drawing cache's bitmap

setDrawingCacheEnabled

Added in API level 1
Deprecated in API level 28
open fun setDrawingCacheEnabled(enabled: Boolean): Unit

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

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().

Parameters
enabled Boolean: true to enable the drawing cache, false otherwise

setDrawingCacheQuality

Added in API level 1
Deprecated in API level 28
open fun setDrawingCacheQuality(quality: Int): Unit

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Set the drawing cache quality of this view. This value is used only when the drawing cache is enabled

Parameters
quality Int: One of DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, or DRAWING_CACHE_QUALITY_HIGH Value is android.view.View#DRAWING_CACHE_QUALITY_LOW, android.view.View#DRAWING_CACHE_QUALITY_HIGH, or android.view.View#DRAWING_CACHE_QUALITY_AUTO

setDuplicateParentStateEnabled

Added in API level 1
open fun setDuplicateParentStateEnabled(enabled: Boolean): Unit

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.

Parameters
enabled Boolean: True to enable duplication of the parent's drawable state, false to disable it.

setElevation

Added in API level 21
open fun setElevation(elevation: Float): Unit

Sets the base elevation of this view, in pixels.

setEnabled

Added in API level 1
open fun setEnabled(enabled: Boolean): Unit

Set the enabled state of this view. The interpretation of the enabled state varies by subclass.

Parameters
enabled Boolean: True if this view is enabled, false otherwise.

setFadingEdgeLength

Added in API level 1
open fun setFadingEdgeLength(length: Int): Unit

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.

Parameters
length Int: The size in pixels of the faded edge used to indicate that more content in this view is visible.

setFilterTouchesWhenObscured

Added in API level 9
open fun setFilterTouchesWhenObscured(enabled: Boolean): Unit

Sets whether the framework should discard touches when the view's window is obscured by another visible window. Refer to the View security documentation for more details.

Parameters
enabled Boolean: True if touch filtering should be enabled.

setFitsSystemWindows

Added in API level 14
open fun setFitsSystemWindows(fitSystemWindows: Boolean): Unit

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.

Parameters
fitSystemWindows Boolean: If true, then the default implementation of fitSystemWindows(android.graphics.Rect) will be executed.

setFocusable

Added in API level 1
open fun setFocusable(focusable: Boolean): Unit

Set whether this view can receive the focus.

Setting this to false will also ensure that this view is not focusable in touch mode.

Parameters
focusable Boolean: If true, this view can receive the focus.

setFocusable

Added in API level 26
open fun setFocusable(focusable: Int): Unit

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.

Parameters
focusable Int: One of NOT_FOCUSABLE, FOCUSABLE, or FOCUSABLE_AUTO. Value is android.view.View#NOT_FOCUSABLE, android.view.View#FOCUSABLE, or android.view.View#FOCUSABLE_AUTO

setFocusableInTouchMode

Added in API level 1
open fun setFocusableInTouchMode(focusableInTouchMode: Boolean): Unit

Set whether this view can receive focus while in touch mode. Setting this to true will also ensure that this view is focusable.

Parameters
focusableInTouchMode Boolean: If true, this view can receive the focus while in touch mode.

setFocusedByDefault

Added in API level 26
open fun setFocusedByDefault(isFocusedByDefault: Boolean): Unit

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.

Parameters
isFocusedByDefault Boolean: true to set this view as the default-focus view, false otherwise.

setForceDarkAllowed

Added in API level 29
open fun setForceDarkAllowed(allow: Boolean): Unit

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.

Parameters
allow Boolean: Whether or not to allow force dark.

setForeground

Added in API level 23
open fun setForeground(foreground: Drawable!): Unit

Supply a Drawable that is to be rendered on top of all of the content in the view.

Parameters
foreground Drawable!: the Drawable to be drawn on top of the children

setForegroundGravity

Added in API level 23
open fun setForegroundGravity(gravity: Int): Unit

Describes how the foreground is positioned. Defaults to START and TOP.

Parameters
gravity Int: see android.view.Gravity

setForegroundTintBlendMode

Added in API level 29
open fun setForegroundTintBlendMode(blendMode: BlendMode?): Unit

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.

Parameters
blendMode BlendMode?: the blending mode used to apply the tint, may be null to clear tint This value may be null.

setForegroundTintList

Added in API level 23
open fun setForegroundTintList(tint: ColorStateList?): Unit

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).

Parameters
tint ColorStateList?: the tint to apply, may be null to clear tint This value may be null.

setForegroundTintMode

Added in API level 23
open fun setForegroundTintMode(tintMode: PorterDuff.Mode?): Unit

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.

Parameters
tintMode PorterDuff.Mode?: the blending mode used to apply the tint, may be null to clear tint This value may be null.

setHapticFeedbackEnabled

Added in API level 3
open fun setHapticFeedbackEnabled(hapticFeedbackEnabled: Boolean): Unit

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.

Parameters
hapticFeedbackEnabled Boolean: whether haptic feedback enabled for this view.

setHasTransientState

Added in API level 16
open fun setHasTransientState(hasTransientState: Boolean): Unit

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.

Parameters
hasTransientState Boolean: true if this view has transient state

setHorizontalFadingEdgeEnabled

Added in API level 1
open fun setHorizontalFadingEdgeEnabled(horizontalFadingEdgeEnabled: Boolean): Unit

Define whether the horizontal edges should be faded when this view is scrolled horizontally.

Parameters
horizontalFadingEdgeEnabled Boolean: true if the horizontal edges should be faded when the view is scrolled horizontally

setHorizontalScrollBarEnabled

Added in API level 1
open fun setHorizontalScrollBarEnabled(horizontalScrollBarEnabled: Boolean): Unit

Define whether the horizontal scrollbar should be drawn or not. The scrollbar is not drawn by default.

Parameters
horizontalScrollBarEnabled Boolean: true if the horizontal scrollbar should be painted

setHorizontalScrollbarThumbDrawable

Added in API level 29
open fun setHorizontalScrollbarThumbDrawable(drawable: Drawable?): Unit

Defines the horizontal thumb drawable

Parameters
drawable Drawable?: This value may be null.

setHorizontalScrollbarTrackDrawable

Added in API level 29
open fun setHorizontalScrollbarTrackDrawable(drawable: Drawable?): Unit

Defines the horizontal track drawable

Parameters
drawable Drawable?: This value may be null.

setHovered

Added in API level 14
open fun setHovered(hovered: Boolean): Unit

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.

Parameters
hovered Boolean: True if the view is hovered.

setId

Added in API level 1
open fun setId(id: Int): Unit

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.

Parameters
id Int: a number used to identify the view

setImportantForAccessibility

Added in API level 16
open fun setImportantForAccessibility(mode: Int): Unit

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.

Parameters
mode Int: How to determine whether this view is important for accessibility.

setImportantForAutofill

Added in API level 26
open fun setImportantForAutofill(mode: Int): Unit

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:

  1. 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.
  2. 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.
  3. 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 be always be considered not important; for example, when the user explicitly makes an autofill request, all views are considered important. See isImportantForAutofill() for more details about how the View's importance for autofill is used.

Parameters
mode Int: IMPORTANT_FOR_AUTOFILL_AUTO, IMPORTANT_FOR_AUTOFILL_YES, IMPORTANT_FOR_AUTOFILL_NO, IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, or IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS. Value is android.view.View#IMPORTANT_FOR_AUTOFILL_AUTO, android.view.View#IMPORTANT_FOR_AUTOFILL_YES, android.view.View#IMPORTANT_FOR_AUTOFILL_NO, android.view.View#IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, or android.view.View#IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS

setImportantForContentCapture

Added in API level 30
open fun setImportantForContentCapture(mode: Int): Unit

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.

Parameters
mode Int: IMPORTANT_FOR_CONTENT_CAPTURE_AUTO, IMPORTANT_FOR_CONTENT_CAPTURE_YES, IMPORTANT_FOR_CONTENT_CAPTURE_NO, IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS, or IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS. Value is android.view.View#IMPORTANT_FOR_CONTENT_CAPTURE_AUTO, android.view.View#IMPORTANT_FOR_CONTENT_CAPTURE_YES, android.view.View#IMPORTANT_FOR_CONTENT_CAPTURE_NO, android.view.View#IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS, or android.view.View#IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS

setKeepScreenOn

Added in API level 1
open fun setKeepScreenOn(keepScreenOn: Boolean): Unit

Controls whether the screen should remain on, modifying the value of KEEP_SCREEN_ON.

Parameters
keepScreenOn Boolean: Supply true to set KEEP_SCREEN_ON.

setKeyboardNavigationCluster

Added in API level 26
open fun setKeyboardNavigationCluster(isCluster: Boolean): Unit

Set whether this view is a root of a keyboard navigation cluster.

Parameters
isCluster Boolean: If true, this view is a root of a cluster.

setLabelFor

Added in API level 17
open fun setLabelFor(id: Int): Unit

Sets the id of a view for which this view serves as a label for accessibility purposes.

Parameters
id Int: The labeled view id.

setLayerPaint

Added in API level 17
open fun setLayerPaint(paint: Paint?): Unit

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:

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.

Parameters
paint Paint?: The paint used to compose the layer. This argument is optional and can be null. It is ignored when the layer type is LAYER_TYPE_NONE This value may be null.

setLayerType

Added in API level 11
open fun setLayerType(
    layerType: Int,
    paint: Paint?
): Unit

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:

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.

Parameters
layerType Int: The type of layer to use with this view, must be one of LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE Value is android.view.View#LAYER_TYPE_NONE, android.view.View#LAYER_TYPE_SOFTWARE, or android.view.View#LAYER_TYPE_HARDWARE
paint Paint?: The paint used to compose the layer. This argument is optional and can be null. It is ignored when the layer type is LAYER_TYPE_NONE This value may be null.

setLayoutDirection

Added in API level 17
open fun setLayoutDirection(layoutDirection: Int): Unit

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.

Parameters
layoutDirection Int: the layout direction to set. Should be one of: LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE. Resolution will be done if the value is set to LAYOUT_DIRECTION_INHERIT. The resolution proceeds up the parent chain of the view to get the value. If there is no parent, then it will return the default LAYOUT_DIRECTION_LTR. Value is android.view.View#LAYOUT_DIRECTION_LTR, android.view.View#LAYOUT_DIRECTION_RTL, android.view.View#LAYOUT_DIRECTION_INHERIT, or android.view.View#LAYOUT_DIRECTION_LOCALE

setLayoutParams

Added in API level 1
open fun setLayoutParams(params: ViewGroup.LayoutParams!): Unit

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.

Parameters
params ViewGroup.LayoutParams!: The layout parameters for this view, cannot be null

setLeft

Added in API level 11
fun setLeft(left: Int): Unit

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.

Parameters
left Int: The left of this view, in pixels.

setLeftTopRightBottom

Added in API level 29
fun setLeftTopRightBottom(
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Unit

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.

Parameters
left Int: Left position, relative to parent
top Int: Top position, relative to parent
right Int: Right position, relative to parent
bottom Int: Bottom position, relative to parent

See Also

setLongClickable

Added in API level 1
open fun setLongClickable(longClickable: Boolean): Unit

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.

Parameters
longClickable Boolean: true to make the view long clickable, false otherwise

setMinimumHeight

Added in API level 1
open fun setMinimumHeight(minHeight: Int): Unit

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).

Parameters
minHeight Int: The minimum height the view will try to be, in pixels

setMinimumWidth

Added in API level 1
open fun setMinimumWidth(minWidth: Int): Unit

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).

Parameters
minWidth Int: The minimum width the view will try to be, in pixels

setNestedScrollingEnabled

Added in API level 21
open fun setNestedScrollingEnabled(enabled: Boolean): Unit

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.

Parameters
enabled Boolean: true to enable nested scrolling, false to disable

setNextClusterForwardId

Added in API level 26
open fun setNextClusterForwardId(nextClusterForwardId: Int): Unit

Sets the id of the view to use as the root of the next keyboard navigation cluster.

Parameters
nextClusterForwardId Int: The next cluster ID, or NO_ID if the framework should decide automatically.

setNextFocusDownId

Added in API level 1
open fun setNextFocusDownId(nextFocusDownId: Int): Unit

Sets the id of the view to use when the next focus is FOCUS_DOWN.

Parameters
nextFocusDownId Int: The next focus ID, or NO_ID if the framework should decide automatically.

setNextFocusForwardId

Added in API level 11
open fun setNextFocusForwardId(nextFocusForwardId: Int): Unit

Sets the id of the view to use when the next focus is FOCUS_FORWARD.

Parameters
nextFocusForwardId Int: The next focus ID, or NO_ID if the framework should decide automatically.

setNextFocusLeftId

Added in API level 1
open fun setNextFocusLeftId(nextFocusLeftId: Int): Unit

Sets the id of the view to use when the next focus is FOCUS_LEFT.

Parameters
nextFocusLeftId Int: The next focus ID, or NO_ID if the framework should decide automatically.

setNextFocusRightId

Added in API level 1
open fun setNextFocusRightId(nextFocusRightId: Int): Unit

Sets the id of the view to use when the next focus is FOCUS_RIGHT.

Parameters
nextFocusRightId Int: The next focus ID, or NO_ID if the framework should decide automatically.

setNextFocusUpId

Added in API level 1
open fun setNextFocusUpId(nextFocusUpId: Int): Unit

Sets the id of the view to use when the next focus is FOCUS_UP.

Parameters
nextFocusUpId Int: The next focus ID, or NO_ID if the framework should decide automatically.

setOnApplyWindowInsetsListener

Added in API level 20
open fun setOnApplyWindowInsetsListener(listener: View.OnApplyWindowInsetsListener!): Unit

Set an OnApplyWindowInsetsListener to take over the policy for applying window insets to this view. The listener's OnApplyWindowInsetsListener#onApplyWindowInsets(View, WindowInsets) method will be called instead of the view's onApplyWindowInsets method.

Parameters
listener View.OnApplyWindowInsetsListener!: Listener to set

setOnCapturedPointerListener

Added in API level 26
open fun setOnCapturedPointerListener(l: View.OnCapturedPointerListener!): Unit

Set a listener to receive callbacks when the pointer capture state of a view changes.

Parameters
l View.OnCapturedPointerListener!: The OnCapturedPointerListener to receive callbacks.

setOnClickListener

Added in API level 1
open fun setOnClickListener(l: View.OnClickListener?): Unit

Register a callback to be invoked when this view is clicked. If this view is not clickable, it becomes clickable.

Parameters
l View.OnClickListener?: The callback that will run This value may be null.

setOnContextClickListener

Added in API level 23
open fun setOnContextClickListener(l: View.OnContextClickListener?): Unit

Register a callback to be invoked when this view is context clicked. If the view is not context clickable, it becomes context clickable.

Parameters
l View.OnContextClickListener?: The callback that will run This value may be null.

setOnCreateContextMenuListener

Added in API level 1
open fun setOnCreateContextMenuListener(l: View.OnCreateContextMenuListener!): Unit

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.

Parameters
l View.OnCreateContextMenuListener!: The callback that will run

setOnDragListener

Added in API level 11
open fun setOnDragListener(l: View.OnDragListener!): Unit

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.

Parameters
l View.OnDragListener!: An implementation of android.view.View.OnDragListener.

setOnFocusChangeListener

Added in API level 1
open fun setOnFocusChangeListener(l: View.OnFocusChangeListener!): Unit

Register a callback to be invoked when focus of this view changed.

Parameters
l View.OnFocusChangeListener!: The callback that will run.

setOnGenericMotionListener

Added in API level 12
open fun setOnGenericMotionListener(l: View.OnGenericMotionListener!): Unit

Register a callback to be invoked when a generic motion event is sent to this view.

Parameters
l View.OnGenericMotionListener!: the generic motion listener to attach to this view

setOnHoverListener

Added in API level 14
open fun setOnHoverListener(l: View.OnHoverListener!): Unit

Register a callback to be invoked when a hover event is sent to this view.

Parameters
l View.OnHoverListener!: the hover listener to attach to this view

setOnKeyListener

Added in API level 1
open fun setOnKeyListener(l: View.OnKeyListener!): Unit

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.

Parameters
l View.OnKeyListener!: the key listener to attach to this view

setOnLongClickListener

Added in API level 1
open fun setOnLongClickListener(l: View.OnLongClickListener?): Unit

Register a callback to be invoked when this view is clicked and held. If this view is not long clickable, it becomes long clickable.

Parameters
l View.OnLongClickListener?: The callback that will run This value may be null.

setOnScrollChangeListener

Added in API level 23
open fun setOnScrollChangeListener(l: View.OnScrollChangeListener!): Unit

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.

Parameters
l View.OnScrollChangeListener!: The listener to notify when the scroll X or Y position changes.

setOnSystemUiVisibilityChangeListener

Added in API level 11
Deprecated in API level 30
open fun setOnSystemUiVisibilityChangeListener(l: View.OnSystemUiVisibilityChangeListener!): Unit

Deprecated: Use WindowInsets#isVisible(int) to find out about system bar visibilities by setting a OnApplyWindowInsetsListener on this view.

Set a listener to receive callbacks when the visibility of the system bar changes.

Parameters
l View.OnSystemUiVisibilityChangeListener!: The OnSystemUiVisibilityChangeListener to receive callbacks.

setOnTouchListener

Added in API level 1
open fun setOnTouchListener(l: View.OnTouchListener!): Unit

Register a callback to be invoked when a touch event is sent to this view.

Parameters
l View.OnTouchListener!: the touch listener to attach to this view

setOutlineAmbientShadowColor

Added in API level 28
open fun setOutlineAmbientShadowColor(color: Int): Unit

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.

Parameters
color Int: The color this View will cast for its elevation shadow.

setOutlineProvider

Added in API level 21
open fun setOutlineProvider(provider: ViewOutlineProvider!): Unit

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.

setOutlineSpotShadowColor

Added in API level 28
open fun setOutlineSpotShadowColor(color: Int): Unit

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.

Parameters
color Int: The color this View will cast for its elevation spot shadow.

setOverScrollMode

Added in API level 9
open fun setOverScrollMode(overScrollMode: Int): Unit

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.

Parameters
overScrollMode Int: The new over-scroll mode for this view.

setPadding

Added in API level 1
open fun setPadding(
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Unit

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.

Parameters
left Int: the left padding in pixels
top Int: the top padding in pixels
right Int: the right padding in pixels
bottom Int: the bottom padding in pixels

setPaddingRelative

Added in API level 17
open fun setPaddingRelative(
    start: Int,
    top: Int,
    end: Int,
    bottom: Int
): Unit

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.

Parameters
start Int: the start padding in pixels
top Int: the top padding in pixels
end Int: the end padding in pixels
bottom Int: the bottom padding in pixels

setPivotX

Added in API level 11
open fun setPivotX(pivotX: Float): Unit

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.

Parameters
pivotX Float: The x location of the pivot point.

setPivotY

Added in API level 11
open fun setPivotY(pivotY: Float): Unit

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.

Parameters
pivotY Float: The y location of the pivot point.

setPointerIcon

Added in API level 24
open fun setPointerIcon(pointerIcon: PointerIcon!): Unit

Set the pointer icon for the current view. Passing null will restore the pointer icon to its default value.

Parameters
pointerIcon PointerIcon!: A PointerIcon instance which will be shown when the mouse hovers.

setPressed

Added in API level 1
open fun setPressed(pressed: Boolean): Unit

Sets the pressed state for this view.

Parameters
pressed Boolean: Pass true to set the View's internal state to "pressed", or false to reverts the View's internal state from a previously set "pressed" state.

setRevealOnFocusHint

Added in API level 25
fun setRevealOnFocusHint(revealOnFocus: Boolean): Unit

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.

Parameters
revealOnFocus Boolean: true to request reveal on focus in ancestors, false otherwise

setRight

Added in API level 11
fun setRight(right: Int): Unit

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.

Parameters
right Int: The right of this view, in pixels.

setRotation

Added in API level 11
open fun setRotation(rotation: Float): Unit

Sets the degrees that the view is rotated around the pivot point. Increasing values result in clockwise rotation.

Parameters
rotation Float: The degrees of rotation.

setRotationX

Added in API level 11
open fun setRotationX(rotationX: Float): Unit

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.

Parameters
rotationX Float: The degrees of X rotation.

setRotationY

Added in API level 11
open fun setRotationY(rotationY: Float): Unit

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.

Parameters
rotationY Float: The degrees of Y rotation.

setSaveEnabled

Added in API level 1
open fun setSaveEnabled(enabled: Boolean): Unit

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.

Parameters
enabled Boolean: Set to false to disable state saving, or true (the default) to allow it.

setSaveFromParentEnabled

Added in API level 11
open fun setSaveFromParentEnabled(enabled: Boolean): Unit

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.

Parameters
enabled Boolean: Set to false to disable state saving, or true (the default) to allow it.

setScaleX

Added in API level 11
open fun setScaleX(scaleX: Float): Unit

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.

Parameters
scaleX Float: The scaling factor.

setScaleY

Added in API level 11
open fun setScaleY(scaleY: Float): Unit

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.

Parameters
scaleY Float: The scaling factor.

setScreenReaderFocusable

Added in API level 28
open fun setScreenReaderFocusable(screenReaderFocusable: Boolean): Unit

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.

Parameters
screenReaderFocusable Boolean: Whether the view should be treated as a unit by screen reader accessibility tools.

setScrollBarDefaultDelayBeforeFade

Added in API level 16
open fun setScrollBarDefaultDelayBeforeFade(scrollBarDefaultDelayBeforeFade: Int): Unit

Define the delay before scrollbars fade.

Parameters
scrollBarDefaultDelayBeforeFade Int: - the delay before scrollbars fade

setScrollBarFadeDuration

Added in API level 16
open fun setScrollBarFadeDuration(scrollBarFadeDuration: Int): Unit

Define the scrollbar fade duration.

Parameters
scrollBarFadeDuration Int: - the scrollbar fade duration, in milliseconds

setScrollBarSize

Added in API level 16
open fun setScrollBarSize(scrollBarSize: Int): Unit

Define the scrollbar size.

Parameters
scrollBarSize Int: - the scrollbar size

setScrollBarStyle

Added in API level 1
open fun setScrollBarStyle(style: Int): Unit

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.

Parameters
style Int: the style of the scrollbars. Should be one of SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. Value is android.view.View#SCROLLBARS_INSIDE_OVERLAY, android.view.View#SCROLLBARS_INSIDE_INSET, android.view.View#SCROLLBARS_OUTSIDE_OVERLAY, or android.view.View#SCROLLBARS_OUTSIDE_INSET

setScrollContainer

Added in API level 3
open fun setScrollContainer(isScrollContainer: Boolean): Unit

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.

setScrollIndicators

Added in API level 23
open fun setScrollIndicators(indicators: Int): Unit

Sets the state of all scroll indicators.

See setScrollIndicators(int,int) for usage information.

Parameters
indicators Int: a bitmask of indicators that should be enabled, or 0 to disable all indicators Value is either 0 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

setScrollIndicators

open fun setScrollIndicators(
    indicators: Int,
    mask: Int
): Unit

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

setScrollX

Added in API level 14
open fun setScrollX(value: Int): Unit

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.

Parameters
value Int: the x position to scroll to

setScrollY

Added in API level 14
open fun setScrollY(value: Int): Unit

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.

Parameters
value Int: the y position to scroll to

setScrollbarFadingEnabled

Added in API level 5
open fun setScrollbarFadingEnabled(fadeScrollbars: Boolean): Unit

Define whether scrollbars will fade when the view is not scrolling.

Parameters
fadeScrollbars Boolean: whether to enable fading

setSelected

Added in API level 1
open fun setSelected(selected: Boolean): Unit

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.

Parameters
selected Boolean: true if the view must be selected, false otherwise

setSoundEffectsEnabled

Added in API level 1
open fun setSoundEffectsEnabled(soundEffectsEnabled: Boolean): Unit

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.

Parameters
soundEffectsEnabled Boolean: whether sound effects are enabled for this view.

setStateDescription

Added in API level 30
open fun setStateDescription(stateDescription: CharSequence?): Unit

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.

Parameters
stateDescription CharSequence?: The state description. This value may be null.

setStateListAnimator

Added in API level 21
open fun setStateListAnimator(stateListAnimator: StateListAnimator!): Unit

Attaches the provided StateListAnimator to this View.

Any previously attached StateListAnimator will be detached.

Parameters
stateListAnimator StateListAnimator!: The StateListAnimator to update the view

setSystemGestureExclusionRects

Added in API level 29
open fun setSystemGestureExclusionRects(rects: MutableList<Rect!>): Unit

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.

Do not modify the provided list after this method is called.

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 Intent#CATEGORY_HOME.

Parameters
rects MutableList<Rect!>: A list of precision gesture regions that this view needs to function correctly This value cannot be null.

setSystemUiVisibility

Added in API level 11
Deprecated in API level 30
open fun setSystemUiVisibility(visibility: Int): Unit

Deprecated: SystemUiVisibility flags are deprecated. Use WindowInsetsController instead.

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.

Parameters
visibility Int: Bitwise-or of flags SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_IMMERSIVE, and SYSTEM_UI_FLAG_IMMERSIVE_STICKY.

setTag

Added in API level 1
open fun setTag(tag: Any!): Unit

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.

Parameters
tag Any!: an Object to tag the view with

setTag

Added in API level 4
open fun setTag(
    key: Int,
    tag: Any!
): Unit

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.

Parameters
key Int: The key identifying the tag
tag Any!: An Object to tag the view with
Exceptions
java.lang.IllegalArgumentException If they specified key is not valid

setTextAlignment

Added in API level 17
open fun setTextAlignment(textAlignment: Int): Unit

Set the text alignment.

Parameters
textAlignment Int: The text alignment to set. Should be one of TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_VIEW_START, TEXT_ALIGNMENT_VIEW_END Resolution will be done if the value is set to TEXT_ALIGNMENT_INHERIT. The resolution proceeds up the parent chain of the view to get the value. If there is no parent, then it will return the default TEXT_ALIGNMENT_GRAVITY. Value is android.view.View#TEXT_ALIGNMENT_INHERIT, android.view.View#TEXT_ALIGNMENT_GRAVITY, android.view.View#TEXT_ALIGNMENT_CENTER, android.view.View#TEXT_ALIGNMENT_TEXT_START, android.view.View#TEXT_ALIGNMENT_TEXT_END, android.view.View#TEXT_ALIGNMENT_VIEW_START, or android.view.View#TEXT_ALIGNMENT_VIEW_END

setTextDirection

Added in API level 17
open fun setTextDirection(textDirection: Int): Unit

Set the text direction.

Parameters
textDirection Int: the direction to set. Should be one of: TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TEXT_DIRECTION_LOCALE TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL, Resolution will be done if the value is set to TEXT_DIRECTION_INHERIT. The resolution proceeds up the parent chain of the view to get the value. If there is no parent, then it will return the default TEXT_DIRECTION_FIRST_STRONG.

setTooltipText

Added in API level 26
open fun setTooltipText(tooltipText: CharSequence?): Unit

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.

Parameters
tooltipText CharSequence?: the tooltip text, or null if no tooltip is required This value may be null.

setTop

Added in API level 11
fun setTop(top: Int): Unit

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.

Parameters
top Int: The top of this view, in pixels.

setTouchDelegate

Added in API level 1
open fun setTouchDelegate(delegate: TouchDelegate!): Unit

Sets the TouchDelegate for this View.

setTransitionAlpha

Added in API level 29
open fun setTransitionAlpha(alpha: Float): Unit

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.

setTransitionName

Added in API level 21
fun setTransitionName(transitionName: String!): Unit

Sets the name of the View to be used to identify Views in Transitions. Names should be unique in the View hierarchy.

Parameters
transitionName String!: The name of the View to uniquely identify it for Transitions.

setTransitionVisibility

Added in API level 29
open fun setTransitionVisibility(visibility: Int): Unit

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.

Parameters
visibility Int: One of VISIBLE, INVISIBLE, or GONE. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

setTranslationX

Added in API level 11
open fun setTranslationX(translationX: Float): Unit

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.

Parameters
translationX Float: The horizontal position of this view relative to its left position, in pixels.

setTranslationY

Added in API level 11
open fun setTranslationY(translationY: Float): Unit

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.

Parameters
translationY Float: The vertical position of this view relative to its top position, in pixels.

setTranslationZ

Added in API level 21
open fun setTranslationZ(translationZ: Float): Unit

Sets the depth location of this view relative to its elevation.

setVerticalFadingEdgeEnabled

Added in API level 1
open fun setVerticalFadingEdgeEnabled(verticalFadingEdgeEnabled: Boolean): Unit

Define whether the vertical edges should be faded when this view is scrolled vertically.

Parameters
verticalFadingEdgeEnabled Boolean: true if the vertical edges should be faded when the view is scrolled vertically

setVerticalScrollBarEnabled

Added in API level 1
open fun setVerticalScrollBarEnabled(verticalScrollBarEnabled: Boolean): Unit

Define whether the vertical scrollbar should be drawn or not. The scrollbar is not drawn by default.

Parameters
verticalScrollBarEnabled Boolean: true if the vertical scrollbar should be painted

setVerticalScrollbarPosition

Added in API level 11
open fun setVerticalScrollbarPosition(position: Int): Unit

Set the position of the vertical scroll bar. Should be one of SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT or SCROLLBAR_POSITION_RIGHT.

Parameters
position Int: Where the vertical scroll bar should be positioned.

setVerticalScrollbarThumbDrawable

Added in API level 29
open fun setVerticalScrollbarThumbDrawable(drawable: Drawable?): Unit

Defines the vertical scrollbar thumb drawable

Parameters
drawable Drawable?: This value may be null.

setVerticalScrollbarTrackDrawable

Added in API level 29
open fun setVerticalScrollbarTrackDrawable(drawable: Drawable?): Unit

Defines the vertical scrollbar track drawable

Parameters
drawable Drawable?: This value may be null.

setVisibility

Added in API level 1
open fun setVisibility(visibility: Int): Unit

Set the visibility state of this view.

Parameters
visibility Int: One of VISIBLE, INVISIBLE, or GONE. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

setWillNotCacheDrawing

Added in API level 1
Deprecated in API level 28
open fun setWillNotCacheDrawing(willNotCacheDrawing: Boolean): Unit

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

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.

Parameters
willNotCacheDrawing Boolean: true if this view does not cache its drawing, false otherwise

setWillNotDraw

Added in API level 1
open fun setWillNotDraw(willNotDraw: Boolean): Unit

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.

Parameters
willNotDraw Boolean: whether or not this View draw on its own

setWindowInsetsAnimationCallback

Added in API level 30
open fun setWindowInsetsAnimationCallback(callback: WindowInsetsAnimation.Callback?): Unit

Sets a WindowInsetsAnimation.Callback to be notified about animations of windows that cause insets.

The callback's WindowInsetsAnimation.Callback#getDispatchMode() will affect whether animation callbacks are dispatched to the children of this view.

Parameters
callback WindowInsetsAnimation.Callback?: The callback to set. This value may be null.

setX

Added in API level 11
open fun setX(x: Float): Unit

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.

Parameters
x Float: The visual x position of this view, in pixels.

setY

Added in API level 11
open fun setY(y: Float): Unit

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.

Parameters
y Float: The visual y position of this view, in pixels.

setZ

Added in API level 21
open fun setZ(z: Float): Unit

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.

Parameters
z Float: The visual z position of this view, in pixels.

showContextMenu

Added in API level 1
open fun showContextMenu(): Boolean

Shows the context menu for this view.

Return
Boolean true if the context menu was shown, false otherwise

showContextMenu

Added in API level 24
open fun showContextMenu(
    x: Float,
    y: Float
): Boolean

Shows the context menu for this view anchored to the specified view-relative coordinate.

Parameters
x Float: the X coordinate in pixels relative to the view to which the menu should be anchored, or Float#NaN to disable anchoring
y Float: the Y coordinate in pixels relative to the view to which the menu should be anchored, or Float#NaN to disable anchoring
Return
Boolean true if the context menu was shown, false otherwise

startActionMode

Added in API level 11
open fun startActionMode(callback: ActionMode.Callback!): ActionMode!

Start an action mode with the default type ActionMode#TYPE_PRIMARY.

Parameters
callback ActionMode.Callback!: Callback that will control the lifecycle of the action mode
Return
ActionMode! The new action mode if it is started, null otherwise

startActionMode

Added in API level 23
open fun startActionMode(
    callback: ActionMode.Callback!,
    type: Int
): ActionMode!

Start an action mode with the given type.

Parameters
callback ActionMode.Callback!: Callback that will control the lifecycle of the action mode
type Int: One of ActionMode#TYPE_PRIMARY or ActionMode#TYPE_FLOATING.
Return
ActionMode! The new action mode if it is started, null otherwise

startAnimation

Added in API level 1
open fun startAnimation(animation: Animation!): Unit

Start the specified animation now.

Parameters
animation Animation!: the animation to start now

startDrag

Added in API level 11
Deprecated in API level 24
fun startDrag(
    data: ClipData!,
    shadowBuilder: View.DragShadowBuilder!,
    myLocalState: Any!,
    flags: Int
): Boolean

Deprecated: Use startDragAndDrop() for newer platform versions.

startDragAndDrop

Added in API level 24
fun startDragAndDrop(
    data: ClipData!,
    shadowBuilder: View.DragShadowBuilder!,
    myLocalState: Any!,
    flags: Int
): Boolean

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.

Parameters
data ClipData!: A android.content.ClipData object pointing to the data to be transferred by the drag and drop operation.
shadowBuilder View.DragShadowBuilder!: A android.view.View.DragShadowBuilder object for building the drag shadow.
myLocalState Any!: An java.lang.Object containing local data about the drag and drop operation. When dispatching drag events to views in the same activity this object will be available through android.view.DragEvent#getLocalState(). Views in other activities will not have access to this data (android.view.DragEvent#getLocalState() will return null).

myLocalState is a lightweight mechanism for the sending information from the dragged View to the target Views. For example, it can contain flags that differentiate between a a copy operation and a move operation.

flags Int: Flags that control the drag and drop operation. This can be set to 0 for no flags, or any combination of the following:
Return
Boolean true if the method completes successfully, or false if it fails anywhere. Returning false means the system was unable to do a drag because of another ongoing operation or some other reasons.

startNestedScroll

Added in API level 21
open fun startNestedScroll(axes: Int): Boolean

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).

Parameters
axes Int: Flags consisting of a combination of SCROLL_AXIS_HORIZONTAL and/or SCROLL_AXIS_VERTICAL.
Return
Boolean true if a cooperative parent was found and nested scrolling has been enabled for the current gesture.

stopNestedScroll

Added in API level 21
open fun stopNestedScroll(): Unit

Stop a nested scroll in progress.

Calling this method when a nested scroll is not currently in progress is harmless.

toString

Added in API level 1
open fun toString(): String
Return
String a string representation of the object.

transformMatrixToGlobal

Added in API level 29
open fun transformMatrixToGlobal(matrix: Matrix): Unit

Modifies the input matrix such that it maps view-local coordinates to on-screen coordinates.

Parameters
matrix Matrix: input matrix to modify This value cannot be null.

transformMatrixToLocal

Added in API level 29
open fun transformMatrixToLocal(matrix: Matrix): Unit

Modifies the input matrix such that it maps on-screen coordinates to view-local coordinates.

Parameters
matrix Matrix: input matrix to modify This value cannot be null.

unscheduleDrawable

Added in API level 1
open fun unscheduleDrawable(
    who: Drawable,
    what: Runnable
): Unit

Cancels a scheduled action on a drawable.

Parameters
who Drawable: the recipient of the action This value cannot be null.
what Runnable: the action to cancel This value cannot be null.

unscheduleDrawable

Added in API level 1
open fun unscheduleDrawable(who: Drawable!): Unit

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.

Parameters
who Drawable!: The Drawable to unschedule.

updateDragShadow

Added in API level 24
fun updateDragShadow(shadowBuilder: View.DragShadowBuilder!): Unit

Updates the drag shadow for the ongoing drag and drop operation.

Parameters
shadowBuilder View.DragShadowBuilder!: A android.view.View.DragShadowBuilder object for building the new drag shadow.

willNotCacheDrawing

Added in API level 1
Deprecated in API level 28
open fun willNotCacheDrawing(): Boolean

Deprecated: The view drawing cache was largely made obsolete with the introduction of hardware-accelerated rendering in API 11. With hardware-acceleration, intermediate cache layers are largely unnecessary and can easily result in a net loss in performance due to the cost of creating and updating the layer. In the rare cases where caching layers are useful, such as for alpha animations, setLayerType(int,android.graphics.Paint) handles this with hardware rendering. For software-rendered snapshots of a small part of the View hierarchy or individual Views it is recommended to create a Canvas from either a Bitmap or android.graphics.Picture and call draw(android.graphics.Canvas) on the View. However these software-rendered usages are discouraged and have compatibility issues with hardware-only rendering features such as Config.HARDWARE bitmaps, real-time shadows, and outline clipping. For screenshots of the UI for feedback reports or unit testing the PixelCopy API is recommended.

Returns whether or not this View can cache its drawing or not.

Return
Boolean true if this view does not cache its drawing, false otherwise

willNotDraw

Added in API level 1
open fun willNotDraw(): Boolean

Returns whether or not this View draws on its own.

Return
Boolean true if this view has nothing to draw, false otherwise

Protected methods

awakenScrollBars

Added in API level 5
protected open fun awakenScrollBars(): Boolean

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).

Return
Boolean true if the animation is played, false otherwise

awakenScrollBars

Added in API level 5
protected open fun awakenScrollBars(startDelay: Int): 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(); in that case the caller should not call invalidate().

This method should be invoked every time a subclass directly updates the scroll parameters.

Parameters
startDelay Int: the delay, in milliseconds, after which the animation should start; when the delay is 0, the animation starts immediately
Return
Boolean true if the animation is played, false otherwise

awakenScrollBars

Added in API level 5
protected open fun awakenScrollBars(
    startDelay: Int,
    invalidate: Boolean
): 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.

Parameters
startDelay Int: the delay, in milliseconds, after which the animation should start; when the delay is 0, the animation starts immediately
invalidate Boolean: Whether this method should call invalidate
Return
Boolean true if the animation is played, false otherwise

computeHorizontalScrollExtent

Added in API level 1
protected open fun computeHorizontalScrollExtent(): Int

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.

Return
Int the horizontal extent of the scrollbar's thumb

computeHorizontalScrollOffset

Added in API level 1
protected open fun computeHorizontalScrollOffset(): Int

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.

Return
Int the horizontal offset of the scrollbar's thumb

computeHorizontalScrollRange

Added in API level 1
protected open fun computeHorizontalScrollRange(): Int

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.

Return
Int the total horizontal range represented by the horizontal scrollbar

computeVerticalScrollExtent

Added in API level 1
protected open fun computeVerticalScrollExtent(): Int

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.

Return
Int the vertical extent of the scrollbar's thumb

computeVerticalScrollOffset

Added in API level 1
protected open fun computeVerticalScrollOffset(): Int

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.

Return
Int the vertical offset of the scrollbar's thumb

computeVerticalScrollRange

Added in API level 1
protected open fun computeVerticalScrollRange(): Int

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().

Return
Int the total vertical range represented by the vertical scrollbar

The default range is the drawing height of this view.

dispatchDraw

Added in API level 1
protected open fun dispatchDraw(canvas: Canvas!): Unit

Called by draw to draw the child views. This may be overridden by derived classes to gain control just before its children are drawn (but after its own view has been drawn).

Parameters
canvas Canvas!: the canvas on which to draw the view

dispatchGenericFocusedEvent

Added in API level 14
protected open fun dispatchGenericFocusedEvent(event: MotionEvent!): Boolean

Dispatch a generic motion event to the currently focused view.

Do not call this method directly. Call dispatchGenericMotionEvent(android.view.MotionEvent) instead.

Parameters
event MotionEvent!: The motion event to be dispatched.
Return
Boolean True if the event was handled by the view, false otherwise.

dispatchGenericPointerEvent

Added in API level 14
protected open fun dispatchGenericPointerEvent(event: MotionEvent!): Boolean

Dispatch a generic motion event to the view under the first pointer.

Do not call this method directly. Call dispatchGenericMotionEvent(android.view.MotionEvent) instead.

Parameters
event MotionEvent!: The motion event to be dispatched.
Return
Boolean True if the event was handled by the view, false otherwise.

dispatchHoverEvent

Added in API level 14
protected open fun dispatchHoverEvent(event: MotionEvent!): Boolean

Dispatch a hover event.

Do not call this method directly. Call dispatchGenericMotionEvent(android.view.MotionEvent) instead.

Parameters
event MotionEvent!: The motion event to be dispatched.
Return
Boolean True if the event was handled by the view, false otherwise.

dispatchRestoreInstanceState

Added in API level 1
protected open fun dispatchRestoreInstanceState(container: SparseArray<Parcelable!>!): Unit

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.

Parameters
container SparseArray<Parcelable!>!: The SparseArray which holds previously saved state.

dispatchSaveInstanceState

Added in API level 1
protected open fun dispatchSaveInstanceState(container: SparseArray<Parcelable!>!): Unit

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.

Parameters
container SparseArray<Parcelable!>!: The SparseArray in which to save the view's state.

dispatchSetActivated

Added in API level 11
protected open fun dispatchSetActivated(activated: Boolean): Unit

Dispatch setActivated to all of this View's children.

Parameters
activated Boolean: The new activated state

dispatchSetPressed

Added in API level 1
protected open fun dispatchSetPressed(pressed: Boolean): Unit

Dispatch setPressed to all of this View's children.

Parameters
pressed Boolean: The new pressed state

dispatchSetSelected

Added in API level 1
protected open fun dispatchSetSelected(selected: Boolean): Unit

Dispatch setSelected to all of this View's children.

Parameters
selected Boolean: The new selected state

dispatchVisibilityChanged

Added in API level 8
protected open fun dispatchVisibilityChanged(
    changedView: View,
    visibility: Int
): Unit

Dispatch a view visibility change down the view hierarchy. ViewGroups should override to route to their children.

Parameters
changedView View: The view whose visibility changed. Could be 'this' or an ancestor view. This value cannot be null.
visibility Int: The new visibility of changedView: VISIBLE, INVISIBLE or GONE. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

drawableStateChanged

Added in API level 1
protected open fun drawableStateChanged(): Unit

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.

fitSystemWindows

Added in API level 1
Deprecated in API level 20
protected open fun fitSystemWindows(insets: Rect!): Boolean

Deprecated: As of API 20 use dispatchApplyWindowInsets(android.view.WindowInsets) to apply insets to views. Views should override onApplyWindowInsets(android.view.WindowInsets) or use setOnApplyWindowInsetsListener(android.view.View.OnApplyWindowInsetsListener) to implement handling their own insets.

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).

Parameters
insets Rect!: Current content insets of the window. Prior to android.os.Build.VERSION_CODES#JELLY_BEAN you must not modify the insets or else you and Android will be unhappy.
Return
Boolean true if this view applied the insets and it should not continue propagating further down the hierarchy, false otherwise.

getBottomFadingEdgeStrength

Added in API level 1
protected open fun getBottomFadingEdgeStrength(): Float

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.

Return
Float the intensity of the bottom fade as a float between 0.0f and 1.0f

getBottomPaddingOffset

Added in API level 2
protected open fun getBottomPaddingOffset(): Int

Amount by which to extend the bottom fading region. Called only when isPaddingOffsetRequired() returns true.

Return
Int The bottom padding offset in pixels.

getContextMenuInfo

Added in API level 1
protected open fun getContextMenuInfo(): ContextMenu.ContextMenuInfo!

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.

Return
ContextMenu.ContextMenuInfo! Extra information about the item for which the context menu should be shown. This information will vary across different subclasses of View.

getHorizontalScrollbarHeight

Added in API level 1
protected open fun getHorizontalScrollbarHeight(): Int

Returns the height of the horizontal scrollbar.

Return
Int The height in pixels of the horizontal scrollbar or 0 if there is no horizontal scrollbar.

getLeftFadingEdgeStrength

Added in API level 1
protected open fun getLeftFadingEdgeStrength(): Float

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.

Return
Float the intensity of the left fade as a float between 0.0f and 1.0f

getLeftPaddingOffset

Added in API level 2
protected open fun getLeftPaddingOffset(): Int

Amount by which to extend the left fading region. Called only when isPaddingOffsetRequired() returns true.

Return
Int The left padding offset in pixels.

getRightFadingEdgeStrength

Added in API level 1
protected open fun getRightFadingEdgeStrength(): Float

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.

Return
Float the intensity of the right fade as a float between 0.0f and 1.0f

getRightPaddingOffset

Added in API level 2
protected open fun getRightPaddingOffset(): Int

Amount by which to extend the right fading region. Called only when isPaddingOffsetRequired() returns true.

Return
Int The right padding offset in pixels.

getSuggestedMinimumHeight

Added in API level 1
protected open fun getSuggestedMinimumHeight(): Int

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.

Return
Int The suggested minimum height of the view.

getSuggestedMinimumWidth

Added in API level 1
protected open fun getSuggestedMinimumWidth(): Int

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.

Return
Int The suggested minimum width of the view.

getTopFadingEdgeStrength

Added in API level 1
protected open fun getTopFadingEdgeStrength(): Float

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.

Return
Float the intensity of the top fade as a float between 0.0f and 1.0f

getTopPaddingOffset

Added in API level 2
protected open fun getTopPaddingOffset(): Int

Amount by which to extend the top fading region. Called only when isPaddingOffsetRequired() returns true.

Return
Int The top padding offset in pixels.

getWindowAttachCount

Added in API level 1
protected open fun getWindowAttachCount(): Int
Return
Int The number of times this view has been attached to a window

isPaddingOffsetRequired

Added in API level 2
protected open fun isPaddingOffsetRequired(): Boolean

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.

Return
Boolean True if padding offset must be applied, false otherwise.

mergeDrawableStates

Added in API level 1
protected open static fun mergeDrawableStates(
    baseState: IntArray!,
    additionalState: IntArray!
): IntArray!

Merge your own state values in additionalState into the base state values baseState that were returned by onCreateDrawableState(int).

Parameters
baseState IntArray!: The base state values returned by onCreateDrawableState(int), which will be modified to also hold your own additional state values.
additionalState IntArray!: The additional state values you would like added to baseState; this array is not modified.
Return
IntArray! As a convenience, the baseState array you originally passed into the function is returned.

onAnimationEnd

Added in API level 1
protected open fun onAnimationEnd(): Unit

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.

onAnimationStart

Added in API level 1
protected open fun onAnimationStart(): Unit

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.

onAttachedToWindow

Added in API level 1
protected open fun onAttachedToWindow(): Unit

This is called when the view is attached to a window. At this point it has a Surface and will start drawing. Note that this function is guaranteed to be called before onDraw(android.graphics.Canvas), however it may be called any time before the first onDraw -- including before or after onMeasure(int,int).
If you override this method you must call through to the superclass implementation.

onConfigurationChanged

Added in API level 8
protected open fun onConfigurationChanged(newConfig: Configuration!): Unit

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.

Parameters
newConfig Configuration!: The new resource configuration.

onCreateContextMenu

Added in API level 1
protected open fun onCreateContextMenu(menu: ContextMenu!): Unit

Views should implement this if the view itself is going to add items to the context menu.

Parameters
menu ContextMenu!: the context menu to populate

onCreateDrawableState

Added in API level 1
protected open fun onCreateDrawableState(extraSpace: Int): IntArray!

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.

Parameters
extraSpace Int: if non-zero, this is the number of extra entries you would like in the returned array in which you can place your own states.
Return
IntArray! Returns an array holding the current Drawable state of the view.

onDetachedFromWindow

Added in API level 1
protected open fun onDetachedFromWindow(): Unit

This is called when the view is detached from a window. At this point it no longer has a surface for drawing.
If you override this method you must call through to the superclass implementation.

onDisplayHint

Added in API level 8
protected open fun onDisplayHint(hint: Int): Unit

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.

Parameters
hint Int: A hint about whether or not this view is displayed: VISIBLE or INVISIBLE. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

onDraw

Added in API level 1
protected open fun onDraw(canvas: Canvas!): Unit

Implement this to do your drawing.

Parameters
canvas Canvas!: the canvas on which the background will be drawn

onDrawScrollBars

Added in API level 7
protected fun onDrawScrollBars(canvas: Canvas!): Unit

Request the drawing of the horizontal and the vertical scrollbar. The scrollbars are painted only if they have been awakened first.

Parameters
canvas Canvas!: the canvas on which to draw the scrollbars

onFinishInflate

Added in API level 1
protected open fun onFinishInflate(): Unit

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.

onFocusChanged

Added in API level 1
protected open fun onFocusChanged(
    gainFocus: Boolean,
    direction: Int,
    previouslyFocusedRect: Rect?
): Unit

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.

Parameters
gainFocus Boolean: True if the View has focus; false otherwise.
direction Int: The direction focus has moved when requestFocus() is called to give this view focus. Values are FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD, or FOCUS_BACKWARD. It may not always apply, in which case use the default. Value is android.view.View#FOCUS_BACKWARD, android.view.View#FOCUS_FORWARD, android.view.View#FOCUS_LEFT, android.view.View#FOCUS_UP, android.view.View#FOCUS_RIGHT, or android.view.View#FOCUS_DOWN
previouslyFocusedRect Rect?: The rectangle, in this view's coordinate system, of the previously focused view. If applicable, this will be passed in as finer grained information about where the focus is coming from (in addition to direction). Will be null otherwise. This value may be null.

onLayout

Added in API level 1
protected open fun onLayout(
    changed: Boolean,
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Unit

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.

Parameters
changed Boolean: This is a new size or position for this view
left Int: Left position, relative to parent
top Int: Top position, relative to parent
right Int: Right position, relative to parent
bottom Int: Bottom position, relative to parent

onMeasure

Added in API level 1
protected open fun onMeasure(
    widthMeasureSpec: Int,
    heightMeasureSpec: Int
): Unit

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int,int) and should be overridden by subclasses to provide accurate and efficient measurement of their contents.

CONTRACT: When overriding this method, you must call setMeasuredDimension(int,int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException, thrown by measure(int,int). Calling the superclass' onMeasure(int,int) is a valid use.

The base class implementation of measure defaults to the background size, unless a larger size is allowed by the MeasureSpec. Subclasses should override onMeasure(int,int) to provide better measurements of their content.

If this method is overridden, it is the subclass's responsibility to make sure the measured height and width are at least the view's minimum height and width (getSuggestedMinimumHeight() and getSuggestedMinimumWidth()).

Parameters
widthMeasureSpec Int: horizontal space requirements as imposed by the parent. The requirements are encoded with android.view.View.MeasureSpec.
heightMeasureSpec Int: vertical space requirements as imposed by the parent. The requirements are encoded with android.view.View.MeasureSpec.

onOverScrolled

Added in API level 9
protected open fun onOverScrolled(
    scrollX: Int,
    scrollY: Int,
    clampedX: Boolean,
    clampedY: Boolean
): Unit

Called by overScrollBy(int,int,int,int,int,int,int,int,boolean) to respond to the results of an over-scroll operation.

Parameters
scrollX Int: New X scroll value in pixels
scrollY Int: New Y scroll value in pixels
clampedX Boolean: True if scrollX was clamped to an over-scroll boundary
clampedY Boolean: True if scrollY was clamped to an over-scroll boundary

onRestoreInstanceState

Added in API level 1
protected open fun onRestoreInstanceState(state: Parcelable!): Unit

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.

Parameters
state Parcelable!: The frozen state that had previously been returned by onSaveInstanceState.

onSaveInstanceState

Added in API level 1
protected open fun onSaveInstanceState(): Parcelable?

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.

Return
Parcelable? Returns a Parcelable object containing the view's current dynamic state, or null if there is nothing interesting to save.

onScrollChanged

Added in API level 1
protected open fun onScrollChanged(
    l: Int,
    t: Int,
    oldl: Int,
    oldt: Int
): Unit

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.

Parameters
l Int: Current horizontal scroll origin.
t Int: Current vertical scroll origin.
oldl Int: Previous horizontal scroll origin.
oldt Int: Previous vertical scroll origin.

onSetAlpha

Added in API level 1
protected open fun onSetAlpha(alpha: Int): Boolean

Invoked if there is a Transform that involves alpha. Subclass that can draw themselves with the specified alpha should return true, and then respect that alpha when their onDraw() is called. If this returns false then the view may be redirected to draw into an offscreen buffer to fulfill the request, which will look fine, but may be slower than if the subclass handles it internally. The default implementation returns false.

Parameters
alpha Int: The alpha (0..255) to apply to the view's drawing
Return
Boolean true if the view can draw with the specified alpha.

onSizeChanged

Added in API level 1
protected open fun onSizeChanged(
    w: Int,
    h: Int,
    oldw: Int,
    oldh: Int
): Unit

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.

Parameters
w Int: Current width of this view.
h Int: Current height of this view.
oldw Int: Old width of this view.
oldh Int: Old height of this view.

onVisibilityChanged

Added in API level 8
protected open fun onVisibilityChanged(
    changedView: View,
    visibility: Int
): Unit

Called when the visibility of the view or an ancestor of the view has changed.

Parameters
changedView View: The view whose visibility changed. May be this or an ancestor view. This value cannot be null.
visibility Int: The new visibility, one of VISIBLE, INVISIBLE or GONE. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

onWindowVisibilityChanged

Added in API level 1
protected open fun onWindowVisibilityChanged(visibility: Int): Unit

Called when the window containing has change its visibility (between GONE, INVISIBLE, and VISIBLE). Note that this tells you whether or not your window is being made visible to the window manager; this does not tell you whether or not your window is obscured by other windows on the screen, even if it is itself visible.

Parameters
visibility Int: The new visibility of the window. Value is android.view.View#VISIBLE, android.view.View#INVISIBLE, or android.view.View#GONE

overScrollBy

Added in API level 9
protected open fun overScrollBy(
    deltaX: Int,
    deltaY: Int,
    scrollX: Int,
    scrollY: Int,
    scrollRangeX: Int,
    scrollRangeY: Int,
    maxOverScrollX: Int,
    maxOverScrollY: Int,
    isTouchEvent: Boolean
): 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.

Parameters
deltaX Int: Change in X in pixels
deltaY Int: Change in Y in pixels
scrollX Int: Current X scroll value in pixels before applying deltaX
scrollY Int: Current Y scroll value in pixels before applying deltaY
scrollRangeX Int: Maximum content scroll range along the X axis
scrollRangeY Int: Maximum content scroll range along the Y axis
maxOverScrollX Int: Number of pixels to overscroll by in either direction along the X axis.
maxOverScrollY Int: Number of pixels to overscroll by in either direction along the Y axis.
isTouchEvent Boolean: true if this scroll operation is the result of a touch event.
Return
Boolean true if scrolling was clamped to an over-scroll boundary along either axis, false otherwise.

setMeasuredDimension

Added in API level 1
protected fun setMeasuredDimension(
    measuredWidth: Int,
    measuredHeight: Int
): Unit

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.

Parameters
measuredWidth Int: The measured width of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.
measuredHeight Int: The measured height of this view. May be a complex bit mask as defined by MEASURED_SIZE_MASK and MEASURED_STATE_TOO_SMALL.

verifyDrawable

Added in API level 1
protected open fun verifyDrawable(who: Drawable): Boolean

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.

Parameters
who Drawable: The Drawable to verify. Return true if it is one you are displaying, else return the result of calling through to the super class. This value cannot be null.
Return
Boolean boolean If true than the Drawable is being displayed in the view; else false and it is not allowed to animate.

Properties

ALPHA

Added in API level 14
static val ALPHA: Property<View!, Float!>!

A Property wrapper around the alpha functionality handled by the View#setAlpha(float) and View#getAlpha() methods.

EMPTY_STATE_SET

Added in API level 1
protected static val EMPTY_STATE_SET: IntArray!

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.

ENABLED_FOCUSED_SELECTED_STATE_SET

Added in API level 1
protected static val ENABLED_FOCUSED_SELECTED_STATE_SET: IntArray!

Indicates the view is enabled, focused and selected.

ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is enabled, focused, selected and its window has the focus.

ENABLED_FOCUSED_STATE_SET

Added in API level 1
protected static val ENABLED_FOCUSED_STATE_SET: IntArray!

Indicates the view is enabled and has the focus.

ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is enabled, focused and its window has the focus.

ENABLED_SELECTED_STATE_SET

Added in API level 1
protected static val ENABLED_SELECTED_STATE_SET: IntArray!

Indicates the view is enabled and selected.

ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is enabled, selected and its window has the focus.

ENABLED_STATE_SET

Added in API level 1
protected static val ENABLED_STATE_SET: IntArray!

Indicates the view is enabled. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state.

ENABLED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val ENABLED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is enabled and that its window has focus.

FOCUSED_SELECTED_STATE_SET

Added in API level 1
protected static val FOCUSED_SELECTED_STATE_SET: IntArray!

Indicates the view is focused and selected.

FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is focused, selected and its window has the focus.

FOCUSED_STATE_SET

Added in API level 1
protected static val FOCUSED_STATE_SET: IntArray!

Indicates the view is focused. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state.

FOCUSED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val FOCUSED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view has the focus and that its window has the focus.

PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET

Added in API level 1
protected static val PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET: IntArray!

Indicates the view is pressed, enabled, focused and selected.

PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed, enabled, focused, selected and its window has the focus.

PRESSED_ENABLED_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_ENABLED_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed, enabled and focused.

PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed, enabled, focused and its window has the focus.

PRESSED_ENABLED_SELECTED_STATE_SET

Added in API level 1
protected static val PRESSED_ENABLED_SELECTED_STATE_SET: IntArray!

Indicates the view is pressed, enabled and selected.

PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed, enabled, selected and its window has the focus.

PRESSED_ENABLED_STATE_SET

Added in API level 1
protected static val PRESSED_ENABLED_STATE_SET: IntArray!

Indicates the view is pressed and enabled.

PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed, enabled and its window has the focus.

PRESSED_FOCUSED_SELECTED_STATE_SET

Added in API level 1
protected static val PRESSED_FOCUSED_SELECTED_STATE_SET: IntArray!

Indicates the view is pressed, focused and selected.

PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed, focused, selected and its window has the focus.

PRESSED_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed and focused.

PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed, focused and its window has the focus.

PRESSED_SELECTED_STATE_SET

Added in API level 1
protected static val PRESSED_SELECTED_STATE_SET: IntArray!

Indicates the view is pressed and selected.

PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed, selected and its window has the focus.

PRESSED_STATE_SET

Added in API level 19
protected static val PRESSED_STATE_SET: IntArray!

Indicates the view is pressed. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state.

PRESSED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val PRESSED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is pressed and its window has the focus.

ROTATION

Added in API level 14
static val ROTATION: Property<View!, Float!>!

A Property wrapper around the rotation functionality handled by the View#setRotation(float) and View#getRotation() methods.

ROTATION_X

Added in API level 14
static val ROTATION_X: Property<View!, Float!>!

A Property wrapper around the rotationX functionality handled by the View#setRotationX(float) and View#getRotationX() methods.

ROTATION_Y

Added in API level 14
static val ROTATION_Y: Property<View!, Float!>!

A Property wrapper around the rotationY functionality handled by the View#setRotationY(float) and View#getRotationY() methods.

SCALE_X

Added in API level 14
static val SCALE_X: Property<View!, Float!>!

A Property wrapper around the scaleX functionality handled by the View#setScaleX(float) and View#getScaleX() methods.

SCALE_Y

Added in API level 14
static val SCALE_Y: Property<View!, Float!>!

A Property wrapper around the scaleY functionality handled by the View#setScaleY(float) and View#getScaleY() methods.

SELECTED_STATE_SET

Added in API level 1
protected static val SELECTED_STATE_SET: IntArray!

Indicates the view is selected. States are used with android.graphics.drawable.Drawable to change the drawing of the view depending on its state.

SELECTED_WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val SELECTED_WINDOW_FOCUSED_STATE_SET: IntArray!

Indicates the view is selected and that its window has the focus.

TRANSLATION_X

Added in API level 14
static val TRANSLATION_X: Property<View!, Float!>!

A Property wrapper around the translationX functionality handled by the View#setTranslationX(float) and View#getTranslationX() methods.

TRANSLATION_Y

Added in API level 14
static val TRANSLATION_Y: Property<View!, Float!>!

A Property wrapper around the translationY functionality handled by the View#setTranslationY(float) and View#getTranslationY() methods.

TRANSLATION_Z

Added in API level 21
static val TRANSLATION_Z: Property<View!, Float!>!

A Property wrapper around the translationZ functionality handled by the View#setTranslationZ(float) and View#getTranslationZ() methods.

WINDOW_FOCUSED_STATE_SET

Added in API level 1
protected static val WINDOW_FOCUSED_STATE_SET: IntArray!

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.

X

Added in API level 14
static val X: Property<View!, Float!>!

A Property wrapper around the x functionality handled by the View#setX(float) and View#getX() methods.

Y

Added in API level 14
static val Y: Property<View!, Float!>!

A Property wrapper around the y functionality handled by the View#setY(float) and View#getY() methods.

Z

Added in API level 21
static val Z: Property<View!, Float!>!

A Property wrapper around the z functionality handled by the View#setZ(float) and View#getZ() methods.