WearableActionDrawerView

Kotlin |Java

open class WearableActionDrawerView : WearableDrawerView

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

Ease of use class for creating a Wearable action drawer. This can be used with to create a drawer for users to easily pull up contextual actions. These contextual actions may be specified by using a Menu, which may be populated by either:

• Specifying the app:actionMenu attribute in the XML layout file. Example:

  <androidx.wear.widget.drawer.WearableActionDrawerView
        xmlns:app="http://schemas.android.com/apk/res-auto"
        android:layout_width=”match_parent”
        android:layout_height=”match_parent”
        app:actionMenu="@menu/action_drawer" />

• Getting the menu with getMenu, and then inflating it with . Example:

  Menu menu = actionDrawer.getMenu();
    getMenuInflater().inflate(R.menu.action_drawer, menu);

The full Menu and MenuItem APIs are not implemented. The following methods are guaranteed to work:

For Menu, the add methods, Menu#clear, Menu#removeItem, , Menu#size, and Menu#getItem are implemented.

For MenuItem, setting and getting the title and icon, MenuItem#getItemId, and MenuItem#setOnMenuItemClickListener are implemented.

Summary

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 Boolean	canScrollHorizontally(direction: Int)
open Menu!	getMenu() Returns the Menu object that this WearableActionDrawer represents.
open Unit	onDrawerOpened()
open Unit	onPeekContainerClicked(v: View!)
open Unit	setOnMenuItemClickListener(listener: OnMenuItemClickListener!) Set a OnMenuItemClickListener for this action drawer.
open Unit	setTitle(@Nullable title: CharSequence?) Sets the title for this action drawer.

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 onDrawerClosed() Called when the drawer has settled in a completely closed state. This is analogous to . Unit onDrawerStateChanged(state: Int) Called when the drawer state changes. This is analogous to . Unit onFinishInflate() 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.

Public constructors

<init>

WearableActionDrawerView(context: Context!)

<init>

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

<init>

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

<init>

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

Public methods

canScrollHorizontally

open fun canScrollHorizontally(direction: Int): Boolean

getMenu

open fun getMenu(): Menu!

Returns the Menu object that this WearableActionDrawer represents.

Applications should use this method to obtain the WearableActionDrawers's Menu object and inflate or add content to it as necessary.

Return
Menu!	the Menu presented by this view

onDrawerOpened

open fun onDrawerOpened(): Unit

onPeekContainerClicked

open fun onPeekContainerClicked(v: View!): Unit

setOnMenuItemClickListener

open fun setOnMenuItemClickListener(listener: OnMenuItemClickListener!): Unit

Set a OnMenuItemClickListener for this action drawer.

setTitle

open fun setTitle(@Nullable title: CharSequence?): Unit

Sets the title for this action drawer. If title is null, then the title will be removed.