SlidingPaneLayout

Artifact: androidx.slidingpanelayout:slidingpanelayout

View Source

Added in 1.1.0

---

Kotlin |Java

public class SlidingPaneLayout extends ViewGroup implements Openable

java.lang.Object
↳	android.view.View
	↳	android.view.ViewGroup
		↳	androidx.slidingpanelayout.widget.SlidingPaneLayout

---

SlidingPaneLayout provides a horizontal, multi-pane layout for use at the top level of a UI. A left (or start) pane is treated as a content list or browser, subordinate to a primary detail view for displaying content.

Child views overlap if their combined width exceeds the available width in the SlidingPaneLayout. Each of child views is expand out to fill the available width in the SlidingPaneLayout. When this occurs, the user may slide the topmost view out of the way by dragging it, and dragging back it from the very edge.

Thanks to this sliding behavior, SlidingPaneLayout may be suitable for creating layouts that can smoothly adapt across many different screen sizes, expanding out fully on larger screens and collapsing on smaller screens.

SlidingPaneLayout is distinct from a navigation drawer as described in the design guide and should not be used in the same scenarios. SlidingPaneLayout should be thought of only as a way to allow a two-pane layout normally used on larger screens to adapt to smaller screens in a natural way. The interaction patterns expressed by SlidingPaneLayout imply a physicality and direct information hierarchy between panes that does not necessarily exist in a scenario where a navigation drawer should be used instead.

Appropriate uses of SlidingPaneLayout include pairings of panes such as a contact list and subordinate interactions with those contacts, or an email thread list with the content pane displaying the contents of the selected thread. Inappropriate uses of SlidingPaneLayout include switching between disparate functions of your app, such as jumping from a social stream view to a view of your personal profile - cases such as this should use the navigation drawer pattern instead. (DrawerLayout implements this pattern.)

Like LinearLayout, SlidingPaneLayout supports the use of the layout parameter layout_weight on child views to determine how to divide leftover space after measurement is complete. It is only relevant for width. When views do not overlap weight behaves as it does in a LinearLayout.

Summary

Nested types
public class SlidingPaneLayout.LayoutParams extends ViewGroup.MarginLayoutParams
public interface SlidingPaneLayout.PanelSlideListener Listener for monitoring events about sliding panes.
public class SlidingPaneLayout.SimplePanelSlideListener implements SlidingPaneLayout.PanelSlideListener No-op stubs for PanelSlideListener.

Constants
static final int	LOCK_MODE_LOCKED = 3 The user cannot swipe between list and detail panes, though the app can open or close the detail pane programmatically.
static final int	LOCK_MODE_LOCKED_CLOSED = 2 The detail pane is locked in a closed position.
static final int	LOCK_MODE_LOCKED_OPEN = 1 The detail pane is locked in an open position.
static final int	LOCK_MODE_UNLOCKED = 0 User can freely swipe between list and detail panes.

Public constructors
SlidingPaneLayout(@NonNull Context context)
SlidingPaneLayout(@NonNull Context context, @Nullable AttributeSet attrs)
SlidingPaneLayout(     @NonNull Context context,     @Nullable AttributeSet attrs,     int defStyle )

Public methods
void	addPanelSlideListener(     @NonNull SlidingPaneLayout.PanelSlideListener listener ) Adds the specified listener to the list of listeners that will be notified of panel slide events.
void	addView(     @NonNull View child,     int index,     @Nullable ViewGroup.LayoutParams params )
boolean	canSlide() This method is deprecated. Renamed to isSlideable - this method is going away soon!
void	close() Close the detail view if it is currently slideable.
boolean	closePane() Close the detail view if it is currently slideable.
void	computeScroll()
void	draw(Canvas c)
ViewGroup.LayoutParams	generateLayoutParams(AttributeSet attrs)
@ColorInt int	getCoveredFadeColor() This method is deprecated. This field is no longer populated by SlidingPaneLayout
final int	getLockMode() Get the lock mode used to control over the swipe behavior.
@Px int	getParallaxDistance()
@ColorInt int	getSliderFadeColor() This method is deprecated. This field is no longer populated by SlidingPaneLayout.
boolean	isOpen() Check if the detail view is completely open.
boolean	isSlideable() Check if both the list and detail view panes in this layout can fully fit side-by-side.
boolean	onInterceptTouchEvent(MotionEvent ev)
boolean	onTouchEvent(MotionEvent ev)
void	open() Open the detail view if it is currently slideable.
boolean	openPane() Open the detail view if it is currently slideable.
void	removePanelSlideListener(     @NonNull SlidingPaneLayout.PanelSlideListener listener ) Removes the specified listener from the list of listeners that will be notified of panel slide events.
void	removeView(@NonNull View view)
void	requestChildFocus(View child, View focused)
void	setCoveredFadeColor(@ColorInt int color) This method is deprecated. SlidingPaneLayout no longer uses this field.
final void	setLockMode(int lockMode) Set the lock mode that controls how the user can swipe between the panes.
void	setPanelSlideListener(     @Nullable SlidingPaneLayout.PanelSlideListener listener ) This method is deprecated. Use addPanelSlideListener
void	setParallaxDistance(@Px int parallaxBy) Set a distance to parallax the lower pane by when the upper pane is in its fully closed state.
void	setShadowDrawable(Drawable d) This method is deprecated. Renamed to setShadowDrawableLeft to support LTR (left to right language) and setShadowDrawableRight to support RTL (right to left language) during opening/closing.
void	setShadowDrawableLeft(@Nullable Drawable d) Set a drawable to use as a shadow cast by the right pane onto the left pane during opening/closing.
void	setShadowDrawableRight(@Nullable Drawable d) Set a drawable to use as a shadow cast by the left pane onto the right pane during opening/closing to support right to left language.
void	setShadowResource(@DrawableRes int resId) This method is deprecated. Renamed to setShadowResourceLeft to support LTR (left to right language) and setShadowResourceRight to support RTL (right to left language) during opening/closing.
void	setShadowResourceLeft(int resId) Set a drawable to use as a shadow cast by the right pane onto the left pane during opening/closing.
void	setShadowResourceRight(int resId) Set a drawable to use as a shadow cast by the left pane onto the right pane during opening/closing to support right to left language.
void	setSliderFadeColor(@ColorInt int color) This method is deprecated. SlidingPaneLayout no longer uses this field.
void	smoothSlideClosed() This method is deprecated. Renamed to closePane - this method is going away soon!
void	smoothSlideOpen() This method is deprecated. Renamed to openPane - this method is going away soon!

Protected methods
boolean	canScroll(View v, boolean checkV, int dx, int x, int y) Tests scrollability within child views of v given a delta of dx.
boolean	checkLayoutParams(ViewGroup.LayoutParams p)
boolean	drawChild(Canvas canvas, View child, long drawingTime)
ViewGroup.LayoutParams	generateDefaultLayoutParams()
ViewGroup.LayoutParams	generateLayoutParams(ViewGroup.LayoutParams p)
void	onAttachedToWindow()
void	onDetachedFromWindow()
void	onLayout(boolean changed, int l, int t, int r, int b)
void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
void	onRestoreInstanceState(Parcelable state)
Parcelable	onSaveInstanceState()
void	onSizeChanged(int w, int h, int oldw, int oldh)

Inherited Constants
From android.view.View static final int ACCESSIBILITY_DATA_SENSITIVE_AUTO = 0 static final int ACCESSIBILITY_DATA_SENSITIVE_NO = 2 static final int ACCESSIBILITY_DATA_SENSITIVE_YES = 1 static final int ACCESSIBILITY_LIVE_REGION_ASSERTIVE = 2 static final int ACCESSIBILITY_LIVE_REGION_NONE = 0 static final int ACCESSIBILITY_LIVE_REGION_POLITE = 1 static final Property<View, Float> ALPHA static final int AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS = 1 static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE = "creditCardExpirationDate" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY = "creditCardExpirationDay" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH = "creditCardExpirationMonth" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR = "creditCardExpirationYear" static final String AUTOFILL_HINT_CREDIT_CARD_NUMBER = "creditCardNumber" static final String AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE = "creditCardSecurityCode" static final String AUTOFILL_HINT_EMAIL_ADDRESS = "emailAddress" static final String AUTOFILL_HINT_NAME = "name" static final String AUTOFILL_HINT_PASSWORD = "password" static final String AUTOFILL_HINT_PHONE = "phone" static final String AUTOFILL_HINT_POSTAL_ADDRESS = "postalAddress" static final String AUTOFILL_HINT_POSTAL_CODE = "postalCode" static final String AUTOFILL_HINT_USERNAME = "username" static final int AUTOFILL_TYPE_DATE = 4 static final int AUTOFILL_TYPE_LIST = 3 static final int AUTOFILL_TYPE_NONE = 0 static final int AUTOFILL_TYPE_TEXT = 1 static final int AUTOFILL_TYPE_TOGGLE = 2 static final int CONTENT_SENSITIVITY_AUTO = 0 static final int CONTENT_SENSITIVITY_NOT_SENSITIVE = 2 static final int CONTENT_SENSITIVITY_SENSITIVE = 1 static final int DRAG_FLAG_ACCESSIBILITY_ACTION = 1024 static final int DRAG_FLAG_GLOBAL = 256 static final int DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION = 64 static final int DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION = 128 static final int DRAG_FLAG_GLOBAL_SAME_APPLICATION = 4096 static final int DRAG_FLAG_GLOBAL_URI_READ = 1 static final int DRAG_FLAG_GLOBAL_URI_WRITE = 2 static final int DRAG_FLAG_OPAQUE = 512 static final int DRAG_FLAG_START_INTENT_SENDER_ON_UNHANDLED_DRAG = 8192 static final int DRAWING_CACHE_QUALITY_AUTO = 0 This field is deprecated. static final int DRAWING_CACHE_QUALITY_HIGH = 1048576 This field is deprecated. static final int DRAWING_CACHE_QUALITY_LOW = 524288 This field is deprecated. static final int[] EMPTY_STATE_SET static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_FOCUSED_STATE_SET static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_SELECTED_STATE_SET static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_STATE_SET static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 2 static final int FIND_VIEWS_WITH_TEXT = 1 static final int FOCUSABLE = 1 static final int FOCUSABLES_ALL = 0 static final int FOCUSABLES_TOUCH_MODE = 1 static final int FOCUSABLE_AUTO = 16 static final int[] FOCUSED_SELECTED_STATE_SET static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] FOCUSED_STATE_SET static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET static final int FOCUS_BACKWARD = 1 static final int FOCUS_DOWN = 130 static final int FOCUS_FORWARD = 2 static final int FOCUS_LEFT = 17 static final int FOCUS_RIGHT = 66 static final int FOCUS_UP = 33 static final int GONE = 8 static final int HAPTIC_FEEDBACK_ENABLED = 268435456 static final int IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0 static final int IMPORTANT_FOR_ACCESSIBILITY_NO = 2 static final int IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 4 static final int IMPORTANT_FOR_ACCESSIBILITY_YES = 1 static final int IMPORTANT_FOR_AUTOFILL_AUTO = 0 static final int IMPORTANT_FOR_AUTOFILL_NO = 2 static final int IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS = 8 static final int IMPORTANT_FOR_AUTOFILL_YES = 1 static final int IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS = 4 static final int IMPORTANT_FOR_CONTENT_CAPTURE_AUTO = 0 static final int IMPORTANT_FOR_CONTENT_CAPTURE_NO = 2 static final int IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS = 8 static final int IMPORTANT_FOR_CONTENT_CAPTURE_YES = 1 static final int IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS = 4 static final int INVISIBLE = 4 static final int KEEP_SCREEN_ON = 67108864 static final int LAYER_TYPE_HARDWARE = 2 static final int LAYER_TYPE_NONE = 0 static final int LAYER_TYPE_SOFTWARE = 1 static final int LAYOUT_DIRECTION_INHERIT = 2 static final int LAYOUT_DIRECTION_LOCALE = 3 static final int LAYOUT_DIRECTION_LTR = 0 static final int LAYOUT_DIRECTION_RTL = 1 static final int MEASURED_HEIGHT_STATE_SHIFT = 16 static final int MEASURED_SIZE_MASK = 16777215 static final int MEASURED_STATE_MASK = -16777216 static final int MEASURED_STATE_TOO_SMALL = 16777216 static final int NOT_FOCUSABLE = 0 static final int NO_ID = -1 static final int OVER_SCROLL_ALWAYS = 0 static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1 static final int OVER_SCROLL_NEVER = 2 static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_SELECTED_STATE_SET static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_STATE_SET static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_SELECTED_STATE_SET static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_STATE_SET static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET static final float REQUESTED_FRAME_RATE_CATEGORY_DEFAULT static final float REQUESTED_FRAME_RATE_CATEGORY_HIGH = -4.0f static final float REQUESTED_FRAME_RATE_CATEGORY_LOW = -2.0f static final float REQUESTED_FRAME_RATE_CATEGORY_NORMAL = -3.0f static final float REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE = -1.0f static final Property<View, Float> ROTATION static final Property<View, Float> ROTATION_X static final Property<View, Float> ROTATION_Y static final Property<View, Float> SCALE_X static final Property<View, Float> SCALE_Y static final int SCREEN_STATE_OFF = 0 static final int SCREEN_STATE_ON = 1 static final int SCROLLBARS_INSIDE_INSET = 16777216 static final int SCROLLBARS_INSIDE_OVERLAY = 0 static final int SCROLLBARS_OUTSIDE_INSET = 50331648 static final int SCROLLBARS_OUTSIDE_OVERLAY = 33554432 static final int SCROLLBAR_POSITION_DEFAULT = 0 static final int SCROLLBAR_POSITION_LEFT = 1 static final int SCROLLBAR_POSITION_RIGHT = 2 static final int SCROLL_AXIS_HORIZONTAL = 1 static final int SCROLL_AXIS_NONE = 0 static final int SCROLL_AXIS_VERTICAL = 2 static final int SCROLL_CAPTURE_HINT_AUTO = 0 static final int SCROLL_CAPTURE_HINT_EXCLUDE = 1 static final int SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS = 4 static final int SCROLL_CAPTURE_HINT_INCLUDE = 2 static final int SCROLL_INDICATOR_BOTTOM = 2 static final int SCROLL_INDICATOR_END = 32 static final int SCROLL_INDICATOR_LEFT = 4 static final int SCROLL_INDICATOR_RIGHT = 8 static final int SCROLL_INDICATOR_START = 16 static final int SCROLL_INDICATOR_TOP = 1 static final int[] SELECTED_STATE_SET static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET static final int SOUND_EFFECTS_ENABLED = 134217728 static final int STATUS_BAR_HIDDEN = 1 This field is deprecated. static final int STATUS_BAR_VISIBLE = 0 This field is deprecated. static final int SYSTEM_UI_FLAG_FULLSCREEN = 4 This field is deprecated. static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 2 This field is deprecated. static final int SYSTEM_UI_FLAG_IMMERSIVE = 2048 This field is deprecated. static final int SYSTEM_UI_FLAG_IMMERSIVE_STICKY = 4096 This field is deprecated. static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 1024 This field is deprecated. static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 512 This field is deprecated. static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 256 This field is deprecated. static final int SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR = 16 This field is deprecated. static final int SYSTEM_UI_FLAG_LIGHT_STATUS_BAR = 8192 This field is deprecated. static final int SYSTEM_UI_FLAG_LOW_PROFILE = 1 This field is deprecated. static final int SYSTEM_UI_FLAG_VISIBLE = 0 This field is deprecated. static final int SYSTEM_UI_LAYOUT_FLAGS = 1536 This field is deprecated. static final int TEXT_ALIGNMENT_CENTER = 4 static final int TEXT_ALIGNMENT_GRAVITY = 1 static final int TEXT_ALIGNMENT_INHERIT = 0 static final int TEXT_ALIGNMENT_TEXT_END = 3 static final int TEXT_ALIGNMENT_TEXT_START = 2 static final int TEXT_ALIGNMENT_VIEW_END = 6 static final int TEXT_ALIGNMENT_VIEW_START = 5 static final int TEXT_DIRECTION_ANY_RTL = 2 static final int TEXT_DIRECTION_FIRST_STRONG = 1 static final int TEXT_DIRECTION_FIRST_STRONG_LTR = 6 static final int TEXT_DIRECTION_FIRST_STRONG_RTL = 7 static final int TEXT_DIRECTION_INHERIT = 0 static final int TEXT_DIRECTION_LOCALE = 5 static final int TEXT_DIRECTION_LTR = 3 static final int TEXT_DIRECTION_RTL = 4 static final Property<View, Float> TRANSLATION_X static final Property<View, Float> TRANSLATION_Y static final Property<View, Float> TRANSLATION_Z static final String VIEW_LOG_TAG = "View" static final int VISIBLE = 0 static final int[] WINDOW_FOCUSED_STATE_SET static final Property<View, Float> X static final Property<View, Float> Y static final Property<View, Float> Z
From android.view.ViewGroup static final int CLIP_TO_PADDING_MASK = 34 static final int FOCUS_AFTER_DESCENDANTS = 262144 static final int FOCUS_BEFORE_DESCENDANTS = 131072 static final int FOCUS_BLOCK_DESCENDANTS = 393216 static final int LAYOUT_MODE_CLIP_BOUNDS = 0 static final int LAYOUT_MODE_OPTICAL_BOUNDS = 1 static final int PERSISTENT_ALL_CACHES = 3 This field is deprecated. static final int PERSISTENT_ANIMATION_CACHE = 1 This field is deprecated. static final int PERSISTENT_NO_CACHE = 0 This field is deprecated. static final int PERSISTENT_SCROLLING_CACHE = 2 This field is deprecated.

Inherited methods

From android.view.View void addOnAttachStateChangeListener(     View.OnAttachStateChangeListener listener ) void addOnLayoutChangeListener(View.OnLayoutChangeListener listener) void addOnUnhandledKeyEventListener(     View.OnUnhandledKeyEventListener listener ) ViewPropertyAnimator animate() void announceForAccessibility(CharSequence text) void autofill(AutofillValue value) boolean awakenScrollBars() void bringToFront() void buildDrawingCache() This method is deprecated. void buildLayer() boolean callOnClick() boolean canResolveLayoutDirection() boolean canResolveTextAlignment() boolean canResolveTextDirection() boolean canScrollHorizontally(int direction) boolean canScrollVertically(int direction) final void cancelDragAndDrop() void cancelLongPress() final void cancelPendingInputEvents() boolean checkInputConnectionProxy(View view) void clearAnimation() void clearPendingCredentialRequest() void clearViewTranslationCallback() static int combineMeasuredStates(int curState, int newState) int computeHorizontalScrollExtent() int computeHorizontalScrollOffset() int computeHorizontalScrollRange() WindowInsets computeSystemWindowInsets(WindowInsets in, Rect outLocalInsets) int computeVerticalScrollExtent() int