to top
Android APIs
public static abstract class

ActionBar.Tab

extends Object
java.lang.Object
   ↳ android.app.ActionBar.Tab

Class Overview

A tab in the action bar.

Tabs manage the hiding and showing of Fragments.

Summary

Constants
int INVALID_POSITION An invalid position for a tab.
Public Constructors
ActionBar.Tab()
Public Methods
abstract CharSequence getContentDescription()
Gets a brief description of this tab's content for use in accessibility support.
abstract View getCustomView()
Retrieve a previously set custom view for this tab.
abstract Drawable getIcon()
Return the icon associated with this tab.
abstract int getPosition()
Return the current position of this tab in the action bar.
abstract Object getTag()
abstract CharSequence getText()
Return the text of this tab.
abstract void select()
Select this tab.
abstract ActionBar.Tab setContentDescription(int resId)
Set a description of this tab's content for use in accessibility support.
abstract ActionBar.Tab setContentDescription(CharSequence contentDesc)
Set a description of this tab's content for use in accessibility support.
abstract ActionBar.Tab setCustomView(int layoutResId)
Set a custom view to be used for this tab.
abstract ActionBar.Tab setCustomView(View view)
Set a custom view to be used for this tab.
abstract ActionBar.Tab setIcon(Drawable icon)
Set the icon displayed on this tab.
abstract ActionBar.Tab setIcon(int resId)
Set the icon displayed on this tab.
abstract ActionBar.Tab setTabListener(ActionBar.TabListener listener)
Set the ActionBar.TabListener that will handle switching to and from this tab.
abstract ActionBar.Tab setTag(Object obj)
Give this Tab an arbitrary object to hold for later use.
abstract ActionBar.Tab setText(int resId)
Set the text displayed on this tab.
abstract ActionBar.Tab setText(CharSequence text)
Set the text displayed on this tab.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int INVALID_POSITION

Added in API level 11

An invalid position for a tab.

See Also
Constant Value: -1 (0xffffffff)

Public Constructors

public ActionBar.Tab ()

Added in API level 11

Public Methods

public abstract CharSequence getContentDescription ()

Added in API level 14

Gets a brief description of this tab's content for use in accessibility support.

Returns
  • Description of this tab's content

public abstract View getCustomView ()

Added in API level 11

Retrieve a previously set custom view for this tab.

Returns

public abstract Drawable getIcon ()

Added in API level 11

Return the icon associated with this tab.

Returns
  • The tab's icon

public abstract int getPosition ()

Added in API level 11

Return the current position of this tab in the action bar.

Returns
  • Current position, or INVALID_POSITION if this tab is not currently in the action bar.

public abstract Object getTag ()

Added in API level 11

Returns
  • This Tab's tag object.

public abstract CharSequence getText ()

Added in API level 11

Return the text of this tab.

Returns
  • The tab's text

public abstract void select ()

Added in API level 11

Select this tab. Only valid if the tab has been added to the action bar.

public abstract ActionBar.Tab setContentDescription (int resId)

Added in API level 14

Set a description of this tab's content for use in accessibility support. If no content description is provided the title will be used.

Parameters
resId A resource ID referring to the description text
Returns
  • The current instance for call chaining

public abstract ActionBar.Tab setContentDescription (CharSequence contentDesc)

Added in API level 14

Set a description of this tab's content for use in accessibility support. If no content description is provided the title will be used.

Parameters
contentDesc Description of this tab's content
Returns
  • The current instance for call chaining

public abstract ActionBar.Tab setCustomView (int layoutResId)

Added in API level 11

Set a custom view to be used for this tab. This overrides values set by setText(CharSequence) and setIcon(Drawable).

Parameters
layoutResId A layout resource to inflate and use as a custom tab view
Returns
  • The current instance for call chaining

public abstract ActionBar.Tab setCustomView (View view)

Added in API level 11

Set a custom view to be used for this tab. This overrides values set by setText(CharSequence) and setIcon(Drawable).

Parameters
view Custom view to be used as a tab.
Returns
  • The current instance for call chaining

public abstract ActionBar.Tab setIcon (Drawable icon)

Added in API level 11

Set the icon displayed on this tab.

Parameters
icon The drawable to use as an icon
Returns
  • The current instance for call chaining

public abstract ActionBar.Tab setIcon (int resId)

Added in API level 11

Set the icon displayed on this tab.

Parameters
resId Resource ID referring to the drawable to use as an icon
Returns
  • The current instance for call chaining

public abstract ActionBar.Tab setTabListener (ActionBar.TabListener listener)

Added in API level 11

Set the ActionBar.TabListener that will handle switching to and from this tab. All tabs must have a TabListener set before being added to the ActionBar.

Parameters
listener Listener to handle tab selection events
Returns
  • The current instance for call chaining

public abstract ActionBar.Tab setTag (Object obj)

Added in API level 11

Give this Tab an arbitrary object to hold for later use.

Parameters
obj Object to store
Returns
  • The current instance for call chaining

public abstract ActionBar.Tab setText (int resId)

Added in API level 11

Set the text displayed on this tab. Text may be truncated if there is not room to display the entire string.

Parameters
resId A resource ID referring to the text that should be displayed
Returns
  • The current instance for call chaining

public abstract ActionBar.Tab setText (CharSequence text)

Added in API level 11

Set the text displayed on this tab. Text may be truncated if there is not room to display the entire string.

Parameters
text The text to display
Returns
  • The current instance for call chaining