LocationButton

Artifact: androidx.core.locationbutton:locationbutton

Kotlin |Java

class LocationButton : ViewGroup

kotlin.Any
↳	android.view.View
	↳	android.view.ViewGroup
		↳	androidx.core.locationbutton.LocationButton

A widget that provides a session-based precise location permission button. It either draws the button remotely rendered by the system on Build.VERSION_CODES.CINNAMON_BUN and above platforms, or falls back to a locally rendered button on platforms before Build.VERSION_CODES.CINNAMON_BUN.

On platforms before Build.VERSION_CODES.CINNAMON_BUN, the button click delegates to OnRequestPermissionsListener if provided, allowing the app to handle the click manually (e.g., by requesting permissions or displaying rationale). If no custom listener is provided, the library automatically requests location permissions.

Summary

Constants
`const Int`	`TEXT_TYPE_NEAR_MY_PRECISE_LOCATION`
`const Int`	`TEXT_TYPE_NEAR_YOUR_PRECISE_LOCATION`
`const Int`	`TEXT_TYPE_NONE`
`const Int`	`TEXT_TYPE_PRECISE_LOCATION`
`const Int`	`TEXT_TYPE_SHARE_PRECISE_LOCATION`
`const Int`	`TEXT_TYPE_USE_PRECISE_LOCATION`

Public constructors
`LocationButton( context: Context, attrs: AttributeSet?, defStyleAttr: Int, defStyleRes: Int )`

Public functions
`open Unit`	`addView(child: View?)`
`open Unit`	`addView(child: View?, index: Int)`
`open Unit`	`addView(child: View?, params: ViewGroup.LayoutParams?)`
`open Unit`	`addView(child: View?, index: Int, params: ViewGroup.LayoutParams?)`
`open Unit`	`addView(child: View?, width: Int, height: Int)`
`Int`	`getCompositionOrder()` Gets the composition order of the underlying SurfaceView.
`open Unit`	`setBackgroundColor(color: Int)`
`Unit`	`setCompositionOrder(order: Int)` Controls the composition order of the underlying SurfaceView.
`Unit`	`setCornerRadius(radius: Float)` Sets the corner radius of the button background.
`Unit`	`setIconTint(color: Int)` Sets the color tint applied to the location icon.
`Unit`	`setOnErrorListener(listener: OnErrorListener?)` Sets the listener to receive remote session errors on `Build.VERSION_CODES.CINNAMON_BUN` and above platforms.
`Unit`	`setOnPermissionResultListener(listener: OnPermissionResultListener?)` Sets the listener to receive permission results.
`Unit`	`setOnRequestPermissionsListener(listener: OnRequestPermissionsListener?)` Sets the listener to handle permission requests on platforms before `Build.VERSION_CODES.CINNAMON_BUN`.
`open Unit`	`setPadding(left: Int, top: Int, right: Int, bottom: Int)`
`open Unit`	`setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int)`
`Unit`	`setPressedCornerRadius(radius: Float)` Sets the corner radius of the button background when the user presses it.
`Unit`	`setStrokeColor(color: Int)` Sets the width of the button's outer stroke border.
`Unit`	`setStrokeWidth(strokeWidth: Int)` Sets the width of the button's outer stroke border.
`Unit`	`setTextColor(color: Int)` Sets the color of the text displayed inside the button.
`Unit`	`setTextType(textType: Int)` Sets the text content displayed inside the button.

Protected functions
`open Boolean`	`addViewInLayout(child: View?, index: Int, params: ViewGroup.LayoutParams?)`
`open Unit`	`onAttachedToWindow()`
`open Unit`	`onConfigurationChanged(newConfig: Configuration?)`
`open Unit`	`onDetachedFromWindow()`
`open Unit`	`onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int)`
`open Unit`	`onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)`
`open Unit`	`onSizeChanged(w: Int, h: Int, oldw: Int, oldh: Int)`

Public properties
`Activity?`	`parentActivity` The `Activity` that hosts this button.

Extension functions
`Unit`	`@RequiresApi(value = 37) LocationButton.setLocationButtonProvider( provider: LocationButtonProvider? )` Sets the `LocationButtonProvider` to provide a location button.

Inherited functions

From android.view.View

`Unit`	`addFocusables(views: ArrayList<View>, direction: Int)`
`Unit`	`addOnAttachStateChangeListener( listener: View.OnAttachStateChangeListener )`
`Unit`	`addOnLayoutChangeListener(listener: View.OnLayoutChangeListener)`
`Unit`	`addOnUnhandledKeyEventListener( listener: View.OnUnhandledKeyEventListener )`
`ViewPropertyAnimator`	`animate()`
`Unit`	`announceForAccessibility(text: CharSequence)`
`Unit`	`autofill(value: AutofillValue)`
`Unit`	`autofill(values: SparseArray<AutofillValue>)`
`Boolean`	`awakenScrollBars()`
`Boolean`	`awakenScrollBars(startDelay: Int)`
`Boolean`	`awakenScrollBars(startDelay: Int, invalidate: Boolean)`
`Unit`	`bringToFront()`
`Unit`	`buildDrawingCache()`
`Unit`	`buildDrawingCache(autoScale: Boolean)`
`Unit`	`buildLayer()`
`Boolean`	`callOnClick()`
`open Boolean`	`canResolveLayoutDirection()`
`open Boolean`	`canResolveTextAlignment()`
`open Boolean`	`canResolveTextDirection()`
`Boolean`	`canScrollHorizontally(direction: Int)`
`Boolean`	`canScrollVertically(direction: Int)`
`Unit`	`cancelDragAndDrop()`
`Unit`	`cancelLongPress()`
`Unit`	`cancelPendingInputEvents()`
`Boolean`	`checkInputConnectionProxy(view: View)`
`Unit`	`clearAnimation()`
`Unit`	`clearPendingCredentialRequest()`
`Unit`	`clearViewTranslationCallback()`
`Int`	`computeHorizontalScrollExtent()`
`Int`	`computeHorizontalScrollOffset()`
`Int`	`computeHorizontalScrollRange()`
`Unit`	`computeScroll()`
`WindowInsets`	`computeSystemWindowInsets(in: WindowInsets, outLocalInsets: Rect)`
`Int`	`computeVerticalScrollExtent()`
`Int`	`computeVerticalScrollOffset()`
`Int`	`computeVerticalScrollRange()`
`AccessibilityNodeInfo`	`createAccessibilityNodeInfo()`
`open Unit`	`createContextMenu(menu: ContextMenu)`
`Unit`	`destroyDrawingCache()`
`Boolean`	`dispatchGenericMotionEvent(event: MotionEvent)`
`Boolean`	`dispatchNestedFling(velocityX: Float, velocityY: Float, consumed: Boolean)`
`Boolean`	`dispatchNestedPreFling(velocityX: Float, velocityY: Float)`
`Boolean`	`dispatchNestedPrePerformAccessibilityAction( action: Int, arguments: Bundle? )`
`Boolean`	`dispatchNestedPreScroll( dx: Int, dy: Int, consumed: IntArray?, offsetInWindow: IntArray? )`
`Boolean`	`dispatchNestedScroll( dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, offsetInWindow: IntArray? )`
`Boolean`	`dispatchPopulateAccessibilityEvent(event: AccessibilityEvent)`
`Unit`	`draw(canvas: Canvas)`
`Unit`	`drawableHotspotChanged(x: Float, y: Float)`
`OnBackInvokedDispatcher?`	`findOnBackInvokedDispatcher()`
`T`	`<T : View> findViewById(id: Int)`
`T`	`<T : View> findViewWithTag(tag: Any)`
`Boolean`	`fitSystemWindows(insets: Rect)`
`View`	`focusSearch(direction: Int)`
`Unit`	`forceHasOverlappingRendering(hasOverlappingRendering: Boolean)`
`Unit`	`forceLayout()`
`Unit`	`generateDisplayHash( hashAlgorithm: String, bounds: Rect?, executor: Executor, callback: DisplayHashResultCallback )`
`IntArray`	`getAttributeResolutionStack(attribute: Int)`
`Boolean`	`getClipBounds(outRect: Rect)`
`Bitmap`	`getDrawingCache(autoScale: Boolean)`
`Unit`	`getDrawingRect(outRect: Rect)`
`ArrayList<View>`	`getFocusables(direction: Int)`
`Unit`	`getFocusedRect(r: Rect)`
`Boolean`	`getGlobalVisibleRect(r: Rect)`
`Boolean`	`getGlobalVisibleRect(r: Rect, globalOffset: Point)`
`Unit`	`getHitRect(outRect: Rect)`
`open Int`	`@ViewDebug.ExportedProperty(category = "layout", mapping = [@ViewDebug.IntToString(from = 0, to = "RESOLVED_DIRECTION_LTR"), @ViewDebug.IntToString(from = 1, to = "RESOLVED_DIRECTION_RTL")]) getLayoutDirection()`
`Boolean`	`getLocalVisibleRect(r: Rect)`
`Unit`	`getLocationInSurface(location: IntArray)`
`Unit`	`getLocationInWindow(outLocation: IntArray)`
`Unit`	`getLocationOnScreen(outLocation: IntArray)`
`ViewParent`	`getParent()`
`open ViewParent`	`getParentForAccessibility()`
`Any`	`getTag(key: Int)`
`open Int`	`@ViewDebug.ExportedProperty(category = "text", mapping = [@ViewDebug.IntToString(from = 0, to = "INHERIT"), @ViewDebug.IntToString(from = 1, to = "GRAVITY"), @ViewDebug.IntToString(from = 2, to = "TEXT_START"), @ViewDebug.IntToString(from = 3, to = "TEXT_END"), @ViewDebug.IntToString(from = 4, to = "CENTER"), @ViewDebug.IntToString(from = 5, to = "VIEW_START"), @ViewDebug.IntToString(from = 6, to = "VIEW_END")]) getTextAlignment()`
`open Int`	@ViewDebug.ExportedProperty(category = "text", mapping = [@ViewDebug.IntToString(from = 0, to = "INHERIT"), @ViewDebug.IntToString(from = 1, to = "FIRST_STRONG"), @ViewDebug.IntToString(from = 2, to = "ANY_RTL"), @ViewDebug.IntToString(from = 3, to = "LTR"), @ViewDebug.IntToString(from = 4, to = "RTL"), @ViewDebug.IntToString(from = 5, to = "LOCALE"), @ViewDebug.IntToString(from = 6, to = "FIRST_STRONG_LTR"), @ViewDebug.IntToString(from = 7, to = "FIRST_STRONG_RTL")]) getTextDirection()
`Unit`	`getWindowVisibleDisplayFrame(outRect: Rect)`
`Boolean`	`hasExplicitFocusable()`
`Boolean`	`hasFocusable()`
`Boolean`	`hasNestedScrollingParent()`
`Boolean`	`hasOnClickListeners()`
`Boolean`	`hasOnLongClickListeners()`
`Boolean`	`hasOverlappingRendering()`
`Boolean`	`hasPointerCapture()`
`Boolean`	`hasWindowFocus()`
`Unit`	`invalidate()`
`Unit`	`invalidate(dirty: Rect)`
`Unit`	`invalidate(l: Int, t: Int, r: Int, b: Int)`
`Unit`	`invalidateDrawable(drawable: Drawable)`
`Unit`	`invalidateOutline()`
`open Boolean`	`isLayoutDirectionResolved()`
`open Boolean`	`isLayoutRequested()`
`open Boolean`	`isTextAlignmentResolved()`
`open Boolean`	`isTextDirectionResolved()`
`Boolean`	`isVisibleToUserForAutofill(virtualId: Int)`
`open View`	`keyboardNavigationClusterSearch(currentCluster: View, direction: Int)`
`Unit`	`measure(widthMeasureSpec: Int, heightMeasureSpec: Int)`
`Unit`	`offsetLeftAndRight(offset: Int)`
`Unit`	`offsetTopAndBottom(offset: Int)`
`Unit`	`onAnimationEnd()`
`Unit`	`onAnimationStart()`
`WindowInsets`	`onApplyWindowInsets(insets: WindowInsets)`
`Unit`	`onCancelPendingInputEvents()`
`Boolean`	`onCapturedPointerEvent(event: MotionEvent)`
`Boolean`	`onCheckIsTextEditor()`
`Unit`	`onCreateContextMenu(menu: ContextMenu)`
`InputConnection`	`onCreateInputConnection(outAttrs: EditorInfo)`
`Unit`	`onCreateViewTranslationRequest( supportedFormats: IntArray, requestsCollector: Consumer<ViewTranslationRequest> )`
`Unit`	`onCreateVirtualViewTranslationRequests( virtualIds: LongArray, supportedFormats: IntArray, requestsCollector: Consumer<ViewTranslationRequest> )`
`Unit`	`onDisplayHint(hint: Int)`
`Boolean`	`onDragEvent(event: DragEvent)`
`Unit`	`onDraw(canvas: Canvas)`
`Unit`	`onDrawForeground(canvas: Canvas)`
`Unit`	`onDrawScrollBars(canvas: Canvas)`
`Boolean`	`onFilterTouchEventForSecurity(event: MotionEvent)`
`Unit`	`onFinishInflate()`
`Unit`	`onFinishTemporaryDetach()`
`Unit`	`onFocusChanged( gainFocus: Boolean, direction: Int, previouslyFocusedRect: Rect? )`
`Boolean`	`onGenericMotionEvent(event: MotionEvent)`
`Unit`	`onHoverChanged(hovered: Boolean)`
`Boolean`	`onHoverEvent(event: MotionEvent)`
`Unit`	`onInitializeAccessibilityEvent(event: AccessibilityEvent)`
`Unit`	`onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo)`
`Boolean`	`onKeyDown(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyLongPress(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyMultiple(keyCode: Int, repeatCount: Int, event: KeyEvent)`
`Boolean`	`onKeyPreIme(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyShortcut(keyCode: Int, event: KeyEvent)`
`Boolean`	`onKeyUp(keyCode: Int, event: KeyEvent)`
`Unit`	`onOverScrolled( scrollX: Int, scrollY: Int, clampedX: Boolean, clampedY: Boolean )`
`Unit`	`onPointerCaptureChange(hasCapture: Boolean)`
`Unit`	`onPopulateAccessibilityEvent(event: AccessibilityEvent)`
`Unit`	`onProvideAutofillStructure(structure: ViewStructure, flags: Int)`
`Unit`	`onProvideAutofillVirtualStructure(structure: ViewStructure, flags: Int)`
`Unit`	`onProvideContentCaptureStructure(structure: ViewStructure, flags: Int)`
`Unit`	`onProvideStructure(structure: ViewStructure)`
`Unit`	`onProvideVirtualStructure(structure: ViewStructure)`
`ContentInfo?`	`onReceiveContent(payload: ContentInfo)`
`Unit`	`onRestoreInstanceState(state: Parcelable)`
`Unit`	`onRtlPropertiesChanged(layoutDirection: Int)`
`Parcelable?`	`onSaveInstanceState()`
`Unit`	`onScreenStateChanged(screenState: Int)`
`Unit`	`onScrollCaptureSearch( localVisibleRect: Rect, windowOffset: Point, targets: Consumer<ScrollCaptureTarget> )`
`Unit`	`onScrollChanged(l: Int, t: Int, oldl: Int, oldt: Int)`
`Boolean`	`onSetAlpha(alpha: Int)`
`Unit`	`onStartTemporaryDetach()`
`Boolean`	`onTouchEvent(event: MotionEvent)`
`Boolean`	`onTrackballEvent(event: MotionEvent)`
`Unit`	`onViewTranslationResponse(response: ViewTranslationResponse)`
`Unit`	`onVirtualViewTranslationResponses( response: LongSparseArray<ViewTranslationResponse> )`
`Unit`	`onVisibilityAggregated(isVisible: Boolean)`
`Unit`	`onVisibilityChanged(changedView: View, visibility: Int)`
`Unit`	`onWindowFocusChanged(hasWindowFocus: Boolean)`
`Unit`	`onWindowSystemUiVisibilityChanged(visible: Int)`
`Unit`	`onWindowVisibilityChanged(visibility: Int)`
`Boolean`	`overScrollBy( deltaX: Int, deltaY: Int, scrollX: Int, scrollY: Int, scrollRangeX: Int, scrollRangeY: Int, maxOverScrollX: Int, maxOverScrollY: Int, isTouchEvent: Boolean )`
`Boolean`	`performAccessibilityAction(action: Int, arguments: Bundle?)`
`Boolean`	`performClick()`
`Boolean`	`performContextClick()`
`Boolean`	`performContextClick(x: Float, y: Float)`
`Boolean`	`performHapticFeedback(feedbackConstant: Int)`
`Boolean`	`performHapticFeedback(request: HapticFeedbackRequest)`
`Boolean`	`performHapticFeedback(feedbackConstant: Int, flags: Int)`
`Boolean`	`performLongClick()`
`Boolean`	`performLongClick(x: Float, y: Float)`
`ContentInfo?`	`performReceiveContent(payload: ContentInfo)`
`Unit`	`playSoundEffect(soundConstant: Int)`
`Boolean`	`post(action: Runnable)`
`Boolean`	`postDelayed(action: Runnable, delayMillis: Long)`
`Unit`	`postInvalidate()`
`Unit`	`postInvalidate(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`postInvalidateDelayed(delayMilliseconds: Long)`
`Unit`	`postInvalidateDelayed( delayMilliseconds: Long, left: Int, top: Int, right: Int, bottom: Int )`
`Unit`	`postInvalidateOnAnimation()`
`Unit`	`postInvalidateOnAnimation(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`postOnAnimation(action: Runnable)`
`Unit`	`postOnAnimationDelayed(action: Runnable, delayMillis: Long)`
`Unit`	`refreshDrawableState()`
`Unit`	`releasePointerCapture()`
`Boolean`	`removeCallbacks(action: Runnable)`
`Unit`	`removeOnAttachStateChangeListener( listener: View.OnAttachStateChangeListener )`
`Unit`	`removeOnLayoutChangeListener(listener: View.OnLayoutChangeListener)`
`Unit`	`removeOnUnhandledKeyEventListener( listener: View.OnUnhandledKeyEventListener )`
`Unit`	`reportAppJankStats(appJankStats: AppJankStats)`
`Unit`	`requestApplyInsets()`
`open Unit`	`requestFitSystemWindows()` This function is deprecated. Deprecated in Java
`Boolean`	`requestFocus()`
`Boolean`	`requestFocus(direction: Int)`
`Boolean`	`requestFocusFromTouch()`
`open Unit`	`requestLayout()`
`Unit`	`requestPointerCapture()`
`Unit`	`requestPointerCapture(mode: Int)`
`Boolean`	`requestRectangleOnScreen(rectangle: Rect)`
`Boolean`	`requestRectangleOnScreen(rectangle: Rect, immediate: Boolean)`
`Boolean`	`requestRectangleOnScreen(rectangle: Rect, immediate: Boolean, source: Int)`
`Unit`	`requestUnbufferedDispatch(event: MotionEvent)`
`Unit`	`requestUnbufferedDispatch(source: Int)`
`T`	`<T : View> requireViewById(id: Int)`
`Unit`	`resetPivot()`
`Unit`	`restoreHierarchyState(container: SparseArray<Parcelable>)`
`Unit`	`saveAttributeDataForStyleable( context: Context, styleable: IntArray, attrs: AttributeSet?, t: TypedArray, defStyleAttr: Int, defStyleRes: Int )`
`Unit`	`saveHierarchyState(container: SparseArray<Parcelable>)`
`Unit`	`scheduleDrawable(who: Drawable, what: Runnable, when: Long)`
`Unit`	`scrollBy(x: Int, y: Int)`
`Unit`	`scrollTo(x: Int, y: Int)`
`Unit`	`sendAccessibilityEvent(eventType: Int)`
`Unit`	`sendAccessibilityEventUnchecked(event: AccessibilityEvent)`
`Unit`	`setAccessibilityDataSensitive(accessibilityDataSensitive: Int)`
`Unit`	`setAllowClickWhenDisabled(clickableWhenDisabled: Boolean)`
`Unit`	`setAllowedHandwritingDelegatePackage(allowedPackageName: String?)`
`Unit`	`setAllowedHandwritingDelegatorPackage(allowedPackageName: String?)`
`Unit`	`setAutofillHints(vararg autofillHints: String)`
`Unit`	`setBackgroundDrawable(background: Drawable)`
`Unit`	`setBackgroundResource(resid: Int)`
`Unit`	`setFadingEdgeLength(length: Int)`
`Unit`	`setHandwritingBoundsOffsets( offsetLeft: Float, offsetTop: Float, offsetRight: Float, offsetBottom: Float )`
`Unit`	`setHasTransientState(hasTransientState: Boolean)`
`Unit`	`setIsCredential(isCredential: Boolean)`
`Unit`	`setIsHandwritingDelegate(isHandwritingDelegate: Boolean)`
`Unit`	`setLayerPaint(paint: Paint?)`
`Unit`	`setLayerType(layerType: Int, paint: Paint?)`
`Unit`	`setLeftTopRightBottom(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`setMeasuredDimension(measuredWidth: Int, measuredHeight: Int)`
`Unit`	`setOnApplyWindowInsetsListener( listener: View.OnApplyWindowInsetsListener )`
`Unit`	`setOnCapturedPointerListener(l: View.OnCapturedPointerListener)`
`Unit`	`setOnClickListener(l: View.OnClickListener?)`
`Unit`	`setOnContextClickListener(l: View.OnContextClickListener?)`
`Unit`	`setOnCreateContextMenuListener(l: View.OnCreateContextMenuListener)`
`Unit`	`setOnDragListener(l: View.OnDragListener)`
`Unit`	`setOnGenericMotionListener(l: View.OnGenericMotionListener)`
`Unit`	`setOnHoverListener(l: View.OnHoverListener)`
`Unit`	`setOnKeyListener(l: View.OnKeyListener)`
`Unit`	`setOnLongClickListener(l: View.OnLongClickListener?)`
`Unit`	`setOnReceiveContentListener( mimeTypes: Array<String>?, listener: OnReceiveContentListener? )`
`Unit`	`setOnScrollChangeListener(l: View.OnScrollChangeListener)`
`Unit`	`setOnSystemUiVisibilityChangeListener( l: View.OnSystemUiVisibilityChangeListener )`
`Unit`	`setOnTouchListener(l: View.OnTouchListener)`
`Unit`	`setPendingCredentialRequest( request: GetCredentialRequest, callback: OutcomeReceiver<GetCredentialResponse, GetCredentialException> )`
`Unit`	`setRenderEffect(renderEffect: RenderEffect?)`
`Unit`	`setScrollCaptureCallback(callback: ScrollCaptureCallback?)`
`Unit`	`setScrollIndicators(indicators: Int, mask: Int)`
`Unit`	`setTag(key: Int, tag: Any)`
`Unit`	`setTransitionVisibility(visibility: Int)`
`Unit`	`setViewTranslationCallback(callback: ViewTranslationCallback)`
`Unit`	`setWillNotCacheDrawing(willNotCacheDrawing: Boolean)`
`Unit`	`setWillNotDraw(willNotDraw: Boolean)`
`Boolean`	`showContextMenu()`
`Boolean`	`showContextMenu(x: Float, y: Float)`
`ActionMode`	`startActionMode(callback: ActionMode.Callback)`
`ActionMode`	`startActionMode(callback: ActionMode.Callback, type: Int)`
`Unit`	`startAnimation(animation: Animation)`
`Boolean`	`startDrag( data: ClipData, shadowBuilder: View.DragShadowBuilder, myLocalState: Any, flags: Int )`
`Boolean`	`startDragAndDrop( data: ClipData, shadowBuilder: View.DragShadowBuilder, myLocalState: Any, flags: Int )`
`Boolean`	`startNestedScroll(axes: Int)`
`Unit`	`stopNestedScroll()`
`open String`	`toString()`
`Unit`	`transformMatrixToGlobal(matrix: Matrix)`
`Unit`	`transformMatrixToLocal(matrix: Matrix)`
`Unit`	`unscheduleDrawable(who: Drawable)`
`Unit`	`unscheduleDrawable(who: Drawable, what: Runnable)`
`Unit`	`updateDragShadow(shadowBuilder: View.DragShadowBuilder)`
`Boolean`	`verifyDrawable(who: Drawable)`
`Boolean`	`willNotCacheDrawing()`
`Boolean`	`willNotDraw()`

From android.view.ViewGroup

`Unit`	`addChildrenForAccessibility(outChildren: ArrayList<View>)`
`Unit`	`addExtraDataToAccessibilityNodeInfo( info: AccessibilityNodeInfo, extraDataKey: String, arguments: Bundle? )`
`Unit`	`addFocusables(views: ArrayList<View>, direction: Int, focusableMode: Int)`
`Unit`	`addKeyboardNavigationClusters( views: MutableCollection<View>, direction: Int )`
`Boolean`	`addStatesFromChildren()`
`Unit`	`addTouchables(views: ArrayList<View>)`
`Boolean`	`addViewInLayout( child: View, index: Int, params: ViewGroup.LayoutParams, preventRequestLayout: Boolean )`
`Unit`	`attachLayoutAnimationParameters( child: View, params: ViewGroup.LayoutParams, index: Int, count: Int )`
`Unit`	`attachViewToParent(child: View, index: Int, params: ViewGroup.LayoutParams)`
`Unit`	`bringChildToFront(child: View)`
`Boolean`	`canAnimate()`
`Boolean`	`checkLayoutParams(p: ViewGroup.LayoutParams)`
`Unit`	`childDrawableStateChanged(child: View)`
`Unit`	`childHasTransientStateChanged( child: View, childHasTransientState: Boolean )`
`Unit`	`cleanupLayoutState(child: View)`
`Unit`	`clearChildFocus(child: View)`
`Unit`	`clearDisappearingChildren()`
`Unit`	`clearFocus()`
`Unit`	`debug(depth: Int)`
`Unit`	`detachAllViewsFromParent()`
`Unit`	`detachViewFromParent(child: View)`
`Unit`	`detachViewFromParent(index: Int)`
`Unit`	`detachViewsFromParent(start: Int, count: Int)`
`WindowInsets`	`dispatchApplyWindowInsets(insets: WindowInsets)`
`Boolean`	`dispatchCapturedPointerEvent(event: MotionEvent)`
`Unit`	`dispatchConfigurationChanged(newConfig: Configuration)`
`Unit`	`dispatchCreateViewTranslationRequest( viewIds: MutableMap<AutofillId, LongArray>, supportedFormats: IntArray, capability: TranslationCapability, requests: MutableList<ViewTranslationRequest> )`
`Unit`	`dispatchDisplayHint(hint: Int)`
`Boolean`	`dispatchDragEvent(event: DragEvent)`
`Unit`	`dispatchDraw(canvas: Canvas)`
`Unit`	`dispatchDrawableHotspotChanged(x: Float, y: Float)`
`Unit`	`dispatchFinishTemporaryDetach()`
`Unit`	`dispatchFreezeSelfOnly(container: SparseArray<Parcelable>)`
`Boolean`	`dispatchGenericFocusedEvent(event: MotionEvent)`
`Boolean`	`dispatchGenericPointerEvent(event: MotionEvent)`
`Boolean`	`dispatchHoverEvent(event: MotionEvent)`
`Boolean`	`dispatchKeyEvent(event: KeyEvent)`
`Boolean`	`dispatchKeyEventPreIme(event: KeyEvent)`
`Boolean`	`dispatchKeyShortcutEvent(event: KeyEvent)`
`Unit`	`dispatchPointerCaptureChanged(hasCapture: Boolean)`
`Unit`	`dispatchProvideAutofillStructure(structure: ViewStructure, flags: Int)`
`Unit`	`dispatchProvideStructure(structure: ViewStructure)`
`Unit`	`dispatchRestoreInstanceState(container: SparseArray<Parcelable>)`
`Unit`	`dispatchSaveInstanceState(container: SparseArray<Parcelable>)`
`Unit`	`dispatchScrollCaptureSearch( localVisibleRect: Rect, windowOffset: Point, targets: Consumer<ScrollCaptureTarget> )`
`Unit`	`dispatchSetActivated(activated: Boolean)`
`Unit`	`dispatchSetPressed(pressed: Boolean)`
`Unit`	`dispatchSetSelected(selected: Boolean)`
`Unit`	`dispatchStartTemporaryDetach()`
`Unit`	`dispatchSystemUiVisibilityChanged(visible: Int)`
`Unit`	`dispatchThawSelfOnly(container: SparseArray<Parcelable>)`
`Boolean`	`dispatchTouchEvent(ev: MotionEvent)`
`Boolean`	`dispatchTrackballEvent(event: MotionEvent)`
`Boolean`	`dispatchUnhandledMove(focused: View, direction: Int)`
`Unit`	`dispatchVisibilityChanged(changedView: View, visibility: Int)`
`Unit`	`dispatchWindowFocusChanged(hasFocus: Boolean)`
`Unit`	`dispatchWindowInsetsAnimationEnd(animation: WindowInsetsAnimation)`
`Unit`	`dispatchWindowInsetsAnimationPrepare(animation: WindowInsetsAnimation)`
`WindowInsets`	`dispatchWindowInsetsAnimationProgress( insets: WindowInsets, runningAnimations: MutableList<WindowInsetsAnimation> )`
`WindowInsetsAnimation.Bounds`	`dispatchWindowInsetsAnimationStart( animation: WindowInsetsAnimation, bounds: WindowInsetsAnimation.Bounds )`
`Unit`	`dispatchWindowSystemUiVisiblityChanged(visible: Int)`
`Unit`	`dispatchWindowVisibilityChanged(visibility: Int)`
`Boolean`	`drawChild(canvas: Canvas, child: View, drawingTime: Long)`
`Unit`	`drawableStateChanged()`
`Unit`	`endViewTransition(view: View)`
`View`	`findFocus()`
`OnBackInvokedDispatcher?`	`findOnBackInvokedDispatcherForChild(child: View, requester: View)`
`Unit`	`findViewsWithText( outViews: ArrayList<View>, text: CharSequence, flags: Int )`
`View`	`focusSearch(focused: View, direction: Int)`
`Unit`	`focusableViewAvailable(v: View)`
`Boolean`	`gatherTransparentRegion(region: Region?)`
`ViewGroup.LayoutParams`	`generateDefaultLayoutParams()`
`ViewGroup.LayoutParams`	`generateLayoutParams(attrs: AttributeSet)`
`ViewGroup.LayoutParams`	`generateLayoutParams(p: ViewGroup.LayoutParams)`
`View`	`getChildAt(index: Int)`
`Int`	`getChildDrawingOrder(drawingPosition: Int)`
`Int`	`getChildDrawingOrder(childCount: Int, drawingPosition: Int)`
`Boolean`	`getChildStaticTransformation(child: View, t: Transformation)`
`Boolean`	`getChildVisibleRect(child: View, r: Rect, offset: Point)`
`Boolean`	`hasFocus()`
`Boolean`	`hasTransientState()`
`Int`	`indexOfChild(child: View)`
`Unit`	`invalidateChild(child: View, dirty: Rect)`
`ViewParent`	`invalidateChildInParent(location: IntArray, dirty: Rect)`
`Unit`	`jumpDrawablesToCurrentState()`
`Unit`	`layout(l: Int, t: Int, r: Int, b: Int)`
`Unit`	`measureChild( child: View, parentWidthMeasureSpec: Int, parentHeightMeasureSpec: Int )`
`Unit`	`measureChildWithMargins( child: View, parentWidthMeasureSpec: Int, widthUsed: Int, parentHeightMeasureSpec: Int, heightUsed: Int )`
`Unit`	`measureChildren(widthMeasureSpec: Int, heightMeasureSpec: Int)`
`Unit`	`notifySubtreeAccessibilityStateChanged( child: View, source: View, changeType: Int )`
`Unit`	`offsetDescendantRectToMyCoords(descendant: View, rect: Rect)`
`Unit`	`offsetRectIntoDescendantCoords(descendant: View, rect: Rect)`
`IntArray`	`onCreateDrawableState(extraSpace: Int)`
`Unit`	`onDescendantInvalidated(child: View, target: View)`
`Boolean`	`onInterceptHoverEvent(event: MotionEvent)`
`Boolean`	`onInterceptTouchEvent(ev: MotionEvent)`
`Boolean`	`onNestedFling( target: View, velocityX: Float, velocityY: Float, consumed: Boolean )`
`Boolean`	`onNestedPreFling(target: View, velocityX: Float, velocityY: Float)`
`Boolean`	`onNestedPrePerformAccessibilityAction( target: View, action: Int, args: Bundle? )`
`Unit`	`onNestedPreScroll(target: View, dx: Int, dy: Int, consumed: IntArray)`
`Unit`	`onNestedScroll( target: View, dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int )`
`Unit`	`onNestedScrollAccepted(child: View, target: View, axes: Int)`
`Boolean`	`onRequestFocusInDescendants(direction: Int, previouslyFocusedRect: Rect)`
`Boolean`	`onRequestSendAccessibilityEvent(child: View, event: AccessibilityEvent)`
`PointerIcon`	`onResolvePointerIcon(event: MotionEvent, pointerIndex: Int)`
`Boolean`	`onStartNestedScroll(child: View, target: View, nestedScrollAxes: Int)`
`Unit`	`onStopNestedScroll(child: View)`
`Unit`	`onViewAdded(child: View)`
`Unit`	`onViewRemoved(child: View)`
`Unit`	`propagateRequestedFrameRate(frameRate: Float, forceOverride: Boolean)`
`Unit`	`recomputeViewAttributes(child: View)`
`Unit`	`removeAllViews()`
`Unit`	`removeAllViewsInLayout()`
`Unit`	`removeDetachedView(child: View, animate: Boolean)`
`Unit`	`removeView(view: View)`
`Unit`	`removeViewAt(index: Int)`
`Unit`	`removeViewInLayout(view: View)`
`Unit`	`removeViews(start: Int, count: Int)`
`Unit`	`removeViewsInLayout(start: Int, count: Int)`
`Unit`	`requestChildFocus(child: View, focused: View)`
`Boolean`	`requestChildRectangleOnScreen( child: View, rectangle: Rect, immediate: Boolean )`
`Unit`	`requestDisallowInterceptTouchEvent(disallowIntercept: Boolean)`
`Boolean`	`requestFocus(direction: Int, previouslyFocusedRect: Rect)`
`Boolean`	`requestSendAccessibilityEvent(child: View, event: AccessibilityEvent)`
`Unit`	`requestTransparentRegion(child: View)`
`Boolean`	`restoreDefaultFocus()`
`Unit`	`scheduleLayoutAnimation()`
`Unit`	`setAddStatesFromChildren(addsStates: Boolean)`
`Unit`	`setChildrenDrawingCacheEnabled(enabled: Boolean)`
`Unit`	`setOnHierarchyChangeListener( listener: ViewGroup.OnHierarchyChangeListener )`
`Unit`	`setStaticTransformationsEnabled(enabled: Boolean)`
`Unit`	`setWindowInsetsAnimationCallback( callback: WindowInsetsAnimation.Callback? )`
`Boolean`	`shouldDelayChildPressedState()`
`Boolean`	`showContextMenuForChild(originalView: View)`
`Boolean`	`showContextMenuForChild(originalView: View, x: Float, y: Float)`
`ActionMode`	`startActionModeForChild( originalView: View, callback: ActionMode.Callback )`
`ActionMode`	`startActionModeForChild( originalView: View, callback: ActionMode.Callback, type: Int )`
`Unit`	`startLayoutAnimation()`
`Unit`	`startViewTransition(view: View)`
`Unit`	`suppressLayout(suppress: Boolean)`
`Unit`	`updateViewLayout(view: View, params: ViewGroup.LayoutParams)`

From android.view.ViewParent

Boolean

requestChildRectangleOnScreen(
    child: View,
    rectangle: Rect,
    immediate: Boolean,
    source: Int
)

Inherited properties

From android.view.View

`open View.AccessibilityDelegate`	`accessibilityDelegate`
`open Int`	`accessibilityLiveRegion`
`open AccessibilityNodeProvider`	`accessibilityNodeProvider`
`open CharSequence?`	`accessibilityPaneTitle`
`open Int`	`accessibilityTraversalAfter`
`open Int`	`accessibilityTraversalBefore`
`open String?`	`allowedHandwritingDelegatePackageName`
`open String?`	`allowedHandwritingDelegatorPackageName`
`open Float`	`alpha`
`open Animation`	`animation`
`open Matrix?`	`animationMatrix`
`open IBinder`	`applicationWindowToken`
`open MutableMap<Int, Int>`	`attributeSourceResourceMap`
`open Array<String>?`	`autofillHints`
`AutofillId`	`autofillId`
`open Int`	`autofillType`
`open AutofillValue?`	`autofillValue`
`open Drawable`	`background`
`open BlendMode?`	`backgroundTintBlendMode`
`open ColorStateList?`	`backgroundTintList`
`open PorterDuff.Mode?`	`backgroundTintMode`
`open Int`	`baseline`
`Int`	`bottom`
`open Float`	`bottomFadingEdgeStrength`
`open Int`	`bottomPaddingOffset`
`open Float`	`cameraDistance`
`open Rect`	`clipBounds`
`Boolean`	`clipToOutline`
`ContentCaptureSession?`	`contentCaptureSession`
`open CharSequence`	`contentDescription`
`Int`	`contentSensitivity`
`Context`	`context`
`open ContextMenu.ContextMenuInfo`	`contextMenuInfo`
`Boolean`	`defaultFocusHighlightEnabled`
`open Display`	`display`
`IntArray`	`drawableState`
`open Bitmap`	`drawingCache`
`open Int`	`drawingCacheBackgroundColor`
`open Int`	`drawingCacheQuality`
`open Long`	`drawingTime`
`open Float`	`elevation`
`open Int`	`explicitStyle`
`open Boolean`	`filterTouchesWhenObscured`
`open Boolean`	`fitsSystemWindows`
`open Int`	`focusable`
`open Drawable`	`foreground`
`open Int`	`foregroundGravity`
`open BlendMode?`	`foregroundTintBlendMode`
`open ColorStateList?`	`foregroundTintList`
`open PorterDuff.Mode?`	`foregroundTintMode`
`open Float`	`frameContentVelocity`
`open Handler`	`handler`
`open Float`	`handwritingBoundsOffsetBottom`
`open Float`	`handwritingBoundsOffsetLeft`
`open Float`	`handwritingBoundsOffsetRight`
`open Float`	`handwritingBoundsOffsetTop`
`open Int`	`handwritingDelegateFlags`
`open Runnable?`	`handwritingDelegatorCallback`
`Boolean`	`hasOverlappingRendering`
`Int`	`height`
`open Int`	`horizontalFadingEdgeLength`
`open Int`	`horizontalScrollbarHeight`
`open Drawable?`	`horizontalScrollbarThumbDrawable`
`open Drawable?`	`horizontalScrollbarTrackDrawable`
`open Int`	`id`
`open Int`	`importantForAccessibility`
`open Int`	`importantForAutofill`
`open Int`	`importantForContentCapture`
`open Boolean`	`isAccessibilityDataSensitive`
`open Boolean`	`isAccessibilityFocused`
`open Boolean`	`isAccessibilityHeading`
`open Boolean`	`isActivated`
`open Boolean`	`isAttachedToWindow`
`open Boolean`	`isAutoHandwritingEnabled`
`open Boolean`	`isClickable`
`Boolean`	`isContentSensitive`
`open Boolean`	`isContextClickable`
`open Boolean`	`isCredential`
`open Boolean`	`isDirty`
`open Boolean`	`isDrawingCacheEnabled`
`open Boolean`	`isDuplicateParentStateEnabled`
`open Boolean`	`isEnabled`
`Boolean`	`isFocusable`
`Boolean`	`isFocusableInTouchMode`
`open Boolean`	`isFocused`
`Boolean`	`isFocusedByDefault`
`open Boolean`	`isForceDarkAllowed`
`open Boolean`	`isHandwritingDelegate`
`open Boolean`	`isHapticFeedbackEnabled`
`open Boolean`	`isHardwareAccelerated`
`open Boolean`	`isHorizontalFadingEdgeEnabled`
`open Boolean`	`isHorizontalScrollBarEnabled`
`open Boolean`	`isHovered`
`open Boolean`	`isImportantForAccessibility`
`Boolean`	`isImportantForAutofill`
`Boolean`	`isImportantForContentCapture`
`open Boolean`	`isInEditMode`
`open Boolean`	`isInLayout`
`open Boolean`	`isInTouchMode`
`Boolean`	`isKeyboardNavigationCluster`
`open Boolean`	`isLaidOut`
`open Boolean`	`isLayoutDirectionResolved`
`open Boolean`	`isLayoutRequested`
`open Boolean`	`isLongClickable`
`open Boolean`	`isNestedScrollingEnabled`
`open Boolean`	`isOpaque`
`open Boolean`	`isPaddingOffsetRequired`
`open Boolean`	`isPaddingRelative`
`open Boolean`	`isPivotSet`
`Boolean`	`isPreferKeepClear`
`open Boolean`	`isPressed`
`open Boolean`	`isSaveEnabled`
`open Boolean`	`isSaveFromParentEnabled`
`open Boolean`	`isScreenReaderFocusable`
`open Boolean`	`isScrollContainer`
`open Boolean`	`isScrollbarFadingEnabled`
`open Boolean`	`isSelected`
`Boolean`	`isShowingLayoutBounds`
`open Boolean`	`isShown`
`open Boolean`	`isSoundEffectsEnabled`
`Boolean`	`isTemporarilyDetached`
`open Boolean`	`isTextAlignmentResolved`
`open Boolean`	`isTextDirectionResolved`
`open Boolean`	`isVerticalFadingEdgeEnabled`
`open Boolean`	`isVerticalScrollBarEnabled`
`open Boolean`	`keepScreenOn`
`open KeyEvent.DispatcherState`	`keyDispatcherState`
`open Int`	`labelFor`
`open Int`	`layerType`
`open Int`	`layoutDirection`
`open ViewGroup.LayoutParams`	`layoutParams`
`Int`	`left`
`open Float`	`leftFadingEdgeStrength`
`open Int`	`leftPaddingOffset`
`open Matrix`	`matrix`
`Int`	`measuredHeight`
`Int`	`measuredHeightAndState`
`Int`	`measuredState`
`Int`	`measuredWidth`
`Int`	`measuredWidthAndState`
`open Int`	`minimumHeight`
`open Int`	`minimumWidth`
`open Int`	`nextClusterForwardId`
`open Int`	`nextFocusDownId`
`open Int`	`nextFocusForwardId`
`open Int`	`nextFocusLeftId`
`open Int`	`nextFocusRightId`
`open Int`	`nextFocusUpId`
`open View.OnFocusChangeListener`	`onFocusChangeListener`
`open Int`	`outlineAmbientShadowColor`
`open ViewOutlineProvider`	`outlineProvider`
`open Int`	`outlineSpotShadowColor`
`open Int`	`overScrollMode`
`open Int`	`paddingBottom`
`open Int`	`paddingEnd`
`open Int`	`paddingLeft`
`open Int`	`paddingRight`
`open Int`	`paddingStart`
`open Int`	`paddingTop`
`final ViewParent`	`parent`
`open ViewParent`	`parentForAccessibility`
`OutcomeReceiver<GetCredentialResponse, GetCredentialException>?`	`pendingCredentialCallback`
`GetCredentialRequest?`	`pendingCredentialRequest`
`open Float`	`pivotX`
`open Float`	`pivotY`
`open PointerIcon`	`pointerIcon`
`MutableList<Rect>`	`preferKeepClearRects`
`open Array<String>?`	`receiveContentMimeTypes`
`open Float`	`requestedFrameRate`
`open Resources`	`resources`
`Boolean`	`revealOnFocusHint`
`Int`	`right`
`open Float`	`rightFadingEdgeStrength`
`open Int`	`rightPaddingOffset`
`open AttachedSurfaceControl?`	`rootSurfaceControl`
`open View`	`rootView`
`open WindowInsets`	`rootWindowInsets`
`open Float`	`rotation`
`open Float`	`rotationX`
`open Float`	`rotationY`
`open Float`	`scaleX`
`open Float`	`scaleY`
`open Int`	`scrollBarDefaultDelayBeforeFade`
`open Int`	`scrollBarFadeDuration`
`open Int`	`scrollBarSize`
`open Int`	`scrollBarStyle`
`open Int`	`scrollCaptureHint`
`open Int`	`scrollIndicators`
`Int`	`scrollX`
`Int`	`scrollY`
`open Int`	`solidColor`
`open Int`	`sourceLayoutResId`
`CharSequence?`	`stateDescription`
`open StateListAnimator`	`stateListAnimator`
`open Int`	`suggestedMinimumHeight`
`open Int`	`suggestedMinimumWidth`
`open CharSequence?`	`supplementalDescription`
`open MutableList<Rect>`	`systemGestureExclusionRects`
`open Int`	`systemUiVisibility`
`open Any`	`tag`
`open Int`	`textAlignment`
`open Int`	`textDirection`
`open CharSequence?`	`tooltipText`
`Int`	`top`
`open Float`	`topFadingEdgeStrength`
`open Int`	`topPaddingOffset`
`open TouchDelegate`	`touchDelegate`
`open ArrayList<View>`	`touchables`
`open Float`	`transitionAlpha`
`open String`	`transitionName`
`open Float`	`translationX`
`open Float`	`translationY`
`open Float`	`translationZ`
`open Long`	`uniqueDrawingId`
`open Int`	`verticalFadingEdgeLength`
`open Int`	`verticalScrollbarPosition`
`open Drawable?`	`verticalScrollbarThumbDrawable`
`open Drawable?`	`verticalScrollbarTrackDrawable`
`open Int`	`verticalScrollbarWidth`
`open ViewTranslationResponse?`	`viewTranslationResponse`
`open ViewTreeObserver`	`viewTreeObserver`
`open Int`	`visibility`
`Int`	`width`
`open Int`	`windowAttachCount`
`open WindowId`	`windowId`
`open WindowInsetsController?`	`windowInsetsController`
`open Int`	`windowSystemUiVisibility`
`open IBinder`	`windowToken`
`open Int`	`windowVisibility`
`open Float`	`x`
`open Float`	`y`
`open Float`	`z`

From android.view.ViewGroup

`open CharSequence`	`accessibilityClassName`
`open Int`	`childCount`
`open Boolean`	`clipChildren`
`open Boolean`	`clipToPadding`
`open Int`	`descendantFocusability`
`open View`	`focusedChild`
`open Boolean`	`isAlwaysDrawnWithCacheEnabled`
`open Boolean`	`isAnimationCacheEnabled`
`open Boolean`	`isChildrenDrawingOrderEnabled`
`open Boolean`	`isChildrenDrawnWithCacheEnabled`
`open Boolean`	`isLayoutSuppressed`
`open Boolean`	`isMotionEventSplittingEnabled`
`open Boolean`	`isTransitionGroup`
`open LayoutAnimationController`	`layoutAnimation`
`open Animation.AnimationListener`	`layoutAnimationListener`
`open Int`	`layoutMode`
`open LayoutTransition`	`layoutTransition`
`open Int`	`nestedScrollAxes`
`open ViewGroupOverlay`	`overlay`
`open Int`	`persistentDrawingCache`
`open Boolean`	`touchscreenBlocksFocus`

Constants

TEXT_TYPE_NEAR_MY_PRECISE_LOCATION

const val TEXT_TYPE_NEAR_MY_PRECISE_LOCATION: Int

TEXT_TYPE_NEAR_YOUR_PRECISE_LOCATION

const val TEXT_TYPE_NEAR_YOUR_PRECISE_LOCATION: Int

TEXT_TYPE_NONE

const val TEXT_TYPE_NONE: Int

TEXT_TYPE_PRECISE_LOCATION

const val TEXT_TYPE_PRECISE_LOCATION: Int

TEXT_TYPE_SHARE_PRECISE_LOCATION

const val TEXT_TYPE_SHARE_PRECISE_LOCATION: Int

TEXT_TYPE_USE_PRECISE_LOCATION

const val TEXT_TYPE_USE_PRECISE_LOCATION: Int

Public constructors

LocationButton

Added in 1.0.0-alpha01

LocationButton(
    context: Context,
    attrs: AttributeSet? = null,
    defStyleAttr: Int = R.attr.locationButtonStyle,
    defStyleRes: Int = R.style.Widget_AndroidXCore_LocationButton
)

Public functions

addView

open fun addView(child: View?): Unit

addView

open fun addView(child: View?, index: Int): Unit

addView

open fun addView(child: View?, params: ViewGroup.LayoutParams?): Unit

addView

open fun addView(child: View?, index: Int, params: ViewGroup.LayoutParams?): Unit

addView

open fun addView(child: View?, width: Int, height: Int): Unit

getCompositionOrder

Added in 1.0.0-alpha01

fun getCompositionOrder(): Int

Gets the composition order of the underlying SurfaceView.

Returns
`Int`	The exact Z-order integer.

setBackgroundColor

open fun setBackgroundColor(color: Int): Unit

setCompositionOrder

Added in 1.0.0-alpha01

fun setCompositionOrder(order: Int): Unit

Controls the composition order of the underlying SurfaceView.

By default, this is set on Top in Z-order, as this button is a secure system component.

For developers migrating from legacy SurfaceView APIs:

setZOrderOnTop(true) is equivalent to passing 1.
setZOrderOnTop(false) is equivalent to passing -2.

See also SurfaceView.setCompositionOrder for reference.

Parameters
`order: Int`	The exact Z-order integer. Default is 1 (on top of the app window).

setCornerRadius

Added in 1.0.0-alpha01

fun setCornerRadius(radius: Float): Unit

Sets the corner radius of the button background.

Parameters
`radius: Float`	The desired corner radius in pixels.

setIconTint

Added in 1.0.0-alpha01

fun setIconTint(color: Int): Unit

Sets the color tint applied to the location icon.

Parameters
`color: Int`	The resolved ARGB color integer.

setOnErrorListener

Added in 1.0.0-alpha01

fun setOnErrorListener(listener: OnErrorListener?): Unit

Sets the listener to receive remote session errors on Build.VERSION_CODES.CINNAMON_BUN and above platforms.

Parameters
`listener: OnErrorListener?`	The `OnErrorListener` that will handle callbacks, or null to clear a previously set listener.

setOnPermissionResultListener

Added in 1.0.0-alpha01

fun setOnPermissionResultListener(listener: OnPermissionResultListener?): Unit

Sets the listener to receive permission results.

Note: On platforms before Build.VERSION_CODES.CINNAMON_BUN, if you rely on the default permission request flow (i.e. you do not provide a custom OnRequestPermissionsListener), the hosting Activity must implement androidx.activity.result.ActivityResultRegistryOwner and the LocationButton must have an android:id to deliver the permission result to this listener.

Parameters
`listener: OnPermissionResultListener?`	The `OnPermissionResultListener` that will handle callbacks, or null to clear a previously set listener.

setOnRequestPermissionsListener

Added in 1.0.0-alpha01

fun setOnRequestPermissionsListener(listener: OnRequestPermissionsListener?): Unit

Sets the listener to handle permission requests on platforms before Build.VERSION_CODES.CINNAMON_BUN.

Provide this listener if you want to customize the permission request flow (e.g. to show rationale) or if the hosting Activity does not implement androidx.activity.result.ActivityResultRegistryOwner on platforms before Build.VERSION_CODES.CINNAMON_BUN.

Parameters
`listener: OnRequestPermissionsListener?`	The `OnRequestPermissionsListener` that will handle callbacks, or null to clear a previously set listener.

setPadding

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

setPaddingRelative

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

setPressedCornerRadius

Added in 1.0.0-alpha01

fun setPressedCornerRadius(radius: Float): Unit

Sets the corner radius of the button background when the user presses it.

Parameters
`radius: Float`	The desired pressed-state corner radius in pixels.

setStrokeColor

Added in 1.0.0-alpha01

fun setStrokeColor(color: Int): Unit

Sets the width of the button's outer stroke border.

Parameters
`color: Int`	The resolved ARGB color integer.

setStrokeWidth

Added in 1.0.0-alpha01

fun setStrokeWidth(strokeWidth: Int): Unit

Sets the width of the button's outer stroke border.

Parameters
`strokeWidth: Int`	The desired stroke width in pixels.

setTextColor

Added in 1.0.0-alpha01

fun setTextColor(color: Int): Unit

Sets the color of the text displayed inside the button.

Parameters
`color: Int`	The resolved ARGB color integer.

setTextType

Added in 1.0.0-alpha01

fun setTextType(textType: Int): Unit

Sets the text content displayed inside the button.

Parameters
`textType: Int`	The predefined `LocationButtonTextType` identifier.

Protected functions

addViewInLayout

protected open fun addViewInLayout(child: View?, index: Int, params: ViewGroup.LayoutParams?): Boolean

onAttachedToWindow

protected open fun onAttachedToWindow(): Unit

onConfigurationChanged

protected open fun onConfigurationChanged(newConfig: Configuration?): Unit

onDetachedFromWindow

protected open fun onDetachedFromWindow(): Unit

onLayout

protected open fun onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int): Unit

onMeasure

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

onSizeChanged

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

Public properties

parentActivity

Added in 1.0.0-alpha01

var parentActivity: Activity?

The Activity that hosts this button.

This activity is used to host the location button. If not explicitly set, the library will attempt to resolve the hosting activity by traversing the Context wrapper chain of the context passed to the constructor.

Extension functions

LocationButton.setLocationButtonProvider

Artifact: androidx.core.locationbutton:locationbutton

View Source

@RequiresApi(value = 37)
fun LocationButton.setLocationButtonProvider(
    provider: LocationButtonProvider?
): Unit

Sets the LocationButtonProvider to provide a location button.

Parameters
`provider: LocationButtonProvider?`	The `LocationButtonProvider` to use, or null to clear.