Added in API level 1

Summary: Inherited XML Attrs | Constants | Inherited Constants | Inherited Fields | Ctors | Methods | Protected Methods | Inherited Methods

SurfaceView

---

Kotlin |Java

public class SurfaceView
extends View

java.lang.Object
↳	android.view.View
	↳	android.view.SurfaceView

Known direct subclasses GLSurfaceView, VideoView GLSurfaceView An implementation of SurfaceView that uses the dedicated surface for displaying OpenGL rendering.  VideoView Displays a video file.

---

Provides a dedicated drawing surface embedded inside of a view hierarchy. You can control the format of this surface and, if you like, its size; the SurfaceView takes care of placing the surface at the correct location on the screen

The surface is Z ordered so that it is behind the window holding its SurfaceView; the SurfaceView punches a hole in its window to allow its surface to be displayed. The view hierarchy will take care of correctly compositing with the Surface any siblings of the SurfaceView that would normally appear on top of it. This can be used to place overlays such as buttons on top of the Surface, though note however that it can have an impact on performance since a full alpha-blended composite will be performed each time the Surface changes.

The transparent region that makes the surface visible is based on the layout positions in the view hierarchy. If the post-layout transform properties are used to draw a sibling view on top of the SurfaceView, the view may not be properly composited with the surface.

Access to the underlying surface is provided via the SurfaceHolder interface, which can be retrieved by calling getHolder().

The Surface will be created for you while the SurfaceView's window is visible; you should implement SurfaceHolder.Callback.surfaceCreated and SurfaceHolder.Callback.surfaceDestroyed to discover when the Surface is created and destroyed as the window is shown and hidden.

One of the purposes of this class is to provide a surface in which a secondary thread can render into the screen. If you are going to use it this way, you need to be aware of some threading semantics:

• All SurfaceView and SurfaceHolder.Callback methods will be called from the thread running the SurfaceView's window (typically the main thread of the application). They thus need to correctly synchronize with any state that is also touched by the drawing thread.
• You must ensure that the drawing thread only touches the underlying Surface while it is valid -- between SurfaceHolder.Callback.surfaceCreated() and SurfaceHolder.Callback.surfaceDestroyed().

Note: Starting in platform version Build.VERSION_CODES.N, SurfaceView's window position is updated synchronously with other View rendering. This means that translating and scaling a SurfaceView on screen will not cause rendering artifacts. Such artifacts may occur on previous versions of the platform when its window is positioned asynchronously.

Note: Starting in platform version Build.VERSION_CODES.UPSIDE_DOWN_CAKE, SurfaceView will support arbitrary alpha blending. Prior platform versions ignored alpha values on the SurfaceView if they were between 0 and 1. If the SurfaceView is configured with Z-above, then the alpha is applied directly to the Surface. If the SurfaceView is configured with Z-below, then the alpha is applied to the hole punch directly. Note that when using Z-below, overlapping SurfaceViews may not blend properly as a consequence of not applying alpha to the surface content directly.

Summary

Inherited XML attributes

From class android.view.View android:accessibilityHeading Whether or not this view is a heading for accessibility purposes.  android:accessibilityLiveRegion Indicates to accessibility services whether the user should be notified when this view changes.  android:accessibilityPaneTitle The title this view should present to accessibility as a pane title.  android:accessibilityTraversalAfter Sets the id of a view that screen readers are requested to visit before this view.  android:accessibilityTraversalBefore Sets the id of a view that screen readers are requested to visit after this view.  android:allowClickWhenDisabled Whether or not allow clicks on disabled view.  android:alpha alpha property of the view, as a value between 0 (completely transparent) and 1 (completely opaque).  android:autoHandwritingEnabled Whether or not the auto handwriting initiation is enabled in this View.  android:autofillHints Describes the content of a view so that a autofill service can fill in the appropriate data.  android:autofilledHighlight Drawable to be drawn over the view to mark it as autofilled May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".  android:background A drawable to use as the background.  android:backgroundTint Tint to apply to the background.  android:backgroundTintMode Blending mode used to apply the background tint.  android:clickable Defines whether this view reacts to click events.  android:clipToOutline Whether the View's Outline should be used to clip the contents of the View.  android:contentDescription Defines text that briefly describes content of the view.  android:contextClickable Defines whether this view reacts to context click events.  android:defaultFocusHighlightEnabled Whether this View should use a default focus highlight when it gets focused but doesn't have R.attr.state_focused defined in its background.  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:elevation base z depth of the view.  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:forceHasOverlappingRendering Whether this view has elements that may overlap when drawn.  android:foreground Defines the drawable to draw over the content.  android:foregroundGravity Defines the gravity to apply to the foreground drawable.  android:foregroundTint Tint to apply to the foreground.  android:foregroundTintMode Blending mode used to apply the foreground tint.  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.findViewById() or Activity.findViewById().  android:importantForAccessibility Describes whether or not this view is important for accessibility.  android:importantForAutofill Hints the Android System whether the view node associated with this View should be included in a view structure used for autofill purposes.  android:importantForContentCapture Hints the Android System whether the view node associated with this View should be use for content capture purposes.  android:isCredential Boolean that hints the Android System that the view is credential and associated with CredentialManager May be a boolean value, such as "true" or "false".  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 View.FOCUS_DOWN If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.  android:nextFocusForward Defines the next view to give focus to when the next focus is View.FOCUS_FORWARD If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.  android:nextFocusLeft Defines the next view to give focus to when the next focus is View.FOCUS_LEFT.  android:nextFocusRight Defines the next view to give focus to when the next focus is View.FOCUS_RIGHT If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.  android:nextFocusUp Defines the next view to give focus to when the next focus is View.FOCUS_UP If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.  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 R.attr.padding.  android:paddingEnd Sets the padding, in pixels, of the end edge; see R.attr.padding.  android:paddingHorizontal Sets the padding, in pixels, of the left and right edges; see R.attr.padding.  android:paddingLeft Sets the padding, in pixels, of the left edge; see R.attr.padding.  android:paddingRight Sets the padding, in pixels, of the right edge; see R.attr.padding.  android:paddingStart Sets the padding, in pixels, of the start edge; see R.attr.padding.  android:paddingTop Sets the padding, in pixels, of the top edge; see R.attr.padding.  android:paddingVertical Sets the padding, in pixels, of the top and bottom edges; see R.attr.padding.  android:preferKeepClear Sets a preference to keep the bounds of this view clear from floating windows above this view's window.  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:screenReaderFocusable Whether this view should be treated as a focusable unit by screen reader accessibility tools.  android:scrollIndicators Defines which scroll indicators should be displayed when the view can be scrolled.  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.getTag() or searched for with View.findViewWithTag().  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:tooltipText Defines text displayed in a small popup window on hover or long press.  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
int	SURFACE_LIFECYCLE_DEFAULT Default lifecycle of the Surface owned by this SurfaceView.
int	SURFACE_LIFECYCLE_FOLLOWS_ATTACHMENT The Surface lifecycle is tied to SurfaceView attachment.
int	SURFACE_LIFECYCLE_FOLLOWS_VISIBILITY The Surface lifecycle is tied to SurfaceView visibility.

Inherited constants

From class android.view.View int ACCESSIBILITY_DATA_SENSITIVE_AUTO Automatically determine whether the view should only allow interactions from AccessibilityServices with the AccessibilityServiceInfo.isAccessibilityTool() property set to true. int ACCESSIBILITY_DATA_SENSITIVE_NO Allow interactions from all AccessibilityServices, regardless of their AccessibilityServiceInfo.isAccessibilityTool() property. int ACCESSIBILITY_DATA_SENSITIVE_YES Only allow interactions from AccessibilityServices with the AccessibilityServiceInfo.isAccessibilityTool() property set to true. int ACCESSIBILITY_LIVE_REGION_ASSERTIVE Live region mode specifying that accessibility services should immediately notify users of changes to this view. int ACCESSIBILITY_LIVE_REGION_NONE Live region mode specifying that accessibility services should not automatically announce changes to this view. int ACCESSIBILITY_LIVE_REGION_POLITE Live region mode specifying that accessibility services should notify users of changes to this view. int AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS Flag requesting you to add views that are marked as not important for autofill (see setImportantForAutofill(int)) to a ViewStructure. String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE Hint indicating that this view can be autofilled with a credit card expiration date. String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY Hint indicating that this view can be autofilled with a credit card expiration day. String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH Hint indicating that this view can be autofilled with a credit card expiration month. String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR Hint indicating that this view can be autofilled with a credit card expiration year. String AUTOFILL_HINT_CREDIT_CARD_NUMBER Hint indicating that this view can be autofilled with a credit card number. String AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE Hint indicating that this view can be autofilled with a credit card security code. String AUTOFILL_HINT_EMAIL_ADDRESS Hint indicating that this view can be autofilled with an email address. String AUTOFILL_HINT_NAME Hint indicating that this view can be autofilled with a user's real name. String AUTOFILL_HINT_PASSWORD Hint indicating that this view can be autofilled with a password. String AUTOFILL_HINT_PHONE Hint indicating that this view can be autofilled with a phone number. String AUTOFILL_HINT_POSTAL_ADDRESS Hint indicating that this view can be autofilled with a postal address. String AUTOFILL_HINT_POSTAL_CODE Hint indicating that this view can be autofilled with a postal code. String AUTOFILL_HINT_USERNAME Hint indicating that this view can be autofilled with a username. int AUTOFILL_TYPE_DATE Autofill type for a field that contains a date, which is represented by a long representing the number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT (see Date.getTime(). int AUTOFILL_TYPE_LIST Autofill type for a selection list field, which is filled by an int representing the element index inside the list (starting at 0). int AUTOFILL_TYPE_NONE Autofill type for views that cannot be autofilled. int AUTOFILL_TYPE_TEXT Autofill type for a text field, which is filled by a CharSequence. int AUTOFILL_TYPE_TOGGLE Autofill type for a togglable field, which is filled by a boolean. int CONTENT_SENSITIVITY_AUTO Content sensitivity is determined by the framework. int CONTENT_SENSITIVITY_NOT_SENSITIVE The view doesn't display sensitive content. int CONTENT_SENSITIVITY_SENSITIVE The view displays sensitive content. int DRAG_FLAG_ACCESSIBILITY_ACTION Flag indicating that the drag was initiated with AccessibilityNodeInfo.AccessibilityAction.ACTION_DRAG_START. int DRAG_FLAG_GLOBAL Flag indicating that a drag can cross window boundaries. int DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION When this flag is used with DRAG_FLAG_GLOBAL_URI_READ and/or DRAG_FLAG_GLOBAL_URI_WRITE, the URI permission grant can be persisted across device reboots until explicitly revoked with Context.revokeUriPermission(Uri, int) Context.revokeUriPermission}. int DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION When this flag is used with DRAG_FLAG_GLOBAL_URI_READ and/or DRAG_FLAG_GLOBAL_URI_WRITE, the URI permission grant applies to any URI that is a prefix match against the original granted URI. int DRAG_FLAG_GLOBAL_SAME_APPLICATION Flag indicating that a drag can cross window boundaries (within the same application). int DRAG_FLAG_GLOBAL_URI_READ When this flag is used with DRAG_FLAG_GLOBAL, the drag recipient will be able to request read access to the content URI(s) contained in the ClipData object. int DRAG_FLAG_GLOBAL_URI_WRITE When this flag is used with DRAG_FLAG_GLOBAL, the drag recipient will be able to request write access to the content URI(s) contained in the ClipData object. int DRAG_FLAG_HIDE_CALLING_TASK_ON_DRAG_START Flag indicating that this drag will result in the caller activity's task to be hidden for the duration of the drag, which means that the source activity will not receive drag events for the current drag gesture. int DRAG_FLAG_OPAQUE Flag indicating that the drag shadow will be opaque. int DRAG_FLAG_START_INTENT_SENDER_ON_UNHANDLED_DRAG Flag indicating that an unhandled drag should be delegated to the system to be started if no visible window wishes to handle the drop. int DRAWING_CACHE_QUALITY_AUTO This constant was deprecated in API level 28. 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 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. int DRAWING_CACHE_QUALITY_HIGH This constant was deprecated in API level 28. 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 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. int DRAWING_CACHE_QUALITY_LOW This constant was deprecated in API level 28. 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 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. int FIND_VIEWS_WITH_CONTENT_DESCRIPTION Find find views that contain the specified content description. int FIND_VIEWS_WITH_TEXT Find views that render the specified text. int FOCUSABLE This view wants keystrokes. int FOCUSABLES_ALL View flag indicating whether addFocusables(java.util.ArrayList, int, int) should add all focusable Views regardless if they are focusable in touch mode. int FOCUSABLES_TOUCH_MODE View flag indicating whether addFocusables(java.util.ArrayList, int, int) should add only Views focusable in touch mode. int FOCUSABLE_AUTO This view determines focusability automatically. int FOCUS_BACKWARD Use with focusSearch(int). int FOCUS_DOWN Use with focusSearch(int). int FOCUS_FORWARD Use with focusSearch(int). int FOCUS_LEFT Use with focusSearch(int). int FOCUS_RIGHT Use with focusSearch(int). int FOCUS_UP Use with focusSearch(int). int GONE This view is invisible, and it doesn't take any space for layout purposes. int HAPTIC_FEEDBACK_ENABLED View flag indicating whether this view should have haptic feedback enabled for events such as long presses. int IMPORTANT_FOR_ACCESSIBILITY_AUTO Automatically determine whether a view is important for accessibility. int IMPORTANT_FOR_ACCESSIBILITY_NO The view is not important for accessibility. int IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS The view is not important for accessibility, nor are any of its descendant views. int IMPORTANT_FOR_ACCESSIBILITY_YES The view is important for accessibility. int IMPORTANT_FOR_AUTOFILL_AUTO Automatically determine whether a view is important for autofill. int IMPORTANT_FOR_AUTOFILL_NO The view is not important for autofill, but its children (if any) will be traversed. int IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS The view is not important for autofill, and its children (if any) will not be traversed. int IMPORTANT_FOR_AUTOFILL_YES The view is important for autofill, and its children (if any) will be traversed. int IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS The view is important for autofill, but its children (if any) will not be traversed. int IMPORTANT_FOR_CONTENT_CAPTURE_AUTO Automatically determine whether a view is important for content capture. int IMPORTANT_FOR_CONTENT_CAPTURE_NO The view is not important for content capture, but its children (if any) will be traversed. int IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS The view is not important for content capture, and its children (if any) will not be traversed. int IMPORTANT_FOR_CONTENT_CAPTURE_YES The view is important for content capture, and its children (if any) will be traversed. int IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS The view is important for content capture, but its children (if any) will not be traversed. int INVISIBLE This view is invisible, but it still takes up space for layout purposes. int KEEP_SCREEN_ON View flag indicating that the screen should remain on while the window containing this view is visible to the user. int LAYER_TYPE_HARDWARE Indicates that the view has a hardware layer. int LAYER_TYPE_NONE Indicates that the view does not have a layer. int LAYER_TYPE_SOFTWARE Indicates that the view has a software layer. int LAYOUT_DIRECTION_INHERIT Horizontal layout direction of this view is inherited from its parent. int LAYOUT_DIRECTION_LOCALE Horizontal layout direction of this view is from deduced from the default language script for the locale. int LAYOUT_DIRECTION_LTR Horizontal layout direction of this view is from Left to Right. int LAYOUT_DIRECTION_RTL Horizontal layout direction of this view is from Right to Left. int MEASURED_HEIGHT_STATE_SHIFT Bit shift of MEASURED_STATE_MASK to get to the height bits for functions that combine both width and height into a single int, such as getMeasuredState() and the childState argument of resolveSizeAndState(int, int, int). int MEASURED_SIZE_MASK Bits of getMeasuredWidthAndState() and getMeasuredWidthAndState() that provide the actual measured size. int MEASURED_STATE_MASK Bits of getMeasuredWidthAndState() and getMeasuredWidthAndState() that provide the additional state bits. int MEASURED_STATE_TOO_SMALL Bit of getMeasuredWidthAndState() and getMeasuredWidthAndState() that indicates the measured size is smaller that the space the view would like to have. int NOT_FOCUSABLE This view does not want keystrokes. int NO_ID Used to mark a View that has no ID. int OVER_SCROLL_ALWAYS Always allow a user to over-scroll this view, provided it is a view that can scroll. int OVER_SCROLL_IF_CONTENT_SCROLLS Allow a user to over-scroll this view only if the content is large enough to meaningfully scroll, provided it is a view that can scroll. int OVER_SCROLL_NEVER Never allow a user to over-scroll this view. float REQUESTED_FRAME_RATE_CATEGORY_DEFAULT float REQUESTED_FRAME_RATE_CATEGORY_HIGH float REQUESTED_FRAME_RATE_CATEGORY_LOW float REQUESTED_FRAME_RATE_CATEGORY_NORMAL float REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE int SCREEN_STATE_OFF Indicates that the screen has changed state and is now off. int SCREEN_STATE_ON Indicates that the screen has changed state and is now on. int SCROLLBARS_INSIDE_INSET The scrollbar style to display the scrollbars inside the padded area, increasing the padding of the view. int SCROLLBARS_INSIDE_OVERLAY The scrollbar style to display the scrollbars inside the content area, without increasing the padding. int SCROLLBARS_OUTSIDE_INSET The scrollbar style to display the scrollbars at the edge of the view, increasing the padding of the view. int SCROLLBARS_OUTSIDE_OVERLAY The scrollbar style to display the scrollbars at the edge of the view, without increasing the padding. int SCROLLBAR_POSITION_DEFAULT Position the scroll bar at the default position as determined by the system. int SCROLLBAR_POSITION_LEFT Position the scroll bar along the left edge. int SCROLLBAR_POSITION_RIGHT Position the scroll bar along the right edge. int SCROLL_AXIS_HORIZONTAL Indicates scrolling along the horizontal axis. int SCROLL_AXIS_NONE Indicates no axis of view scrolling. int SCROLL_AXIS_VERTICAL Indicates scrolling along the vertical axis. int SCROLL_CAPTURE_HINT_AUTO The content of this view will be considered for scroll capture if scrolling is possible. int SCROLL_CAPTURE_HINT_EXCLUDE Explicitly exclude this view as a potential scroll capture target. int SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS Explicitly exclude all children of this view as potential scroll capture targets. int SCROLL_CAPTURE_HINT_INCLUDE Explicitly include this view as a potential scroll capture target. int SCROLL_INDICATOR_BOTTOM Scroll indicator direction for the bottom edge of the view. int SCROLL_INDICATOR_END Scroll indicator direction for the ending edge of the view. int SCROLL_INDICATOR_LEFT Scroll indicator direction for the left edge of the view. int SCROLL_INDICATOR_RIGHT Scroll indicator direction for the right edge of the view. int SCROLL_INDICATOR_START Scroll indicator direction for the starting edge of the view. int SCROLL_INDICATOR_TOP Scroll indicator direction for the top edge of the view. int SOUND_EFFECTS_ENABLED View flag indicating whether this view should have sound effects enabled for events such as clicking and touching. int STATUS_BAR_HIDDEN This constant was deprecated in API level 15. Use SYSTEM_UI_FLAG_LOW_PROFILE instead. int STATUS_BAR_VISIBLE This constant was deprecated in API level 15. Use SYSTEM_UI_FLAG_VISIBLE instead. int SYSTEM_UI_FLAG_FULLSCREEN This constant was deprecated in API level 30. Use WindowInsetsController.hide(int) with Type.statusBars() instead. int SYSTEM_UI_FLAG_HIDE_NAVIGATION This constant was deprecated in API level 30. Use WindowInsetsController.hide(int) with Type.navigationBars() instead. int SYSTEM_UI_FLAG_IMMERSIVE This constant was deprecated in API level 30. Use WindowInsetsController.BEHAVIOR_DEFAULT instead. int SYSTEM_UI_FLAG_IMMERSIVE_STICKY This constant was deprecated in API level 30. Use WindowInsetsController.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE instead. int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN This constant was deprecated in API level 30. For floating windows, use LayoutParams.setFitInsetsTypes(int) with Type.statusBars() ()}. For non-floating windows that fill the screen, call Window.setDecorFitsSystemWindows(boolean) with false. int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION This constant was deprecated in API level 30. For floating windows, use LayoutParams.setFitInsetsTypes(int) with Type.navigationBars(). For non-floating windows that fill the screen, call Window.setDecorFitsSystemWindows(boolean) with false. int SYSTEM_UI_FLAG_LAYOUT_STABLE This constant was deprecated in API level 30. Use WindowInsets.getInsetsIgnoringVisibility(int) instead to retrieve insets that don't change when system bars change visibility state. int SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR This constant was deprecated in API level 30. Use WindowInsetsController.APPEARANCE_LIGHT_NAVIGATION_BARS instead. int SYSTEM_UI_FLAG_LIGHT_STATUS_BAR This constant was deprecated in API level 30. Use WindowInsetsController.APPEARANCE_LIGHT_STATUS_BARS instead. int SYSTEM_UI_FLAG_LOW_PROFILE This constant was deprecated in API level 30. 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(). int SYSTEM_UI_FLAG_VISIBLE This constant was deprecated in API level 30. SystemUiVisibility flags are deprecated. Use WindowInsetsController instead. int SYSTEM_UI_LAYOUT_FLAGS This constant was deprecated in API level 30. System UI layout flags are deprecated. int TEXT_ALIGNMENT_CENTER Center the paragraph, e.g. ALIGN_CENTER. int TEXT_ALIGNMENT_GRAVITY Default for the root view. int TEXT_ALIGNMENT_INHERIT Default text alignment. int TEXT_ALIGNMENT_TEXT_END Align to the end of the paragraph, e.g. ALIGN_OPPOSITE. int TEXT_ALIGNMENT_TEXT_START Align to the start of the paragraph, e.g. ALIGN_NORMAL. int TEXT_ALIGNMENT_VIEW_END Align to the end of the view, which is ALIGN_RIGHT if the view's resolved layoutDirection is LTR, and ALIGN_LEFT otherwise. int TEXT_ALIGNMENT_VIEW_START Align to the start of the view, which is ALIGN_LEFT if the view's resolved layoutDirection is LTR, and ALIGN_RIGHT otherwise. int TEXT_DIRECTION_ANY_RTL Text direction is using "any-RTL" algorithm. int TEXT_DIRECTION_FIRST_STRONG Text direction is using "first strong algorithm". int TEXT_DIRECTION_FIRST_STRONG_LTR Text direction is using "first strong algorithm". int TEXT_DIRECTION_FIRST_STRONG_RTL Text direction is using "first strong algorithm". int TEXT_DIRECTION_INHERIT Text direction is inherited through ViewGroup int TEXT_DIRECTION_LOCALE Text direction is coming from the system Locale. int TEXT_DIRECTION_LTR Text direction is forced to LTR. int TEXT_DIRECTION_RTL Text direction is forced to RTL. String VIEW_LOG_TAG The logging tag used by this class with android.util.Log. int VISIBLE This view is visible.

Inherited fields

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

Public constructors
SurfaceView(Context context)
SurfaceView(Context context, AttributeSet attrs)
SurfaceView(Context context, AttributeSet attrs, int defStyleAttr)
SurfaceView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Public methods
void	applyTransactionToFrame(SurfaceControl.Transaction transaction) Adds a transaction that would be applied synchronously with displaying the SurfaceView's next frame.
void	draw(Canvas canvas) Manually render this view (and all of its children) to the given Canvas.
boolean	gatherTransparentRegion(Region region) This is used by the ViewRoot to perform an optimization when the view hierarchy contains one or several SurfaceView.
SurfaceHolder	getHolder() Return the SurfaceHolder providing access and control over this SurfaceView's underlying surface.
IBinder	getHostToken() This method was deprecated in API level 35. Use AttachedSurfaceControl.getInputTransferToken() instead.
int	getImportantForAccessibility() Gets the mode for determining whether this View is important for accessibility.
SurfaceControl	getSurfaceControl() Return a SurfaceControl which can be used for parenting Surfaces to this SurfaceView.
boolean	hasOverlappingRendering() Returns whether this View has content which overlaps.
void	setAlpha(float alpha) 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.
void	setChildSurfacePackage(SurfaceControlViewHost.SurfacePackage p) Displays the view-hierarchy embedded within a SurfaceControlViewHost.SurfacePackage within this SurfaceView.
void	setClipBounds(Rect clipBounds) Sets a rectangular area on this view to which the view will be clipped when it is drawn.
void	setDesiredHdrHeadroom(float desiredHeadroom) Sets the desired amount of HDR headroom to be used when HDR content is presented on this SurfaceView.
void	setSecure(boolean isSecure) Control whether the surface view's content should be treated as secure, preventing it from appearing in screenshots or from being viewed on non-secure displays.
void	setSurfaceLifecycle(int lifecycleStrategy) Controls the lifecycle of the Surface owned by this SurfaceView.
void	setVisibility(int visibility) Set the visibility state of this view.
void	setZOrderMediaOverlay(boolean isMediaOverlay) Control whether the surface view's surface is placed on top of another regular surface view in the window (but still behind the window itself).
void	setZOrderOnTop(boolean onTop) Control whether the surface view's surface is placed on top of its window.

Protected methods
void	dispatchDraw(Canvas canvas) Called by draw to draw the child views.
void	onAttachedToWindow() This is called when the view is attached to a window.
void	onDetachedFromWindow() This is called when the view is detached from a window.
void	onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) Called by the view system when the focus state of this view changes.
void	onMeasure(int widthMeasureSpec, int heightMeasureSpec) Measure the view and its content to determine the measured width and the measured height.
boolean	onSetAlpha(int alpha) Invoked if there is a Transform that involves alpha.
void	onWindowVisibilityChanged(int visibility) Called when the window containing has change its visibility (between GONE, INVISIBLE, and VISIBLE).

Inherited methods
From class android.view.View void addChildrenForAccessibility(ArrayList<View> outChildren) Adds the children of this View relevant for accessibility to the given list as output. void addExtraDataToAccessibilityNodeInfo(AccessibilityNodeInfo info, String extraDataKey, Bundle arguments) Adds extra data to an AccessibilityNodeInfo based on an explicit request for the additional data. void addFocusables(ArrayList<View> views, int direction) Add any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views. void addFocusables(ArrayList<View> views, int direction, int focusableMode) Adds any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views. void addKeyboardNavigationClusters(Collection<View> views, int direction) 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. void addOnAttachStateChangeListener(View.OnAttachStateChangeListener listener) Add a listener for attach state changes. void addOnLayoutChangeListener(View.OnLayoutChangeListener listener) Add a listener that will be called when the bounds of the view change due to layout processing. void addOnUnhandledKeyEventListener(View.OnUnhandledKeyEventListener listener) Adds a listener which will receive unhandled KeyEvents. void addTouchables(ArrayList<View> views) Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views. ViewPropertyAnimator animate() This method returns a ViewPropertyAnimator object, which can be used to animate specific properties on this View. void announceForAccessibility(CharSequence text) This method was deprecated in API level Baklava. Use one of the methods described in the documentation above to semantically describe UI instead of using an announcement, as accessibility services may choose to ignore events dispatched with this method. void autofill(AutofillValue value) Automatically fills the content of this view with the value. void autofill(SparseArray<AutofillValue> values) Automatically fills the content of the virtual children within this view. boolean awakenScrollBars(int startDelay, boolean invalidate) Trigger the scrollbars to draw. boolean awakenScrollBars(int startDelay) Trigger the scrollbars to draw. boolean awakenScrollBars() Trigger the scrollbars to draw. void bringToFront() Change the view's z order in the tree, so it's on top of other sibling views. void buildDrawingCache(boolean autoScale) This method was deprecated in API level 28. 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 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. void buildDrawingCache() This method was deprecated in API level 28. 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 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. void buildLayer() Forces this view's layer to be created and this view to be rendered into its layer. boolean callOnClick() Directly call any attached OnClickListener. boolean canResolveLayoutDirection() Check if layout direction resolution can be done. boolean canResolveTextAlignment() Check if text alignment resolution can be done. boolean canResolveTextDirection() Check if text direction resolution can be done. boolean canScrollHorizontally(int direction) Check if this view can be scrolled horizontally in a certain direction. boolean canScrollVertically(int direction) Check if this view can be scrolled vertically in a certain direction. final void cancelDragAndDrop() Cancels an ongoing drag and drop operation. void cancelLongPress() Cancels a pending long press. final void cancelPendingInputEvents() Cancel any deferred high-level input events that were previously posted to the event queue. boolean checkInputConnectionProxy(View view) Called by the InputMethodManager when a view who is not the current input connection target is trying to make a call on the manager. void clearAnimation() Cancels any animations for this view. void clearFocus() Called when this view wants to give up focus. void clearPendingCredentialRequest() Clears the request and callback previously set through View.setPendingCredentialRequest. void clearViewTranslationCallback() Clear the ViewTranslationCallback from this view. static int combineMeasuredStates(int curState, int newState) Merge two states as returned by getMeasuredState(). int computeHorizontalScrollExtent() Compute the horizontal extent of the horizontal scrollbar's thumb within the horizontal range. int computeHorizontalScrollOffset() Compute the horizontal offset of the horizontal scrollbar's thumb within the horizontal range. int computeHorizontalScrollRange() Compute the horizontal range that the horizontal scrollbar represents. void computeScroll() Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary. WindowInsets computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets) Compute insets that should be consumed by this view and the ones that should propagate to those under it. int computeVerticalScrollExtent() Compute the vertical extent of the vertical scrollbar's thumb within the vertical range. int computeVerticalScrollOffset() Compute the vertical offset of the vertical scrollbar's thumb within the horizontal range. int computeVerticalScrollRange() Compute the vertical range that the vertical scrollbar represents. AccessibilityNodeInfo createAccessibilityNodeInfo() Returns an AccessibilityNodeInfo representing this view from the point of view of an AccessibilityService. void createContextMenu(ContextMenu menu) Show the context menu for this view. void destroyDrawingCache() This method was deprecated in API level 28. 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 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. WindowInsets dispatchApplyWindowInsets(WindowInsets insets) Request to apply the given window insets to this view or another view in its subtree. boolean dispatchCapturedPointerEvent(MotionEvent event) Pass a captured pointer event down to the focused view. void dispatchConfigurationChanged(Configuration newConfig) Dispatch a notification about a resource configuration change down the view hierarchy. void dispatchCreateViewTranslationRequest(Map<AutofillId, long[]> viewIds, int[] supportedFormats, TranslationCapability capability, List<ViewTranslationRequest> requests) Dispatch to collect the ViewTranslationRequests for translation purpose by traversing the hierarchy when the app requests ui translation. void dispatchDisplayHint(int hint) Dispatch a hint about whether this view is displayed. boolean dispatchDragEvent(DragEvent event) Detects if this View is enabled and has a drag event listener. void dispatchDraw(Canvas canvas) Called by draw to draw the child views. void dispatchDrawableHotspotChanged(float x, float y) Dispatches drawableHotspotChanged to all of this View's children. void dispatchFinishTemporaryDetach() Dispatch onFinishTemporaryDetach() to this View and its direct children if this is a container View. boolean dispatchGenericFocusedEvent(MotionEvent event) Dispatch a generic motion event to the currently focused view. boolean dispatchGenericMotionEvent(MotionEvent event) Dispatch a generic motion event. boolean dispatchGenericPointerEvent(MotionEvent event) Dispatch a generic motion event to the view under the first pointer. boolean dispatchHoverEvent(MotionEvent event) Dispatch a hover event. boolean dispatchKeyEvent(KeyEvent event) Dispatch a key event to the next view on the focus path. boolean dispatchKeyEventPreIme(KeyEvent event) Dispatch a key event before it is processed by any input method associated with the view hierarchy. boolean dispatchKeyShortcutEvent(KeyEvent event) Dispatches a key shortcut event. boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed) Dispatch a fling to a nested scrolling parent. boolean dispatchNestedPreFling(float velocityX, float velocityY) Dispatch a fling to a nested scrolling parent before it is processed by this view. boolean dispatchNestedPrePerformAccessibilityAction(int action, Bundle arguments) Report an accessibility action to this view's parents for delegated processing. boolean dispatchNestedPreScroll(int dx, int dy, int[] consumed, int[] offsetInWindow) Dispatch one step of a nested scroll in progress before this view consumes any portion of it. boolean dispatchNestedScroll(int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int[] offsetInWindow) Dispatch one step of a nested scroll in progress. void dispatchPointerCaptureChanged(boolean hasCapture) boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) Dispatches an AccessibilityEvent to the View to add the text content of the view and its children. void dispatchProvideAutofillStructure(ViewStructure structure, int flags) Dispatches creation of a ViewStructures for autofill purposes down the hierarchy, when an Assist structure is being created as part of an autofill request. void dispatchProvideStructure(ViewStructure structure) Dispatch creation of ViewStructure down the hierarchy. void dispatchRestoreInstanceState(SparseArray<Parcelable> container) Called by restoreHierarchyState(android.util.SparseArray) to retrieve the state for this view and its children. void dispatchSaveInstanceState(SparseArray<Parcelable> container) Called by saveHierarchyState(android.util.SparseArray) to store the state for this view and its children. void dispatchScrollCaptureSearch(Rect localVisibleRect, Point windowOffset, Consumer<ScrollCaptureTarget> targets) Dispatch a scroll capture search request down the view hierarchy. void dispatchSetActivated(boolean activated) Dispatch setActivated to all of this View's children. void dispatchSetPressed(boolean pressed) Dispatch setPressed to all of this View's children. void dispatchSetSelected(boolean selected) Dispatch setSelected to all of this View's children. void dispatchStartTemporaryDetach() Dispatch onStartTemporaryDetach() to this View and its direct children if this is a container View. void dispatchSystemUiVisibilityChanged(int visibility) This method was deprecated in API level 30. Use WindowInsets.isVisible(int) to find out about system bar visibilities by setting a OnApplyWindowInsetsListener on this view. boolean dispatchTouchEvent(MotionEvent event) Pass the touch screen motion event down to the target view, or this view if it is the target. boolean dispatchTrackballEvent(MotionEvent event) Pass a trackball motion event down to the focused view. boolean dispatchUnhandledMove(View focused, int direction) This method is the last chance for the focused view and its ancestors to respond to an arrow key. void dispatchVisibilityChanged(View changedView, int visibility) Dispatch a view visibility change down the view hierarchy. void dispatchWindowFocusChanged(boolean hasFocus) Called when the window containing this view gains or loses window focus. void dispatchWindowInsetsAnimationEnd(WindowInsetsAnimation animation) Dispatches WindowInsetsAnimation.Callback.onEnd(WindowInsetsAnimation) when Window Insets animation ends. void dispatchWindowInsetsAnimationPrepare(WindowInsetsAnimation animation) Dispatches WindowInsetsAnimation.Callback.onPrepare(WindowInsetsAnimation) when Window Insets animation is being prepared. WindowInsets dispatchWindowInsetsAnimationProgress(WindowInsets insets, List<WindowInsetsAnimation> runningAnimations) Dispatches WindowInsetsAnimation.Callback.onProgress(WindowInsets, List) when Window Insets animation makes progress. WindowInsetsAnimation.Bounds dispatchWindowInsetsAnimationStart(WindowInsetsAnimation animation, WindowInsetsAnimation.Bounds bounds) Dispatches WindowInsetsAnimation.Callback.onStart(WindowInsetsAnimation, Bounds) when Window Insets animation is started. void dispatchWindowSystemUiVisiblityChanged(int visible) This method was deprecated in API level 30. SystemUiVisibility flags are deprecated. Use WindowInsetsController instead. void dispatchWindowVisibilityChanged(int visibility) Dispatch a window visibility change down the view hierarchy. void draw(Canvas canvas) Manually render this view (and all of its children) to the given Canvas. void drawableHotspotChanged(float x, float y) This function is called whenever the view hotspot changes and needs to be propagated to drawables or child views managed by the view. void drawableStateChanged() This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown. View findFocus() Find the view in the hierarchy rooted at this view that currently has focus. final OnBackInvokedDispatcher findOnBackInvokedDispatcher() Walk up the View hierarchy to find the nearest OnBackInvokedDispatcher. final <T extends View> T findViewById(int id) 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. final <T extends View> T findViewWithTag(Object tag) Look for a child view with the given tag. void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags) Finds the Views that contain given text. boolean fitSystemWindows(Rect insets) This method was deprecated in API level 20. 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. View focusSearch(int direction) Find the nearest view in the specified direction that can take focus. void forceHasOverlappingRendering(boolean hasOverlappingRendering) Sets the behavior for overlapping rendering for this view (see hasOverlappingRendering() for more details on this behavior). void forceLayout() Forces this view to be laid out during the next layout pass. boolean gatherTransparentRegion(Region region) This is used by the ViewRoot to perform an optimization when the view hierarchy contains one or several SurfaceView. void generateDisplayHash(String hashAlgorithm, Rect bounds, Executor executor, DisplayHashResultCallback callback) Called to generate a DisplayHash for this view. static int generateViewId() Generate a value suitable for use in setId(int). CharSequence getAccessibilityClassName() Return the class name of this object to be used for accessibility purposes. View.AccessibilityDelegate getAccessibilityDelegate() Returns the delegate for implementing accessibility support via composition. int getAccessibilityLiveRegion() Gets the live region mode for this View. AccessibilityNodeProvider getAccessibilityNodeProvider() Gets the provider for managing a virtual view hierarchy rooted at this View and reported to AccessibilityServices that explore the window content. CharSequence getAccessibilityPaneTitle() Get the title of the pane for purposes of accessibility. int getAccessibilityTraversalAfter() Gets the id of a view after which this one is visited in accessibility traversal. int getAccessibilityTraversalBefore() Gets the id of a view before which this one is visited in accessibility traversal. String getAllowedHandwritingDelegatePackageName() Returns the allowed package for delegate editor views for which this view may act as a handwriting delegator, as set by setAllowedHandwritingDelegatePackage(String). String getAllowedHandwritingDelegatorPackageName() Returns the allowed package for views which may act as a handwriting delegator for this delegate editor view, as set by setAllowedHandwritingDelegatorPackage(String). float getAlpha() The opacity of the view. Animation getAnimation() Get the animation currently associated with this view. Matrix getAnimationMatrix() Return the current transformation matrix of the view. IBinder getApplicationWindowToken() Retrieve a unique token identifying the top-level "real" window of the window that this view is attached to. int[] getAttributeResolutionStack(int attribute) Returns the ordered list of resource ID that are considered when resolving attribute values for this View. Map<Integer, Integer> getAttributeSourceResourceMap() Returns the mapping of attribute resource ID to source resource ID where the attribute value was set. String[] getAutofillHints() Gets the hints that help an AutofillService determine how to autofill the view with the user's data. final AutofillId getAutofillId() Gets the unique, logical identifier of this view in the activity, for autofill purposes. int getAutofillType() Describes the autofill type of this view, so an AutofillService can create the proper AutofillValue when autofilling the view. AutofillValue getAutofillValue() Gets the View's current autofill value. Drawable getBackground() Gets the background drawable BlendMode getBackgroundTintBlendMode() Return the blending mode used to apply the tint to the background drawable, if specified. ColorStateList getBackgroundTintList() Return the tint applied to the background drawable, if specified. PorterDuff.Mode getBackgroundTintMode() Return the blending mode used to apply the tint to the background drawable, if specified. int getBaseline() Return the offset of the widget's text baseline from the widget's top boundary. final int getBottom() Bottom position of this view relative to its parent. float getBottomFadingEdgeStrength() Returns the strength, or intensity, of the bottom faded edge. int getBottomPaddingOffset() Amount by which to extend the bottom fading region. float getCameraDistance() Gets the distance along the Z axis from the camera to this view. boolean getClipBounds(Rect outRect) 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. Rect getClipBounds() Returns a copy of the current clipBounds. final boolean getClipToOutline() Returns whether the Outline should be used to clip the contents of the View. final ContentCaptureSession getContentCaptureSession() Gets the session used to notify content capture events. CharSequence getContentDescription() Returns the View's content description. final int getContentSensitivity() Gets content sensitivity mode to determine whether this view displays sensitive content. final Context getContext() Returns the context the view is running in, through which it can access the current theme, resources, etc. ContextMenu.ContextMenuInfo getContextMenuInfo() Views should implement this if they have extra information to associate with the context menu. final boolean getDefaultFocusHighlightEnabled() Returns whether this View should use a default focus highlight when it gets focused but doesn't have R.attr.state_focused defined in its background. static int getDefaultSize(int size, int measureSpec) Utility to return a default size. Display getDisplay() Gets the logical display to which the view's window has been attached. final int[] getDrawableState() Return an array of resource IDs of the drawable states representing the current state of the view. Bitmap getDrawingCache() This method was deprecated in API level 28. 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 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. Bitmap getDrawingCache(boolean autoScale) This method was deprecated in API level 28. 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 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. int getDrawingCacheBackgroundColor() This method was deprecated in API level 28. 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 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. int getDrawingCacheQuality() This method was deprecated in API level 28. 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 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. void getDrawingRect(Rect outRect) Return the visible drawing bounds of your view. long getDrawingTime() Return the time at which the drawing of the view hierarchy started. float getElevation() The base elevation of this view relative to its parent, in pixels. int getExplicitStyle() Returns the resource ID for the style specified using style="..." in the AttributeSet's backing XML element or Resources.ID_NULL otherwise if not specified or otherwise not applicable. boolean getFilterTouchesWhenObscured() Gets whether the framework should discard touches when the view's window is obscured by another visible window at the touched location. boolean getFitsSystemWindows() Check for state of setFitsSystemWindows(boolean). int getFocusable() Returns the focusable setting for this view. ArrayList<View> getFocusables(int direction) Find and return all focusable views that are descendants of this view, possibly including this view if it is focusable itself. void getFocusedRect(Rect r) 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. Drawable getForeground() Returns the drawable used as the foreground of this View. int getForegroundGravity() Describes how the foreground is positioned. BlendMode getForegroundTintBlendMode() Return the blending mode used to apply the tint to the foreground drawable, if specified. ColorStateList getForegroundTintList() Return the tint applied to the foreground drawable, if specified. PorterDuff.Mode getForegroundTintMode() Return the blending mode used to apply the tint to the foreground drawable, if specified. float getFrameContentVelocity() Get the current velocity of the View. final boolean getGlobalVisibleRect(Rect r) Sets r to the coordinates of the non-clipped area of this view in the coordinate space of the view's root view. boolean getGlobalVisibleRect(Rect r, Point globalOffset) Sets r to the coordinates of the non-clipped area of this view in the coordinate space of the view's root view. Handler getHandler() float getHandwritingBoundsOffsetBottom() Return the amount of offset applied to the bottom edge of this view's handwriting bounds, in the unit of pixel. float getHandwritingBoundsOffsetLeft() Return the amount of offset applied to the left edge of this view's handwriting bounds, in the unit of pixel. float getHandwritingBoundsOffsetRight() Return the amount of offset applied to the right edge of this view's handwriting bounds, in the unit of pixel. float getHandwritingBoundsOffsetTop() Return the amount of offset applied to the top edge of this view's handwriting bounds, in the unit of pixel. int getHandwritingDelegateFlags() Returns flags configuring the handwriting delegation behavior for this delegate editor view, as set by setHandwritingDelegateFlags(int). Runnable getHandwritingDelegatorCallback() Returns the callback set by setHandwritingDelegatorCallback(Runnable) which should be called when a stylus MotionEvent occurs within this view's bounds. final boolean getHasOverlappingRendering() Returns the value for overlapping rendering that is used internally. final int getHeight() Return the height of your view. void getHitRect(Rect outRect) Hit rectangle in parent's coordinates int getHorizontalFadingEdgeLength() Returns the size of the horizontal faded edges used to indicate that more content in this view is visible. int getHorizontalScrollbarHeight() Returns the height of the horizontal scrollbar. Drawable getHorizontalScrollbarThumbDrawable() Returns the currently configured Drawable for the thumb of the horizontal scroll bar if it exists, null otherwise. Drawable getHorizontalScrollbarTrackDrawable() Returns the currently configured Drawable for the track of the horizontal scroll bar if it exists, null otherwise. int getId() Returns this view's identifier. int getImportantForAccessibility() Gets the mode for determining whether this View is important for accessibility. int getImportantForAutofill() Gets the mode for determining whether this view is important for autofill. int getImportantForContentCapture() Gets the mode for determining whether this view is important for content capture. boolean getKeepScreenOn() Returns whether the screen should remain on, corresponding to the current value of KEEP_SCREEN_ON. KeyEvent.DispatcherState getKeyDispatcherState() Return the global KeyEvent.DispatcherState for this view's window. int getLabelFor() Gets the id of a view for which this view serves as a label for accessibility purposes. int getLayerType() Indicates what type of layer is currently associated with this view. int getLayoutDirection() Returns the resolved layout direction for this view. ViewGroup.LayoutParams getLayoutParams() Get the LayoutParams associated with this view. final int getLeft() Left position of this view relative to its parent. float getLeftFadingEdgeStrength() Returns the strength, or intensity, of the left faded edge. int getLeftPaddingOffset() Amount by which to extend the left fading region. final boolean getLocalVisibleRect(Rect r) Sets r to the coordinates of the non-clipped area of this view relative to the top left corner of the view. void getLocationInSurface(int[] location) Gets the coordinates of this view in the coordinate space of the Surface that contains the view. void getLocationInWindow(int[] outLocation) Gets the coordinates of this view in the coordinate space of the window that contains the view, irrespective of system decorations. void getLocationOnScreen(int[] outLocation) Gets the coordinates of this view in the coordinate space of the device screen, irrespective of system decorations and whether the system is in multi-window mode. Matrix getMatrix() The transform matrix of this view, which is calculated based on the current rotation, scale, and pivot properties. final int getMeasuredHeight() Like getMeasuredHeightAndState(), but only returns the raw height component (that is the result is masked by MEASURED_SIZE_MASK). final int getMeasuredHeightAndState() Return the full height measurement information for this view as computed by the most recent call to measure(int, int). final int getMeasuredState() Return only the state bits of getMeasuredWidthAndState() and getMeasuredHeightAndState(), combined into one integer. final int getMeasuredWidth() Like getMeasuredWidthAndState(), but only returns the raw width component (that is the result is masked by MEASURED_SIZE_MASK). final int getMeasuredWidthAndState() Return the full width measurement information for this view as computed by the most recent call to measure(int, int). int getMinimumHeight() Returns the minimum height of the view. int getMinimumWidth() Returns the minimum width of the view. int getNextClusterForwardId() Gets the id of the root of the next keyboard navigation cluster. int getNextFocusDownId() Gets the id of the view to use when the next focus is FOCUS_DOWN. int getNextFocusForwardId() Gets the id of the view to use when the next focus is FOCUS_FORWARD. int getNextFocusLeftId() Gets the id of the view to use when the next focus is FOCUS_LEFT. int getNextFocusRightId() Gets the id of the view to use when the next focus is FOCUS_RIGHT. int getNextFocusUpId() Gets the id of the view to use when the next focus is FOCUS_UP. View.OnFocusChangeListener getOnFocusChangeListener() Returns the focus-change callback registered for this view. int getOutlineAmbientShadowColor() ViewOutlineProvider getOutlineProvider() Returns the current ViewOutlineProvider of the view, which generates the Outline that defines the shape of the shadow it casts, and enables outline clipping. int getOutlineSpotShadowColor() int getOverScrollMode() Returns the over-scroll mode for this view. ViewOverlay getOverlay() Returns the overlay for this view, creating it if it does not yet exist. int getPaddingBottom() Returns the bottom padding of this view. int getPaddingEnd() Returns the end padding of this view depending on its resolved layout direction. int getPaddingLeft() Returns the left padding of this view. int getPaddingRight() Returns the right padding of this view. int getPaddingStart() Returns the start padding of this view depending on its resolved layout direction. int getPaddingTop() Returns the top padding of this view. final ViewParent getParent() Gets the parent of this view. ViewParent getParentForAccessibility() Gets the parent for accessibility purposes. final OutcomeReceiver<GetCredentialResponse, GetCredentialException> getPendingCredentialCallback() Returns the callback that has previously been set up on this view through the setPendingCredentialRequest(GetCredentialRequest, OutcomeReceiver) API. final GetCredentialRequest getPendingCredentialRequest() Returns the GetCredentialRequest associated with the view. float getPivotX() The x location of the point around which the view is rotated and scaled. float getPivotY() The y location of the point around which the view is rotated and scaled. PointerIcon getPointerIcon() Gets the mouse pointer icon for the current view. final List<Rect> getPreferKeepClearRects() String[] getReceiveContentMimeTypes() Returns the MIME types accepted by performReceiveContent(ContentInfo) for this view, as configured via setOnReceiveContentListener(String, OnReceiveContentListener). float getRequestedFrameRate() Get the current preferred frame rate of the View. Resources getResources() Returns the resources associated with this view. final boolean getRevealOnFocusHint() Returns this view's preference for reveal behavior when it gains focus. final int getRight() Right position of this view relative to its parent. float getRightFadingEdgeStrength() Returns the strength, or intensity, of the right faded edge. int getRightPaddingOffset() Amount by which to extend the right fading region. AttachedSurfaceControl getRootSurfaceControl() The AttachedSurfaceControl itself is not a View, it is just the interface to the windowing-system object that contains the entire view hierarchy. View getRootView() Finds the topmost view in the current view hierarchy. WindowInsets getRootWindowInsets() Provide original WindowInsets that are dispatched to the view hierarchy. float getRotation() The degrees that the view is rotated around the pivot point. float getRotationX() The degrees that the view is rotated around the horizontal axis through the pivot point. float getRotationY() The degrees that the view is rotated around the vertical axis through the pivot point. float getScaleX() The amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width. float getScaleY() The amount that the view is scaled in y around the pivot point, as a proportion of the view's unscaled height. int getScrollBarDefaultDelayBeforeFade() Returns the delay before scrollbars fade. int getScrollBarFadeDuration() Returns the scrollbar fade duration. int getScrollBarSize() Returns the scrollbar size. int getScrollBarStyle() Returns the current scrollbar style. int getScrollCaptureHint() Returns the current scroll capture hint for this view. int getScrollIndicators() Returns a bitmask representing the enabled scroll indicators. final int getScrollX() Return the scrolled left position of this view. final int getScrollY() Return the scrolled top position of this view. int getSolidColor() Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges. int getSourceLayoutResId() A View can be inflated from an XML layout. final CharSequence getStateDescription() Returns the View's state description. StateListAnimator getStateListAnimator() Returns the current StateListAnimator if exists. int getSuggestedMinimumHeight() Returns the suggested minimum height that the view should use. int getSuggestedMinimumWidth() Returns the suggested minimum width that the view should use. List<Rect> getSystemGestureExclusionRects() Retrieve the list of areas within this view's post-layout coordinate space where the system should not intercept touch or other pointing device gestures. int getSystemUiVisibility() This method was deprecated in API level 30. SystemUiVisibility flags are deprecated. Use WindowInsetsController instead. Object getTag() Returns this view's tag. Object getTag(int key) Returns the tag associated with this view and the specified key. int getTextAlignment() Return the resolved text alignment. int getTextDirection() Return the resolved text direction. CharSequence getTooltipText() Returns the view's tooltip text. final int getTop() Top position of this view relative to its parent. float getTopFadingEdgeStrength() Returns the strength, or intensity, of the top faded edge. int getTopPaddingOffset() Amount by which to extend the top fading region. TouchDelegate getTouchDelegate() Gets the TouchDelegate for this View. ArrayList<View> getTouchables() Find and return all touchable views that are descendants of this view, possibly including this view if it is touchable itself. float getTransitionAlpha() This property is intended only for use by the Fade transition, which animates it to produce a visual translucency that does not side-effect (or get affected by) the real alpha property. String getTransitionName() Returns the name of the View to be used to identify Views in Transitions. float getTranslationX() The horizontal location of this view relative to its left position. float getTranslationY() The vertical location of this view relative to its top position. float getTranslationZ() The depth location of this view relative to its elevation. long getUniqueDrawingId() Get the identifier used for this view by the drawing system. int getVerticalFadingEdgeLength() Returns the size of the vertical faded edges used to indicate that more content in this view is visible. int getVerticalScrollbarPosition() Drawable getVerticalScrollbarThumbDrawable() Returns the currently configured Drawable for the thumb of the vertical scroll bar if it exists, null otherwise. Drawable getVerticalScrollbarTrackDrawable() Returns the currently configured Drawable for the track of the vertical scroll bar if it exists, null otherwise. int getVerticalScrollbarWidth() Returns the width of the vertical scrollbar. ViewTranslationResponse getViewTranslationResponse() Returns the ViewTranslationResponse associated with this view. ViewTreeObserver getViewTreeObserver() Returns the ViewTreeObserver for this view's hierarchy. int getVisibility() Returns the visibility status for this view. final int getWidth() Return the width of your view. int getWindowAttachCount() WindowId getWindowId() Retrieve the WindowId for the window this view is currently attached to. WindowInsetsController getWindowInsetsController() Retrieves the single WindowInsetsController of the window this view is attached to. int getWindowSystemUiVisibility() This method was deprecated in API level 30. SystemUiVisibility flags are deprecated. Use WindowInsetsController instead. IBinder getWindowToken() Retrieve a unique token identifying the window this view is attached to. int getWindowVisibility() Returns the current visibility of the window this view is attached to (either GONE, INVISIBLE, or VISIBLE). void getWindowVisibleDisplayFrame(Rect outRect) Retrieve the overall visible display size in which the window this view is attached to has been positioned in. float getX() The visual x position of this view, in pixels. float getY() The visual y position of this view, in pixels. float getZ() The visual z position of this view, in pixels. boolean hasExplicitFocusable() Returns true if this view is focusable or if it contains a reachable View for which hasExplicitFocusable() returns true. boolean hasFocus() Returns true if this view has focus itself, or is the ancestor of the view that has focus. boolean hasFocusable() Returns true if this view is focusable or if it contains a reachable View for which hasFocusable() returns true. boolean hasNestedScrollingParent() Returns true if this view has a nested scrolling parent. boolean hasOnClickListeners() Return whether this view has an attached OnClickListener. boolean hasOnLongClickListeners() Return whether this view has an attached OnLongClickListener. boolean hasOverlappingRendering() Returns whether this View has content which overlaps. boolean hasPointerCapture() Checks pointer capture status. boolean hasTransientState() Indicates whether the view is currently tracking transient state that the app should not need to concern itself with saving and restoring, but that the framework should take special note to preserve when possible. boolean hasWindowFocus() Returns true if this view is in a window that currently has window focus. static View inflate(Context context, int resource, ViewGroup root) Inflate a view from an XML resource. void invalidate() Invalidate the whole view. void invalidate(Rect dirty) This method was deprecated in API level 28. 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(). void invalidate(int l, int t, int r, int b) This method was deprecated in API level 28. 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(). void invalidateDrawable(Drawable drawable) Invalidates the specified Drawable. void invalidateOutline() Called to rebuild this View's Outline from its outline provider boolean isAccessibilityDataSensitive() Whether this view should restrict accessibility service access only to services that have the AccessibilityServiceInfo.isAccessibilityTool() property set to true. boolean isAccessibilityFocused() Returns whether this View is accessibility focused. boolean isAccessibilityHeading() Gets whether this view is a heading for accessibility purposes. boolean isActivated() Indicates the activation state of this view. boolean isAttachedToWindow() Returns true if this view is currently attached to a window. boolean isAutoHandwritingEnabled() Return whether the View allows automatic handwriting initiation. boolean isClickable() Indicates whether this view reacts to click events or not. final boolean isContentSensitive() Returns whether this view displays sensitive content, based on the value explicitly set by setContentSensitivity(int). boolean isContextClickable() Indicates whether this view reacts to context clicks or not. boolean isCredential() Gets the mode for determining whether this view is a credential. boolean isDirty() True if this view has changed since the last time being drawn. boolean isDrawingCacheEnabled() This method was deprecated in API level 28. 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 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. boolean isDuplicateParentStateEnabled() Indicates whether this duplicates its drawable state from its parent. boolean isEnabled() Returns the enabled status for this view. final boolean isFocusable() Returns whether this View is currently able to take focus. final boolean isFocusableInTouchMode() When a view is focusable, it may not want to take focus when in touch mode. boolean isFocused() Returns true if this view has focus final boolean isFocusedByDefault() Returns whether this View should receive focus when the focus is restored for the view hierarchy containing this view. boolean isForceDarkAllowed() See setForceDarkAllowed(boolean) boolean isHandwritingDelegate() Returns whether this view has been set as a handwriting delegate by setIsHandwritingDelegate(boolean). boolean isHapticFeedbackEnabled() boolean isHardwareAccelerated() Indicates whether this view is attached to a hardware accelerated window or not. boolean isHorizontalFadingEdgeEnabled() Indicate whether the horizontal edges are faded when the view is scrolled horizontally. boolean isHorizontalScrollBarEnabled() Indicate whether the horizontal scrollbar should be drawn or not. boolean isHovered() Returns true if the view is currently hovered. boolean isImportantForAccessibility() Computes whether this view should be exposed for accessibility. final boolean isImportantForAutofill() Hints the Android System whether the AssistStructure.ViewNode associated with this view is considered important for autofill purposes. final boolean isImportantForContentCapture() Hints the Android System whether this view is considered important for content capture, based on the value explicitly set by setImportantForContentCapture(int) and heuristics when it's IMPORTANT_FOR_CONTENT_CAPTURE_AUTO. boolean isInEditMode() Indicates whether this View is currently in edit mode. boolean isInLayout() Returns whether the view hierarchy is currently undergoing a layout pass. boolean isInTouchMode() Returns the touch mode state associated with this view. final boolean isKeyboardNavigationCluster() Returns whether this View is a root of a keyboard navigation cluster. boolean isLaidOut() Returns true if this view has been through at least one layout since it was last attached to or detached from a window. boolean isLayoutDirectionResolved() boolean isLayoutRequested() Indicates whether or not this view's layout will be requested during the next hierarchy layout pass. boolean isLongClickable() Indicates whether this view reacts to long click events or not. boolean isNestedScrollingEnabled() Returns true if nested scrolling is enabled for this view. boolean isOpaque() Indicates whether this View is opaque. boolean isPaddingOffsetRequired() If the View draws content inside its padding and enables fading edges, it needs to support padding offsets. boolean isPaddingRelative() Return if the padding has been set through relative values setPaddingRelative(int, int, int, int) or through boolean isPivotSet() Returns whether or not a pivot has been set by a call to setPivotX(float) or setPivotY(float). final boolean isPreferKeepClear() Retrieve the preference for this view to be kept clear. boolean isPressed() Indicates whether the view is currently in pressed state. boolean isSaveEnabled() Indicates whether this view will save its state (that is, whether its onSaveInstanceState() method will be called). boolean isSaveFromParentEnabled() Indicates whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent. boolean isScreenReaderFocusable() Returns whether the view should be treated as a focusable unit by screen reader accessibility tools. boolean isScrollContainer() Indicates whether this view is one of the set of scrollable containers in its window. boolean isScrollbarFadingEnabled() Returns true if scrollbars will fade when this view is not scrolling boolean isSelected() Indicates the selection state of this view. final boolean isShowingLayoutBounds() Returns true when the View is attached and the system developer setting to show the layout bounds is enabled or false otherwise. boolean isShown() Returns the visibility of this view and all of its ancestors boolean isSoundEffectsEnabled() final boolean isTemporarilyDetached() Tells whether the View is in the state between onStartTemporaryDetach() and onFinishTemporaryDetach(). boolean isTextAlignmentResolved() boolean isTextDirectionResolved() boolean isVerticalFadingEdgeEnabled() Indicate whether the vertical edges are faded when the view is scrolled horizontally. boolean isVerticalScrollBarEnabled() Indicate whether the vertical scrollbar should be drawn or not. boolean isVisibleToUserForAutofill(int virtualId) Computes whether this virtual autofill view is visible to the user. void jumpDrawablesToCurrentState() Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view. View keyboardNavigationClusterSearch(View currentCluster, int direction) Find the nearest keyboard navigation cluster in the specified direction. void layout(int l, int t, int r, int b) Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism. final void measure(int widthMeasureSpec, int heightMeasureSpec) This is called to find out how big a view should be. static int[] mergeDrawableStates(int[] baseState, int[] additionalState) Merge your own state values in additionalState into the base state values baseState that were returned by onCreateDrawableState(int). void offsetLeftAndRight(int offset) Offset this view's horizontal location by the specified amount of pixels. void offsetTopAndBottom(int offset) Offset this view's vertical location by the specified number of pixels. void onAnimationEnd() Invoked by a parent ViewGroup to notify the end of the animation currently associated with this view. void onAnimationStart() Invoked by a parent ViewGroup to notify the start of the animation currently associated with this view. WindowInsets onApplyWindowInsets(WindowInsets insets) Called when the view should apply WindowInsets according to its internal policy. void onAttachedToWindow() This is called when the view is attached to a window. void onCancelPendingInputEvents() Called as the result of a call to cancelPendingInputEvents() on this view or a parent view. boolean onCapturedPointerEvent(MotionEvent event) Implement this method to handle captured pointer events boolean onCheckIsTextEditor() Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it. void onConfigurationChanged(Configuration newConfig) Called when the current configuration of the resources being used by the application have changed. void onCreateContextMenu(ContextMenu menu) Views should implement this if the view itself is going to add items to the context menu. int[] onCreateDrawableState(int extraSpace) Generate the new Drawable state for this view. InputConnection onCreateInputConnection(EditorInfo outAttrs) Create a new InputConnection for an InputMethod to interact with the view. void onCreateViewTranslationRequest(int[] supportedFormats, Consumer<ViewTranslationRequest> requestsCollector) Collects a ViewTranslationRequest which represents the content to be translated in the view. void onCreateVirtualViewTranslationRequests(long[] virtualIds, int[] supportedFormats, Consumer<ViewTranslationRequest> requestsCollector) Collects ViewTranslationRequests which represents the content to be translated for the virtual views in the host view. void onDetachedFromWindow() This is called when the view is detached from a window. void onDisplayHint(int hint) Gives this view a hint about whether is displayed or not. boolean onDragEvent(DragEvent event) Handles drag events sent by the system following a call to startDragAndDrop(). void onDraw(Canvas canvas) Implement this to do your drawing. void onDrawForeground(Canvas canvas) Draw any foreground content for this view. final void onDrawScrollBars(Canvas canvas) Request the drawing of the horizontal and the vertical scrollbar. boolean onFilterTouchEventForSecurity(MotionEvent event) Filter the touch event to apply security policies. void onFinishInflate() Finalize inflating a view from XML. void onFinishTemporaryDetach() Called after onStartTemporaryDetach() when the container is done changing the view. void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) Called by the view system when the focus state of this view changes. boolean onGenericMotionEvent(MotionEvent event) Implement this method to handle generic motion events. void onHoverChanged(boolean hovered) Implement this method to handle hover state changes. boolean onHoverEvent(MotionEvent event) Implement this method to handle hover events. void onInitializeAccessibilityEvent(AccessibilityEvent event) Initializes an AccessibilityEvent with information about this View which is the event source. void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) Initializes an AccessibilityNodeInfo with information about this view. boolean onKeyDown(int keyCode, KeyEvent event) Default implementation of KeyEvent.Callback.onKeyDown(): perform press of the view when KeyEvent.KEYCODE_DPAD_CENTER or KeyEvent.KEYCODE_ENTER is released, if the view is enabled and clickable. boolean onKeyLongPress(int keyCode, KeyEvent event) Default implementation of KeyEvent.Callback.onKeyLongPress(): always returns false (doesn't handle the event). boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event). boolean onKeyPreIme(int keyCode, KeyEvent event) Handle a key event before it is processed by any input method associated with the view hierarchy. boolean onKeyShortcut(int keyCode, KeyEvent event) Called on the focused view when a key shortcut event is not handled. boolean onKeyUp(int keyCode, KeyEvent event) Default implementation of KeyEvent.Callback.onKeyUp(): perform clicking of the view when KeyEvent.KEYCODE_DPAD_CENTER, KeyEvent.KEYCODE_ENTER or KeyEvent.KEYCODE_SPACE is released. void onLayout(boolean changed, int left, int top, int right, int bottom) Called from layout when this view should assign a size and position to each of its children. void onMeasure(int widthMeasureSpec, int heightMeasureSpec) Measure the view and its content to determine the measured width and the measured height. void onOverScrolled(int scrollX, int scrollY, boolean clampedX, boolean clampedY) Called by overScrollBy(int, int, int, int, int, int, int, int, boolean) to respond to the results of an over-scroll operation. void onPointerCaptureChange(boolean hasCapture) Called when the window has just acquired or lost pointer capture. void onPopulateAccessibilityEvent(AccessibilityEvent event) Called from dispatchPopulateAccessibilityEvent(android.view.accessibility.AccessibilityEvent) giving a chance to this View to populate the accessibility event with its text content. void onProvideAutofillStructure(ViewStructure structure, int flags) Populates a ViewStructure to fullfil an autofill request. void onProvideAutofillVirtualStructure(ViewStructure structure, int flags) Populates a ViewStructure containing virtual children to fullfil an autofill request. void onProvideContentCaptureStructure(ViewStructure structure, int flags) Populates a ViewStructure for content capture. void onProvideStructure(ViewStructure structure) Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData. void onProvideVirtualStructure(ViewStructure structure) Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData to generate additional virtual structure under this view. ContentInfo onReceiveContent(ContentInfo payload) Implements the default behavior for receiving content for this type of view. PointerIcon onResolvePointerIcon(MotionEvent event, int pointerIndex) Resolve the pointer icon that should be used for specified pointer in the motion event. void onRestoreInstanceState(Parcelable state) Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). void onRtlPropertiesChanged(int layoutDirection) Called when any RTL property (layout direction or text direction or text alignment) has been changed. Parcelable onSaveInstanceState() Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state. void onScreenStateChanged(int screenState) This method is called whenever the state of the screen this view is attached to changes. void onScrollCaptureSearch(Rect localVisibleRect, Point windowOffset, Consumer<ScrollCaptureTarget> targets) Called when scroll capture is requested, to search for appropriate content to scroll. void onScrollChanged(int l, int t, int oldl, int oldt) This is called in response to an internal scroll in this view (i.e., the view scrolled its own contents). boolean onSetAlpha(int alpha) Invoked if there is a Transform that involves alpha. void onSizeChanged(int w, int h, int oldw, int oldh) This is called during layout when the size of this view has changed. void onStartTemporaryDetach() This is called when a container is going to temporarily detach a child, with ViewGroup.detachViewFromParent. boolean onTouchEvent(MotionEvent event) Implement this method to handle pointer events. boolean onTrackballEvent(MotionEvent event) Implement this method to handle trackball motion events. void onViewTranslationResponse(ViewTranslationResponse response) Called when the content from View.onCreateViewTranslationRequest had been translated by the TranslationService. void onVirtualViewTranslationResponses(LongSparseArray<ViewTranslationResponse> response) Called when the content from View.onCreateVirtualViewTranslationRequests had been translated by the TranslationService. void onVisibilityAggregated(boolean isVisible) 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. void onVisibilityChanged(View changedView, int visibility) Called when the visibility of the view or an ancestor of the view has changed. void onWindowFocusChanged(boolean hasWindowFocus) Called when the window containing this view gains or loses focus. void onWindowSystemUiVisibilityChanged(int visible) This method was deprecated in API level 30. SystemUiVisibility flags are deprecated. Use WindowInsetsController instead. void onWindowVisibilityChanged(int visibility) Called when the window containing has change its visibility (between GONE, INVISIBLE, and VISIBLE). boolean overScrollBy(int deltaX, int deltaY, int scrollX, int scrollY, int scrollRangeX, int scrollRangeY, int maxOverScrollX, int maxOverScrollY, boolean isTouchEvent) Scroll the view with standard behavior for scrolling beyond the normal content boundaries. boolean performAccessibilityAction(int action, Bundle arguments) Performs the specified accessibility action on the view. boolean performClick() Call this view's OnClickListener, if it is defined. boolean performContextClick(float x, float y) Call this view's OnContextClickListener, if it is defined. boolean performContextClick() Call this view's OnContextClickListener, if it is defined. boolean performHapticFeedback(int feedbackConstant) BZZZTT!!1! Provide haptic feedback to the user for this view. boolean performHapticFeedback(int feedbackConstant, int flags) BZZZTT!!1! Like performHapticFeedback(int), with additional options. boolean performLongClick(float x, float y) Calls this view's OnLongClickListener, if it is defined. boolean performLongClick() Calls this view's OnLongClickListener, if it is defined. ContentInfo performReceiveContent(ContentInfo payload) Receives the given content. void playSoundEffect(int soundConstant) Play a sound effect for this view. boolean post(Runnable action) Causes the Runnable to be added to the message queue. boolean postDelayed(Runnable action, long delayMillis) Causes the Runnable to be added to the message queue, to be run after the specified amount of time elapses. void postInvalidate() Cause an invalidate to happen on a subsequent cycle through the event loop. void postInvalidate(int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop. void postInvalidateDelayed(long delayMilliseconds, int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop. void postInvalidateDelayed(long delayMilliseconds) Cause an invalidate to happen on a subsequent cycle through the event loop. void postInvalidateOnAnimation(int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on the next animation time step, typically the next display frame. void postInvalidateOnAnimation() Cause an invalidate to happen on the next animation time step, typically the next display frame. void postOnAnimation(Runnable action) Causes the Runnable to execute on the next animation time step. void postOnAnimationDelayed(Runnable action, long delayMillis) Causes the Runnable to execute on the next animation time step, after the specified amount of time elapses. void refreshDrawableState() Call this to force a view to update its drawable state. void releasePointerCapture() Releases the pointer capture. boolean removeCallbacks(Runnable action) Removes the specified Runnable from the message queue. void removeOnAttachStateChangeListener(View.OnAttachStateChangeListener listener) Remove a listener for attach state changes. void removeOnLayoutChangeListener(View.OnLayoutChangeListener listener) Remove a listener for layout changes. void removeOnUnhandledKeyEventListener(View.OnUnhandledKeyEventListener listener) Removes a listener which will receive unhandled KeyEvents. void requestApplyInsets() Ask that a new dispatch of onApplyWindowInsets(android.view.WindowInsets) be performed. void requestFitSystemWindows() This method was deprecated in API level 20. Use requestApplyInsets() for newer platform versions. final boolean requestFocus(int direction) 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. final boolean requestFocus() Call this to try to give focus to a specific view or to one of its descendants. boolean requestFocus(int direction, Rect previouslyFocusedRect) 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. final boolean requestFocusFromTouch() Call this to try to give focus to a specific view or to one of its descendants. void requestLayout() Call this when something has changed which has invalidated the layout of this view. void requestPointerCapture() Requests pointer capture mode. boolean requestRectangleOnScreen(Rect rectangle) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough. boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough. final void requestUnbufferedDispatch(int source) Request unbuffered dispatch of the given event source class to this view. final void requestUnbufferedDispatch(MotionEvent event) Request unbuffered dispatch of the given stream of MotionEvents to this View. final <T extends View> T requireViewById(int id) 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. void resetPivot() Clears any pivot previously set by a call to setPivotX(float) or setPivotY(float). static int resolveSize(int size, int measureSpec) Version of resolveSizeAndState(int, int, int) returning only the MEASURED_SIZE_MASK bits of the result. static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec. boolean restoreDefaultFocus() Gives focus to the default-focus view in the view hierarchy that has this view as a root. void restoreHierarchyState(SparseArray<Parcelable> container) Restore this view hierarchy's frozen state from the given container. final void saveAttributeDataForStyleable(Context context, int[] styleable, AttributeSet attrs, TypedArray t, int defStyleAttr, int defStyleRes) Stores debugging information about attributes. void saveHierarchyState(SparseArray<Parcelable> container) Store this view hierarchy's frozen state into the given container. void scheduleDrawable(Drawable who, Runnable what, long when) Schedules an action on a drawable to occur at a specified time. void scrollBy(int x, int y) Move the scrolled position of your view. void scrollTo(int x, int y) Set the scrolled position of your view. void sendAccessibilityEvent(int eventType) Sends an accessibility event of the given type. void sendAccessibilityEventUnchecked(AccessibilityEvent event) 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. void setAccessibilityDataSensitive(int accessibilityDataSensitive) Specifies whether this view should only allow interactions from AccessibilityServices with the AccessibilityServiceInfo.isAccessibilityTool() property set to true. void setAccessibilityDelegate(View.AccessibilityDelegate delegate) Sets a delegate for implementing accessibility support via composition (as opposed to inheritance). void setAccessibilityHeading(boolean isHeading) Set if view is a heading for a section of content for accessibility purposes. void setAccessibilityLiveRegion(int mode) Sets the live region mode for this view. void setAccessibilityPaneTitle(CharSequence accessibilityPaneTitle) Visually distinct portion of a window with window-like semantics are considered panes for accessibility purposes. void setAccessibilityTraversalAfter(int afterId) Sets the id of a view that screen readers are requested to visit before this view. void setAccessibilityTraversalBefore(int beforeId) Sets the id of a view that screen readers are requested to visit after this view. void setActivated(boolean activated) Changes the activated state of this view. void setAllowClickWhenDisabled(boolean clickableWhenDisabled) Enables or disables click events for this view when disabled. void setAllowedHandwritingDelegatePackage(String allowedPackageName) Specifies that this view may act as a handwriting initiation delegator for a delegate editor view from the specified package. void setAllowedHandwritingDelegatorPackage(String allowedPackageName) Specifies that a view from the specified package may act as a handwriting delegator for this delegate editor view. void setAlpha(float alpha) 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. void setAnimation(Animation animation) Sets the next animation to play for this view. void setAnimationMatrix(Matrix matrix) Changes the transformation matrix on the view. void setAutoHandwritingEnabled(boolean enabled) Set whether this view enables automatic handwriting initiation. void setAutofillHints(String... autofillHints) Sets the hints that help an AutofillService determine how to autofill the view with the user's data. void setAutofillId(AutofillId id) Sets the unique, logical identifier of this view in the activity, for autofill purposes. void setBackground(Drawable background) Set the background to a given Drawable, or remove the background. void setBackgroundColor(int color) Sets the background color for this view. void setBackgroundDrawable(Drawable background) This method was deprecated in API level 16. use setBackground(android.graphics.drawable.Drawable) instead void setBackgroundResource(int resid) Set the background to a given resource. void setBackgroundTintBlendMode(BlendMode blendMode) Specifies the blending mode used to apply the tint specified by setBackgroundTintList(android.content.res.ColorStateList)} to the background drawable. void setBackgroundTintList(ColorStateList tint) Applies a tint to the background drawable. void setBackgroundTintMode(PorterDuff.Mode tintMode) Specifies the blending mode used to apply the tint specified by setBackgroundTintList(android.content.res.ColorStateList)} to the background drawable. final void setBottom(int bottom) Sets the bottom position of this view relative to its parent. void setCameraDistance(float distance) Sets the distance along the Z axis (orthogonal to the X/Y plane on which views are drawn) from the camera to this view. void setClickable(boolean clickable) Enables or disables click events for this view. void setClipBounds(Rect clipBounds) Sets a rectangular area on this view to which the view will be clipped when it is drawn. void setClipToOutline(boolean clipToOutline) Sets whether the View's Outline should be used to clip the contents of the View. void setContentCaptureSession(ContentCaptureSession contentCaptureSession) Sets the (optional) ContentCaptureSession associated with this view. void setContentDescription(CharSequence contentDescription) Sets the View's content description. final void setContentSensitivity(int mode) Sets content sensitivity mode to determine whether this view displays sensitive content (e.g. username, password etc.). void setContextClickable(boolean contextClickable) Enables or disables context clicking for this view. void setDefaultFocusHighlightEnabled(boolean defaultFocusHighlightEnabled) Sets whether this View should use a default focus highlight when it gets focused but doesn't have R.attr.state_focused defined in its background. void setDrawingCacheBackgroundColor(int color) This method was deprecated in API level 28. 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 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. void setDrawingCacheEnabled(boolean enabled) This method was deprecated in API level 28. 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 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. void setDrawingCacheQuality(int quality) This method was deprecated in API level 28. 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 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. void setDuplicateParentStateEnabled(boolean enabled) Enables or disables the duplication of the parent's state into this view. void setElevation(float elevation) Sets the base elevation of this view, in pixels. void setEnabled(boolean enabled) Set the enabled state of this view. void setFadingEdgeLength(int length) Set the size of the faded edge used to indicate that more content in this view is available. void setFilterTouchesWhenObscured(boolean enabled) Sets whether the framework should discard touches when the view's window is obscured by another visible window at the touched location. void setFitsSystemWindows(boolean fitSystemWindows) 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. void setFocusable(boolean focusable) Set whether this view can receive the focus. void setFocusable(int focusable) Sets whether this view can receive focus. void setFocusableInTouchMode(boolean focusableInTouchMode) Set whether this view can receive focus while in touch mode. void setFocusedByDefault(boolean isFocusedByDefault) Sets whether this View should receive focus when the focus is restored for the view hierarchy containing this view. void setForceDarkAllowed(boolean allow) Sets whether or not to allow force dark to apply to this view. void setForeground(Drawable foreground) Supply a Drawable that is to be rendered on top of all of the content in the view. void setForegroundGravity(int gravity) Describes how the foreground is positioned. void setForegroundTintBlendMode(BlendMode blendMode) Specifies the blending mode used to apply the tint specified by setForegroundTintList(android.content.res.ColorStateList)} to the background drawable. void setForegroundTintList(ColorStateList tint) Applies a tint to the foreground drawable. void setForegroundTintMode(PorterDuff.Mode tintMode) Specifies the blending mode used to apply the tint specified by setForegroundTintList(android.content.res.ColorStateList)} to the background drawable. void setFrameContentVelocity(float pixelsPerSecond) Set the current velocity of the View, we only track positive value. void setHandwritingBoundsOffsets(float offsetLeft, float offsetTop, float offsetRight, float offsetBottom) Set the amount of offset applied to this view's stylus handwriting bounds. void setHandwritingDelegateFlags(int flags) Sets flags configuring the handwriting delegation behavior for this delegate editor view. void setHandwritingDelegatorCallback(Runnable callback) Sets a callback which should be called when a stylus MotionEvent occurs within this view's bounds. void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) Set whether this view should have haptic feedback for events such as long presses. void setHasTransientState(boolean hasTransientState) Set whether this view is currently tracking transient state that the framework should attempt to preserve when possible. void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) Define whether the horizontal edges should be faded when this view is scrolled horizontally. void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) Define whether the horizontal scrollbar should be drawn or not. void setHorizontalScrollbarThumbDrawable(Drawable drawable) Defines the horizontal thumb drawable void setHorizontalScrollbarTrackDrawable(Drawable drawable) Defines the horizontal track drawable void setHovered(boolean hovered) Sets whether the view is currently hovered. void setId(int id) Sets the identifier for this view. void setImportantForAccessibility(int mode) 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. void setImportantForAutofill(int mode) Sets the mode for determining whether this view is considered important for autofill. void setImportantForContentCapture(int mode) Sets the mode for determining whether this view is considered important for content capture. void setIsCredential(boolean isCredential) Sets whether this view is a credential for Credential Manager purposes. void setIsHandwritingDelegate(boolean isHandwritingDelegate) Sets this view to be a handwriting delegate. void setKeepScreenOn(boolean keepScreenOn) Controls whether the screen should remain on, modifying the value of KEEP_SCREEN_ON. void setKeyboardNavigationCluster(boolean isCluster) Set whether this view is a root of a keyboard navigation cluster. void setLabelFor(int id) Sets the id of a view for which this view serves as a label for accessibility purposes. void setLayerPaint(Paint paint) Updates the Paint object used with the current layer (used only if the current layer type is not set to LAYER_TYPE_NONE). void setLayerType(int layerType, Paint paint) Specifies the type of layer backing this view. void setLayoutDirection(int layoutDirection) Set the layout direction for this view. void setLayoutParams(ViewGroup.LayoutParams params) Set the layout parameters associated with this view. final void setLeft(int left) Sets the left position of this view relative to its parent. final void setLeftTopRightBottom(int left, int top, int right, int bottom) Assign a size and position to this view. void setLongClickable(boolean longClickable) Enables or disables long click events for this view. final void setMeasuredDimension(int measuredWidth, int measuredHeight) This method must be called by onMeasure(int, int) to store the measured width and measured height. void setMinimumHeight(int minHeight) Sets the minimum height of the view. void setMinimumWidth(int minWidth) Sets the minimum width of the view. void setNestedScrollingEnabled(boolean enabled) Enable or disable nested scrolling for this view. void setNextClusterForwardId(int nextClusterForwardId) Sets the id of the view to use as the root of the next keyboard navigation cluster. void setNextFocusDownId(int nextFocusDownId) Sets the id of the view to use when the next focus is FOCUS_DOWN. void setNextFocusForwardId(int nextFocusForwardId) Sets the id of the view to use when the next focus is FOCUS_FORWARD. void setNextFocusLeftId(int nextFocusLeftId) Sets the id of the view to use when the next focus is FOCUS_LEFT. void setNextFocusRightId(int nextFocusRightId) Sets the id of the view to use when the next focus is FOCUS_RIGHT. void setNextFocusUpId(int nextFocusUpId) Sets the id of the view to use when the next focus is FOCUS_UP. void setOnApplyWindowInsetsListener(View.OnApplyWindowInsetsListener listener) Set an OnApplyWindowInsetsListener to take over the policy for applying window insets to this view. void setOnCapturedPointerListener(View.OnCapturedPointerListener l) Set a listener to receive callbacks when the pointer capture state of a view changes. void setOnClickListener(View.OnClickListener l) Register a callback to be invoked when this view is clicked. void setOnContextClickListener(View.OnContextClickListener l) Register a callback to be invoked when this view is context clicked. void setOnCreateContextMenuListener(View.OnCreateContextMenuListener l) Register a callback to be invoked when the context menu for this view is being built. void setOnDragListener(View.OnDragListener l) Register a drag event listener callback object for this View. void setOnFocusChangeListener(View.OnFocusChangeListener l) Register a callback to be invoked when focus of this view changed. void setOnGenericMotionListener(View.OnGenericMotionListener l) Register a callback to be invoked when a generic motion event is sent to this view. void setOnHoverListener(View.OnHoverListener l) Register a callback to be invoked when a hover event is sent to this view. void setOnKeyListener(View.OnKeyListener l) Register a callback to be invoked when a hardware key is pressed in this view. void setOnLongClickListener(View.OnLongClickListener l) Register a callback to be invoked when this view is clicked and held. void setOnReceiveContentListener(String[] mimeTypes, OnReceiveContentListener listener) Sets the listener to be used to handle insertion of content into this view. void setOnScrollChangeListener(View.OnScrollChangeListener l) Register a callback to be invoked when the scroll X or Y positions of this view change. void setOnSystemUiVisibilityChangeListener(View.OnSystemUiVisibilityChangeListener l) This method was deprecated in API level 30. Use WindowInsets.isVisible(int) to find out about system bar visibilities by setting a OnApplyWindowInsetsListener on this view. void setOnTouchListener(View.OnTouchListener l) Register a callback to be invoked when a touch event is sent to this view. void setOutlineAmbientShadowColor(int color) Sets the color of the ambient shadow that is drawn when the view has a positive Z or elevation value. void setOutlineProvider(ViewOutlineProvider provider) Sets the ViewOutlineProvider of the view, which generates the Outline that defines the shape of the shadow it casts, and enables outline clipping. void setOutlineSpotShadowColor(int color) Sets the color of the spot shadow that is drawn when the view has a positive Z or elevation value. void setOverScrollMode(int overScrollMode) Set the over-scroll mode for this view. void setPadding(int left, int top, int right, int bottom) Sets the padding. void setPaddingRelative(int start, int top, int end, int bottom) Sets the relative padding. void setPendingCredentialRequest(GetCredentialRequest request, OutcomeReceiver<GetCredentialResponse, GetCredentialException> callback) Sets a CredentialManager request to retrieve credentials, when the user focuses on this given view. void setPivotX(float pivotX) Sets the x location of the point around which the view is rotated and scaled. void setPivotY(float pivotY) Sets the y location of the point around which the view is rotated and scaled. void setPointerIcon(PointerIcon pointerIcon) Set the pointer icon to be used for a mouse pointer in the current view. final void setPreferKeepClear(boolean preferKeepClear) Set a preference to keep the bounds of this view clear from floating windows above this view's window. final void setPreferKeepClearRects(List<Rect> rects) Set a preference to keep the provided rects clear from floating windows above this view's window. void setPressed(boolean pressed) Sets the pressed state for this view. void setRenderEffect(RenderEffect renderEffect) Configure the RenderEffect to apply to this View. void setRequestedFrameRate(float frameRate) You can set the preferred frame rate for a View using a positive number or by specifying the preferred frame rate category using constants, including REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE, REQUESTED_FRAME_RATE_CATEGORY_LOW, REQUESTED_FRAME_RATE_CATEGORY_NORMAL, REQUESTED_FRAME_RATE_CATEGORY_HIGH. final void setRevealOnFocusHint(boolean revealOnFocus) Sets this view's preference for reveal behavior when it gains focus. final void setRight(int right) Sets the right position of this view relative to its parent. void setRotation(float rotation) Sets the degrees that the view is rotated around the pivot point. void setRotationX(float rotationX) Sets the degrees that the view is rotated around the horizontal axis through the pivot point. void setRotationY(float rotationY) Sets the degrees that the view is rotated around the vertical axis through the pivot point. void setSaveEnabled(boolean enabled) Controls whether the saving of this view's state is enabled (that is, whether its onSaveInstanceState() method will be called). void setSaveFromParentEnabled(boolean enabled) Controls whether the entire hierarchy under this view will save its state when a state saving traversal occurs from its parent. void setScaleX(float scaleX) Sets the amount that the view is scaled in x around the pivot point, as a proportion of the view's unscaled width. void setScaleY(float scaleY) Sets the amount that the view is scaled in Y around the pivot point, as a proportion of the view's unscaled width. void setScreenReaderFocusable(boolean screenReaderFocusable) Sets whether this View should be a focusable element for screen readers and include non-focusable Views from its subtree when providing feedback. void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) Define the delay before scrollbars fade. void setScrollBarFadeDuration(int scrollBarFadeDuration) Define the scrollbar fade duration. void setScrollBarSize(int scrollBarSize) Define the scrollbar size. void setScrollBarStyle(int style) Specify the style of the scrollbars. final void setScrollCaptureCallback(ScrollCaptureCallback callback) Sets the callback to receive scroll capture requests. void setScrollCaptureHint(int hint) Sets the scroll capture hint for this View. void setScrollContainer(boolean isScrollContainer) Change whether this view is one of the set of scrollable containers in its window. void setScrollIndicators(int indicators, int mask) Sets the state of the scroll indicators specified by the mask. void setScrollIndicators(int indicators) Sets the state of all scroll indicators. void setScrollX(int value) Set the horizontal scrolled position of your view. void setScrollY(int value) Set the vertical scrolled position of your view. void setScrollbarFadingEnabled(boolean fadeScrollbars) Define whether scrollbars will fade when the view is not scrolling. void setSelected(boolean selected) Changes the selection state of this view. void setSoundEffectsEnabled(boolean soundEffectsEnabled) Set whether this view should have sound effects enabled for events such as clicking and touching. void setStateDescription(CharSequence stateDescription) Sets the View's state description. void setStateListAnimator(StateListAnimator stateListAnimator) Attaches the provided StateListAnimator to this View. void setSystemGestureExclusionRects(List<Rect> rects) 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. void setSystemUiVisibility(int visibility) This method was deprecated in API level 30. SystemUiVisibility flags are deprecated. Use WindowInsetsController instead. void setTag(int key, Object tag) Sets a tag associated with this view and a key. void setTag(Object tag) Sets the tag associated with this view. void setTextAlignment(int textAlignment) Set the text alignment. void setTextDirection(int textDirection) Set the text direction. void setTooltipText(CharSequence tooltipText) Sets the tooltip text which will be displayed in a small popup next to the view. final void setTop(int top) Sets the top position of this view relative to its parent. void setTouchDelegate(TouchDelegate delegate) Sets the TouchDelegate for this View. void setTransitionAlpha(float alpha) 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. final void setTransitionName(String transitionName) Sets the name of the View to be used to identify Views in Transitions. void setTransitionVisibility(int visibility) Changes the visibility of this View without triggering any other changes. void setTranslationX(float translationX) Sets the horizontal location of this view relative to its left position. void setTranslationY(float translationY) Sets the vertical location of this view relative to its top position. void setTranslationZ(float translationZ) Sets the depth location of this view relative to its elevation. void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) Define whether the vertical edges should be faded when this view is scrolled vertically. void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) Define whether the vertical scrollbar should be drawn or not. void setVerticalScrollbarPosition(int position) Set the position of the vertical scroll bar. void setVerticalScrollbarThumbDrawable(Drawable drawable) Defines the vertical scrollbar thumb drawable void setVerticalScrollbarTrackDrawable(Drawable drawable) Defines the vertical scrollbar track drawable void setViewTranslationCallback(ViewTranslationCallback callback) Sets a ViewTranslationCallback that is used to display/hide the translated information. void setVisibility(int visibility) Set the visibility state of this view. void setWillNotCacheDrawing(boolean willNotCacheDrawing) This method was deprecated in API level 28. 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 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. void setWillNotDraw(boolean willNotDraw) If this view doesn't do any drawing on its own, set this flag to allow further optimizations. void setWindowInsetsAnimationCallback(WindowInsetsAnimation.Callback callback) Sets a WindowInsetsAnimation.Callback to be notified about animations of windows that cause insets. void setX(float x) Sets the visual x position of this view, in pixels. void setY(float y) Sets the visual y position of this view, in pixels. void setZ(float z) Sets the visual z position of this view, in pixels. boolean showContextMenu() Shows the context menu for this view. boolean showContextMenu(float x, float y) Shows the context menu for this view anchored to the specified view-relative coordinate. ActionMode startActionMode(ActionMode.Callback callback, int type) Start an action mode with the given type. ActionMode startActionMode(ActionMode.Callback callback) Start an action mode with the default type ActionMode.TYPE_PRIMARY. void startAnimation(Animation animation) Start the specified animation now. final boolean startDrag(ClipData data, View.DragShadowBuilder shadowBuilder, Object myLocalState, int flags) This method was deprecated in API level 24. Use startDragAndDrop() for newer platform versions. final boolean startDragAndDrop(ClipData data, View.DragShadowBuilder shadowBuilder, Object myLocalState, int flags) Starts a drag and drop operation. boolean startNestedScroll(int axes) Begin a nestable scroll operation along the given axes. void stopNestedScroll() Stop a nested scroll in progress. String toString() Returns a string representation of the object. void transformMatrixToGlobal(Matrix matrix) Modifies the input matrix such that it maps view-local coordinates to on-screen coordinates. void transformMatrixToLocal(Matrix matrix) Modifies the input matrix such that it maps on-screen coordinates to view-local coordinates. void unscheduleDrawable(Drawable who, Runnable what) Cancels a scheduled action on a drawable. void unscheduleDrawable(Drawable who) Unschedule any events associated with the given Drawable. final void updateDragShadow(View.DragShadowBuilder shadowBuilder) Updates the drag shadow for the ongoing drag and drop operation. boolean verifyDrawable(Drawable who) If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying. boolean willNotCacheDrawing() This method was deprecated in API level 28. 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 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. boolean willNotDraw() Returns whether or not this View draws on its own.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.view.accessibility.AccessibilityEventSource abstract void sendAccessibilityEvent(int eventType) Handles the request for sending an AccessibilityEvent given the event type. abstract void sendAccessibilityEventUnchecked(AccessibilityEvent event) Handles the request for sending an AccessibilityEvent.
From interface android.graphics.drawable.Drawable.Callback abstract void invalidateDrawable(Drawable who) Called when the drawable needs to be redrawn. abstract void scheduleDrawable(Drawable who, Runnable what, long when) A Drawable can call this to schedule the next frame of its animation. abstract void unscheduleDrawable(Drawable who, Runnable what) A Drawable can call this to unschedule an action previously scheduled with scheduleDrawable(Drawable, Runnable, long).
From interface android.view.KeyEvent.Callback abstract boolean onKeyDown(int keyCode, KeyEvent event) Called when a key down event has occurred. abstract boolean onKeyLongPress(int keyCode, KeyEvent event) Called when a long press has occurred. abstract boolean onKeyMultiple(int keyCode, int count, KeyEvent event) Called when a user's interaction with an analog control, such as flinging a trackball, generates simulated down/up events for the same key multiple times in quick succession. abstract boolean onKeyUp(int keyCode, KeyEvent event) Called when a key up event has occurred.

Constants

SURFACE_LIFECYCLE_DEFAULT

Added in API level 34

public static final int SURFACE_LIFECYCLE_DEFAULT

Default lifecycle of the Surface owned by this SurfaceView. The default lifecycle matches SURFACE_LIFECYCLE_FOLLOWS_VISIBILITY.

Constant Value: 0 (0x00000000)

SURFACE_LIFECYCLE_FOLLOWS_ATTACHMENT

Added in API level 34

public static final int SURFACE_LIFECYCLE_FOLLOWS_ATTACHMENT

The Surface lifecycle is tied to SurfaceView attachment. The Surface is created when the SurfaceView first becomes attached, but is not destroyed until this SurfaceView has been detached from the current window.

Constant Value: 2 (0x00000002)

SURFACE_LIFECYCLE_FOLLOWS_VISIBILITY

Added in API level 34

public static final int SURFACE_LIFECYCLE_FOLLOWS_VISIBILITY

The Surface lifecycle is tied to SurfaceView visibility. The Surface is created when the SurfaceView becomes visible, and is destroyed when the SurfaceView is no longer visible.

Constant Value: 1 (0x00000001)

Public constructors

SurfaceView

Added in API level 1

public SurfaceView (Context context)

Parameters
context	Context

SurfaceView

Added in API level 1

public SurfaceView (Context context, 
                AttributeSet attrs)

Parameters
context	Context
attrs	AttributeSet

SurfaceView

Added in API level 1

public SurfaceView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context	Context
attrs	AttributeSet
defStyleAttr	int

SurfaceView

Added in API level 21

public SurfaceView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context	Context
attrs	AttributeSet
defStyleAttr	int
defStyleRes	int

Public methods

applyTransactionToFrame

Added in API level 34

public void applyTransactionToFrame (SurfaceControl.Transaction transaction)

Adds a transaction that would be applied synchronously with displaying the SurfaceView's next frame. Note that the exact frame that the transaction is applied with is only well-defined when SurfaceView rendering is paused prior to calling applyTransactionToFrame(), so that the transaction is applied with the next frame rendered after applyTransactionToFrame() is called. If frames are continuously rendering to the SurfaceView when applyTransactionToFrame() is called, then it is undefined which frame the transaction is applied with. It is also possible for the transaction to not be applied if no new frames are rendered to the SurfaceView after this is called.

Parameters
transaction	SurfaceControl.Transaction: The transaction to apply. The system takes ownership of the transaction and promises to eventually apply the transaction. This value cannot be null.

Throws
IllegalStateException	if the underlying Surface does not exist (and therefore there is no next frame).

draw

Added in API level 1

public void draw (Canvas canvas)

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. This value cannot be null.

gatherTransparentRegion

Added in API level 1

public boolean gatherTransparentRegion (Region region)

This is used by the ViewRoot to perform an optimization when the view hierarchy contains one or several SurfaceView. SurfaceView is always considered transparent, but its children are not, therefore all View objects remove themselves from the global transparent region (passed as a parameter to this function).

Parameters
region	Region: The transparent region for this ViewAncestor (window). This value may be null.

Returns
boolean	Returns true if the effective visibility of the view at this point is opaque, regardless of the transparent region; returns false if it is possible for underlying windows to be seen behind the view.

getHolder

Added in API level 1

public SurfaceHolder getHolder ()

Return the SurfaceHolder providing access and control over this SurfaceView's underlying surface.

Returns
SurfaceHolder	SurfaceHolder The holder of the surface.

getHostToken

Added in API level 30
Deprecated in API level 35

public IBinder getHostToken ()

This method was deprecated in API level 35.
Use AttachedSurfaceControl.getInputTransferToken() instead.

A token used for constructing SurfaceControlViewHost. This token should be passed from the host process to the client process.

Returns
IBinder	The token This value may be null.

getImportantForAccessibility

Added in API level 16

public int getImportantForAccessibility ()

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.

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

getSurfaceControl

Added in API level 29

public SurfaceControl getSurfaceControl ()

Return a SurfaceControl which can be used for parenting Surfaces to this SurfaceView. Note that this SurfaceControl is effectively read-only. Its only well-defined usage is in using the SurfaceControl as a parent for an application's hierarchy of SurfaceControls. All other properties of the SurfaceControl, such as its position, may be mutated by the SurfaceView at any time which will override what the application is requesting. Do not apply any SurfaceControl.Transaction to this SurfaceControl except for reparenting child SurfaceControls. See: SurfaceControl.Transaction.reparent.

Returns
SurfaceControl	The SurfaceControl for this SurfaceView.

hasOverlappingRendering

Added in API level 16

public boolean hasOverlappingRendering ()

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 forceHasOverlappingRendering(boolean) has been called on this view.

Returns
boolean	true if the content in this view might overlap, false otherwise.

setAlpha

Added in API level 11

public void setAlpha (float alpha)

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

setChildSurfacePackage

Added in API level 30

public void setChildSurfacePackage (SurfaceControlViewHost.SurfacePackage p)

Displays the view-hierarchy embedded within a SurfaceControlViewHost.SurfacePackage within this SurfaceView. This can be called independently of the SurfaceView lifetime callbacks. SurfaceView will internally manage reparenting the package to our Surface as it is created and destroyed. If this SurfaceView is above its host Surface (see setZOrderOnTop(boolean) then the embedded Surface hierarchy will be able to receive input. This will take ownership of the SurfaceControl contained inside the SurfacePackage and free the caller of the obligation to call SurfaceControlViewHost.SurfacePackage.release. However, note that SurfaceControlViewHost.SurfacePackage.release and SurfaceControlViewHost.release are not the same. While the ownership of this particular SurfaceControlViewHost.SurfacePackage will be taken by the SurfaceView the underlying SurfaceControlViewHost remains managed by it's original remote-owner. Users can call ERROR(SurfaceView.clearChildSurfacePackage/android.view.SurfaceView#clearChildSurfacePackage SurfaceView.clearChildSurfacePackage) to clear the package.

Parameters
p	SurfaceControlViewHost.SurfacePackage: The SurfacePackage to embed. This value cannot be null.

setClipBounds

Added in API level 18

public void setClipBounds (Rect clipBounds)

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.

setDesiredHdrHeadroom

Added in API level 35

public void setDesiredHdrHeadroom (float desiredHeadroom)

Sets the desired amount of HDR headroom to be used when HDR content is presented on this SurfaceView. This is expressed as the ratio of maximum HDR white point over the SDR white point, not as absolute nits.

By default the system will choose an amount of HDR headroom that is appropriate for the underlying device capabilities & bit-depth of the panel. However, for some types of content this can end up being more headroom than necessary or desired. An example would be a messaging app or gallery thumbnail view where some amount of HDR pop is desired without overly influencing the perceived brightness of the majority SDR content. This can also be used to animate in/out of an HDR range for smoother transitions.

Note: The actual amount of HDR headroom that will be given is subject to a variety of factors such as ambient conditions, display capabilities, or bit-depth limitations. See Display.getHdrSdrRatio() for more information as well as how to query the current value.

Note: This API operates independently of both the Widow color mode and the Window desiredHdrHeadroom

Parameters
desiredHeadroom	float: The amount of HDR headroom that is desired. Must be >= 1.0 (no HDR) and <= 10,000.0. Passing 0.0 will reset to the default, automatically chosen value. Value is between 0.0f and 10000.0 inclusive

See also:

• Display.getHdrSdrRatio()

setSecure

Added in API level 17

public void setSecure (boolean isSecure)

Control whether the surface view's content should be treated as secure, preventing it from appearing in screenshots or from being viewed on non-secure displays.

Note that this must be set before the surface view's containing window is attached to the window manager.

See Display.FLAG_SECURE for details.

Parameters
isSecure	boolean: True if the surface view is secure.

setSurfaceLifecycle

Added in API level 34

public void setSurfaceLifecycle (int lifecycleStrategy)

Controls the lifecycle of the Surface owned by this SurfaceView.

By default, the lifecycycle strategy employed by the SurfaceView is SURFACE_LIFECYCLE_DEFAULT.

Parameters
lifecycleStrategy	int: The strategy for the lifecycle of the Surface owned by this SurfaceView. Value is SURFACE_LIFECYCLE_DEFAULT, SURFACE_LIFECYCLE_FOLLOWS_VISIBILITY, or SURFACE_LIFECYCLE_FOLLOWS_ATTACHMENT

setVisibility

Added in API level 1

public void setVisibility (int visibility)

Set the visibility state of this view.

Parameters
visibility	int: One of View.VISIBLE, View.INVISIBLE, or View.GONE. Value is View.VISIBLE, View.INVISIBLE, or View.GONE

setZOrderMediaOverlay

Added in API level 5

public void setZOrderMediaOverlay (boolean isMediaOverlay)

Control whether the surface view's surface is placed on top of another regular surface view in the window (but still behind the window itself). This is typically used to place overlays on top of an underlying media surface view.

Note that this must be set before the surface view's containing window is attached to the window manager.

Calling this overrides any previous call to setZOrderOnTop(boolean).

Parameters
isMediaOverlay	boolean

setZOrderOnTop

Added in API level 5

public void setZOrderOnTop (boolean onTop)

Control whether the surface view's surface is placed on top of its window. Normally it is placed behind the window, to allow it to (for the most part) appear to composite with the views in the hierarchy. By setting this, you cause it to be placed above the window. This means that none of the contents of the window this SurfaceView is in will be visible on top of its surface.

Note that this must be set before the surface view's containing window is attached to the window manager. If you target Build.VERSION_CODES.R the Z ordering can be changed dynamically if the backing surface is created, otherwise it would be applied at surface construction time.

Calling this overrides any previous call to setZOrderMediaOverlay(boolean).

Parameters
onTop	boolean: Whether to show the surface on top of this view's window.

Protected methods

dispatchDraw

Added in API level 1

protected void dispatchDraw (Canvas canvas)

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 This value cannot be null.

onAttachedToWindow

Added in API level 1

protected void onAttachedToWindow ()

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.

onDetachedFromWindow

Added in API level 1

protected void onDetachedFromWindow ()

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.

onFocusChanged

Added in API level 1

protected void onFocusChanged (boolean gainFocus, 
                int direction, 
                Rect previouslyFocusedRect)

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: Value is View.FOCUS_BACKWARD, View.FOCUS_FORWARD, View.FOCUS_LEFT, View.FOCUS_UP, View.FOCUS_RIGHT, or View.FOCUS_DOWN
previouslyFocusedRect	Rect: This value may be null.

onMeasure

Added in API level 1

protected void onMeasure (int widthMeasureSpec, 
                int heightMeasureSpec)

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 View.MeasureSpec.
heightMeasureSpec	int: vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.

onSetAlpha

Added in API level 1

protected boolean onSetAlpha (int alpha)

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

Returns
boolean	true if the view can draw with the specified alpha.

onWindowVisibilityChanged

Added in API level 1

protected void onWindowVisibilityChanged (int visibility)

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 View.VISIBLE, View.INVISIBLE, or View.GONE