to top
Android APIs
public class

TabHost

extends FrameLayout
implements ViewTreeObserver.OnTouchModeChangeListener
java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.FrameLayout
         ↳ android.widget.TabHost

Class Overview

Container for a tabbed window view. This object holds two children: a set of tab labels that the user clicks to select a specific tab, and a FrameLayout object that displays the contents of that page. The individual elements are typically controlled using this container object, rather than setting values on the child elements themselves.

Summary

Nested Classes
interface TabHost.OnTabChangeListener Interface definition for a callback to be invoked when tab changed  
interface TabHost.TabContentFactory Makes the content of a tab when it is selected. 
class TabHost.TabSpec A tab has a tab indicator, content, and a tag that is used to keep track of it. 
[Expand]
Inherited XML Attributes
From class android.widget.FrameLayout
From class android.view.ViewGroup
From class android.view.View
[Expand]
Inherited Constants
From class android.view.ViewGroup
From class android.view.View
[Expand]
Inherited Fields
From class android.view.View
Public Constructors
TabHost(Context context)
TabHost(Context context, AttributeSet attrs)
Public Methods
void addTab(TabHost.TabSpec tabSpec)
Add a tab.
void clearAllTabs()
Removes all tabs from the tab widget associated with this tab host.
boolean dispatchKeyEvent(KeyEvent event)
Dispatch a key event to the next view on the focus path.
void dispatchWindowFocusChanged(boolean hasFocus)
Called when the window containing this view gains or loses window focus.
int getCurrentTab()
String getCurrentTabTag()
View getCurrentTabView()
View getCurrentView()
FrameLayout getTabContentView()
Get the FrameLayout which holds tab content
TabWidget getTabWidget()
TabHost.TabSpec newTabSpec(String tag)
Get a new TabHost.TabSpec associated with this tab host.
void onInitializeAccessibilityEvent(AccessibilityEvent event)
Initializes an AccessibilityEvent with information about this View which is the event source.
void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info)
Initializes an AccessibilityNodeInfo with information about this view.
void onTouchModeChanged(boolean isInTouchMode)
Callback method to be invoked when the touch mode changes.
void sendAccessibilityEvent(int eventType)
Sends an accessibility event of the given type.
void setCurrentTab(int index)
void setCurrentTabByTag(String tag)
void setOnTabChangedListener(TabHost.OnTabChangeListener l)
Register a callback to be invoked when the selected state of any of the items in this list changes
void setup()

Call setup() before adding tabs if loading TabHost using findViewById().

void setup(LocalActivityManager activityGroup)
If you are using setContent(android.content.Intent), this must be called since the activityGroup is needed to launch the local activity.
Protected Methods
void onAttachedToWindow()
This is called when the view is attached to a window.
void onDetachedFromWindow()
This is called when the view is detached from a window.
[Expand]
Inherited Methods
From class android.widget.FrameLayout
From class android.view.ViewGroup
From class android.view.View
From class java.lang.Object
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.ViewManager
From interface android.view.ViewParent
From interface android.view.ViewTreeObserver.OnTouchModeChangeListener
From interface android.view.accessibility.AccessibilityEventSource

Public Constructors

public TabHost (Context context)

Since: API Level 1

public TabHost (Context context, AttributeSet attrs)

Since: API Level 1

Public Methods

public void addTab (TabHost.TabSpec tabSpec)

Since: API Level 1

Add a tab.

Parameters
tabSpec Specifies how to create the indicator and content.

public void clearAllTabs ()

Since: API Level 1

Removes all tabs from the tab widget associated with this tab host.

public boolean dispatchKeyEvent (KeyEvent event)

Since: API Level 1

Dispatch a key event to the next view on the focus path. This path runs from the top of the view tree down to the currently focused view. If this view has focus, it will dispatch to itself. Otherwise it will dispatch the next node down the focus path. This method also fires any key listeners.

Parameters
event The key event to be dispatched.
Returns
  • True if the event was handled, false otherwise.

public void dispatchWindowFocusChanged (boolean hasFocus)

Since: API Level 1

Called when the window containing this view gains or loses window focus. ViewGroups should override to route to their children.

Parameters
hasFocus True if the window containing this view now has focus, false otherwise.

public int getCurrentTab ()

Since: API Level 1

public String getCurrentTabTag ()

Since: API Level 1

public View getCurrentTabView ()

Since: API Level 1

public View getCurrentView ()

Since: API Level 1

public FrameLayout getTabContentView ()

Since: API Level 1

Get the FrameLayout which holds tab content

public TabWidget getTabWidget ()

Since: API Level 1

public TabHost.TabSpec newTabSpec (String tag)

Since: API Level 1

Get a new TabHost.TabSpec associated with this tab host.

Parameters
tag required tag of tab.

public void onInitializeAccessibilityEvent (AccessibilityEvent event)

Since: API Level 14

Initializes an AccessibilityEvent with information about this View which is the event source. In other words, the source of an accessibility event is the view whose state change triggered firing the event.

Example: Setting the password property of an event in addition to properties set by the super implementation: 

 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
     super.onInitializeAccessibilityEvent(event);
     event.setPassword(true);
 }

If an View.AccessibilityDelegate has been specified via calling setAccessibilityDelegate(AccessibilityDelegate) its onInitializeAccessibilityEvent(View, AccessibilityEvent) is responsible for handling this call.

Note: Always call the super implementation before adding information to the event, in case the default implementation has basic information to add.

Parameters
event The event to initialize.

public void onInitializeAccessibilityNodeInfo (AccessibilityNodeInfo info)

Since: API Level 14

Initializes an AccessibilityNodeInfo with information about this view. The base implementation sets:

Subclasses should override this method, call the super implementation, and set additional attributes.

If an View.AccessibilityDelegate has been specified via calling setAccessibilityDelegate(AccessibilityDelegate) its onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo) is responsible for handling this call.

Parameters
info The instance to initialize.

public void onTouchModeChanged (boolean isInTouchMode)

Since: API Level 1

Callback method to be invoked when the touch mode changes.

Parameters
isInTouchMode True if the view hierarchy is now in touch mode, false otherwise.

public void sendAccessibilityEvent (int eventType)

Since: API Level 4

Sends an accessibility event of the given type. If accessiiblity is not enabled this method has no effect. The default implementation calls onInitializeAccessibilityEvent(AccessibilityEvent) first to populate information about the event source (this View), then calls dispatchPopulateAccessibilityEvent(AccessibilityEvent) to populate the text content of the event source including its descendants, and last calls requestSendAccessibilityEvent(View, AccessibilityEvent) on its parent to resuest sending of the event to interested parties.

If an View.AccessibilityDelegate has been specified via calling setAccessibilityDelegate(AccessibilityDelegate) its sendAccessibilityEvent(View, int) is responsible for handling this call.

Parameters
eventType The type of the event to send, as defined by several types from AccessibilityEvent, such as TYPE_VIEW_CLICKED or TYPE_VIEW_HOVER_ENTER.

public void setCurrentTab (int index)

Since: API Level 1

public void setCurrentTabByTag (String tag)

Since: API Level 1

public void setOnTabChangedListener (TabHost.OnTabChangeListener l)

Since: API Level 1

Register a callback to be invoked when the selected state of any of the items in this list changes

Parameters
l The callback that will run

public void setup ()

Since: API Level 1

Call setup() before adding tabs if loading TabHost using findViewById(). However: You do not need to call setup() after getTabHost() in TabActivity. Example:

mTabHost = (TabHost)findViewById(R.id.tabhost);
mTabHost.setup();
mTabHost.addTab(TAB_TAG_1, "Hello, world!", "Tab 1");

public void setup (LocalActivityManager activityGroup)

Since: API Level 1

If you are using setContent(android.content.Intent), this must be called since the activityGroup is needed to launch the local activity. This is done for you if you extend TabActivity.

Parameters
activityGroup Used to launch activities for tab content.

Protected Methods

protected void onAttachedToWindow ()

Since: API Level 1

This is called when the view is attached to a window. At this point it has a Surface and will start drawing. Note that this function is guaranteed to be called before onDraw(android.graphics.Canvas), however it may be called any time before the first onDraw -- including before or after onMeasure(int, int).

protected void onDetachedFromWindow ()

Since: API Level 1

This is called when the view is detached from a window. At this point it no longer has a surface for drawing.