Toolbar

Artifact: androidx.appcompat:appcompat

View Source

Added in 1.1.0

---

Kotlin |Java

public class Toolbar extends ViewGroup implements MenuHost

java.lang.Object
↳	android.view.View
	↳	android.view.ViewGroup
		↳	androidx.appcompat.widget.Toolbar

---

A standard toolbar for use within application content.

A Toolbar is a generalization of action bars for use within application layouts. While an action bar is traditionally part of an Activity's opaque window decor controlled by the framework, a Toolbar may be placed at any arbitrary level of nesting within a view hierarchy. An application may choose to designate a Toolbar as the action bar for an Activity using the setSupportActionBar() method.

Toolbar supports a more focused feature set than ActionBar. From start to end, a toolbar may contain a combination of the following optional elements:

• A navigation button. This may be an Up arrow, navigation menu toggle, close, collapse, done or another glyph of the app's choosing. This button should always be used to access other navigational destinations within the container of the Toolbar and its signified content or otherwise leave the current context signified by the Toolbar. The navigation button is vertically aligned within the Toolbar's minimum height, if set.
• A branded logo image. This may extend to the height of the bar and can be arbitrarily wide.
• A title and subtitle. The title should be a signpost for the Toolbar's current position in the navigation hierarchy and the content contained there. The subtitle, if present should indicate any extended information about the current content. If an app uses a logo image it should strongly consider omitting a title and subtitle.
• One or more custom views. The application may add arbitrary child views to the Toolbar. They will appear at this position within the layout. If a child view's LayoutParams indicates a Gravity value of CENTER_HORIZONTAL the view will attempt to center within the available space remaining in the Toolbar after all other elements have been measured.
• An action menu. The menu of actions will pin to the end of the Toolbar offering a few frequent, important or typical actions along with an optional overflow menu for additional actions. Action buttons are vertically aligned within the Toolbar's minimum height, if set.

In modern Android UIs developers should lean more on a visually distinct color scheme for toolbars than on their application icon. The use of application icon plus title as a standard layout is discouraged on API 21 devices and newer.

buttonGravitycollapseContentDescriptioncollapseIconcontentInsetEndcontentInsetLeftcontentInsetRightcontentInsetStartcontentInsetStartWithNavigationcontentInsetEndWithActionsgravitylogologoDescriptionmaxButtonHeightnavigationContentDescriptionnavigationIconpopupThemesubtitlesubtitleTextAppearancesubtitleTextColortitletitleMargintitleMarginBottomtitleMarginEndtitleMarginStarttitleMarginToptitleTextAppearancetitleTextColormenu

Summary

Nested types
public class Toolbar.LayoutParams extends ActionBar.LayoutParams Layout information for child views of Toolbars.
public interface Toolbar.OnMenuItemClickListener Interface responsible for receiving menu item click events if the items themselves do not have individual item click listeners.
public class Toolbar.SavedState extends AbsSavedState

Public constructors
Toolbar(@NonNull Context context)
Toolbar(@NonNull Context context, @Nullable AttributeSet attrs)
Toolbar(     @NonNull Context context,     @Nullable AttributeSet attrs,     int defStyleAttr )

Public methods
void	@MainThread addMenuProvider(@NonNull MenuProvider provider) Adds the given MenuProvider to this MenuHost.
void	@MainThread addMenuProvider(     @NonNull MenuProvider provider,     @NonNull LifecycleOwner owner ) Adds the given MenuProvider to this MenuHost.
void	@MainThread addMenuProvider(     @NonNull MenuProvider provider,     @NonNull LifecycleOwner owner,     @NonNull Lifecycle.State state ) Adds the given MenuProvider to this MenuHost once the given LifecycleOwner reaches the given Lifecycle.State.
void	collapseActionView() Collapse a currently expanded action view.
void	dismissPopupMenus() Dismiss all currently showing popup menus, including overflow or submenus.
Toolbar.LayoutParams	generateLayoutParams(AttributeSet attrs)
@Nullable CharSequence	@Attribute(value = "androidx.appcompat:collapseContentDescription") getCollapseContentDescription() Retrieve the currently configured content description for the collapse button view.
@Nullable Drawable	@Attribute(value = "androidx.appcompat:collapseIcon") getCollapseIcon() Return the current drawable used as the collapse icon.
int	@Attribute(value = "androidx.appcompat:contentInsetEnd") getContentInsetEnd() Gets the ending content inset for this toolbar.
int	@Attribute(value = "androidx.appcompat:contentInsetEndWithActions") getContentInsetEndWithActions() Gets the end content inset to use when action buttons are present.
int	@Attribute(value = "androidx.appcompat:contentInsetLeft") getContentInsetLeft() Gets the left content inset for this toolbar.
int	@Attribute(value = "androidx.appcompat:contentInsetRight") getContentInsetRight() Gets the right content inset for this toolbar.
int	@Attribute(value = "androidx.appcompat:contentInsetStart") getContentInsetStart() Gets the starting content inset for this toolbar.
int	@Attribute(value = "androidx.appcompat:contentInsetStartWithNavigation") getContentInsetStartWithNavigation() Gets the start content inset to use when a navigation button is present.
int	getCurrentContentInsetEnd() Gets the content inset that will be used on the ending side of the bar in the current toolbar configuration.
int	getCurrentContentInsetLeft() Gets the content inset that will be used on the left side of the bar in the current toolbar configuration.
int	getCurrentContentInsetRight() Gets the content inset that will be used on the right side of the bar in the current toolbar configuration.
int	getCurrentContentInsetStart() Gets the content inset that will be used on the starting side of the bar in the current toolbar configuration.
Drawable	@Attribute(value = "androidx.appcompat:logo") getLogo() Return the current logo drawable.
CharSequence	@Attribute(value = "androidx.appcompat:logoDescription") getLogoDescription() Return the description of the toolbar's logo.
Menu	@Attribute(value = "androidx.appcompat:menu") getMenu() Return the Menu shown in the toolbar.
@Nullable CharSequence	@Attribute(value = "androidx.appcompat:navigationContentDescription") getNavigationContentDescription() Retrieve the currently configured content description for the navigation button view.
@Nullable Drawable	@Attribute(value = "androidx.appcompat:navigationIcon") getNavigationIcon() Return the current drawable used as the navigation icon.
@Nullable Drawable	getOverflowIcon() Return the current drawable used as the overflow icon.
@StyleRes int	@Attribute(value = "androidx.appcompat:popupTheme") getPopupTheme()
CharSequence	@Attribute(value = "androidx.appcompat:subtitle") getSubtitle() Return the subtitle of this toolbar.
CharSequence	@Attribute(value = "androidx.appcompat:title") getTitle() Returns the title of this toolbar.
int	@Attribute(value = "androidx.appcompat:titleMarginBottom") getTitleMarginBottom()
int	@Attribute(value = "androidx.appcompat:titleMarginEnd") getTitleMarginEnd()
int	@Attribute(value = "androidx.appcompat:titleMarginStart") getTitleMarginStart()
int	@Attribute(value = "androidx.appcompat:titleMarginTop") getTitleMarginTop()
boolean	hasExpandedActionView() Check whether this Toolbar is currently hosting an expanded action view.
boolean	hideOverflowMenu() Hide the overflow items from the associated menu.
void	inflateMenu(@MenuRes int resId) Inflate a menu resource into this toolbar.
void	@MainThread invalidateMenu() Invalidates the to ensure that what is displayed matches the current internal state of the menu.
boolean	isBackInvokedCallbackEnabled() Returns whether the toolbar will attempt to register its own OnBackInvokedCallback in supported configurations to handle collapsing expanded action items when a back invocation occurs.
boolean	isOverflowMenuShowing() Check whether the overflow menu is currently showing.
boolean	onHoverEvent(MotionEvent ev)
void	onRtlPropertiesChanged(int layoutDirection)
boolean	onTouchEvent(MotionEvent ev)
void	@MainThread removeMenuProvider(@NonNull MenuProvider provider) Removes the given MenuProvider from this MenuHost.
void	setBackInvokedCallbackEnabled(boolean enabled) Sets whether the toolbar will attempt to register its own OnBackInvokedCallback in supported configurations to handle collapsing expanded action items when a back invocation occurs.
void	setCollapseContentDescription(@Nullable CharSequence description) Set a content description for the collapse button if one is present.
void	setCollapseContentDescription(@StringRes int resId) Set a content description for the collapse button if one is present.
void	setCollapseIcon(@Nullable Drawable icon) Set the icon to use for the toolbar's collapse button.
void	setCollapseIcon(@DrawableRes int resId) Set the icon to use for the toolbar's collapse button.
void	setContentInsetEndWithActions(int insetEndWithActions) Sets the start content inset to use when action buttons are present.
void	setContentInsetStartWithNavigation(int insetStartWithNavigation) Sets the start content inset to use when a navigation button is present.
void	setContentInsetsAbsolute(int contentInsetLeft, int contentInsetRight) Sets the content insets for this toolbar.
void	setContentInsetsRelative(int contentInsetStart, int contentInsetEnd) Sets the content insets for this toolbar relative to layout direction.
void	setLogo(Drawable drawable) Set a logo drawable.
void	setLogo(@DrawableRes int resId) Set a logo drawable from a resource id.
void	setLogoDescription(CharSequence description) Set a description of the toolbar's logo.
void	setLogoDescription(@StringRes int resId) Set a description of the toolbar's logo.
void	setNavigationContentDescription(@Nullable CharSequence description) Set a content description for the navigation button if one is present.
void	setNavigationContentDescription(@StringRes int resId) Set a content description for the navigation button if one is present.
void	setNavigationIcon(@Nullable Drawable icon) Set the icon to use for the toolbar's navigation button.
void	setNavigationIcon(@DrawableRes int resId) Set the icon to use for the toolbar's navigation button.
void	setNavigationOnClickListener(View.OnClickListener listener) Set a listener to respond to navigation events.
void	setOnMenuItemClickListener(Toolbar.OnMenuItemClickListener listener) Set a listener to respond to menu item click events.
void	setOverflowIcon(@Nullable Drawable icon) Set the icon to use for the overflow button.
void	setPopupTheme(@StyleRes int resId) Specifies the theme to use when inflating popup menus.
void	setSubtitle(@StringRes int resId) Set the subtitle of this toolbar.
void	setSubtitle(CharSequence subtitle) Set the subtitle of this toolbar.
void	setSubtitleTextAppearance(Context context, @StyleRes int resId) Sets the text color, size, style, hint color, and highlight color from the specified TextAppearance resource.
void	setSubtitleTextColor(@NonNull ColorStateList color) Sets the text color of the subtitle, if present.
void	setSubtitleTextColor(@ColorInt int color) Sets the text color of the subtitle, if present.
void	setTitle(@StringRes int resId) Set the title of this toolbar.
void	setTitle(CharSequence title) Set the title of this toolbar.
void	setTitleMargin(int start, int top, int end, int bottom) Sets the title margin.
void	setTitleMarginBottom(int margin) Sets the bottom title margin in pixels.
void	setTitleMarginEnd(int margin) Sets the ending title margin in pixels.
void	setTitleMarginStart(int margin) Sets the starting title margin in pixels.
void	setTitleMarginTop(int margin) Sets the top title margin in pixels.
void	setTitleTextAppearance(Context context, @StyleRes int resId) Sets the text color, size, style, hint color, and highlight color from the specified TextAppearance resource.
void	setTitleTextColor(@NonNull ColorStateList color) Sets the text color of the title, if present.
void	setTitleTextColor(@ColorInt int color) Sets the text color of the title, if present.
boolean	showOverflowMenu() Show the overflow items from the associated menu.

Protected methods
boolean	checkLayoutParams(ViewGroup.LayoutParams p)
Toolbar.LayoutParams	generateDefaultLayoutParams()
Toolbar.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()

Extension functions
final void	ToolbarKt.setupWithNavController(     @NonNull Toolbar receiver,     @NonNull NavController navController,     @NonNull AppBarConfiguration configuration ) Sets up a Toolbar for use with a NavController.
final void	ToolbarKt.setupWithNavController(     @NonNull Toolbar receiver,     @NonNull NavController navController,     DrawerLayout drawerLayout ) Sets up a Toolbar for use with a NavController.

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