ActionBar.Tab

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

abstract class ActionBar.Tab

A tab in the action bar.

Tabs manage the hiding and showing of Fragments.

Summary

Constants
`const Int`	`INVALID_POSITION = -1` An invalid position for a tab.

Public constructors
`Tab()`

Public functions
`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 Any!`	`getTag()`
`abstract CharSequence!`	`getText()` Return the text of this tab.
`abstract Unit`	`select()` Select this tab.
`abstract ActionBar.Tab!`	`setContentDescription(contentDesc: CharSequence!)` Set a description of this tab's content for use in accessibility support.
`abstract ActionBar.Tab!`	`setContentDescription(resId: @StringRes Int)` Set a description of this tab's content for use in accessibility support.
`abstract ActionBar.Tab!`	`setCustomView(layoutResId: Int)` 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(icon: Drawable!)` Set the icon displayed on this tab.
`abstract ActionBar.Tab!`	`setIcon(resId: @DrawableRes Int)` Set the icon displayed on this tab.
`abstract ActionBar.Tab!`	`setTabListener(listener: ActionBar.TabListener!)` Set the `TabListener` that will handle switching to and from this tab.
`abstract ActionBar.Tab!`	`setTag(obj: Any!)` Give this Tab an arbitrary object to hold for later use.
`abstract ActionBar.Tab!`	`setText(resId: Int)` Set the text displayed on this tab.
`abstract ActionBar.Tab!`	`setText(text: CharSequence!)` Set the text displayed on this tab.

Constants

INVALID_POSITION

Added in 1.1.0

Deprecated in 1.1.0

const val INVALID_POSITION = -1: Int

An invalid position for a tab.

See also
`getPosition`

Public constructors

Tab

Added in 1.1.0

Deprecated in 1.1.0

Tab()

Public functions

getContentDescription

Added in 1.1.0

Deprecated in 1.1.0

abstract fun getContentDescription(): CharSequence!

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

Returns
`CharSequence!`	Description of this tab's content

See also
`setContentDescription`
`setContentDescription`

getCustomView

Added in 1.1.0

Deprecated in 1.1.0

abstract fun getCustomView(): View!

Retrieve a previously set custom view for this tab.

Returns
`View!`	The custom view set by `setCustomView`.

getIcon

Added in 1.1.0

Deprecated in 1.1.0

abstract fun getIcon(): Drawable!

Return the icon associated with this tab.

Returns
`Drawable!`	The tab's icon

getPosition

Added in 1.1.0

Deprecated in 1.1.0

abstract fun getPosition(): Int

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

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

getTag

Added in 1.1.0

Deprecated in 1.1.0

abstract fun getTag(): Any!

Returns
`Any!`	This Tab's tag object.

getText

Added in 1.1.0

Deprecated in 1.1.0

abstract fun getText(): CharSequence!

Return the text of this tab.

Returns
`CharSequence!`	The tab's text

select

Added in 1.1.0

Deprecated in 1.1.0

abstract fun select(): Unit

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

setContentDescription

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setContentDescription(contentDesc: CharSequence!): ActionBar.Tab!

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: CharSequence!`	Description of this tab's content

Returns
`ActionBar.Tab!`	The current instance for call chaining

See also
`setContentDescription`
`getContentDescription`

setContentDescription

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setContentDescription(resId: @StringRes Int): ActionBar.Tab!

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: @StringRes Int`	A resource ID referring to the description text

Returns
`ActionBar.Tab!`	The current instance for call chaining

See also
`setContentDescription`
`getContentDescription`

setCustomView

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setCustomView(layoutResId: Int): ActionBar.Tab!

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

Parameters
`layoutResId: Int`	A layout resource to inflate and use as a custom tab view

Returns
`ActionBar.Tab!`	The current instance for call chaining

setCustomView

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setCustomView(view: View!): ActionBar.Tab!

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

Parameters
`view: View!`	Custom view to be used as a tab.

Returns
`ActionBar.Tab!`	The current instance for call chaining

setIcon

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setIcon(icon: Drawable!): ActionBar.Tab!

Set the icon displayed on this tab.

Parameters
`icon: Drawable!`	The drawable to use as an icon

Returns
`ActionBar.Tab!`	The current instance for call chaining

setIcon

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setIcon(resId: @DrawableRes Int): ActionBar.Tab!

Set the icon displayed on this tab.

Parameters
`resId: @DrawableRes Int`	Resource ID referring to the drawable to use as an icon

Returns
`ActionBar.Tab!`	The current instance for call chaining

setTabListener

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setTabListener(listener: ActionBar.TabListener!): ActionBar.Tab!

Set the 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: ActionBar.TabListener!`	Listener to handle tab selection events

Returns
`ActionBar.Tab!`	The current instance for call chaining

setTag

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setTag(obj: Any!): ActionBar.Tab!

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

Parameters
`obj: Any!`	Object to store

Returns
`ActionBar.Tab!`	The current instance for call chaining

setText

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setText(resId: Int): ActionBar.Tab!

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

Parameters
`resId: Int`	A resource ID referring to the text that should be displayed

Returns
`ActionBar.Tab!`	The current instance for call chaining

setText

Added in 1.1.0

Deprecated in 1.1.0

abstract fun setText(text: CharSequence!): ActionBar.Tab!

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

Parameters
`text: CharSequence!`	The text to display

Returns
`ActionBar.Tab!`	The current instance for call chaining