swiperefreshlayout/androidx.swiperefreshlayout.widget/SwipeRefreshLayout

SwipeRefreshLayout

open class SwipeRefreshLayout : ViewGroup, NestedScrollingParent3, NestedScrollingParent2, NestedScrollingChild3, NestedScrollingChild2, NestedScrollingParent, NestedScrollingChild(source)

(SESL modified) The SwipeRefreshLayout should be used whenever the user can refresh the contents of a view via a vertical swipe gesture. The activity that instantiates this view should add an OnRefreshListener to be notified whenever the swipe to refresh gesture is completed. The SwipeRefreshLayout will notify the listener each and every time the gesture is completed again; the listener is responsible for correctly determining when to actually initiate a refresh of its content. If the listener determines there should not be a refresh, it must call setRefreshing(false) to cancel any visual indication of a refresh. If an activity wishes to show just the progress animation, it should call setRefreshing(true). To disable the gesture and progress animation, call setEnabled(false) on the view.

This layout should be made the parent of the view that will be refreshed as a result of the gesture and can only support one direct child. This view will also be made the target of the gesture and will be forced to match both the width and the height supplied in this layout. The SwipeRefreshLayout does not provide accessibility events; instead, a menu item must be provided to allow refresh of the content wherever this gesture is used.

Constructors

SwipeRefreshLayout

constructor(@NonNull context: Context)

Simple constructor to use when creating a SwipeRefreshLayout from code.

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)

Constructor that is called when inflating SwipeRefreshLayout from XML.

Types

OnChildScrollUpCallback

interface OnChildScrollUpCallback

Classes that wish to override canChildScrollUp method behavior should implement this interface.

OnRefreshListener

interface OnRefreshListener

Classes that wish to be notified when the swipe gesture correctly triggers a refresh should implement this interface.

Properties

DEFAULT

val DEFAULT: Int = 1

DEFAULT_SLINGSHOT_DISTANCE

val DEFAULT_SLINGSHOT_DISTANCE: Int = -1

LARGE

val LARGE: Int = 0

Functions

canChildScrollUp

open fun canChildScrollUp(): Boolean

dispatchNestedFling

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

dispatchNestedPreFling

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

dispatchNestedPreScroll

open fun dispatchNestedPreScroll(dx: Int, dy: Int, @Nullable consumed: Array<Int>, @Nullable offsetInWindow: Array<Int>): Boolean

open fun dispatchNestedPreScroll(dx: Int, dy: Int, @Nullable consumed: Array<Int>, @Nullable offsetInWindow: Array<Int>, type: Int): Boolean

dispatchNestedScroll

open fun dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, @Nullable offsetInWindow: Array<Int>): Boolean

open fun dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, @Nullable offsetInWindow: Array<Int>, type: Int): Boolean

open fun dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, @Nullable offsetInWindow: Array<Int>, type: Int, @NonNull consumed: Array<Int>)

getNestedScrollAxes

open fun getNestedScrollAxes(): Int

getProgressCircleDiameter

open fun getProgressCircleDiameter(): Int

Get the diameter of the progress circle that is displayed as part of the swipe to refresh layout.

getProgressViewEndOffset

open fun getProgressViewEndOffset(): Int

getProgressViewStartOffset

open fun getProgressViewStartOffset(): Int

hasNestedScrollingParent

open fun hasNestedScrollingParent(): Boolean

open fun hasNestedScrollingParent(type: Int): Boolean

isNestedScrollingEnabled

open fun isNestedScrollingEnabled(): Boolean

isRefreshing

open fun isRefreshing(): Boolean

onInterceptTouchEvent

open fun onInterceptTouchEvent(ev: MotionEvent): Boolean

onMeasure

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

onNestedFling

open fun onNestedFling(target: View, velocityX: Float, velocityY: Float, consumed: Boolean): Boolean

onNestedPreFling

open fun onNestedPreFling(target: View, velocityX: Float, velocityY: Float): Boolean

onNestedPreScroll

open fun onNestedPreScroll(target: View, dx: Int, dy: Int, consumed: Array<Int>)

open fun onNestedPreScroll(@NonNull target: View, dx: Int, dy: Int, @NonNull consumed: Array<Int>, type: Int)

onNestedScroll

open fun onNestedScroll(target: View, dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int)

open fun onNestedScroll(@NonNull target: View, dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, type: Int)

open fun onNestedScroll(@NonNull target: View, dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int, dyUnconsumed: Int, type: Int, @NonNull consumed: Array<Int>)

onNestedScrollAccepted