IT. Expert System.

Android Reference

ActionBar


android.app

Class ActionBar



  • public abstract class ActionBar
    extends Object
    A window feature at the top of the activity that may display the activity title, navigation modes, and other interactive items.

    Beginning with Android 3.0 (API level 11), the action bar appears at the top of an activity's window when the activity uses the system's Holo theme (or one of its descendant themes), which is the default. You may otherwise add the action bar by calling requestFeature(FEATURE_ACTION_BAR) or by declaring it in a custom theme with the windowActionBar property.

    By default, the action bar shows the application icon on the left, followed by the activity title. 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.

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

    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.

    Developer Guides

    For information about how to use the action bar, including how to add action items, navigation modes and more, read the Action Bar developer guide.

    • Constructor Detail

      • ActionBar

        public ActionBar()
    • Method Detail

      • setCustomView

        public abstract void setCustomView(View view)
        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.
        Parameters:
        view - Custom navigation view to place in the ActionBar.
      • setCustomView

        public abstract void setCustomView(View view,
                         ActionBar.LayoutParams layoutParams)
        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.

        Parameters:
        view - Custom navigation view to place in the ActionBar.
        layoutParams - How this custom view should layout in the bar.
        See Also:
        setDisplayOptions(int, int)
      • setCustomView

        public abstract void setCustomView(int resId)
        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.

        Parameters:
        resId - Resource ID of a layout to inflate into the ActionBar.
        See Also:
        setDisplayOptions(int, int)
      • setIcon

        public abstract void setIcon(int resId)
        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.
        Parameters:
        resId - Resource ID of a drawable to show as an icon.
        See Also:
        setDisplayUseLogoEnabled(boolean), setDisplayShowHomeEnabled(boolean)
      • setLogo

        public abstract void setLogo(int resId)
        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.
        Parameters:
        resId - Resource ID of a drawable to show as a logo.
        See Also:
        setDisplayUseLogoEnabled(boolean), setDisplayShowHomeEnabled(boolean)
      • setListNavigationCallbacks

        public abstract void setListNavigationCallbacks(SpinnerAdapter adapter,
                                      ActionBar.OnNavigationListener callback)
        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.
        Parameters:
        adapter - An adapter that will provide views both to display the current navigation selection and populate views within the dropdown navigation menu.
        callback - An OnNavigationListener that will receive events when the user selects a navigation item.
      • setSelectedNavigationItem

        public abstract void setSelectedNavigationItem(int position)
        Set the selected navigation item in list or tabbed navigation modes.
        Parameters:
        position - Position of the item to select.
      • getSelectedNavigationIndex

        public abstract int getSelectedNavigationIndex()
        Get the position of the selected navigation item in list or tabbed navigation modes.
        Returns:
        Position of the selected item.
      • getNavigationItemCount

        public abstract int getNavigationItemCount()
        Get the number of navigation items present in the current navigation mode.
        Returns:
        Number of navigation items.
      • setDisplayOptions

        public abstract void setDisplayOptions(int options)
        Set display options. This changes all display option bits at once. To change a limited subset of display options, see setDisplayOptions(int, int).
        Parameters:
        options - A combination of the bits defined by the DISPLAY_ constants defined in ActionBar.
      • setDisplayOptions

        public abstract void setDisplayOptions(int options,
                             int mask)
        Set selected display options. Only the options specified by mask will be changed. To change all display option bits at once, see setDisplayOptions(int).

        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.

        Parameters:
        options - A combination of the bits defined by the DISPLAY_ constants defined in ActionBar.
        mask - A bit mask declaring which display options should be changed.
      • setDisplayUseLogoEnabled

        public abstract void setDisplayUseLogoEnabled(boolean useLogo)
        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.

        Parameters:
        useLogo - true to use the activity logo, false to use the activity icon.
        See Also:
        setDisplayOptions(int), setDisplayOptions(int, int)
      • setDisplayShowHomeEnabled

        public abstract void setDisplayShowHomeEnabled(boolean showHome)
        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.

        Parameters:
        showHome - true to show home, false otherwise.
        See Also:
        setDisplayOptions(int), setDisplayOptions(int, int)
      • setDisplayHomeAsUpEnabled

        public abstract void setDisplayHomeAsUpEnabled(boolean showHomeAsUp)
        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.

        Parameters:
        showHomeAsUp - true to show the user that selecting home will return one level up rather than to the top level of the app.
        See Also:
        setDisplayOptions(int), setDisplayOptions(int, int)
      • setDisplayShowTitleEnabled

        public abstract void setDisplayShowTitleEnabled(boolean showTitle)
        Set whether an activity title/subtitle should be displayed.

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

        Parameters:
        showTitle - true to display a title/subtitle if present.
        See Also:
        setDisplayOptions(int), setDisplayOptions(int, int)
      • setDisplayShowCustomEnabled

        public abstract void setDisplayShowCustomEnabled(boolean showCustom)
        Set whether a custom view should be displayed, if set.

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

        Parameters:
        showCustom - true if the currently set custom view should be displayed, false otherwise.
        See Also:
        setDisplayOptions(int), setDisplayOptions(int, int)
      • setStackedBackgroundDrawable

        public void setStackedBackgroundDrawable(Drawable d)
        Set the ActionBar's stacked background. This will appear in the second row/stacked bar on some devices and configurations.
        Parameters:
        d - Background drawable for the stacked row
      • setSplitBackgroundDrawable

        public void setSplitBackgroundDrawable(Drawable d)
        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 android.R.attr#uiOptions

        Parameters:
        d - Background drawable for the split bar
      • getCustomView

        public abstract View getCustomView()
        Returns:
        The current custom view.
      • getDisplayOptions

        public abstract int getDisplayOptions()
        Returns:
        The current set of display options.
      • newTab

        public abstract ActionBar.Tab newTab()
        Create and return a new ActionBar.Tab. This tab will not be included in the action bar until it is added.

        Very often tabs will be used to switch between Fragment objects. Here is a typical implementation of such tabs:

        Returns:
        A new Tab
        See Also:
        addTab(Tab)
      • addTab

        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:
        tab - Tab to add
      • addTab

        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:
        tab - Tab to add
        setSelected - True if the added tab should become the selected tab.
      • addTab

        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:
        tab - The tab to add
        position - The new position of the tab
      • addTab

        public abstract void addTab(ActionBar.Tab tab,
                  int position,
                  boolean setSelected)
        Add a tab for use in tabbed navigation mode. The tab will be insterted at position.
        Parameters:
        tab - The tab to add
        position - The new position of the tab
        setSelected - True if the added tab should become the selected tab.
      • removeTab

        public abstract void removeTab(ActionBar.Tab tab)
        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.
        Parameters:
        tab - The tab to remove
      • removeTabAt

        public abstract void removeTabAt(int position)
        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.
        Parameters:
        position - Position of the tab to remove
      • removeAllTabs

        public abstract void removeAllTabs()
        Remove all tabs from the action bar and deselect the current tab.
      • selectTab

        public abstract void selectTab(ActionBar.Tab tab)
        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(int).

        Parameters:
        tab - Tab to select
      • getSelectedTab

        public abstract ActionBar.Tab getSelectedTab()
        Returns the currently selected tab if in tabbed navigation mode and there is at least one tab present.
        Returns:
        The currently selected tab or null
      • getTabAt

        public abstract ActionBar.Tab getTabAt(int index)
        Returns the tab at the specified index.
        Parameters:
        index - Index value in the range 0-get
        Returns:
      • getTabCount

        public abstract int getTabCount()
        Returns the number of tabs currently registered with the action bar.
        Returns:
        Tab count
      • getHeight

        public abstract int getHeight()
        Retrieve the current height of the ActionBar.
        Returns:
        The ActionBar's height
      • show

        public abstract void show()
        Show the ActionBar if it is not currently showing. If the window hosting the ActionBar does not have the feature Window.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.

      • hide

        public abstract void hide()
        Hide the ActionBar if it is currently showing. If the window hosting the ActionBar does not have the feature Window.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.

      • isShowing

        public abstract boolean isShowing()
        Returns:
        true if the ActionBar is showing, false otherwise.
      • addOnMenuVisibilityListener

        public abstract void addOnMenuVisibilityListener(ActionBar.OnMenuVisibilityListener listener)
        Add a listener that will respond to menu visibility change events.
        Parameters:
        listener - The new listener to add
      • removeOnMenuVisibilityListener

        public abstract void removeOnMenuVisibilityListener(ActionBar.OnMenuVisibilityListener listener)
        Remove a menu visibility listener. This listener will no longer receive menu visibility change events.
        Parameters:
        listener - A listener to remove that was previously added
      • setHomeButtonEnabled

        public void setHomeButtonEnabled(boolean enabled)
        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 systemwide home button.)

        This defaults to true for packages targeting < API 14. For packages targeting API 14 or greater, the application should call this method to enable interaction with the home/up affordance.

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

        Parameters:
        enabled - true to enable the home button, false to disable the home button.
      • getThemedContext

        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:
        A themed Context for creating views


Content

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.
All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.
Copyright 2016 © ELTASK.COM. All rights reserved.
Site is optimized for mobile devices.
Downloads: 2447 / 96488246. Delta: 0.47280 с