de.mrapp.android.tabswitcher.model

Class TabSwitcherModel

java.lang.Object

de.mrapp.android.tabswitcher.model.TabSwitcherModel

All Implemented Interfaces:

Model, Restorable, java.lang.Iterable<Tab>

public class TabSwitcherModel
extends java.lang.Object
implements Model, Restorable

The model of a TabSwitcher.

Since:

0.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface de.mrapp.android.tabswitcher.model.Model

Model.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REFERENCE_TAB_INDEX_EXTRA The name of the extra, which is used to store the index of the tab, which is used as a reference, when restoring the positions of tabs, within a bundle.
static java.lang.String	REFERENCE_TAB_POSITION_EXTRA The name of the extra, which is used to store the position of the tab, which is used as a reference, when restoring the positions of tabs, within a bundle.

Constructor Summary

Constructors

Constructor and Description
TabSwitcherModel(TabSwitcher tabSwitcher) Creates a new model of a TabSwitcher.

Method Summary

Modifier and Type	Method and Description
void	addAllTabs(java.util.Collection<? extends Tab> tabs) Adds all tabs, which are contained by a collection, to the tab switcher.
void	addAllTabs(java.util.Collection<? extends Tab> tabs, int index) Adds all tabs, which are contained by a collection, to the tab switcher, starting at a specific index.
void	addAllTabs(java.util.Collection<? extends Tab> tabs, int index, Animation animation) Adds all tabs, which are contained by a collection, to the tab switcher, starting at a specific index.
void	addAllTabs(Tab[] tabs) Adds all tabs, which are contained by an array, to the tab switcher.
void	addAllTabs(Tab[] tabs, int index) Adds all tabs, which are contained by an array, to the tab switcher, starting at a specific index.
void	addAllTabs(Tab[] tabs, int index, Animation animation) Adds all tabs, which are contained by an array, to the tab switcher, starting at a specific index.
void	addCloseTabListener(TabCloseListener listener) Adds a new listener, which should be notified, when a tab is about to be closed by clicking its close button.
void	addListener(Model.Listener listener) Adds a new listener, which should be notified about the model's events.
void	addTab(Tab tab) Adds a new tab to the tab switcher.
void	addTab(Tab tab, int index) Adds a new tab to the tab switcher at a specific index.
void	addTab(Tab tab, int index, Animation animation) Adds a new tab to the tab switcher at a specific index.
void	addTabPreviewListener(TabPreviewListener listener) Adds a new listener, which should be notified, when the preview of a tab is about to be loaded.
boolean	areToolbarsShown() Returns, whether the toolbars are shown, when the tab switcher is shown, or not.
void	clear() Removes all tabs from the tab switcher.
void	clear(Animation animation) Removes all tabs from the tab switcher.
android.content.res.ColorStateList	getAddTabButtonColor() Returns the color of the button, which allows to add a new tab.
AddTabButtonListener	getAddTabButtonListener() Returns the listener, which is notified, when the button, which allows to add a new tab, has been clicked.
ContentRecyclerAdapter	getContentRecyclerAdapter() Returns the adapter, which allows to inflate the views, which are associated with tabs.
android.content.Context	getContext() Returns the context, which is used by the tab switcher.
int	getCount() Returns the number of tabs, which are contained by the tab switcher.
TabSwitcherDecorator	getDecorator() Returns the decorator, which allows to inflate the views, which correspond to the tabs of the tab switcher.
android.view.View	getEmptyView() Returns the view, which is shown, when the tab switcher is empty.
long	getEmptyViewAnimationDuration() Returns the duration of the fade animation, which should be used to show or hide the view, which is shown, when the tab switcher is empty.
LogLevel	getLogLevel() Returns the log level, which is used for logging.
int	getPaddingBottom() Returns the bottom padding of the tab switcher.
int	getPaddingEnd() Returns the end padding of the tab switcher.
int	getPaddingLeft() Returns the left padding of the tab switcher.
int	getPaddingRight() Returns the right padding of the tab switcher.
int	getPaddingStart() Returns the start padding of the tab switcher.
int	getPaddingTop() Returns the top padding of the tab switcher.
int	getReferenceTabIndex() Returns the index of the tab, which is used as a reference, when restoring the positions of tabs.
float	getReferenceTabPosition() Returns the position of the tab, which is used as a reference, when restoring the positions of tabs.
Tab	getSelectedTab() Returns the currently selected tab.
int	getSelectedTabIndex() Returns the index of the currently selected tab.
Tab	getTab(int index) Returns the tab at a specific index.
android.content.res.ColorStateList	getTabBackgroundColor() Returns the default background color of a tab.
android.graphics.drawable.Drawable	getTabCloseButtonIcon() Returns the default icon of a tab's close button.
java.util.Set<TabCloseListener>	getTabCloseListeners() Returns the listeners, which should be notified, when a tab is about to be closed by clicking its close button.
int	getTabContentBackgroundColor() Returns the default background color of a tab's content.
android.graphics.drawable.Drawable	getTabIcon() Returns the default icon of a tab.
java.util.Set<TabPreviewListener>	getTabPreviewListeners() Returns the listeners, which should be notified, when the previews of tabs are about to be loaded.
int	getTabProgressBarColor() Returns the color of a tab's progress bar.
android.content.res.ColorStateList	getTabTitleTextColor() Returns the default text color of a tab's title.
int	getToolbarMenuId() Returns the resource id of the menu of the toolbar, which is shown, when the tab switcher is shown.
OnMenuItemClickListener	getToolbarMenuItemListener() Returns the listener, which is notified, when an item of the menu of the toolbar, which is shown, when the tab switcher is shown, has been clicked.
android.graphics.drawable.Drawable	getToolbarNavigationIcon() Returns the navigation icon of the toolbar, which is shown, when the tab switcher is shown.
android.view.View.OnClickListener	getToolbarNavigationIconListener() Returns the listener, which is notified, when the navigation icon of the toolbar, which is shown, when the tab switcher is shown, has been clicked.
java.lang.CharSequence	getToolbarTitle() Returns the title of the toolbar, which is shown, when the tab switcher is shown.
void	hideSwitcher() Hides the tab switcher by using an animation, if it is currently shown.
int	indexOf(Tab tab) Returns the index of a specific tab.
void	inflateToolbarMenu(int resourceId, OnMenuItemClickListener listener) Inflates the menu of the toolbar, which is shown, when the tab switcher is shown.
boolean	isAddTabButtonShown() Returns, whether a button, which allows to add a new tab, is shown.
boolean	isEmpty() Returns, whether the tab switcher is empty, or not.
boolean	isSwitcherShown() Returns, whether the tab switcher is currently shown.
java.util.Iterator<Tab>	iterator()
void	removeCloseTabListener(TabCloseListener listener) Removes a specific listener, which should not be notified, when a tab is about to be closed by clicking its close button, anymore.
void	removeListener(Model.Listener listener) Removes a specific listener, which should not be notified about the model's events, anymore.
void	removeTab(Tab tab) Removes a specific tab from the tab switcher.
void	removeTab(Tab tab, Animation animation) Removes a specific tab from the tab switcher.
void	removeTabPreviewListener(TabPreviewListener listener) Removes a specific listener, which should not be notified, when the preview of a tab is about to be loaded.
void	restoreInstanceState(android.os.Bundle savedInstanceState) Restores a previously saved state.
void	saveInstanceState(android.os.Bundle outState) Saves the current state.
void	selectTab(int index) Selects the tab as a specific index.
void	selectTab(Tab tab) Selects a specific tab.
void	setAddTabButtonColor(android.content.res.ColorStateList colorStateList) Sets the color of the button, which allows to add a new tab.
void	setAddTabButtonColor(int color) Sets the color of the button, which allows to add a new tab.
void	setDecorator(TabSwitcherDecorator decorator) Sets the decorator, which allows to inflate the views, which correspond to the tabs of the tab switcher.
void	setEmptyView(int resourceId) Sets the view, which should be shown, when the tab switcher is empty.
void	setEmptyView(int resourceId, long animationDuration) Sets the view, which should be shown, when the tab switcher is empty.
void	setEmptyView(android.view.View view) Sets the view, which should be shown, when the tab switcher is empty.
void	setEmptyView(android.view.View view, long animationDuration) Sets the view, which should be shown, when the tab switcher is empty.
void	setLogLevel(LogLevel logLevel) Sets the log level, which should be used for logging.
void	setPadding(int left, int top, int right, int bottom) Sets the padding of the tab switcher.
void	setReferenceTabIndex(int referenceTabIndex) Sets the index of the tab, which should be used as a reference, when restoring the positions of tabs.
void	setReferenceTabPosition(float referenceTabPosition) Sets the position of the tab, which should be used as a reference, when restoring the positions of tabs.
void	setTabBackgroundColor(android.content.res.ColorStateList colorStateList) Sets the default background color of a tab.
void	setTabBackgroundColor(int color) Sets the default background color of a tab.
void	setTabCloseButtonIcon(android.graphics.Bitmap icon) Sets the default icon of a tab's close button.
void	setTabCloseButtonIcon(int resourceId) Sets the default icon of a tab's close button.
void	setTabContentBackgroundColor(int color) Sets the default background color of a tab's content.
void	setTabIcon(android.graphics.Bitmap icon) Sets the default icon of a tab.
void	setTabIcon(int resourceId) Sets the default icon of a tab.
void	setTabProgressBarColor(int color) Sets the color of a tab's progress bar.
void	setTabTitleTextColor(android.content.res.ColorStateList colorStateList) Sets the default text color of a tab's title.
void	setTabTitleTextColor(int color) Sets the default text color of a tab's title.
void	setToolbarNavigationIcon(android.graphics.drawable.Drawable icon, android.view.View.OnClickListener listener) Sets the navigation icon of the toolbar, which is shown, when the tab switcher is shown.
void	setToolbarNavigationIcon(int resourceId, android.view.View.OnClickListener listener) Sets the navigation icon of the toolbar, which is shown, when the tab switcher is shown.
void	setToolbarTitle(java.lang.CharSequence title) Sets the title of the toolbar, which is shown, when the tab switcher is shown.
void	setToolbarTitle(int resourceId) Sets the title of the toolbar, which is shown, when the tab switcher is shown.
void	showAddTabButton(AddTabButtonListener listener) Sets, whether a button, which allows to add a new tab, should be shown.
void	showSwitcher() Shows the tab switcher by using an animation, if it is not already shown.
void	showToolbars(boolean show) Sets, whether the toolbars should be shown, when the tab switcher is shown, or not.
void	toggleSwitcherVisibility() Toggles the visibility of the tab switcher by using an animation, i.e.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

REFERENCE_TAB_INDEX_EXTRA

public static final java.lang.String REFERENCE_TAB_INDEX_EXTRA

The name of the extra, which is used to store the index of the tab, which is used as a reference, when restoring the positions of tabs, within a bundle.

REFERENCE_TAB_POSITION_EXTRA

public static final java.lang.String REFERENCE_TAB_POSITION_EXTRA

The name of the extra, which is used to store the position of the tab, which is used as a reference, when restoring the positions of tabs, within a bundle.

Constructor Detail

TabSwitcherModel

public TabSwitcherModel(TabSwitcher tabSwitcher)

Creates a new model of a TabSwitcher.

Parameters:

tabSwitcher - The tab switcher, the model belongs to, as an instance of the class ViewGroup. The parent may not be null

Method Detail

addListener

public final void addListener(Model.Listener listener)

Adds a new listener, which should be notified about the model's events.

Parameters:

listener - The listener, which should be added, as an instance of the type Listener. The listener may not be null

removeListener

public final void removeListener(Model.Listener listener)

Removes a specific listener, which should not be notified about the model's events, anymore.

Parameters:

listener - The listener, which should be removed, as an instance of the type Listener. The listener may not be null

getReferenceTabIndex

public final int getReferenceTabIndex()

Returns the index of the tab, which is used as a reference, when restoring the positions of tabs.

Returns:

The index of the tab, which is used as a reference, when restoring the positions of tabs, as an Integer value or -1, if the positions of tabs should not be restored

setReferenceTabIndex

public final void setReferenceTabIndex(int referenceTabIndex)

Sets the index of the tab, which should be used as a reference, when restoring the positions of tabs.

Parameters:

referenceTabIndex - The index, which should be set, as an Integer value or -1, if the positions of tabs should not be restored

getReferenceTabPosition

public final float getReferenceTabPosition()

Returns the position of the tab, which is used as a reference, when restoring the positions of tabs.

Returns:

The position of the tab, which is used as a reference, when restoring the positions of tabs, in relation to the available space as a Float value or -1, if the positions of tabs should not be restored

setReferenceTabPosition

public final void setReferenceTabPosition(float referenceTabPosition)

Sets the position of the tab, which should be used as a reference, when restoring the positions of tabs.

Parameters:

referenceTabPosition - The position, which should be set, in relation to the available space as a Float value or -1, if the position of tabs should not be restored

getAddTabButtonListener

public final AddTabButtonListener getAddTabButtonListener()

Returns the listener, which is notified, when the button, which allows to add a new tab, has been clicked.

Returns:

The listener, which is notified, when the button, which allows to add a new tab, has been clicked, as an instance of the type AddTabButtonListener or null, if the button is not shown

getToolbarNavigationIconListener

public final android.view.View.OnClickListener getToolbarNavigationIconListener()

Returns the listener, which is notified, when the navigation icon of the toolbar, which is shown, when the tab switcher is shown, has been clicked.

Returns:

The listener, which is notified, when the navigation icon of the toolbar, which is shown, when the tab switcher is shown, has been clicked as an instance of the type View.OnClickListener or null, if no listener should be notified

getToolbarMenuId

public final int getToolbarMenuId()

Returns the resource id of the menu of the toolbar, which is shown, when the tab switcher is shown.

Returns:

The resource id of the menu of the toolbar, which is shown, when the tab switcher is shown, as an Integer value. The resource id must correspond to a valid menu resource

getToolbarMenuItemListener

public final OnMenuItemClickListener getToolbarMenuItemListener()

Returns the listener, which is notified, when an item of the menu of the toolbar, which is shown, when the tab switcher is shown, has been clicked.

Returns:

The listener, which is notified, when an item of the menu of the toolbar, which is shown, when the tab switcher is shown, has been clicked as an instance of the type OnMenuItemClickListener or null, if no listener should be notified

getEmptyViewAnimationDuration

public final long getEmptyViewAnimationDuration()

Returns the duration of the fade animation, which should be used to show or hide the view, which is shown, when the tab switcher is empty.

Returns:

The duration of the fade animation, which should be used to show or hide the view, which is shown, when the tab switcher is empty, in milliseconds as a Long value

getTabCloseListeners

public final java.util.Set<TabCloseListener> getTabCloseListeners()

Returns the listeners, which should be notified, when a tab is about to be closed by clicking its close button.

Returns:

A set, which contains the listeners, which should be notified, when a tab is about to be closed by clicking its close button, as an instance of the type Set or an empty set, if no listeners should be notified

getTabPreviewListeners

public final java.util.Set<TabPreviewListener> getTabPreviewListeners()

Returns the listeners, which should be notified, when the previews of tabs are about to be loaded.

Returns:

A set, which contains the listeners, which should be notified, when the previews of tabs are about to be loaded, as an instance of the type Set or an empty set, if no listeners should be notified

getContentRecyclerAdapter

public final ContentRecyclerAdapter getContentRecyclerAdapter()

Returns the adapter, which allows to inflate the views, which are associated with tabs.

Returns:

The adapter, which allows to inflate the views, which are associated with tabs, as an instance of the class ContentRecyclerAdapter

getContext

public final android.content.Context getContext()

Description copied from interface: Model

Returns the context, which is used by the tab switcher.

Specified by:

getContext in interface Model

Returns:

The context, which is used by the tab switcher, as an instance of the class Context. The context may not be null

setDecorator

public final void setDecorator(TabSwitcherDecorator decorator)

Description copied from interface: Model

Sets the decorator, which allows to inflate the views, which correspond to the tabs of the tab switcher.

Specified by:

setDecorator in interface Model

Parameters:

decorator - The decorator, which should be set, as an instance of the class TabSwitcherDecorator. The decorator may not be null

getDecorator

public final TabSwitcherDecorator getDecorator()

Description copied from interface: Model

Returns the decorator, which allows to inflate the views, which correspond to the tabs of the tab switcher.

Specified by:

getDecorator in interface Model

Returns:

The decorator as an instance of the class TabSwitcherDecorator or null, if no decorator has been set

getLogLevel

public final LogLevel getLogLevel()

Description copied from interface: Model

Returns the log level, which is used for logging.

Specified by:

getLogLevel in interface Model

Returns:

The log level, which is used for logging, as a value of the enum LogLevel. The log level may not be null

setLogLevel

public final void setLogLevel(LogLevel logLevel)

Description copied from interface: Model

Sets the log level, which should be used for logging.

Specified by:

setLogLevel in interface Model

Parameters:

logLevel - The log level, which should be set, as a value of the enum LogLevel. The log level may not be null

isEmpty

public final boolean isEmpty()

Description copied from interface: Model

Returns, whether the tab switcher is empty, or not.

Specified by:

isEmpty in interface Model

Returns:

True, if the tab switcher is empty, false otherwise

getCount

public final int getCount()

Description copied from interface: Model

Returns the number of tabs, which are contained by the tab switcher.

Specified by:

getCount in interface Model

Returns:

The number of tabs, which are contained by the tab switcher, as an Integer value

getTab

public final Tab getTab(int index)

Description copied from interface: Model

Returns the tab at a specific index.

Specified by:

getTab in interface Model

Parameters:

index - The index of the tab, which should be returned, as an Integer value. The index must be at least 0 and at maximum getCount() - 1, otherwise a IndexOutOfBoundsException will be thrown

Returns:

The tab, which corresponds to the given index, as an instance of the class Tab. The tab may not be null

indexOf

public final int indexOf(Tab tab)

Description copied from interface: Model

Returns the index of a specific tab.

Specified by:

indexOf in interface Model

Parameters:

tab - The tab, whose index should be returned, as an instance of the class Tab. The tab may not be null

Returns:

The index of the given tab as an Integer value or -1, if the given tab is not contained by the tab switcher

addTab

public final void addTab(Tab tab)

Description copied from interface: Model

Adds a new tab to the tab switcher. By default, the tab is added at the end. If the switcher is currently shown, the tab is added by using an animation. By default, a SwipeAnimation with direction SwipeAnimation.SwipeDirection.RIGHT_OR_BOTTOM is used. If an animation is currently running, the tab will be added once all previously started animations have been finished.

Specified by:

addTab in interface Model

Parameters:

tab - The tab, which should be added, as an instance of the class Tab. The tab may not be null

addTab

public final void addTab(Tab tab,
                         int index)

Description copied from interface: Model

Adds a new tab to the tab switcher at a specific index. If the switcher is currently shown, the tab is added by using an animation. By default, a SwipeAnimation with direction SwipeAnimation.SwipeDirection.RIGHT_OR_BOTTOM is used. If an animation is currently running, the tab will be added once all previously started animations have been finished.

Specified by:

addTab in interface Model

Parameters:

tab - The tab, which should be added, as an instance of the class Tab. The tab may not be null

index - The index, the tab should be added at, as an Integer value. The index must be at least 0 and at maximum getCount(), otherwise an IndexOutOfBoundsException will be thrown

addTab

public final void addTab(Tab tab,
                         int index,
                         Animation animation)

Description copied from interface: Model

Adds a new tab to the tab switcher at a specific index. If the switcher is currently shown, the tab is added by using a specific animation. If an animation is currently running, the tab will be added once all previously started animations have been finished.

Specified by:

addTab in interface Model

Parameters:

tab - The tab, which should be added, as an instance of the class Tab. The tab may not be null

index - The index, the tab should be added at, as an Integer value. The index must be at least 0 and at maximum getCount(), otherwise an IndexOutOfBoundsException will be thrown

animation - The animation, which should be used to add the tab, as an instance of the class Animation. The animation may not be null

addAllTabs

public final void addAllTabs(java.util.Collection<? extends Tab> tabs)

Description copied from interface: Model

Adds all tabs, which are contained by a collection, to the tab switcher. By default, the tabs are added at the end. If the switcher is currently shown, the tabs are added by using an animation. By default, a SwipeAnimation with direction SwipeAnimation.SwipeDirection.RIGHT_OR_BOTTOM is used. If an animation is currently running, the tabs will be added once all previously started animations have been finished.

Specified by:

addAllTabs in interface Model

Parameters:

tabs - A collection, which contains the tabs, which should be added, as an instance of the type Collection or an empty collection, if no tabs should be added

addAllTabs

public final void addAllTabs(java.util.Collection<? extends Tab> tabs,
                             int index)

Description copied from interface: Model

Adds all tabs, which are contained by a collection, to the tab switcher, starting at a specific index. If the switcher is currently shown, the tabs are added by using an animation. By default, a SwipeAnimation with direction SwipeAnimation.SwipeDirection.RIGHT_OR_BOTTOM is used. If an animation is currently running, the tabs will be added once all previously started animations have been finished.

Specified by:

addAllTabs in interface Model

Parameters:

tabs - A collection, which contains the tabs, which should be added, as an instance of the type Collection or an empty collection, if no tabs should be added

index - The index, the first tab should be started at, as an Integer value. The index must be at least 0 and at maximum getCount(), otherwise an IndexOutOfBoundsException will be thrown

addAllTabs

public final void addAllTabs(java.util.Collection<? extends Tab> tabs,
                             int index,
                             Animation animation)

Description copied from interface: Model

Adds all tabs, which are contained by a collection, to the tab switcher, starting at a specific index. If the switcher is currently shown, the tabs are added by using a specific animation. If an animation is currently running, the tabs will be added once all previously started animations have been finished.

Specified by:

addAllTabs in interface Model

Parameters:

tabs - A collection, which contains the tabs, which should be added, as an instance of the type Collection or an empty collection, if no tabs should be added

index - The index, the first tab should be started at, as an Integer value. The index must be at least 0 and at maximum getCount(), otherwise an IndexOutOfBoundsException will be thrown

animation - The animation, which should be used to add the tabs, as an instance of the class Animation. The animation may not be null

addAllTabs

public final void addAllTabs(Tab[] tabs)

Description copied from interface: Model

Adds all tabs, which are contained by an array, to the tab switcher. By default, the tabs are added at the end. If the switcher is currently shown, the tabs are added by using an animation. By default, a SwipeAnimation with direction SwipeAnimation.SwipeDirection.RIGHT_OR_BOTTOM is used. If an animation is currently running, the tabs will be added once all previously started animations have been finished.

Specified by:

addAllTabs in interface Model

Parameters:

tabs - An array, which contains the tabs, which should be added, as an array of the type Tab or an empty array, if no tabs should be added

addAllTabs

public final void addAllTabs(Tab[] tabs,
                             int index)

Description copied from interface: Model

Adds all tabs, which are contained by an array, to the tab switcher, starting at a specific index. If the switcher is currently shown, the tabs are added by using an animation. By default, a SwipeAnimation with direction SwipeAnimation.SwipeDirection.RIGHT_OR_BOTTOM is used. If an animation is currently running, the tabs will be added once all previously started animations have been finished.

Specified by:

addAllTabs in interface Model

Parameters:

tabs - An array, which contains the tabs, which should be added, as an array of the type Tab or an empty array, if no tabs should be added

index - The index, the first tab should be started at, as an Integer value. The index must be at least 0 and at maximum getCount(), otherwise an IndexOutOfBoundsException will be thrown

addAllTabs

public final void addAllTabs(Tab[] tabs,
                             int index,
                             Animation animation)

Description copied from interface: Model

Adds all tabs, which are contained by an array, to the tab switcher, starting at a specific index. If the switcher is currently shown, the tabs are added by using a specific animation. If an animation is currently running, the tabs will be added once all previously started animations have been finished.

Specified by:

addAllTabs in interface Model

Parameters:

tabs - An array, which contains the tabs, which should be added, as an array of the type Tab or an empty array, if no tabs should be added

index - The index, the first tab should be started at, as an Integer value. The index must be at least 0 and at maximum getCount(), otherwise an IndexOutOfBoundsException will be thrown

animation - The animation, which should be used to add the tabs, as an instance of the class Animation. The animation may not be null

removeTab

public final void removeTab(Tab tab)

Description copied from interface: Model

Removes a specific tab from the tab switcher. If the switcher is currently shown, the tab is removed by using an animation. By default, a SwipeAnimation with direction SwipeAnimation.SwipeDirection.RIGHT_OR_BOTTOM is used. If an animation is currently running, the tab will be removed once all previously started animations have been finished.

Specified by:

removeTab in interface Model

Parameters:

tab - The tab, which should be removed, as an instance of the class Tab. The tab may not be null

removeTab

public final void removeTab(Tab tab,
                            Animation animation)

Description copied from interface: Model

Removes a specific tab from the tab switcher. If the switcher is currently shown, the tab is removed by using a specific animation. If an animation is currently running, the tab will be removed once all previously started animations have been finished.

Specified by:

removeTab in interface Model

Parameters:

tab - The tab, which should be removed, as an instance of the class Tab. The tab may not be null

animation - The animation, which should be used to remove the tabs, as an instance of the class Animation. The animation may not be null

clear

public final void clear()

Description copied from interface: Model

Removes all tabs from the tab switcher. If the switcher is currently shown, the tabs are removed by using an animation. By default, a SwipeAnimation with direction SwipeAnimation.SwipeDirection.RIGHT_OR_BOTTOM is used. If an animation is currently running, the tabs will be removed once all previously started animations have been finished.

Specified by:

clear in interface Model

clear

public final void clear(Animation animation)

Description copied from interface: Model

Removes all tabs from the tab switcher. If the switcher is currently shown, the tabs are removed by using a specific animation. If an animation is currently running, the tabs will be removed once all previously started animations have been finished.

Specified by:

clear in interface Model

Parameters:

animation - The animation, which should be used to remove the tabs, as an instance of the class Animation. The animation may not be null

isSwitcherShown

public final boolean isSwitcherShown()

Description copied from interface: Model

Returns, whether the tab switcher is currently shown.

Specified by:

isSwitcherShown in interface Model

Returns:

True, if the tab switcher is currently shown, false otherwise

showSwitcher

public final void showSwitcher()

Description copied from interface: Model

Shows the tab switcher by using an animation, if it is not already shown.

Specified by:

showSwitcher in interface Model

hideSwitcher

public final void hideSwitcher()

Description copied from interface: Model

Hides the tab switcher by using an animation, if it is currently shown.

Specified by:

hideSwitcher in interface Model

toggleSwitcherVisibility

public final void toggleSwitcherVisibility()

Description copied from interface: Model

Toggles the visibility of the tab switcher by using an animation, i.e. if the switcher is currently shown, it is hidden, otherwise it is shown.

Specified by:

toggleSwitcherVisibility in interface Model

getSelectedTab

public final Tab getSelectedTab()

Description copied from interface: Model

Returns the currently selected tab.

Specified by:

getSelectedTab in interface Model

Returns:

The currently selected tab as an instance of the class Tab or null, if no tab is currently selected

getSelectedTabIndex

public final int getSelectedTabIndex()

Description copied from interface: Model

Returns the index of the currently selected tab.

Specified by:

getSelectedTabIndex in interface Model

Returns:

The index of the currently selected tab as an Integer value or -1, if no tab is currently selected

selectTab

public final void selectTab(Tab tab)

Description copied from interface: Model

Selects a specific tab.

Specified by:

selectTab in interface Model

Parameters:

tab - The tab, which should be selected, as an instance of the class Tab. The tab may not be null. If the tab is not contained by the tab switcher, a NoSuchElementException will be thrown

selectTab

public final void selectTab(int index)

Description copied from interface: Model

Selects the tab as a specific index.

Specified by:

selectTab in interface Model

Parameters:

index - The index of the tab, which should be selected, as an Integer value. The index must be at least 0 and at maximum getCount() - 1, otherwise a IndexOutOfBoundsException will be thrown

iterator

public final java.util.Iterator<Tab> iterator()

Specified by:

iterator in interface java.lang.Iterable<Tab>

setPadding

public final void setPadding(int left,
                             int top,
                             int right,
                             int bottom)

Description copied from interface: Model

Sets the padding of the tab switcher.

Specified by:

setPadding in interface Model

Parameters:

left - The left padding, which should be set, in pixels as an Integer value

top - The top padding, which should be set, in pixels as an Integer value

right - The right padding, which should be set, in pixels as an Integer value

bottom - The bottom padding, which should be set, in pixels as an Integer value

getPaddingLeft

public final int getPaddingLeft()

Description copied from interface: Model

Returns the left padding of the tab switcher.

Specified by:

getPaddingLeft in interface Model

Returns:

The left padding of the tab switcher in pixels as an Integer value

getPaddingTop

public final int getPaddingTop()

Description copied from interface: Model

Returns the top padding of the tab switcher.

Specified by:

getPaddingTop in interface Model

Returns:

The top padding of the tab switcher in pixels as an Integer value

getPaddingRight

public final int getPaddingRight()

Description copied from interface: Model

Returns the right padding of the tab switcher.

Specified by:

getPaddingRight in interface Model

Returns:

The right padding of the tab switcher in pixels as an Integer value

getPaddingBottom

public final int getPaddingBottom()

Description copied from interface: Model

Returns the bottom padding of the tab switcher.

Specified by:

getPaddingBottom in interface Model

Returns:

The bottom padding of the tab switcher in pixels as an Integer value

getPaddingStart

public final int getPaddingStart()

Description copied from interface: Model

Returns the start padding of the tab switcher. This corresponds to the right padding, if a right-to-left layout is used, or to the left padding otherwise.

Specified by:

getPaddingStart in interface Model

Returns:

The start padding of the tab switcher in pixels as an Integer value

getPaddingEnd

public final int getPaddingEnd()

Description copied from interface: Model

Returns the end padding of the tab switcher. This corresponds ot the left padding, if a right-to-left layout is used, or to the right padding otherwise.

Specified by:

getPaddingEnd in interface Model

Returns:

The end padding of the tab switcher in pixels as an Integer value

getTabIcon

public final android.graphics.drawable.Drawable getTabIcon()

Description copied from interface: Model

Returns the default icon of a tab.

Specified by:

getTabIcon in interface Model

Returns:

The default icon of a tab as an instance of the class Drawable or null, if no icon is set

setTabIcon

public final void setTabIcon(int resourceId)

Description copied from interface: Model

Sets the default icon of a tab.

Specified by:

setTabIcon in interface Model

Parameters:

resourceId - The resource id of the icon, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource

setTabIcon

public final void setTabIcon(android.graphics.Bitmap icon)

Description copied from interface: Model

Sets the default icon of a tab.

Specified by:

setTabIcon in interface Model

Parameters:

icon - The icon, which should be set, as an instance of the class Bitmap or null, if no icon should be set

getTabBackgroundColor

public final android.content.res.ColorStateList getTabBackgroundColor()

Description copied from interface: Model

Returns the default background color of a tab.

Specified by:

getTabBackgroundColor in interface Model

Returns:

The default background color of a tab as an instance of the class ColorStateList or null, if the default color is used

setTabBackgroundColor

public final void setTabBackgroundColor(int color)

Description copied from interface: Model

Sets the default background color of a tab.

Specified by:

setTabBackgroundColor in interface Model

Parameters:

color - The color, which should be set, as an Integer value or -1, if the default color should be used

setTabBackgroundColor

public final void setTabBackgroundColor(android.content.res.ColorStateList colorStateList)

Description copied from interface: Model

Sets the default background color of a tab.

Specified by:

setTabBackgroundColor in interface Model

Parameters:

colorStateList - The color, which should be set, as an instance of the class ColorStateList or null, if the default color should be used

getTabContentBackgroundColor

public final int getTabContentBackgroundColor()

Description copied from interface: Model

Returns the default background color of a tab's content.

Specified by:

getTabContentBackgroundColor in interface Model

Returns:

The default background color of a tab's content as an Integer value

setTabContentBackgroundColor

public final void setTabContentBackgroundColor(int color)

Description copied from interface: Model

Sets the default background color of a tab's content.

Specified by:

setTabContentBackgroundColor in interface Model

Parameters:

color - The color, which should be set, as an Integer value or -1, if the default color should be used

getTabTitleTextColor

public final android.content.res.ColorStateList getTabTitleTextColor()

Description copied from interface: Model

Returns the default text color of a tab's title.

Specified by:

getTabTitleTextColor in interface Model

Returns:

The default text color of a tab's title as an instance of the class ColorStateList or null, if the default color is used

setTabTitleTextColor

public final void setTabTitleTextColor(int color)

Description copied from interface: Model

Sets the default text color of a tab's title.

Specified by:

setTabTitleTextColor in interface Model

Parameters:

color - The color, which should be set, as an Integer value or -1, if the default color should be used

setTabTitleTextColor

public final void setTabTitleTextColor(android.content.res.ColorStateList colorStateList)

Description copied from interface: Model

Sets the default text color of a tab's title.

Specified by:

setTabTitleTextColor in interface Model

Parameters:

colorStateList - The color state list, which should be set, as an instance of the class ColorStateList or null, if the default color should be used

getTabCloseButtonIcon

public final android.graphics.drawable.Drawable getTabCloseButtonIcon()

Description copied from interface: Model

Returns the default icon of a tab's close button.

Specified by:

getTabCloseButtonIcon in interface Model

Returns:

The default icon of a tab's close button as an instance of the class Drawable or null, if the default icon is used

getTabProgressBarColor

public final int getTabProgressBarColor()

Description copied from interface: Model

Returns the color of a tab's progress bar.

Specified by:

getTabProgressBarColor in interface Model

Returns:

The color of a tab's progress bar as an Integer value or -1, if the default color is used

setTabProgressBarColor

public final void setTabProgressBarColor(int color)

Description copied from interface: Model

Sets the color of a tab's progress bar.

Specified by:

setTabProgressBarColor in interface Model

Parameters:

color - The color, which should be set, as an Integer value or -1, if the default color should be used

setTabCloseButtonIcon

public final void setTabCloseButtonIcon(int resourceId)

Description copied from interface: Model

Sets the default icon of a tab's close button.

Specified by:

setTabCloseButtonIcon in interface Model

Parameters:

resourceId - The resource id of the icon, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource

setTabCloseButtonIcon

public final void setTabCloseButtonIcon(android.graphics.Bitmap icon)

Description copied from interface: Model

Sets the default icon of a tab's close button.

Specified by:

setTabCloseButtonIcon in interface Model

Parameters:

icon - The icon, which should be set, as an instance of the class Bitmap or null, if the default icon should be used

isAddTabButtonShown

public final boolean isAddTabButtonShown()

Description copied from interface: Model

Returns, whether a button, which allows to add a new tab, is shown. When using the smartphone layout, such a button is never shown. When using the tablet layout, the button is shown next to the tabs.

Specified by:

isAddTabButtonShown in interface Model

Returns:

True, if a button, which allows to add a new tab, is shown, false otherwise

showAddTabButton

public final void showAddTabButton(AddTabButtonListener listener)

Description copied from interface: Model

Sets, whether a button, which allows to add a new tab, should be shown. This method does not have any effect when using the smartphone layout. When using the tablet layout, the button is shown next to the tabs.

Specified by:

showAddTabButton in interface Model

Parameters:

listener - The listener, which should be notified, when the button has been clicked, as an instance of the type AddTabButtonListener or null, if the button should not be shown

getAddTabButtonColor

public final android.content.res.ColorStateList getAddTabButtonColor()

Description copied from interface: Model

Returns the color of the button, which allows to add a new tab. When using the smartphone layout, such a button is never shown. When using the tablet layout, the button is shown next to the tabs.

Specified by:

getAddTabButtonColor in interface Model

Returns:

The color of the button, which allows to add a new tab, as an instance of the class ColorStateList or null, if the default color is used

setAddTabButtonColor

public final void setAddTabButtonColor(int color)

Description copied from interface: Model

Sets the color of the button, which allows to add a new tab. This method does not have any effect when using the smartphone layout. When using the tablet layout, the button is shown next to the tabs.

Specified by:

setAddTabButtonColor in interface Model

Parameters:

color - The color, which should be set, as an Integer value or -1, if the default color should be used

setAddTabButtonColor

public final void setAddTabButtonColor(android.content.res.ColorStateList colorStateList)

Description copied from interface: Model

Sets the color of the button, which allows to add a new tab. This method does not have any effect when using the smartphone layout. When using the tablet layout, the button is shown next to the tabs.

Specified by:

setAddTabButtonColor in interface Model

Parameters:

colorStateList - The color, which should be set, as an instance of the class ColorStateList or null, if the default color should be used

areToolbarsShown

public final boolean areToolbarsShown()

Description copied from interface: Model

Returns, whether the toolbars are shown, when the tab switcher is shown, or not. When using the tablet layout, the toolbars are always shown.

Specified by:

areToolbarsShown in interface Model

Returns:

True, if the toolbars are shown, false otherwise

showToolbars

public final void showToolbars(boolean show)

Description copied from interface: Model

Sets, whether the toolbars should be shown, when the tab switcher is shown, or not. This method does not have any effect when using the tablet layout.

Specified by:

showToolbars in interface Model

Parameters:

show - True, if the toolbars should be shown, false otherwise

getToolbarTitle

public final java.lang.CharSequence getToolbarTitle()

Description copied from interface: Model

Returns the title of the toolbar, which is shown, when the tab switcher is shown. When using the tablet layout, the title corresponds to the primary toolbar.

Specified by:

getToolbarTitle in interface Model

Returns:

The title of the toolbar, which is shown, when the tab switcher is shown, as an instance of the type CharSequence or null, if no title is set

setToolbarTitle

public void setToolbarTitle(int resourceId)

Description copied from interface: Model

Sets the title of the toolbar, which is shown, when the tab switcher is shown. When using the tablet layout, the title is set to the primary toolbar.

Specified by:

setToolbarTitle in interface Model

Parameters:

resourceId - The resource id of the title, which should be set, as an Integer value. The resource id must correspond to a valid string resource

setToolbarTitle

public final void setToolbarTitle(java.lang.CharSequence title)

Description copied from interface: Model

Sets the title of the toolbar, which is shown, when the tab switcher is shown. When using the tablet layout, the title is set to the primary toolbar.

Specified by:

setToolbarTitle in interface Model

Parameters:

title - The title, which should be set, as an instance of the type CharSequence or null, if no title should be set

getToolbarNavigationIcon

public final android.graphics.drawable.Drawable getToolbarNavigationIcon()

Description copied from interface: Model

Returns the navigation icon of the toolbar, which is shown, when the tab switcher is shown. When using the tablet layout, the icon corresponds to the primary toolbar.

Specified by:

getToolbarNavigationIcon in interface Model

Returns:

The icon of the toolbar, which is shown, when the tab switcher is shown, as an instance of the class Drawable or null, if no icon is set

setToolbarNavigationIcon

public final void setToolbarNavigationIcon(int resourceId,
                                           android.view.View.OnClickListener listener)

Description copied from interface: Model

Sets the navigation icon of the toolbar, which is shown, when the tab switcher is shown. When using the tablet layout, the icon is set to the primary toolbar.

Specified by:

setToolbarNavigationIcon in interface Model

Parameters:

resourceId - The resource id of the icon, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource

listener - The listener, which should be notified, when the navigation item has been clicked, as an instance of the type View.OnClickListener or null, if no listener should be notified

setToolbarNavigationIcon

public final void setToolbarNavigationIcon(android.graphics.drawable.Drawable icon,
                                           android.view.View.OnClickListener listener)

Description copied from interface: Model

Sets the navigation icon of the toolbar, which is shown, when the tab switcher is shown. When using the tablet layout, the icon is set to the primary toolbar.

Specified by:

setToolbarNavigationIcon in interface Model

Parameters:

icon - The icon, which should be set, as an instance of the class Drawable or null, if no icon should be set

listener - The listener, which should be notified, when the navigation item has been clicked, as an instance of the type View.OnClickListener or null, if no listener should be notified

inflateToolbarMenu

public final void inflateToolbarMenu(int resourceId,
                                     OnMenuItemClickListener listener)

Description copied from interface: Model

Inflates the menu of the toolbar, which is shown, when the tab switcher is shown. When using the tablet layout, the menu is inflated into the secondary toolbar. If another menu has already been inflated, its items will be removed.

Specified by:

inflateToolbarMenu in interface Model

Parameters:

resourceId - The resource id of the menu, which should be inflated, as an Integer value. The resource id must correspond to a valid menu resource

listener - The listener, which should be notified, when an menu item has been clicked, as an instance of the type OnMenuItemClickListener or null, if no listener should be notified

getEmptyView

public final android.view.View getEmptyView()

Description copied from interface: Model

Returns the view, which is shown, when the tab switcher is empty.

Specified by:

getEmptyView in interface Model

Returns:

The view, which is shown, when the tab switcher is empty, as an instance of the class View or null, if no view is shown

setEmptyView

public final void setEmptyView(android.view.View view)

Description copied from interface: Model

Sets the view, which should be shown, when the tab switcher is empty.

Specified by:

setEmptyView in interface Model

Parameters:

view - The view, which should be set, as an instance of the class View or null, if no view should be shown, when the tab switcher is empty

setEmptyView

public final void setEmptyView(android.view.View view,
                               long animationDuration)

Description copied from interface: Model

Sets the view, which should be shown, when the tab switcher is empty.

Specified by:

setEmptyView in interface Model

Parameters:

view - The view, which should be set, as an instance of the class View or null, if no view should be shown, when the tab switcher is empty

animationDuration - The duration of the fade animation, which is used to show or hide the view, in milliseconds as a Long value. The duration must be at least 0 or -1, if the default duration should be used

setEmptyView

public final void setEmptyView(int resourceId)

Description copied from interface: Model

Sets the view, which should be shown, when the tab switcher is empty.

Specified by:

setEmptyView in interface Model

Parameters:

resourceId - The resource id of the view, which should be set, as an Integer value. The resource id must correspond to a valid layout resource

setEmptyView

public final void setEmptyView(int resourceId,
                               long animationDuration)

Description copied from interface: Model

Sets the view, which should be shown, when the tab switcher is empty.

Specified by:

setEmptyView in interface Model

Parameters:

resourceId - The resource id of the view, which should be set, as an Integer value. The resource id must correspond to a valid layout resource

animationDuration - The duration of the fade animation, which is used to show or hide the view, in milliseconds as a Long value. The duration must be at least 0 or -1, if the default duration should be used

addCloseTabListener

public final void addCloseTabListener(TabCloseListener listener)

Description copied from interface: Model

Adds a new listener, which should be notified, when a tab is about to be closed by clicking its close button.

Specified by:

addCloseTabListener in interface Model

Parameters:

listener - The listener, which should be added, as an instance of the type TabCloseListener. The listener may not be null

removeCloseTabListener

public final void removeCloseTabListener(TabCloseListener listener)

Description copied from interface: Model

Removes a specific listener, which should not be notified, when a tab is about to be closed by clicking its close button, anymore.

Specified by:

removeCloseTabListener in interface Model

Parameters:

listener - The listener, which should be removed, as an instance of the type TabCloseListener. The listener may not be null

addTabPreviewListener

public final void addTabPreviewListener(TabPreviewListener listener)

Description copied from interface: Model

Adds a new listener, which should be notified, when the preview of a tab is about to be loaded. Previews are only loaded when using the smartphone layout.

Specified by:

addTabPreviewListener in interface Model

Parameters:

listener - The listener, which should be added, as an instance of the type TabPreviewListener. The listener may not be null

removeTabPreviewListener

public final void removeTabPreviewListener(TabPreviewListener listener)

Description copied from interface: Model

Removes a specific listener, which should not be notified, when the preview of a tab is about to be loaded.

Specified by:

removeTabPreviewListener in interface Model

Parameters:

listener - The listener, which should be removed, as an instance of the type TabPreviewListener. The listener may not be null

saveInstanceState

public final void saveInstanceState(android.os.Bundle outState)

Description copied from interface: Restorable

Saves the current state.

Specified by:

saveInstanceState in interface Restorable

Parameters:

outState - The bundle, which should be used to store the saved state, as an instance of the class Bundle. The bundle may not be null

restoreInstanceState

public final void restoreInstanceState(android.os.Bundle savedInstanceState)

Description copied from interface: Restorable

Restores a previously saved state.

Specified by:

restoreInstanceState in interface Restorable

Parameters:

savedInstanceState - The saved state as an instance of the class Bundle or null, if no saved state is available