ActionBar

const val DISPLAY_HOME_AS_UP = 4: Int

Display the 'home' element such that it appears as an 'up' affordance. e.g. show an arrow to the left indicating the action that will be taken. Set this flag if selecting the 'home' button in the action bar to return up by a single level in your UI rather than back to the top level or front page.

Setting this option will implicitly enable interaction with the home/up button. See setHomeButtonEnabled.

const val DISPLAY_SHOW_CUSTOM = 16: Int

Show the custom view if one has been set.

const val DISPLAY_SHOW_HOME = 2: Int

Show 'home' elements in this action bar, leaving more space for other navigation elements. This includes logo and icon.

const val DISPLAY_SHOW_TITLE = 8: Int

Show the activity title and subtitle, if present.

const val DISPLAY_USE_LOGO = 1: Int

Use logo instead of icon if available. This flag will cause appropriate navigation modes to use a wider logo in place of the standard icon.

const val NAVIGATION_MODE_LIST = 1: Int

List navigation mode. Instead of static title text this mode presents a list menu for navigation within the activity. e.g. this might be presented to the user as a dropdown list.

const val NAVIGATION_MODE_STANDARD = 0: Int

Standard navigation mode. Consists of either a logo or icon and title text with an optional subtitle. Clicking any of these elements will dispatch onOptionsItemSelected to the host Activity with a MenuItem with item ID android.R.id.home.

const val NAVIGATION_MODE_TABS = 2: Int

Tab navigation mode. Instead of static title text this mode presents a series of tabs for navigation within the activity.

abstract fun addOnMenuVisibilityListener(
    listener: ActionBar.OnMenuVisibilityListener!
): Unit

Add a listener that will respond to menu visibility change events.

abstract fun addTab(tab: ActionBar.Tab!): Unit

Add a tab for use in tabbed navigation mode. The tab will be added at the end of the list. If this is the first tab to be added it will become the selected tab.

abstract fun addTab(tab: ActionBar.Tab!, position: Int): Unit

Add a tab for use in tabbed navigation mode. The tab will be inserted at position. If this is the first tab to be added it will become the selected tab.

abstract fun addTab(tab: ActionBar.Tab!, setSelected: Boolean): Unit

Add a tab for use in tabbed navigation mode. The tab will be added at the end of the list.

abstract fun addTab(tab: ActionBar.Tab!, position: Int, setSelected: Boolean): Unit

Add a tab for use in tabbed navigation mode. The tab will be inserted at position.

fun getElevation(): Float

Get the Z-axis elevation of the action bar in pixels.

The action bar's elevation is the distance it is placed from its parent surface. Higher values are closer to the user.

abstract fun getHeight(): Int

Retrieve the current height of the ActionBar.

fun getHideOffset(): Int

Return the current vertical offset of the action bar.

The action bar's current hide offset is the distance that the action bar is currently scrolled offscreen in pixels. The valid range is 0 (fully visible) to the action bar's current measured height (fully invisible).

abstract fun getNavigationItemCount(): Int

Get the number of navigation items present in the current navigation mode.

abstract fun getNavigationMode(): Int

Returns the current navigation mode. The result will be one of:

• NAVIGATION_MODE_STANDARD
• NAVIGATION_MODE_LIST
• NAVIGATION_MODE_TABS

abstract fun getSelectedNavigationIndex(): Int

Get the position of the selected navigation item in list or tabbed navigation modes.

abstract fun getSelectedTab(): ActionBar.Tab?

Returns the currently selected tab if in tabbed navigation mode and there is at least one tab present.

abstract fun getSubtitle(): CharSequence?

Returns the current ActionBar subtitle in standard mode. Returns null if getNavigationMode would not return NAVIGATION_MODE_STANDARD.

abstract fun getTabAt(index: Int): ActionBar.Tab!

Returns the tab at the specified index.

abstract fun getTabCount(): Int

Returns the number of tabs currently registered with the action bar.

fun getThemedContext(): Context!

Returns a Context with an appropriate theme for creating views that will appear in the action bar. If you are inflating or instantiating custom views that will appear in an action bar, you should use the Context returned by this method. (This includes adapters used for list navigation mode.) This will ensure that views contrast properly against the action bar.

abstract fun getTitle(): CharSequence?

Returns the current ActionBar title in standard mode. Returns null if getNavigationMode would not return NAVIGATION_MODE_STANDARD.

abstract fun hide(): Unit

Hide the ActionBar if it is currently showing. If the window hosting the ActionBar does not have the feature FEATURE_ACTION_BAR_OVERLAY it will resize application content to fit the new space available.

Instead of calling this function directly, you can also cause an ActionBar using the overlay feature to hide through View.SYSTEM_UI_FLAG_FULLSCREEN. Hiding the ActionBar through this system UI flag allows you to more seamlessly hide it in conjunction with other screen decorations.

fun isHideOnContentScrollEnabled(): Boolean

Return whether the action bar is configured to scroll out of sight along with a nested scrolling child.

abstract fun newTab(): ActionBar.Tab!

Create and return a new Tab. This tab will not be included in the action bar until it is added.

abstract fun removeAllTabs(): Unit

Remove all tabs from the action bar and deselect the current tab.

abstract fun removeOnMenuVisibilityListener(
    listener: ActionBar.OnMenuVisibilityListener!
): Unit

Remove a menu visibility listener. This listener will no longer receive menu visibility change events.

abstract fun removeTab(tab: ActionBar.Tab!): Unit

Remove a tab from the action bar. If the removed tab was selected it will be deselected and another tab will be selected if present.

abstract fun removeTabAt(position: Int): Unit

Remove a tab from the action bar. If the removed tab was selected it will be deselected and another tab will be selected if present.

abstract fun selectTab(tab: ActionBar.Tab!): Unit

Select the specified tab. If it is not a child of this action bar it will be added.

Note: If you want to select by index, use setSelectedNavigationItem.

abstract fun setBackgroundDrawable(d: Drawable?): Unit

Set the ActionBar's background. This will be used for the primary action bar.

abstract fun setCustomView(resId: Int): Unit

Set the action bar into custom navigation mode, supplying a view for custom navigation.

Custom navigation views appear between the application icon and any action buttons and may use any space available there. Common use cases for custom navigation views might include an auto-suggesting address bar for a browser or other navigation mechanisms that do not translate well to provided navigation modes.

The display option DISPLAY_SHOW_CUSTOM must be set for the custom view to be displayed.

abstract fun setCustomView(view: View!): Unit

Set the action bar into custom navigation mode, supplying a view for custom navigation. Custom navigation views appear between the application icon and any action buttons and may use any space available there. Common use cases for custom navigation views might include an auto-suggesting address bar for a browser or other navigation mechanisms that do not translate well to provided navigation modes.

abstract fun setCustomView(view: View!, layoutParams: ActionBar.LayoutParams!): Unit

Set the action bar into custom navigation mode, supplying a view for custom navigation.

Custom navigation views appear between the application icon and any action buttons and may use any space available there. Common use cases for custom navigation views might include an auto-suggesting address bar for a browser or other navigation mechanisms that do not translate well to provided navigation modes.

The display option DISPLAY_SHOW_CUSTOM must be set for the custom view to be displayed.

abstract fun setDisplayHomeAsUpEnabled(showHomeAsUp: Boolean): Unit

Set whether home should be displayed as an "up" affordance. Set this to true if selecting "home" returns up by a single level in your UI rather than back to the top level or front page.

To set several display options at once, see the setDisplayOptions methods.

abstract fun setDisplayOptions(options: Int): Unit

Set display options. This changes all display option bits at once. To change a limited subset of display options, see setDisplayOptions.

abstract fun setDisplayOptions(options: Int, mask: Int): Unit

Set selected display options. Only the options specified by mask will be changed. To change all display option bits at once, see setDisplayOptions.

Example: setDisplayOptions(0, DISPLAY_SHOW_HOME) will disable the DISPLAY_SHOW_HOME option. setDisplayOptions(DISPLAY_SHOW_HOME, DISPLAY_SHOW_HOME | DISPLAY_USE_LOGO) will enable DISPLAY_SHOW_HOME and disable DISPLAY_USE_LOGO.

abstract fun setDisplayShowCustomEnabled(showCustom: Boolean): Unit

Set whether a custom view should be displayed, if set.

To set several display options at once, see the setDisplayOptions methods.

abstract fun setDisplayShowHomeEnabled(showHome: Boolean): Unit

Set whether to include the application home affordance in the action bar. Home is presented as either an activity icon or logo.

To set several display options at once, see the setDisplayOptions methods.

abstract fun setDisplayShowTitleEnabled(showTitle: Boolean): Unit

Set whether an activity title/subtitle should be displayed.

To set several display options at once, see the setDisplayOptions methods.

abstract fun setDisplayUseLogoEnabled(useLogo: Boolean): Unit

Set whether to display the activity logo rather than the activity icon. A logo is often a wider, more detailed image.

To set several display options at once, see the setDisplayOptions methods.

fun setElevation(elevation: Float): Unit

Set the Z-axis elevation of the action bar in pixels.

The action bar's elevation is the distance it is placed from its parent surface. Higher values are closer to the user.

fun setHideOffset(offset: Int): Unit

Set the current hide offset of the action bar.

The action bar's current hide offset is the distance that the action bar is currently scrolled offscreen in pixels. The valid range is 0 (fully visible) to the action bar's current measured height (fully invisible).

fun setHideOnContentScrollEnabled(hideOnContentScroll: Boolean): Unit

Enable hiding the action bar on content scroll.

If enabled, the action bar will scroll out of sight along with a nested scrolling child view's content. The action bar must be in overlay mode to enable hiding on content scroll.

When partially scrolled off screen the action bar is considered hidden. A call to show will cause it to return to full view.

fun setHomeActionContentDescription(description: CharSequence?): Unit

Set an alternate description for the Home/Up action, when enabled.

This description is commonly used for accessibility/screen readers when the Home action is enabled. (See setDisplayHomeAsUpEnabled.) Examples of this are, "Navigate Home" or "Navigate Up" depending on the DISPLAY_HOME_AS_UP display option. If you have changed the home-as-up indicator using setHomeAsUpIndicator to indicate more specific functionality such as a sliding drawer, you should also set this to accurately describe the action.

Setting this to null will use the system default description.

fun setHomeActionContentDescription(resId: @StringRes Int): Unit

Set an alternate description for the Home/Up action, when enabled.

This description is commonly used for accessibility/screen readers when the Home action is enabled. (See setDisplayHomeAsUpEnabled.) Examples of this are, "Navigate Home" or "Navigate Up" depending on the DISPLAY_HOME_AS_UP display option. If you have changed the home-as-up indicator using setHomeAsUpIndicator to indicate more specific functionality such as a sliding drawer, you should also set this to accurately describe the action.

Setting this to 0 will use the system default description.

fun setHomeAsUpIndicator(indicator: Drawable?): Unit

Set an alternate drawable to display next to the icon/logo/title when DISPLAY_HOME_AS_UP is enabled. This can be useful if you are using this mode to display an alternate selection for up navigation, such as a sliding drawer.

If you pass null to this method, the default drawable from the theme will be used.

If you implement alternate or intermediate behavior around Up, you should also call setHomeActionContentDescription() to provide a correct description of the action for accessibility support.

fun setHomeAsUpIndicator(resId: @DrawableRes Int): Unit

Set an alternate drawable to display next to the icon/logo/title when DISPLAY_HOME_AS_UP is enabled. This can be useful if you are using this mode to display an alternate selection for up navigation, such as a sliding drawer.

If you pass 0 to this method, the default drawable from the theme will be used.

If you implement alternate or intermediate behavior around Up, you should also call setHomeActionContentDescription() to provide a correct description of the action for accessibility support.

fun setHomeButtonEnabled(enabled: Boolean): Unit

Enable or disable the "home" button in the corner of the action bar. (Note that this is the application home/up affordance on the action bar, not the system wide home button.)

This defaults to true for packages targeting

Setting the DISPLAY_HOME_AS_UP display option will automatically enable the home button.

abstract fun setIcon(icon: Drawable!): Unit

Set the icon to display in the 'home' section of the action bar. The action bar will use an icon specified by its style or the activity icon by default. Whether the home section shows an icon or logo is controlled by the display option DISPLAY_USE_LOGO.

abstract fun setIcon(resId: @DrawableRes Int): Unit

Set the icon to display in the 'home' section of the action bar. The action bar will use an icon specified by its style or the activity icon by default. Whether the home section shows an icon or logo is controlled by the display option DISPLAY_USE_LOGO.

abstract fun setListNavigationCallbacks(
    adapter: SpinnerAdapter!,
    callback: ActionBar.OnNavigationListener!
): Unit

Set the adapter and navigation callback for list navigation mode. The supplied adapter will provide views for the expanded list as well as the currently selected item. (These may be displayed differently.) The supplied OnNavigationListener will alert the application when the user changes the current list selection.

abstract fun setLogo(logo: Drawable!): Unit

Set the logo to display in the 'home' section of the action bar. The action bar will use a logo specified by its style or the activity logo by default. Whether the home section shows an icon or logo is controlled by the display option DISPLAY_USE_LOGO.

abstract fun setLogo(resId: @DrawableRes Int): Unit

Set the logo to display in the 'home' section of the action bar. The action bar will use a logo specified by its style or the activity logo by default. Whether the home section shows an icon or logo is controlled by the display option DISPLAY_USE_LOGO.

abstract fun setNavigationMode(mode: Int): Unit

Set the current navigation mode.

abstract fun setSelectedNavigationItem(position: Int): Unit

Set the selected navigation item in list or tabbed navigation modes.

fun setSplitBackgroundDrawable(d: Drawable!): Unit

Set the ActionBar's split background. This will appear in the split action bar containing menu-provided action buttons on some devices and configurations.

You can enable split action bar with uiOptions

fun setStackedBackgroundDrawable(d: Drawable!): Unit

Set the ActionBar's stacked background. This will appear in the second row/stacked bar on some devices and configurations.

abstract fun setSubtitle(resId: Int): Unit

Set the action bar's subtitle. This will only be displayed if DISPLAY_SHOW_TITLE is set.

abstract fun setSubtitle(subtitle: CharSequence!): Unit

Set the action bar's subtitle. This will only be displayed if DISPLAY_SHOW_TITLE is set. Set to null to disable the subtitle entirely.

abstract fun setTitle(resId: @StringRes Int): Unit

Set the action bar's title. This will only be displayed if DISPLAY_SHOW_TITLE is set.

abstract fun setTitle(title: CharSequence!): Unit

Set the action bar's title. This will only be displayed if DISPLAY_SHOW_TITLE is set.

abstract fun show(): Unit

Show the ActionBar if it is not currently showing. If the window hosting the ActionBar does not have the feature FEATURE_ACTION_BAR_OVERLAY it will resize application content to fit the new space available.

If you are hiding the ActionBar through View.SYSTEM_UI_FLAG_FULLSCREEN, you should not call this function directly.