com.actionbarsherlock.app

Class ActionBar.Tab

java.lang.Object

com.actionbarsherlock.app.ActionBar.Tab

Direct Known Subclasses:

ActionBarImpl.TabImpl, ActionBarWrapper.TabWrapper

Enclosing class:

ActionBar

public abstract static class ActionBar.Tab
extends java.lang.Object

A tab in the action bar.

Tabs manage the hiding and showing of Fragments.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_POSITION An invalid position for a tab.

Constructor Summary

Constructors

Constructor and Description
ActionBar.Tab()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.CharSequence	getContentDescription() Gets a brief description of this tab's content for use in accessibility support.
abstract android.view.View	getCustomView() Retrieve a previously set custom view for this tab.
abstract android.graphics.drawable.Drawable	getIcon() Return the icon associated with this tab.
abstract int	getPosition() Return the current position of this tab in the action bar.
abstract java.lang.Object	getTag()
abstract java.lang.CharSequence	getText() Return the text of this tab.
abstract void	select() Select this tab.
abstract ActionBar.Tab	setContentDescription(java.lang.CharSequence contentDesc) Set a description of this tab's content for use in accessibility support.
abstract ActionBar.Tab	setContentDescription(int resId) 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(android.view.View view) Set a custom view to be used for this tab.
abstract ActionBar.Tab	setIcon(android.graphics.drawable.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(java.lang.Object obj) Give this Tab an arbitrary object to hold for later use.
abstract ActionBar.Tab	setText(java.lang.CharSequence text) Set the text displayed on this tab.
abstract ActionBar.Tab	setText(int resId) Set the text displayed on this tab.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INVALID_POSITION

public static final int INVALID_POSITION

An invalid position for a tab.

See Also:

getPosition(), Constant Field Values

Constructor Detail

ActionBar.Tab

public ActionBar.Tab()

Method Detail

getPosition

public abstract int getPosition()

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.

getIcon

public abstract android.graphics.drawable.Drawable getIcon()

Return the icon associated with this tab.

Returns:

The tab's icon

getText

public abstract java.lang.CharSequence getText()

Return the text of this tab.

Returns:

The tab's text

setIcon

public abstract ActionBar.Tab setIcon(android.graphics.drawable.Drawable icon)

Set the icon displayed on this tab.

Parameters:

icon - The drawable to use as an icon

Returns:

The current instance for call chaining

setIcon

public abstract ActionBar.Tab setIcon(int resId)

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

setText

public abstract ActionBar.Tab setText(java.lang.CharSequence text)

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

setText

public abstract ActionBar.Tab setText(int resId)

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

setCustomView

public abstract ActionBar.Tab setCustomView(android.view.View view)

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

setCustomView

public abstract ActionBar.Tab setCustomView(int layoutResId)

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

getCustomView

public abstract android.view.View getCustomView()

Retrieve a previously set custom view for this tab.

Returns:

The custom view set by setCustomView(View).

setTag

public abstract ActionBar.Tab setTag(java.lang.Object obj)

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

Parameters:

obj - Object to store

Returns:

The current instance for call chaining

getTag

public abstract java.lang.Object getTag()

Returns:

This Tab's tag object.

setTabListener

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

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

select

public abstract void select()

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

setContentDescription

public abstract ActionBar.Tab setContentDescription(int resId)

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

See Also:

setContentDescription(CharSequence), getContentDescription()

setContentDescription

public abstract ActionBar.Tab setContentDescription(java.lang.CharSequence contentDesc)

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

See Also:

setContentDescription(int), getContentDescription()

getContentDescription

public abstract java.lang.CharSequence getContentDescription()

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

Returns:

Description of this tab's content

See Also:

setContentDescription(CharSequence), setContentDescription(int)