Package icyllis.modernui.widget

Class TabLayout.Tab

java.lang.Object

icyllis.modernui.widget.TabLayout.Tab

Enclosing class:

TabLayout

public static final class TabLayout.Tab
extends Object

A tab in this layout. Instances can be created via TabLayout.newTab().

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
CharSequence	getContentDescription()	Gets a brief description of this tab's content for use in accessibility support.
View	getCustomView()	Returns the custom view used for this tab.
Drawable	getIcon()	Return the icon associated with this tab.
int	getId()	Returns the id for this tab, View.NO_ID if not set.
int	getPosition()	Return the current position of this tab in the tab layout.
int	getTabLabelVisibility()	Gets the visibility mode for the Labels in this Tab.
Object	getTag()
CharSequence	getText()	Return the text of this tab.
boolean	isSelected()	Returns true if this tab is currently selected.
void	select()	Select this tab.
TabLayout.Tab	setContentDescription(CharSequence contentDesc)	Set a description of this tab's content for use in accessibility support.
TabLayout.Tab	setCustomView(View view)	Set a custom view to be used for this tab.
TabLayout.Tab	setIcon(Drawable icon)	Set the icon displayed on this tab.
TabLayout.Tab	setId(int id)	Give this tab an id, useful for testing.
TabLayout.Tab	setTabLabelVisibility(int mode)	Sets the visibility mode for the Labels in this Tab.
TabLayout.Tab	setTag(Object tag)	Give this Tab an arbitrary object to hold for later use.
TabLayout.Tab	setText(CharSequence text)	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 Details

INVALID_POSITION

public static final int INVALID_POSITION

An invalid position for a tab.

See Also:

• getPosition()
• Constant Field Values

Method Details

getTag

@Nullable
public Object getTag()

Returns:

This Tab's tag object.

setTag

@NonNull
public TabLayout.Tab setTag(@Nullable
 Object tag)

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

Parameters:

tag - Object to store

Returns:

The current instance for call chaining

setId

@NonNull
public TabLayout.Tab setId(int id)

Give this tab an id, useful for testing.

Do not rely on this if using TabLayout.setupWithViewPager(ViewPager)

Parameters:

id - unique id for this tab

getId

public int getId()

Returns the id for this tab, View.NO_ID if not set.

getCustomView

@Nullable
public View getCustomView()

Returns the custom view used for this tab.

See Also:

• setCustomView(View)

setCustomView

@NonNull
public TabLayout.Tab setCustomView(@Nullable
 View view)

Set a custom view to be used for this tab.

If the provided view contains a TextView with an ID of R.id.text1 then that will be updated with the value given to setText(CharSequence). Similarly, if this layout contains an ImageView with ID R.id.icon then it will be updated with the value given to setIcon(Drawable).

Parameters:

view - Custom view to be used as a tab.

Returns:

The current instance for call chaining

getIcon

@Nullable
public Drawable getIcon()

Return the icon associated with this tab.

Returns:

The tab's icon

getPosition

public int getPosition()

Return the current position of this tab in the tab layout.

Returns:

Current position, or INVALID_POSITION if this tab is not currently in the tab layout.

getText

@Nullable
public CharSequence getText()

Return the text of this tab.

Returns:

The tab's text

setIcon

@NonNull
public TabLayout.Tab setIcon(@Nullable
 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

setText

@NonNull
public TabLayout.Tab setText(@Nullable
 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

setTabLabelVisibility

@NonNull
public TabLayout.Tab setTabLabelVisibility(int mode)

Sets the visibility mode for the Labels in this Tab. The valid input options are:

• TabLayout.TAB_LABEL_VISIBILITY_UNLABELED: Tabs will appear without labels regardless of whether text is set.
• TabLayout.TAB_LABEL_VISIBILITY_LABELED: Tabs will appear labeled if text is set.

Parameters:

mode - one of TabLayout.TAB_LABEL_VISIBILITY_UNLABELED or TabLayout.TAB_LABEL_VISIBILITY_LABELED.

Returns:

The current instance for call chaining.

getTabLabelVisibility

public int getTabLabelVisibility()

Gets the visibility mode for the Labels in this Tab.

Returns:

the label visibility mode, one of TabLayout.TAB_LABEL_VISIBILITY_UNLABELED or TabLayout.TAB_LABEL_VISIBILITY_LABELED.

See Also:

• setTabLabelVisibility(int)

select

public void select()

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

isSelected

public boolean isSelected()

Returns true if this tab is currently selected.

setContentDescription

@NonNull
public TabLayout.Tab setContentDescription(@Nullable
 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:

• getContentDescription()

getContentDescription

@Nullable
public 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)