WearableNavigationDrawerView

Kotlin |Java

open class WearableNavigationDrawerView : WearableDrawerView

kotlin.Any
↳	android.view.View
	↳	android.view.ViewGroup
		↳	android.widget.FrameLayout
			↳	androidx.wear.widget.drawer.WearableDrawerView
				↳	androidx.wear.widget.drawer.WearableNavigationDrawerView

Ease of use class for creating a Wearable navigation drawer. This can be used with to create a drawer for users to easily navigate a wearable app.

There are two ways this information may be presented: as a single page and as multiple pages. The single page navigation drawer will display 1-7 items to the user representing different navigation verticals. If more than 7 items are provided to a single page navigation drawer, the navigation drawer will be displayed as empty. The multiple page navigation drawer will display 1 or more pages to the user, each representing different navigation verticals.

The developer may specify which style to use with the app:navigationStyle custom attribute. If not specified, singlePage will be used as the default.

Summary

Nested classes
abstract	OnItemSelectedListener Listener which is notified when the user selects an item.
abstract	WearableNavigationDrawerAdapter Adapter for specifying the contents of WearableNavigationDrawer.

Constants
static Int	MULTI_PAGE Multi-page navigation drawer style.
static Int	SINGLE_PAGE Single page navigation drawer style.

Inherited constants
From class WearableDrawerView Int STATE_DRAGGING Indicates that the drawer is currently being dragged by the user. Int STATE_IDLE Indicates that the drawer is in an idle, settled state. No animation is in progress. Int STATE_SETTLING Indicates that the drawer is in the process of settling to a final position.

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

Public methods
open Unit	addOnItemSelectedListener(listener: WearableNavigationDrawerView.OnItemSelectedListener!) Add an OnItemSelectedListener that will be notified when the user selects an item.
open Boolean	canScrollHorizontally(direction: Int)
open Int	getNavigationStyle() Returns the style this drawer is using, either SINGLE_PAGE or MULTI_PAGE.
open Unit	onDrawerClosed()
open Unit	onDrawerOpened()
open Boolean	onInterceptTouchEvent(ev: MotionEvent!)
open Unit	removeOnItemSelectedListener(listener: WearableNavigationDrawerView.OnItemSelectedListener!) Remove an OnItemSelectedListener.
open Unit	setAdapter(adapter: WearableNavigationDrawerView.WearableNavigationDrawerAdapter!) Set a WearableNavigationDrawerAdapter that will supply data for this drawer.
open Unit	setCurrentItem(index: Int, smoothScrollTo: Boolean) Changes which index is selected.

Inherited functions

From class WearableDrawerView Unit addView(child: View!, index: Int, params: LayoutParams!) WearableDrawerController! getController() Returns the WearableDrawerController associated with this WearableDrawerView. This will only be valid after this View has been added to its parent. View? getDrawerContent() Returns the drawer content view. Int getDrawerState() Returns the current drawer state, which will be one of STATE_DRAGGING, , or STATE_IDLE Boolean isAutoPeekEnabled() Returns true if this drawer has auto-peeking enabled. This will always return false for a locked drawer. Boolean isClosed() Returns true if the drawer is fully closed. Boolean isLocked() Returns true if the position of the drawer cannot be modified by user interaction. Specifically, a drawer cannot be opened, closed, or automatically peeked by . However, it can be explicitly opened, closed, and peeked by the developer. A drawer may be considered locked if the drawer is locked open, locked closed, or is closed and isLockedWhenClosed returns true. Boolean isLockedWhenClosed() Returns true if this drawer should be locked when the user cannot see it. Boolean isOpenOnlyAtTopEnabled() Returns whether this drawer may only be opened by the user when at the top of the scrolling content. If there is no scrolling content, then this has no effect. Defaults to false. Boolean isOpened() Returns true if the drawer is fully open. Boolean isPeekOnScrollDownEnabled() Gets whether or not this drawer should peek while scrolling down. This is currently only supported for bottom drawers. Defaults to false. Boolean isPeeking() Returns whether the drawer is either peeking or the peek view is animating open. Unit onAttachedToWindow() Unit onDrawerStateChanged(state: Int) Called when the drawer state changes. This is analogous to . Unit onFinishInflate() Unit onPeekContainerClicked(v: View!) Called when anything within the peek container is clicked. However, if a custom peek view is supplied and it handles the click, then this may not be called. The default behavior is to open the drawer. Unit setDrawerContent(@Nullable content: View?) Set the drawer content view. Unit setIsAutoPeekEnabled(canAutoPeek: Boolean) Sets whether or not the drawer can automatically adjust its peek state. Note that locked drawers will never auto-peek, but their isAutoPeekEnabled state will be maintained through a lock/unlock cycle. Unit setIsLocked(locked: Boolean) Sets whether or not the position of the drawer can be modified by user interaction. Unit setLockedWhenClosed(locked: Boolean) Sets whether this drawer should be locked when the user cannot see it. Unit setOpenOnlyAtTopEnabled(openOnlyAtTop: Boolean) Only allow the user to open this drawer when at the top of the scrolling content. If there is no scrolling content, then this has no effect. Defaults to false. Unit setPeekContent(content: View!) Set the peek content view. Unit setPeekOnScrollDownEnabled(peekOnScrollDown: Boolean) Sets whether or not this drawer should peek while scrolling down. This is currently only supported for bottom drawers. Defaults to false.

Constants

MULTI_PAGE

static val MULTI_PAGE: Int

Multi-page navigation drawer style. Each item is on its own page. Useful when more than 7 items exist.

Value: 1

SINGLE_PAGE

static val SINGLE_PAGE: Int

Single page navigation drawer style. This is the default drawer style. It is ideal for 1-5 items, but works with up to 7 items. If more than 7 items exist, then the drawer will be displayed as empty.

Value: 0

Public constructors

<init>

WearableNavigationDrawerView(context: Context!)

<init>

WearableNavigationDrawerView(
    context: Context!, 
    attrs: AttributeSet!)

<init>

WearableNavigationDrawerView(
    context: Context!, 
    attrs: AttributeSet!, 
    defStyleAttr: Int)

<init>

WearableNavigationDrawerView(
    context: Context!, 
    attrs: AttributeSet!, 
    defStyleAttr: Int, 
    defStyleRes: Int)

Public methods

addOnItemSelectedListener

open fun addOnItemSelectedListener(listener: WearableNavigationDrawerView.OnItemSelectedListener!): Unit

Add an OnItemSelectedListener that will be notified when the user selects an item.

canScrollHorizontally

open fun canScrollHorizontally(direction: Int): Boolean

getNavigationStyle

open fun getNavigationStyle(): Int

Returns the style this drawer is using, either SINGLE_PAGE or MULTI_PAGE.

onDrawerClosed

open fun onDrawerClosed(): Unit

onDrawerOpened

open fun onDrawerOpened(): Unit

onInterceptTouchEvent

open fun onInterceptTouchEvent(ev: MotionEvent!): Boolean

removeOnItemSelectedListener

open fun removeOnItemSelectedListener(listener: WearableNavigationDrawerView.OnItemSelectedListener!): Unit

Remove an OnItemSelectedListener.

setAdapter

open fun setAdapter(adapter: WearableNavigationDrawerView.WearableNavigationDrawerAdapter!): Unit

Set a WearableNavigationDrawerAdapter that will supply data for this drawer.

setCurrentItem

open fun setCurrentItem(
    index: Int, 
    smoothScrollTo: Boolean
): Unit

Changes which index is selected. OnItemSelectedListener#onItemSelected will be called when the specified index is reached, but it won't be called for items between the current index and the destination index.