ActionBar

Added in 1.1.0

Kotlin |Java

public abstract class ActionBar

A primary toolbar within the activity that may display the activity title, application-level navigation affordances, and other interactive items.

The action bar appears at the top of an activity's window when the activity uses the AppCompat's AppCompat theme (or one of its descendant themes). You may otherwise add the action bar by calling requestFeature(FEATURE_SUPPORT_ACTION_BAR) or by declaring it in a custom theme with the windowActionBar property.

The action bar may be represented by any Toolbar widget within the application layout. The application may signal to the Activity which Toolbar should be treated as the Activity's action bar. Activities that use this feature should use one of the supplied .NoActionBar themes, set the windowActionBar attribute to false or otherwise not request the window feature.

If your activity has an options menu, you can make select items accessible directly from the action bar as "action items". You can also modify various characteristics of the action bar or remove it completely.

The navigation button (formerly "Home") takes over the space previously occupied by the application icon. Apps wishing to express a stronger branding should use their brand colors heavily in the action bar and other application chrome or use a logo in place of their standard title text.

From your activity, you can retrieve an instance of ActionBar by calling getSupportActionBar getSupportActionBar()}.

In some cases, the action bar may be overlayed by another bar that enables contextual actions, using an ActionMode. For example, when the user selects one or more items in your activity, you can enable an action mode that offers actions specific to the selected items, with a UI that temporarily replaces the action bar. Although the UI may occupy the same space, the ActionMode APIs are distinct and independent from those for ActionBar.

Summary

Nested types
`public class ActionBar.LayoutParams extends ViewGroup.MarginLayoutParams` Per-child layout information associated with action bar custom views.
`public interface ActionBar.OnMenuVisibilityListener` Listener for receiving events when action bar menus are shown or hidden.
`public interface ActionBar.OnNavigationListener` This interface is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`public abstract class ActionBar.Tab` This class is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`public interface ActionBar.TabListener` This interface is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.

Constants
`static final int`	`DISPLAY_HOME_AS_UP = 4` 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.
`static final int`	`DISPLAY_SHOW_CUSTOM = 16` Show the custom view if one has been set.
`static final int`	`DISPLAY_SHOW_HOME = 2` Show 'home' elements in this action bar, leaving more space for other navigation elements.
`static final int`	`DISPLAY_SHOW_TITLE = 8` Show the activity title and subtitle, if present.
`static final int`	`DISPLAY_USE_LOGO = 1` Use logo instead of icon if available.
`static final int`	`NAVIGATION_MODE_LIST = 1` This field is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`static final int`	`NAVIGATION_MODE_STANDARD = 0` This field is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`static final int`	`NAVIGATION_MODE_TABS = 2` This field is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.

Public constructors
`ActionBar()`

Public methods
`abstract void`	`addOnMenuVisibilityListener( ActionBar.OnMenuVisibilityListener listener )` Add a listener that will respond to menu visibility change events.
`abstract void`	`addTab(ActionBar.Tab tab)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`addTab(ActionBar.Tab tab, int position)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`addTab(ActionBar.Tab tab, boolean setSelected)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`addTab(ActionBar.Tab tab, int position, boolean setSelected)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract View`	`getCustomView()`
`abstract int`	`getDisplayOptions()`
`float`	`getElevation()` Get the Z-axis elevation of the action bar in pixels.
`abstract int`	`getHeight()` Retrieve the current height of the ActionBar.
`int`	`getHideOffset()` Return the current vertical offset of the action bar.
`abstract int`	`getNavigationItemCount()` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract int`	`getNavigationMode()` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract int`	`getSelectedNavigationIndex()` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract @Nullable ActionBar.Tab`	`getSelectedTab()` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract @Nullable CharSequence`	`getSubtitle()` Returns the current ActionBar subtitle in standard mode.
`abstract ActionBar.Tab`	`getTabAt(int index)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract int`	`getTabCount()` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`Context`	`getThemedContext()` Returns a `Context` with an appropriate theme for creating views that will appear in the action bar.
`abstract @Nullable CharSequence`	`getTitle()` Returns the current ActionBar title in standard mode.
`abstract void`	`hide()` Hide the ActionBar if it is currently showing.
`boolean`	`isHideOnContentScrollEnabled()` Return whether the action bar is configured to scroll out of sight along with a `nested scrolling child`.
`abstract boolean`	`isShowing()`
`abstract ActionBar.Tab`	`newTab()` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`removeAllTabs()` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`removeOnMenuVisibilityListener( ActionBar.OnMenuVisibilityListener listener )` Remove a menu visibility listener.
`abstract void`	`removeTab(ActionBar.Tab tab)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`removeTabAt(int position)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`selectTab(ActionBar.Tab tab)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`setBackgroundDrawable(@Nullable Drawable d)` Set the ActionBar's background.
`abstract void`	`setCustomView(int resId)` Set the action bar into custom navigation mode, supplying a view for custom navigation.
`abstract void`	`setCustomView(View view)` Set the action bar into custom navigation mode, supplying a view for custom navigation.
`abstract void`	`setCustomView(View view, ActionBar.LayoutParams layoutParams)` Set the action bar into custom navigation mode, supplying a view for custom navigation.
`abstract void`	`setDisplayHomeAsUpEnabled(boolean showHomeAsUp)` Set whether home should be displayed as an "up" affordance.
`abstract void`	`setDisplayOptions(int options)` Set display options.
`abstract void`	`setDisplayOptions(int options, int mask)` Set selected display options.
`abstract void`	`setDisplayShowCustomEnabled(boolean showCustom)` Set whether a custom view should be displayed, if set.
`abstract void`	`setDisplayShowHomeEnabled(boolean showHome)` Set whether to include the application home affordance in the action bar.
`abstract void`	`setDisplayShowTitleEnabled(boolean showTitle)` Set whether an activity title/subtitle should be displayed.
`abstract void`	`setDisplayUseLogoEnabled(boolean useLogo)` Set whether to display the activity logo rather than the activity icon.
`void`	`setElevation(float elevation)` Set the Z-axis elevation of the action bar in pixels.
`void`	`setHideOffset(int offset)` Set the current hide offset of the action bar.
`void`	`setHideOnContentScrollEnabled(boolean hideOnContentScroll)` Enable hiding the action bar on content scroll.
`void`	`setHomeActionContentDescription(@Nullable CharSequence description)` Set an alternate description for the Home/Up action, when enabled.
`void`	`setHomeActionContentDescription(@StringRes int resId)` Set an alternate description for the Home/Up action, when enabled.
`void`	`setHomeAsUpIndicator(@Nullable Drawable indicator)` Set an alternate drawable to display next to the icon/logo/title when `DISPLAY_HOME_AS_UP` is enabled.
`void`	`setHomeAsUpIndicator(@DrawableRes int resId)` Set an alternate drawable to display next to the icon/logo/title when `DISPLAY_HOME_AS_UP` is enabled.
`void`	`setHomeButtonEnabled(boolean enabled)` Enable or disable the "home" button in the corner of the action bar.
`abstract void`	`setIcon(Drawable icon)` Set the icon to display in the 'home' section of the action bar.
`abstract void`	`setIcon(@DrawableRes int resId)` Set the icon to display in the 'home' section of the action bar.
`abstract void`	`setListNavigationCallbacks( SpinnerAdapter adapter, ActionBar.OnNavigationListener callback )` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`setLogo(Drawable logo)` Set the logo to display in the 'home' section of the action bar.
`abstract void`	`setLogo(@DrawableRes int resId)` Set the logo to display in the 'home' section of the action bar.
`abstract void`	`setNavigationMode(int mode)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`abstract void`	`setSelectedNavigationItem(int position)` This method is deprecated. Action bar navigation modes are deprecated and not supported by inline toolbar action bars.
`void`	`setSplitBackgroundDrawable(Drawable d)` Set the ActionBar's split background.
`void`	`setStackedBackgroundDrawable(Drawable d)` Set the ActionBar's stacked background.
`abstract void`	`setSubtitle(int resId)` Set the action bar's subtitle.
`abstract void`	`setSubtitle(CharSequence subtitle)` Set the action bar's subtitle.
`abstract void`	`setTitle(@StringRes int resId)` Set the action bar's title.
`abstract void`	`setTitle(CharSequence title)` Set the action bar's title.
`abstract void`	`show()` Show the ActionBar if it is not currently showing.

Constants

DISPLAY_HOME_AS_UP

Added in 1.1.0

public static final int DISPLAY_HOME_AS_UP = 4

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.

See also
`setDisplayOptions`
`setDisplayOptions`

DISPLAY_SHOW_CUSTOM

Added in 1.1.0

public static final int DISPLAY_SHOW_CUSTOM = 16

Show the custom view if one has been set.

See also
`setCustomView`
`setDisplayOptions`
`setDisplayOptions`

DISPLAY_SHOW_HOME

Added in 1.1.0

public static final int DISPLAY_SHOW_HOME = 2

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

See also
`setDisplayOptions`
`setDisplayOptions`

DISPLAY_SHOW_TITLE

Added in 1.1.0

public static final int DISPLAY_SHOW_TITLE = 8

Show the activity title and subtitle, if present.

See also
`setTitle`
`setTitle`
`setSubtitle`
`setSubtitle`
`setDisplayOptions`
`setDisplayOptions`

DISPLAY_USE_LOGO

Added in 1.1.0

public static final int DISPLAY_USE_LOGO = 1

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.

See also
`setDisplayOptions`
`setDisplayOptions`

NAVIGATION_MODE_LIST

Added in 1.1.0

Deprecated in 1.1.0

public static final int NAVIGATION_MODE_LIST = 1

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.

NAVIGATION_MODE_STANDARD

Added in 1.1.0

Deprecated in 1.1.0

public static final int NAVIGATION_MODE_STANDARD = 0

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.

NAVIGATION_MODE_TABS

Added in 1.1.0

Deprecated in 1.1.0

public static final int NAVIGATION_MODE_TABS = 2

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

Public constructors

ActionBar

Added in 1.1.0

public ActionBar()

Public methods

addOnMenuVisibilityListener

Added in 1.1.0

public abstract void addOnMenuVisibilityListener(
    ActionBar.OnMenuVisibilityListener listener
)

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

Parameters
`ActionBar.OnMenuVisibilityListener listener`	The new listener to add

addTab

Added in 1.1.0

Deprecated in 1.1.0

public abstract void addTab(ActionBar.Tab tab)

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.

Parameters
`ActionBar.Tab tab`	Tab to add

addTab

Added in 1.1.0

Deprecated in 1.1.0

public abstract void addTab(ActionBar.Tab tab, int position)

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.

Parameters
`ActionBar.Tab tab`	The tab to add
`int position`	The new position of the tab

addTab

Added in 1.1.0

Deprecated in 1.1.0

public abstract void addTab(ActionBar.Tab tab, boolean setSelected)

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

Parameters
`ActionBar.Tab tab`	Tab to add
`boolean setSelected`	True if the added tab should become the selected tab.

addTab

Added in 1.1.0

Deprecated in 1.1.0

public abstract void addTab(ActionBar.Tab tab, int position, boolean setSelected)

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

Parameters
`ActionBar.Tab tab`	The tab to add
`int position`	The new position of the tab
`boolean setSelected`	True if the added tab should become the selected tab.

getCustomView

Added in 1.1.0

public abstract View getCustomView()

Returns
`View`	The current custom view.

getDisplayOptions

Added in 1.1.0

public abstract int getDisplayOptions()

Returns
`int`	The current set of display options.

getElevation

Added in 1.1.0

public float getElevation()

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.

Returns
`float`	Elevation value in pixels

getHeight

Added in 1.1.0

public abstract int getHeight()

Retrieve the current height of the ActionBar.

Returns
`int`	The ActionBar's height

getHideOffset

Added in 1.1.0

public int getHideOffset()

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).

Returns
`int`	The action bar's offset toward its fully hidden state in pixels

getNavigationItemCount

Added in 1.1.0

Deprecated in 1.1.0

public abstract int getNavigationItemCount()

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

Returns
`int`	Number of navigation items.

getNavigationMode

Added in 1.1.0

Deprecated in 1.1.0

public abstract int getNavigationMode()

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

Returns
`int`	The current navigation mode.

getSelectedNavigationIndex

Added in 1.1.0

Deprecated in 1.1.0

public abstract int getSelectedNavigationIndex()

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

Returns
`int`	Position of the selected item.

getSelectedTab

Added in 1.1.0

Deprecated in 1.1.0

public abstract @Nullable ActionBar.Tab getSelectedTab()

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

Returns
`@Nullable ActionBar.Tab`	The currently selected tab or null

getSubtitle

Added in 1.1.0

public abstract @Nullable CharSequence getSubtitle()

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

Returns
`@Nullable CharSequence`	The current ActionBar subtitle or null.

getTabAt

Added in 1.1.0

Deprecated in 1.1.0

public abstract ActionBar.Tab getTabAt(int index)

Returns the tab at the specified index.

Parameters
`int index`	Index value in the range 0-get

Returns
`ActionBar.Tab`

getTabCount

Added in 1.1.0

Deprecated in 1.1.0

public abstract int getTabCount()

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

Returns
`int`	Tab count

getThemedContext

Added in 1.1.0

public Context getThemedContext()

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.

Returns
`Context`	A themed Context for creating views

getTitle

Added in 1.1.0

public abstract @Nullable CharSequence getTitle()

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

Returns
`@Nullable`

ActionBar

Summary

Nested types

Constants

Public constructors

Public methods

Constants

DISPLAY_HOME_AS_UP

DISPLAY_SHOW_CUSTOM

DISPLAY_SHOW_HOME

DISPLAY_SHOW_TITLE

DISPLAY_USE_LOGO

NAVIGATION_MODE_LIST

NAVIGATION_MODE_STANDARD

NAVIGATION_MODE_TABS

Public constructors

ActionBar

Public methods

addOnMenuVisibilityListener

addTab

addTab

addTab

addTab

getCustomView

getDisplayOptions

getElevation

getHeight

getHideOffset

getNavigationItemCount

getNavigationMode

getSelectedNavigationIndex

getSelectedTab

getSubtitle

getTabAt

getTabCount

getThemedContext

getTitle