public class

FragmentTabHost

extends android.widget.TabHost

 java.lang.Object

↳android.widget.TabHost

↳androidx.fragment.app.FragmentTabHost

Gradle dependencies

compile group: 'androidx.fragment', name: 'fragment', version: '1.5.0-rc01'

  • groupId: androidx.fragment
  • artifactId: fragment
  • version: 1.5.0-rc01

Artifact androidx.fragment:fragment:1.5.0-rc01 it located at Google repository (https://maven.google.com/)

Androidx artifact mapping:

androidx.fragment:fragment com.android.support:support-fragment

Androidx class mapping:

androidx.fragment.app.FragmentTabHost android.support.v4.app.FragmentTabHost

Overview

Special TabHost that allows the use of Fragment objects for its tab content. When placing this in a view hierarchy, after inflating the hierarchy you must call FragmentTabHost.setup(Context, FragmentManager, int) to complete the initialization of the tab host.

Summary

Constructors
publicFragmentTabHost(Context context)

publicFragmentTabHost(Context context, AttributeSet attrs)

Methods
public voidaddTab(android.widget.TabHost.TabSpec tabSpec, java.lang.Class<java.lang.Object> clss, Bundle args)

protected voidonAttachedToWindow()

protected voidonDetachedFromWindow()

protected voidonRestoreInstanceState(Parcelable state)

protected ParcelableonSaveInstanceState()

public voidonTabChanged(java.lang.String tabId)

public voidsetOnTabChangedListener(OnTabChangeListener l)

public voidsetup()

public voidsetup(Context context, FragmentManager manager)

Set up the FragmentTabHost to use the given FragmentManager

public voidsetup(Context context, FragmentManager manager, int containerId)

Set up the FragmentTabHost to use the given FragmentManager

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public FragmentTabHost(Context context)

Deprecated: Use TabLayout and ViewPager instead.

public FragmentTabHost(Context context, AttributeSet attrs)

Deprecated: Use TabLayout and ViewPager instead.

Methods

public void setup()

Deprecated: Use TabLayout and ViewPager instead.

public void setup(Context context, FragmentManager manager)

Deprecated: Use TabLayout and ViewPager instead.

Set up the FragmentTabHost to use the given FragmentManager

public void setup(Context context, FragmentManager manager, int containerId)

Deprecated: Use TabLayout and ViewPager instead.

Set up the FragmentTabHost to use the given FragmentManager

public void setOnTabChangedListener(OnTabChangeListener l)

Deprecated: Use TabLayout and ViewPager instead.

public void addTab(android.widget.TabHost.TabSpec tabSpec, java.lang.Class<java.lang.Object> clss, Bundle args)

Deprecated: Use TabLayout and ViewPager instead.

protected void onAttachedToWindow()

Deprecated: Use TabLayout and ViewPager instead.

protected void onDetachedFromWindow()

Deprecated: Use TabLayout and ViewPager instead.

protected Parcelable onSaveInstanceState()

Deprecated: Use TabLayout and ViewPager instead.

protected void onRestoreInstanceState(Parcelable state)

Deprecated: Use TabLayout and ViewPager instead.

public void onTabChanged(java.lang.String tabId)

Deprecated: Use TabLayout and ViewPager instead.

Source

/*
 * Copyright 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.fragment.app;

import android.annotation.SuppressLint;
import android.content.Context;
import android.content.res.TypedArray;
import android.os.Bundle;
import android.os.Parcel;
import android.os.Parcelable;
import android.util.AttributeSet;
import android.view.View;
import android.view.ViewGroup;
import android.widget.FrameLayout;
import android.widget.LinearLayout;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import java.util.ArrayList;

/**
 * Special TabHost that allows the use of {@link Fragment} objects for
 * its tab content.  When placing this in a view hierarchy, after inflating
 * the hierarchy you must call {@link #setup(Context, FragmentManager, int)}
 * to complete the initialization of the tab host.
 *
 * @deprecated Use <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
 *  TabLayout and ViewPager</a> instead.
 */
@SuppressWarnings("deprecation")
@Deprecated
public class FragmentTabHost extends android.widget.TabHost
        implements android.widget.TabHost.OnTabChangeListener {
    private final ArrayList<TabInfo> mTabs = new ArrayList<>();

    private FrameLayout mRealTabContent;
    private Context mContext;
    private FragmentManager mFragmentManager;
    private int mContainerId;
    private android.widget.TabHost.OnTabChangeListener mOnTabChangeListener;
    private TabInfo mLastTab;
    private boolean mAttached;

    static final class TabInfo {
        final @NonNull String tag;
        final @NonNull Class<?> clss;
        final @Nullable Bundle args;
        Fragment fragment;

        TabInfo(@NonNull String _tag, @NonNull Class<?> _class, @Nullable Bundle _args) {
            tag = _tag;
            clss = _class;
            args = _args;
        }
    }

    static class DummyTabFactory implements android.widget.TabHost.TabContentFactory {
        private final Context mContext;

        public DummyTabFactory(Context context) {
            mContext = context;
        }

        @Override
        public View createTabContent(String tag) {
            View v = new View(mContext);
            v.setMinimumWidth(0);
            v.setMinimumHeight(0);
            return v;
        }
    }

    static class SavedState extends BaseSavedState {
        String curTab;

        SavedState(Parcelable superState) {
            super(superState);
        }

        SavedState(Parcel in) {
            super(in);
            curTab = in.readString();
        }

        @Override
        public void writeToParcel(Parcel out, int flags) {
            super.writeToParcel(out, flags);
            out.writeString(curTab);
        }

        @NonNull
        @Override
        public String toString() {
            return "FragmentTabHost.SavedState{"
                    + Integer.toHexString(System.identityHashCode(this))
                    + " curTab=" + curTab + "}";
        }

        public static final Parcelable.Creator<SavedState> CREATOR
                = new Parcelable.Creator<SavedState>() {
            @Override
            public SavedState createFromParcel(Parcel in) {
                return new SavedState(in);
            }

            @Override
            public SavedState[] newArray(int size) {
                return new SavedState[size];
            }
        };
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    public FragmentTabHost(@NonNull Context context) {
        // Note that we call through to the version that takes an AttributeSet,
        // because the simple Context construct can result in a broken object!
        super(context, null);
        initFragmentTabHost(context, null);
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    public FragmentTabHost(@NonNull Context context, @Nullable AttributeSet attrs) {
        super(context, attrs);
        initFragmentTabHost(context, attrs);
    }

    private void initFragmentTabHost(Context context, AttributeSet attrs) {
        final TypedArray a = context.obtainStyledAttributes(attrs,
                new int[] { android.R.attr.inflatedId }, 0, 0);
        mContainerId = a.getResourceId(0, 0);
        a.recycle();

        super.setOnTabChangedListener(this);
    }

    private void ensureHierarchy(Context context) {
        // If owner hasn't made its own view hierarchy, then as a convenience
        // we will construct a standard one here.
        if (findViewById(android.R.id.tabs) == null) {
            LinearLayout ll = new LinearLayout(context);
            ll.setOrientation(LinearLayout.VERTICAL);
            addView(ll, new FrameLayout.LayoutParams(
                    ViewGroup.LayoutParams.MATCH_PARENT,
                    ViewGroup.LayoutParams.MATCH_PARENT));

            android.widget.TabWidget tw = new android.widget.TabWidget(context);
            tw.setId(android.R.id.tabs);
            tw.setOrientation(android.widget.TabWidget.HORIZONTAL);
            ll.addView(tw, new LinearLayout.LayoutParams(
                    ViewGroup.LayoutParams.MATCH_PARENT,
                    ViewGroup.LayoutParams.WRAP_CONTENT, 0));

            FrameLayout fl = new FrameLayout(context);
            fl.setId(android.R.id.tabcontent);
            ll.addView(fl, new LinearLayout.LayoutParams(0, 0, 0));

            mRealTabContent = fl = new FrameLayout(context);
            mRealTabContent.setId(mContainerId);
            ll.addView(fl, new LinearLayout.LayoutParams(
                    LinearLayout.LayoutParams.MATCH_PARENT, 0, 1));
        }
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Override @Deprecated
    public void setup() {
        throw new IllegalStateException(
                "Must call setup() that takes a Context and FragmentManager");
    }

    /**
     * Set up the FragmentTabHost to use the given FragmentManager
     *
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    public void setup(@NonNull Context context, @NonNull FragmentManager manager) {
        ensureHierarchy(context);  // Ensure views required by super.setup()
        super.setup();
        mContext = context;
        mFragmentManager = manager;
        ensureContent();
    }

    /**
     * Set up the FragmentTabHost to use the given FragmentManager
     *
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    public void setup(@NonNull Context context, @NonNull FragmentManager manager,
            int containerId) {
        ensureHierarchy(context);  // Ensure views required by super.setup()
        super.setup();
        mContext = context;
        mFragmentManager = manager;
        mContainerId = containerId;
        ensureContent();
        mRealTabContent.setId(containerId);

        // We must have an ID to be able to save/restore our state.  If
        // the owner hasn't set one at this point, we will set it ourselves.
        if (getId() == View.NO_ID) {
            setId(android.R.id.tabhost);
        }
    }

    private void ensureContent() {
        if (mRealTabContent == null) {
            mRealTabContent = (FrameLayout)findViewById(mContainerId);
            if (mRealTabContent == null) {
                throw new IllegalStateException(
                        "No tab content FrameLayout found for id " + mContainerId);
            }
        }
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    @Override
    public void setOnTabChangedListener(@Nullable OnTabChangeListener l) {
        mOnTabChangeListener = l;
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    public void addTab(@NonNull android.widget.TabHost.TabSpec tabSpec, @NonNull Class<?> clss,
            @Nullable Bundle args) {
        tabSpec.setContent(new DummyTabFactory(mContext));

        final String tag = tabSpec.getTag();
        final TabInfo info = new TabInfo(tag, clss, args);

        if (mAttached) {
            // If we are already attached to the window, then check to make
            // sure this tab's fragment is inactive if it exists.  This shouldn't
            // normally happen.
            info.fragment = mFragmentManager.findFragmentByTag(tag);
            if (info.fragment != null && !info.fragment.isDetached()) {
                final FragmentTransaction ft = mFragmentManager.beginTransaction();
                ft.detach(info.fragment);
                ft.commit();
            }
        }

        mTabs.add(info);
        addTab(tabSpec);
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    @Override
    protected void onAttachedToWindow() {
        super.onAttachedToWindow();

        final String currentTag = getCurrentTabTag();

        // Go through all tabs and make sure their fragments match
        // the correct state.
        FragmentTransaction ft = null;
        for (int i = 0, count = mTabs.size(); i < count; i++) {
            final TabInfo tab = mTabs.get(i);
            tab.fragment = mFragmentManager.findFragmentByTag(tab.tag);
            if (tab.fragment != null && !tab.fragment.isDetached()) {
                if (tab.tag.equals(currentTag)) {
                    // The fragment for this tab is already there and
                    // active, and it is what we really want to have
                    // as the current tab.  Nothing to do.
                    mLastTab = tab;
                } else {
                    // This fragment was restored in the active state,
                    // but is not the current tab.  Deactivate it.
                    if (ft == null) {
                        ft = mFragmentManager.beginTransaction();
                    }
                    ft.detach(tab.fragment);
                }
            }
        }

        // We are now ready to go.  Make sure we are switched to the
        // correct tab.
        mAttached = true;
        ft = doTabChanged(currentTag, ft);
        if (ft != null) {
            ft.commit();
            mFragmentManager.executePendingTransactions();
        }
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    @Override
    protected void onDetachedFromWindow() {
        super.onDetachedFromWindow();
        mAttached = false;
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    @Override
    @NonNull
    protected Parcelable onSaveInstanceState() {
        Parcelable superState = super.onSaveInstanceState();
        SavedState ss = new SavedState(superState);
        ss.curTab = getCurrentTabTag();
        return ss;
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    @Override
    protected void onRestoreInstanceState(@SuppressLint("UnknownNullness") Parcelable state) {
        if (!(state instanceof SavedState)) {
            super.onRestoreInstanceState(state);
            return;
        }
        SavedState ss = (SavedState) state;
        super.onRestoreInstanceState(ss.getSuperState());
        setCurrentTabByTag(ss.curTab);
    }

    /**
     * @deprecated Use
     * <a href="https://developer.android.com/guide/navigation/navigation-swipe-view ">
     *  TabLayout and ViewPager</a> instead.
     */
    @Deprecated
    @Override
    public void onTabChanged(@Nullable String tabId) {
        if (mAttached) {
            final FragmentTransaction ft = doTabChanged(tabId, null);
            if (ft != null) {
                ft.commit();
            }
        }
        if (mOnTabChangeListener != null) {
            mOnTabChangeListener.onTabChanged(tabId);
        }
    }

    @Nullable
    private FragmentTransaction doTabChanged(@Nullable String tag,
            @Nullable FragmentTransaction ft) {
        final TabInfo newTab = getTabInfoForTag(tag);
        if (mLastTab != newTab) {
            if (ft == null) {
                ft = mFragmentManager.beginTransaction();
            }

            if (mLastTab != null) {
                if (mLastTab.fragment != null) {
                    ft.detach(mLastTab.fragment);
                }
            }

            if (newTab != null) {
                if (newTab.fragment == null) {
                    newTab.fragment = mFragmentManager.getFragmentFactory().instantiate(
                            mContext.getClassLoader(), newTab.clss.getName());
                    newTab.fragment.setArguments(newTab.args);
                    ft.add(mContainerId, newTab.fragment, newTab.tag);
                } else {
                    ft.attach(newTab.fragment);
                }
            }

            mLastTab = newTab;
        }

        return ft;
    }

    @Nullable
    private TabInfo getTabInfoForTag(String tabId) {
        for (int i = 0, count = mTabs.size(); i < count; i++) {
            final TabInfo tab = mTabs.get(i);
            if (tab.tag.equals(tabId)) {
                return tab;
            }
        }
        return null;
    }
}