/**@class android.widget.Toolbar
@extends android.view.ViewGroup
A standard toolbar for use within application content.
<p>A Toolbar is a generalization of {@link android.app.ActionBar action bars} for use
within application layouts. While an action bar is traditionally part of an
{@link android.app.Activity 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 {@link android.app.Activity#setActionBar(Toolbar) setActionBar()} method.</p>
<p>Toolbar supports a more focused feature set than ActionBar. From start to end, a toolbar
may contain a combination of the following optional elements:
<ul>
<li><em>A navigation button.</em> 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
{@link android.R.styleable#View_minHeight minimum height}, if set.</li>
<li><em>A branded logo image.</em> This may extend to the height of the bar and can be
arbitrarily wide.</li>
<li><em>A title and subtitle.</em> 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.</li>
<li><em>One or more custom views.</em> The application may add arbitrary child views
to the Toolbar. They will appear at this position within the layout. If a child view's
{@link android.widget.AbsListView.LayoutParams} indicates a {@link Gravity} value of
{@link Gravity#CENTER_HORIZONTAL CENTER_HORIZONTAL} the view will attempt to center
within the available space remaining in the Toolbar after all other elements have been
measured.</li>
<li><em>An {@link android.widget.ActionMenuView action menu}.</em> The menu of actions will pin to the
end of the Toolbar offering a few
<a href="http://developer.android.com/design/patterns/actionbar.html#ActionButtons">
frequent, important or typical</a> actions along with an optional overflow menu for
additional actions. Action buttons are vertically aligned within the Toolbar's
{@link android.R.styleable#View_minHeight minimum height}, if set.</li>
</ul>
</p>
<p>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.</p>
@attr ref android.R.styleable#Toolbar_buttonGravity
@attr ref android.R.styleable#Toolbar_collapseContentDescription
@attr ref android.R.styleable#Toolbar_collapseIcon
@attr ref android.R.styleable#Toolbar_contentInsetEnd
@attr ref android.R.styleable#Toolbar_contentInsetLeft
@attr ref android.R.styleable#Toolbar_contentInsetRight
@attr ref android.R.styleable#Toolbar_contentInsetStart
@attr ref android.R.styleable#Toolbar_contentInsetStartWithNavigation
@attr ref android.R.styleable#Toolbar_contentInsetEndWithActions
@attr ref android.R.styleable#Toolbar_gravity
@attr ref android.R.styleable#Toolbar_logo
@attr ref android.R.styleable#Toolbar_logoDescription
@attr ref android.R.styleable#Toolbar_maxButtonHeight
@attr ref android.R.styleable#Toolbar_navigationContentDescription
@attr ref android.R.styleable#Toolbar_navigationIcon
@attr ref android.R.styleable#Toolbar_popupTheme
@attr ref android.R.styleable#Toolbar_subtitle
@attr ref android.R.styleable#Toolbar_subtitleTextAppearance
@attr ref android.R.styleable#Toolbar_subtitleTextColor
@attr ref android.R.styleable#Toolbar_title
@attr ref android.R.styleable#Toolbar_titleMargin
@attr ref android.R.styleable#Toolbar_titleMarginBottom
@attr ref android.R.styleable#Toolbar_titleMarginEnd
@attr ref android.R.styleable#Toolbar_titleMarginStart
@attr ref android.R.styleable#Toolbar_titleMarginTop
@attr ref android.R.styleable#Toolbar_titleTextAppearance
@attr ref android.R.styleable#Toolbar_titleTextColor
*/
var Toolbar = {
/**Specifies the theme to use when inflating popup menus. By default, uses
the same theme as the toolbar itself.
@param {Number} resId theme used to inflate popup menus
@see #getPopupTheme()
*/
setPopupTheme : function( ) {},
/**
@return {Number} resource identifier of the theme used to inflate popup menus, or
0 if menus are inflated against the toolbar theme
@see #setPopupTheme(int)
*/
getPopupTheme : function( ) {},
/**Sets the title margin.
@param {Number} start the starting title margin in pixels
@param {Number} top the top title margin in pixels
@param {Number} end the ending title margin in pixels
@param {Number} bottom the bottom title margin in pixels
@see #getTitleMarginStart()
@see #getTitleMarginTop()
@see #getTitleMarginEnd()
@see #getTitleMarginBottom()
@attr ref android.R.styleable#Toolbar_titleMargin
*/
setTitleMargin : function( ) {},
/**
@return {Number} the starting title margin in pixels
@see #setTitleMarginStart(int)
@attr ref android.R.styleable#Toolbar_titleMarginStart
*/
getTitleMarginStart : function( ) {},
/**Sets the starting title margin in pixels.
@param {Number} margin the starting title margin in pixels
@see #getTitleMarginStart()
@attr ref android.R.styleable#Toolbar_titleMarginStart
*/
setTitleMarginStart : function( ) {},
/**
@return {Number} the top title margin in pixels
@see #setTitleMarginTop(int)
@attr ref android.R.styleable#Toolbar_titleMarginTop
*/
getTitleMarginTop : function( ) {},
/**Sets the top title margin in pixels.
@param {Number} margin the top title margin in pixels
@see #getTitleMarginTop()
@attr ref android.R.styleable#Toolbar_titleMarginTop
*/
setTitleMarginTop : function( ) {},
/**
@return {Number} the ending title margin in pixels
@see #setTitleMarginEnd(int)
@attr ref android.R.styleable#Toolbar_titleMarginEnd
*/
getTitleMarginEnd : function( ) {},
/**Sets the ending title margin in pixels.
@param {Number} margin the ending title margin in pixels
@see #getTitleMarginEnd()
@attr ref android.R.styleable#Toolbar_titleMarginEnd
*/
setTitleMarginEnd : function( ) {},
/**
@return {Number} the bottom title margin in pixels
@see #setTitleMarginBottom(int)
@attr ref android.R.styleable#Toolbar_titleMarginBottom
*/
getTitleMarginBottom : function( ) {},
/**Sets the bottom title margin in pixels.
@param {Number} margin the bottom title margin in pixels
@see #getTitleMarginBottom()
@attr ref android.R.styleable#Toolbar_titleMarginBottom
*/
setTitleMarginBottom : function( ) {},
/**
*/
onRtlPropertiesChanged : function( ) {},
/**Set a logo drawable from a resource id.
<p>This drawable should generally take the place of title text. The logo cannot be
clicked. Apps using a logo should also supply a description using
{@link #setLogoDescription}(int).</p>
@param {Number} resId ID of a drawable resource
*/
setLogo : function( ) {},
/**
@hide
*/
canShowOverflowMenu : function( ) {},
/**Check whether the overflow menu is currently showing. This may not reflect
a pending show operation in progress.
@return {Boolean} true if the overflow menu is currently showing
*/
isOverflowMenuShowing : function( ) {},
/**
@hide
*/
isOverflowMenuShowPending : function( ) {},
/**Show the overflow items from the associated menu.
@return {Boolean} true if the menu was able to be shown, false otherwise
*/
showOverflowMenu : function( ) {},
/**Hide the overflow items from the associated menu.
@return {Boolean} true if the menu was able to be hidden, false otherwise
*/
hideOverflowMenu : function( ) {},
/**
@hide
*/
setMenu : function( ) {},
/**Dismiss all currently showing popup menus, including overflow or submenus.
*/
dismissPopupMenus : function( ) {},
/**
@hide
*/
isTitleTruncated : function( ) {},
/**Set a logo drawable.
<p>This drawable should generally take the place of title text. The logo cannot be
clicked. Apps using a logo should also supply a description using
{@link #setLogoDescription}(int).</p>
@param {Object {Drawable}} drawable Drawable to use as a logo
*/
setLogo : function( ) {},
/**Return the current logo drawable.
@return {Object {android.graphics.drawable.Drawable}} The current logo drawable
@see #setLogo(int)
@see #setLogo(android.graphics.drawable.Drawable)
*/
getLogo : function( ) {},
/**Set a description of the toolbar's logo.
<p>This description will be used for accessibility or other similar descriptions
of the UI.</p>
@param {Number} resId String resource id
*/
setLogoDescription : function( ) {},
/**Set a description of the toolbar's logo.
<p>This description will be used for accessibility or other similar descriptions
of the UI.</p>
@param {Object {CharSequence}} description Description to set
*/
setLogoDescription : function( ) {},
/**Return the description of the toolbar's logo.
@return {Object {java.lang.CharSequence}} A description of the logo
*/
getLogoDescription : function( ) {},
/**Check whether this Toolbar is currently hosting an expanded action view.
<p>An action view may be expanded either directly from the
{@link android.view.MenuItem MenuItem} it belongs to or by user action. If the Toolbar
has an expanded action view it can be collapsed using the {@link #collapseActionView}()
method.</p>
@return {Boolean} true if the Toolbar has an expanded action view
*/
hasExpandedActionView : function( ) {},
/**Collapse a currently expanded action view. If this Toolbar does not have an
expanded action view this method has no effect.
<p>An action view may be expanded either directly from the
{@link android.view.MenuItem MenuItem} it belongs to or by user action.</p>
@see #hasExpandedActionView()
*/
collapseActionView : function( ) {},
/**Returns the title of this toolbar.
@return {Object {java.lang.CharSequence}} The current title.
*/
getTitle : function( ) {},
/**Set the title of this toolbar.
<p>A title should be used as the anchor for a section of content. It should
describe or name the content being viewed.</p>
@param {Number} resId Resource ID of a string to set as the title
*/
setTitle : function( ) {},
/**Set the title of this toolbar.
<p>A title should be used as the anchor for a section of content. It should
describe or name the content being viewed.</p>
@param {Object {CharSequence}} title Title to set
*/
setTitle : function( ) {},
/**Return the subtitle of this toolbar.
@return {Object {java.lang.CharSequence}} The current subtitle
*/
getSubtitle : function( ) {},
/**Set the subtitle of this toolbar.
<p>Subtitles should express extended information about the current content.</p>
@param {Number} resId String resource ID
*/
setSubtitle : function( ) {},
/**Set the subtitle of this toolbar.
<p>Subtitles should express extended information about the current content.</p>
@param {Object {CharSequence}} subtitle Subtitle to set
*/
setSubtitle : function( ) {},
/**Sets the text color, size, style, hint color, and highlight color
from the specified TextAppearance resource.
*/
setTitleTextAppearance : function( ) {},
/**Sets the text color, size, style, hint color, and highlight color
from the specified TextAppearance resource.
*/
setSubtitleTextAppearance : function( ) {},
/**Sets the text color of the title, if present.
@param {Number} color The new text color in 0xAARRGGBB format
*/
setTitleTextColor : function( ) {},
/**Sets the text color of the subtitle, if present.
@param {Number} color The new text color in 0xAARRGGBB format
*/
setSubtitleTextColor : function( ) {},
/**Retrieve the currently configured content description for the navigation button view.
This will be used to describe the navigation action to users through mechanisms such
as screen readers or tooltips.
@return {Object {java.lang.CharSequence}} The navigation button's content description
@attr ref android.R.styleable#Toolbar_navigationContentDescription
*/
getNavigationContentDescription : function( ) {},
/**Set a content description for the navigation button if one is present. The content
description will be read via screen readers or other accessibility systems to explain
the action of the navigation button.
@param {Number} resId Resource ID of a content description string to set, or 0 to
clear the description
@attr ref android.R.styleable#Toolbar_navigationContentDescription
*/
setNavigationContentDescription : function( ) {},
/**Set a content description for the navigation button if one is present. The content
description will be read via screen readers or other accessibility systems to explain
the action of the navigation button.
@param {Object {CharSequence}} description Content description to set, or <code>null</code> to
clear the content description
@attr ref android.R.styleable#Toolbar_navigationContentDescription
*/
setNavigationContentDescription : function( ) {},
/**Set the icon to use for the toolbar's navigation button.
<p>The navigation button appears at the start of the toolbar if present. Setting an icon
will make the navigation button visible.</p>
<p>If you use a navigation icon you should also set a description for its action using
{@link #setNavigationContentDescription}(int). This is used for accessibility and
tooltips.</p>
@param {Number} resId Resource ID of a drawable to set
@attr ref android.R.styleable#Toolbar_navigationIcon
*/
setNavigationIcon : function( ) {},
/**Set the icon to use for the toolbar's navigation button.
<p>The navigation button appears at the start of the toolbar if present. Setting an icon
will make the navigation button visible.</p>
<p>If you use a navigation icon you should also set a description for its action using
{@link #setNavigationContentDescription}(int). This is used for accessibility and
tooltips.</p>
@param {Object {Drawable}} icon Drawable to set, may be null to clear the icon
@attr ref android.R.styleable#Toolbar_navigationIcon
*/
setNavigationIcon : function( ) {},
/**Return the current drawable used as the navigation icon.
@return {Object {android.graphics.drawable.Drawable}} The navigation icon drawable
@attr ref android.R.styleable#Toolbar_navigationIcon
*/
getNavigationIcon : function( ) {},
/**Set a listener to respond to navigation events.
<p>This listener will be called whenever the user clicks the navigation button
at the start of the toolbar. An icon must be set for the navigation button to appear.</p>
@param {Object {View.OnClickListener}} listener Listener to set
@see #setNavigationIcon(android.graphics.drawable.Drawable)
*/
setNavigationOnClickListener : function( ) {},
/**
@hide
*/
getNavigationView : function( ) {},
/**Retrieve the currently configured content description for the collapse button view.
This will be used to describe the collapse action to users through mechanisms such
as screen readers or tooltips.
@return {Object {java.lang.CharSequence}} The collapse button's content description
@attr ref android.R.styleable#Toolbar_collapseContentDescription
*/
getCollapseContentDescription : function( ) {},
/**Set a content description for the collapse button if one is present. The content description
will be read via screen readers or other accessibility systems to explain the action of the
collapse button.
@param {Number} resId Resource ID of a content description string to set, or 0 to
clear the description
@attr ref android.R.styleable#Toolbar_collapseContentDescription
*/
setCollapseContentDescription : function( ) {},
/**Set a content description for the collapse button if one is present. The content description
will be read via screen readers or other accessibility systems to explain the action of the
navigation button.
@param {Object {CharSequence}} description Content description to set, or <code>null</code> to
clear the content description
@attr ref android.R.styleable#Toolbar_collapseContentDescription
*/
setCollapseContentDescription : function( ) {},
/**Return the current drawable used as the collapse icon.
@return {Object {android.graphics.drawable.Drawable}} The collapse icon drawable
@attr ref android.R.styleable#Toolbar_collapseIcon
*/
getCollapseIcon : function( ) {},
/**Set the icon to use for the toolbar's collapse button.
<p>The collapse button appears at the start of the toolbar when an action view is present
.</p>
@param {Number} resId Resource ID of a drawable to set
@attr ref android.R.styleable#Toolbar_collapseIcon
*/
setCollapseIcon : function( ) {},
/**Set the icon to use for the toolbar's collapse button.
<p>The collapse button appears at the start of the toolbar when an action view is present
.</p>
@param {Object {Drawable}} icon Drawable to set, may be null to use the default icon
@attr ref android.R.styleable#Toolbar_collapseIcon
*/
setCollapseIcon : function( ) {},
/**Return the Menu shown in the toolbar.
<p>Applications that wish to populate the toolbar's menu can do so from here. To use
an XML menu resource, use {@link #inflateMenu}(int).</p>
@return {Object {android.view.Menu}} The toolbar's Menu
*/
getMenu : function( ) {},
/**Set the icon to use for the overflow button.
@param {Object {Drawable}} icon Drawable to set, may be null to clear the icon
*/
setOverflowIcon : function( ) {},
/**Return the current drawable used as the overflow icon.
@return {Object {android.graphics.drawable.Drawable}} The overflow icon drawable
*/
getOverflowIcon : function( ) {},
/**Inflate a menu resource into this toolbar.
<p>Inflate an XML menu resource into this toolbar. Existing items in the menu will not
be modified or removed.</p>
@param {Number} resId ID of a menu resource to inflate
*/
inflateMenu : function( ) {},
/**Set a listener to respond to menu item click events.
<p>This listener will be invoked whenever a user selects a menu item from
the action buttons presented at the end of the toolbar or the associated overflow.</p>
@param {Object {Toolbar.OnMenuItemClickListener}} listener Listener to set
*/
setOnMenuItemClickListener : function( ) {},
/**Sets the content insets for this toolbar relative to layout direction.
<p>The content inset affects the valid area for Toolbar content other than
the navigation button and menu. Insets define the minimum margin for these components
and can be used to effectively align Toolbar content along well-known gridlines.</p>
@param {Number} contentInsetStart Content inset for the toolbar starting edge
@param {Number} contentInsetEnd Content inset for the toolbar ending edge
@see #setContentInsetsAbsolute(int, int)
@see #getContentInsetStart()
@see #getContentInsetEnd()
@see #getContentInsetLeft()
@see #getContentInsetRight()
@attr ref android.R.styleable#Toolbar_contentInsetEnd
@attr ref android.R.styleable#Toolbar_contentInsetStart
*/
setContentInsetsRelative : function( ) {},
/**Gets the starting content inset for this toolbar.
<p>The content inset affects the valid area for Toolbar content other than
the navigation button and menu. Insets define the minimum margin for these components
and can be used to effectively align Toolbar content along well-known gridlines.</p>
@return {Number} The starting content inset for this toolbar
@see #setContentInsetsRelative(int, int)
@see #setContentInsetsAbsolute(int, int)
@see #getContentInsetEnd()
@see #getContentInsetLeft()
@see #getContentInsetRight()
@attr ref android.R.styleable#Toolbar_contentInsetStart
*/
getContentInsetStart : function( ) {},
/**Gets the ending content inset for this toolbar.
<p>The content inset affects the valid area for Toolbar content other than
the navigation button and menu. Insets define the minimum margin for these components
and can be used to effectively align Toolbar content along well-known gridlines.</p>
@return {Number} The ending content inset for this toolbar
@see #setContentInsetsRelative(int, int)
@see #setContentInsetsAbsolute(int, int)
@see #getContentInsetStart()
@see #getContentInsetLeft()
@see #getContentInsetRight()
@attr ref android.R.styleable#Toolbar_contentInsetEnd
*/
getContentInsetEnd : function( ) {},
/**Sets the content insets for this toolbar.
<p>The content inset affects the valid area for Toolbar content other than
the navigation button and menu. Insets define the minimum margin for these components
and can be used to effectively align Toolbar content along well-known gridlines.</p>
@param {Number} contentInsetLeft Content inset for the toolbar's left edge
@param {Number} contentInsetRight Content inset for the toolbar's right edge
@see #setContentInsetsAbsolute(int, int)
@see #getContentInsetStart()
@see #getContentInsetEnd()
@see #getContentInsetLeft()
@see #getContentInsetRight()
@attr ref android.R.styleable#Toolbar_contentInsetLeft
@attr ref android.R.styleable#Toolbar_contentInsetRight
*/
setContentInsetsAbsolute : function( ) {},
/**Gets the left content inset for this toolbar.
<p>The content inset affects the valid area for Toolbar content other than
the navigation button and menu. Insets define the minimum margin for these components
and can be used to effectively align Toolbar content along well-known gridlines.</p>
@return {Number} The left content inset for this toolbar
@see #setContentInsetsRelative(int, int)
@see #setContentInsetsAbsolute(int, int)
@see #getContentInsetStart()
@see #getContentInsetEnd()
@see #getContentInsetRight()
@attr ref android.R.styleable#Toolbar_contentInsetLeft
*/
getContentInsetLeft : function( ) {},
/**Gets the right content inset for this toolbar.
<p>The content inset affects the valid area for Toolbar content other than
the navigation button and menu. Insets define the minimum margin for these components
and can be used to effectively align Toolbar content along well-known gridlines.</p>
@return {Number} The right content inset for this toolbar
@see #setContentInsetsRelative(int, int)
@see #setContentInsetsAbsolute(int, int)
@see #getContentInsetStart()
@see #getContentInsetEnd()
@see #getContentInsetLeft()
@attr ref android.R.styleable#Toolbar_contentInsetRight
*/
getContentInsetRight : function( ) {},
/**Gets the start content inset to use when a navigation button is present.
<p>Different content insets are often called for when additional buttons are present
in the toolbar, as well as at different toolbar sizes. The larger value of
{@link #getContentInsetStart}() and this value will be used during layout.</p>
@return {Number} the start content inset used when a navigation icon has been set in pixels
@see #setContentInsetStartWithNavigation(int)
@attr ref android.R.styleable#Toolbar_contentInsetStartWithNavigation
*/
getContentInsetStartWithNavigation : function( ) {},
/**Sets the start content inset to use when a navigation button is present.
<p>Different content insets are often called for when additional buttons are present
in the toolbar, as well as at different toolbar sizes. The larger value of
{@link #getContentInsetStart}() and this value will be used during layout.</p>
@param {Number} insetStartWithNavigation the inset to use when a navigation icon has been set
in pixels
@see #getContentInsetStartWithNavigation()
@attr ref android.R.styleable#Toolbar_contentInsetStartWithNavigation
*/
setContentInsetStartWithNavigation : function( ) {},
/**Gets the end content inset to use when action buttons are present.
<p>Different content insets are often called for when additional buttons are present
in the toolbar, as well as at different toolbar sizes. The larger value of
{@link #getContentInsetEnd}() and this value will be used during layout.</p>
@return {Number} the end content inset used when a menu has been set in pixels
@see #setContentInsetEndWithActions(int)
@attr ref android.R.styleable#Toolbar_contentInsetEndWithActions
*/
getContentInsetEndWithActions : function( ) {},
/**Sets the start content inset to use when action buttons are present.
<p>Different content insets are often called for when additional buttons are present
in the toolbar, as well as at different toolbar sizes. The larger value of
{@link #getContentInsetEnd}() and this value will be used during layout.</p>
@param {Number} insetEndWithActions the inset to use when a menu has been set in pixels
@see #setContentInsetEndWithActions(int)
@attr ref android.R.styleable#Toolbar_contentInsetEndWithActions
*/
setContentInsetEndWithActions : function( ) {},
/**Gets the content inset that will be used on the starting side of the bar in the current
toolbar configuration.
@return {Number} the current content inset start in pixels
@see #getContentInsetStartWithNavigation()
*/
getCurrentContentInsetStart : function( ) {},
/**Gets the content inset that will be used on the ending side of the bar in the current
toolbar configuration.
@return {Number} the current content inset end in pixels
@see #getContentInsetEndWithActions()
*/
getCurrentContentInsetEnd : function( ) {},
/**Gets the content inset that will be used on the left side of the bar in the current
toolbar configuration.
@return {Number} the current content inset left in pixels
@see #getContentInsetStartWithNavigation()
@see #getContentInsetEndWithActions()
*/
getCurrentContentInsetLeft : function( ) {},
/**Gets the content inset that will be used on the right side of the bar in the current
toolbar configuration.
@return {Number} the current content inset right in pixels
@see #getContentInsetStartWithNavigation()
@see #getContentInsetEndWithActions()
*/
getCurrentContentInsetRight : function( ) {},
/**
*/
onTouchEvent : function( ) {},
/**
*/
generateLayoutParams : function( ) {},
/**
@hide
*/
getWrapper : function( ) {},
/**Force the toolbar to collapse to zero-height during measurement if
it could be considered "empty" (no visible elements with nonzero measured size)
@hide
*/
setCollapsible : function( ) {},
/**Must be called before the menu is accessed
@hide
*/
setMenuCallbacks : function( ) {},
};