de.mrapp.android.tabswitcher

Class TabSwitcherDecorator

java.lang.Object

AbstractViewHolderAdapter

de.mrapp.android.tabswitcher.TabSwitcherDecorator

public abstract class TabSwitcherDecorator
extends AbstractViewHolderAdapter

An abstract base class for all decorators, which are responsible for inflating views, which should be used to visualize the tabs of a TabSwitcher.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
TabSwitcherDecorator()

Method Summary

Modifier and Type	Method and Description
void	applyDecorator(android.content.Context context, TabSwitcher tabSwitcher, android.view.View view, Tab tab, int index, android.os.Bundle savedInstanceState) The method, which is invoked by a TabSwitcher to apply the decorator.
int	getViewType(Tab tab, int index) Returns the view type, which corresponds to a specific tab.
int	getViewTypeCount() Returns the number of view types, which are used by the decorator.
android.view.View	inflateView(android.view.LayoutInflater inflater, android.view.ViewGroup parent, Tab tab, int index) The method, which is invoked by a TabSwitcher to inflate the view, which should be used to visualize a specific tab.
abstract android.view.View	onInflateView(android.view.LayoutInflater inflater, android.view.ViewGroup parent, int viewType) The method which is invoked, when a view, which is used to visualize a tab, should be inflated.
void	onSaveInstanceState(android.view.View view, Tab tab, int index, int viewType, android.os.Bundle outState) The method, which is invoked, when the view, which is used to visualize a tab, is removed.
abstract void	onShowTab(android.content.Context context, TabSwitcher tabSwitcher, android.view.View view, Tab tab, int index, int viewType, android.os.Bundle savedInstanceState) The method which is invoked, when the view, which is used to visualize a tab, should be shown, respectively when it should be refreshed.
android.os.Bundle	saveInstanceState(android.view.View view, Tab tab, int index) The method, which is invoked by a TabSwitcher to save the current state of a tab.

Methods inherited from class java.lang.Object

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

Constructor Detail

TabSwitcherDecorator

public TabSwitcherDecorator()

Method Detail

onInflateView

public abstract android.view.View onInflateView(android.view.LayoutInflater inflater,
                                                android.view.ViewGroup parent,
                                                int viewType)

The method which is invoked, when a view, which is used to visualize a tab, should be inflated.

Parameters:

inflater - The inflater, which should be used to inflate the view, as an instance of the class LayoutInflater. The inflater may not be null

parent - The parent view of the view, which should be inflated, as an instance of the class ViewGroup or null, if no parent view is available

viewType - The view type of the tab, which should be visualized, as an Integer value

Returns:

The view, which has been inflated, as an instance of the class View. The view may not be null

onShowTab

public abstract void onShowTab(android.content.Context context,
                               TabSwitcher tabSwitcher,
                               android.view.View view,
                               Tab tab,
                               int index,
                               int viewType,
                               android.os.Bundle savedInstanceState)

The method which is invoked, when the view, which is used to visualize a tab, should be shown, respectively when it should be refreshed. The purpose of this method is to customize the appearance of the view, which is used to visualize the corresponding tab, depending on its state and whether the tab switcher is currently shown, or not.

Parameters:

context - The context, the tab switcher belongs to, as an instance of the class Context. The context may not be null

tabSwitcher - The tab switcher, whose tabs are visualized by the decorator, as an instance of the type TabSwitcher. The tab switcher may not be null

view - The view, which is used to visualize the tab, as an instance of the class View. The view may not be null

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

index - The index of the tab, which should be visualized, as an Integer value

viewType - The view type of the tab, which should be visualized, as an Integer value

savedInstanceState - The bundle, which has previously been used to save the state of the view as an instance of the class Bundle or null, if no saved state is available

onSaveInstanceState

public void onSaveInstanceState(android.view.View view,
                                Tab tab,
                                int index,
                                int viewType,
                                android.os.Bundle outState)

The method, which is invoked, when the view, which is used to visualize a tab, is removed. The purpose of this method is to save the current state of the tab in a bundle.

Parameters:

view - The view, which is used to visualize the tab, as an instance of the class View

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

index - The index of the tab, whose state should be saved, as an Integer value

viewType - The view type of the tab, whose state should be saved, as an Integer value

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

getViewType

public int getViewType(Tab tab,
                       int index)

Returns the view type, which corresponds to a specific tab. For each layout, which is inflated by the onInflateView-method, a distinct view type must be returned.

Parameters:

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

index - The index of the tab, whose view type should be returned, as an Integer value

Returns:

The view type, which corresponds to the given tab, as an Integer value

getViewTypeCount

public int getViewTypeCount()

Returns the number of view types, which are used by the decorator.

Returns:

The number of view types, which are used by the decorator, as an Integer value. The number of view types must correspond to the number of distinct values, which are returned by the getViewType-method

inflateView

public final android.view.View inflateView(android.view.LayoutInflater inflater,
                                           android.view.ViewGroup parent,
                                           Tab tab,
                                           int index)

The method, which is invoked by a TabSwitcher to inflate the view, which should be used to visualize a specific tab.

Parameters:

inflater - The inflater, which should be used to inflate the view, as an instance of the class LayoutInflater. The inflater may not be null

parent - The parent view of the view, which should be inflated, as an instance of the class ViewGroup or null, if no parent view is available

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

index - The index of the tab, which should be visualized, as an Integer value

Returns:

The view, which has been inflated, as an instance of the class View. The view may not be null

applyDecorator

public final void applyDecorator(android.content.Context context,
                                 TabSwitcher tabSwitcher,
                                 android.view.View view,
                                 Tab tab,
                                 int index,
                                 android.os.Bundle savedInstanceState)

The method, which is invoked by a TabSwitcher to apply the decorator. It initializes the view holder pattern, which is provided by the decorator and then delegates the method call to the decorator's custom implementation of the method onShowTab(...):void.

Parameters:

context - The context, the tab switcher belongs to, as an instance of the class Context. The context may not be null

tabSwitcher - The tab switcher, whose tabs are visualized by the decorator, as an instance of the class TabSwitcher. The tab switcher may not be null

view - The view, which is used to visualize the tab, as an instance of the class View. The view may not be null

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

index - The index of the tab, which should be visualized, as an Integer value

savedInstanceState - The bundle, which has previously been used to save the state of the view as an instance of the class Bundle or null, if no saved state is available

saveInstanceState

public final android.os.Bundle saveInstanceState(android.view.View view,
                                                 Tab tab,
                                                 int index)

The method, which is invoked by a TabSwitcher to save the current state of a tab. It initializes the view holder pattern, which is provided by the decorator and then delegates the method call to the decorator's custom implementation of the method onSaveInstanceState(...):void.

Parameters:

view - The view, which is used to visualize the tab, as an instance of the class View

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

index - The index of the tab, whose state should be saved, as an Integer value

Returns:

The bundle, which has been used to save the state, as an instance of the class Bundle. The bundle may not be null