Google Git
Sign in
android / platform / tools / dokka-devsite-plugin / 9c09705e94665fe98274aed3547b89579188d4b3 / . / testData / fragment / docs / reference / androidx / fragment / app / FragmentStatePagerAdapter.html
blob: ecf57c0e3e067fa970fbd7950afa825cfd0654d0 [file] [log] [blame]
<html devsite="true">
<head>
<title>FragmentStatePagerAdapter</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div itemscope="" itemtype="http://developers.google.com/ReferenceObject">
<meta itemprop="name" content="FragmentStatePagerAdapter">
<meta itemprop="path" content="androidx.fragment.app">
<meta itemprop="property" content="destroyItem(android.view.ViewGroup,int,java.lang.Object)">
<meta itemprop="property" content="finishUpdate(android.view.ViewGroup)">
<meta itemprop="property" content="getItem(int)">
<meta itemprop="property" content="instantiateItem(android.view.ViewGroup,int)">
<meta itemprop="property" content="isViewFromObject(android.view.View,java.lang.Object)">
<meta itemprop="property" content="restoreState(android.os.Parcelable,java.lang.ClassLoader)">
<meta itemprop="property" content="saveState()">
<meta itemprop="property" content="setPrimaryItem(android.view.ViewGroup,int,java.lang.Object)">
<meta itemprop="property" content="startUpdate(android.view.ViewGroup)">
<meta itemprop="property" content="BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()">
<meta itemprop="property" content="BEHAVIOR_SET_USER_VISIBLE_HINT()">
<meta itemprop="language" content="JAVA">
</div>
<div id="header-block">
<div>
<h1>FragmentStatePagerAdapter</h1>
</div>
<div id="metadata-info-block">
<div id="source-link"><a href="https://cs.android.com/search?q=file:androidx/fragment/app/FragmentStatePagerAdapter.java+class:androidx.fragment.app.FragmentStatePagerAdapter&amp;ss=androidx/platform/frameworks/support" class="external">View Source</a></div>
<div id="version-metadata">
<div id="added-in">Added in 1.1.0</div>
<div id="deprecated-in">Deprecated in 1.3.0</div>
</div>
</div>
</div>
<div id="refdoc-switcher-placeholder"></div>
<p>
<pre>public abstract class <a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html">FragmentStatePagerAdapter</a> extends <a href="/reference/androidx/viewpager/widget/PagerAdapter.html">PagerAdapter</a></pre>
</p>
<div class="devsite-table-wrapper">
<table class="jd-inheritance-table">
<tbody>
<tr>
<td colspan="3"><a href="https://developer.android.com/reference/java/lang/Object.html">java.lang.Object</a></td>
</tr>
<tr>
<td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;↳</td>
<td colspan="2"><a href="/reference/androidx/viewpager/widget/PagerAdapter.html">androidx.viewpager.widget.PagerAdapter</a></td>
</tr>
<tr>
<td>&nbsp;</td>
<td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;↳</td>
<td colspan="1"><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html">androidx.fragment.app.FragmentStatePagerAdapter</a></td>
</tr>
</tbody>
</table>
</div>
<hr>
<aside class="caution"><strong>This class is deprecated.</strong><br>
<p>Switch to androidx.viewpager2.widget.ViewPager2 and use androidx.viewpager2.adapter.FragmentStateAdapter instead.</p>
</aside>
<p>Implementation of <code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html">PagerAdapter</a></code> that uses a <code><a href="/reference/androidx/fragment/app/Fragment.html">Fragment</a></code> to manage each page. This class also handles saving and restoring of fragment's state. </p>
<p>This version of the pager is more useful when there are a large number of pages, working more like a list view. When pages are not visible to the user, their entire fragment may be destroyed, only keeping the saved state of that fragment. This allows the pager to hold on to much less memory associated with each visited page as compared to <code><a href="/reference/androidx/fragment/app/FragmentPagerAdapter.html">FragmentPagerAdapter</a></code> at the cost of potentially more overhead when switching between pages. </p>
<p>When using FragmentPagerAdapter the host ViewPager must have a valid ID set.</p>
<p>Subclasses only need to implement <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#getItem(int)">getItem</a></code> and <code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#getCount()">getCount</a></code> to have a working adapter. </p>
Here is an example implementation of a pager containing fragments of lists:
<pre class="prettyprint lang-java">
public class FragmentStatePagerSupport extends FragmentActivity {
static final int NUM_ITEMS = 10;
MyAdapter mAdapter;
ViewPager mPager;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.fragment_pager);
mAdapter = new MyAdapter(getSupportFragmentManager());
mPager = (ViewPager)findViewById(R.id.pager);
mPager.setAdapter(mAdapter);
// Watch for button clicks.
Button button = (Button)findViewById(R.id.goto_first);
button.setOnClickListener(new OnClickListener() {
@Override
public void onClick(View v) {
mPager.setCurrentItem(0);
}
});
button = (Button)findViewById(R.id.goto_last);
button.setOnClickListener(new OnClickListener() {
@Override
public void onClick(View v) {
mPager.setCurrentItem(NUM_ITEMS-1);
}
});
}
public static class MyAdapter extends FragmentStatePagerAdapter {
public MyAdapter(FragmentManager fm) {
super(fm, BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT);
}
@Override
public int getCount() {
return NUM_ITEMS;
}
@Override
public Fragment getItem(int position) {
return ArrayListFragment.newInstance(position);
}
}
public static class ArrayListFragment extends ListFragment {
int mNum;
/**
* Create a new instance of CountingFragment, providing &quot;num&quot;
* as an argument.
*/
static ArrayListFragment newInstance(int num) {
ArrayListFragment f = new ArrayListFragment();
// Supply num input as an argument.
Bundle args = new Bundle();
args.putInt(&quot;num&quot;, num);
f.setArguments(args);
return f;
}
/**
* When creating, retrieve this instance's number from its arguments.
*/
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mNum = getArguments() != null ? getArguments().getInt(&quot;num&quot;) : 1;
}
/**
* The Fragment's UI is just a simple text view showing its
* instance number.
*/
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
View v = inflater.inflate(R.layout.fragment_pager_list, container, false);
View tv = v.findViewById(R.id.text);
((TextView)tv).setText(&quot;Fragment #&quot; + mNum);
return v;
}
@Override
public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
super.onViewCreated(view, savedInstanceState);
setListAdapter(new ArrayAdapter&lt;String&gt;(getActivity(),
android.R.layout.simple_list_item_1, Cheeses.sCheeseStrings));
}
@Override
public void onListItemClick(ListView l, View v, int position, long id) {
Log.i(&quot;FragmentList&quot;, &quot;Item clicked: &quot; + id);
}
}
}
</pre>
The <code>R.layout.fragment_pager</code>resource of the top-level fragment is:
<pre class="prettyprint lang-xml">
&lt;LinearLayout xmlns:android=&quot;http://schemas.android.com/apk/res/android&quot;
android:orientation=&quot;vertical&quot; android:padding=&quot;4dip&quot;
android:gravity=&quot;center_horizontal&quot;
android:layout_width=&quot;match_parent&quot; android:layout_height=&quot;match_parent&quot;&gt;
&lt;androidx.viewpager.widget.ViewPager
android:id=&quot;@+id/pager&quot;
android:layout_width=&quot;match_parent&quot;
android:layout_height=&quot;0px&quot;
android:layout_weight=&quot;1&quot;&gt;
&lt;/androidx.viewpager.widget.ViewPager&gt;
&lt;LinearLayout android:orientation=&quot;horizontal&quot;
android:gravity=&quot;center&quot; android:measureWithLargestChild=&quot;true&quot;
android:layout_width=&quot;match_parent&quot; android:layout_height=&quot;wrap_content&quot;
android:layout_weight=&quot;0&quot;&gt;
&lt;Button android:id=&quot;@+id/goto_first&quot;
android:layout_width=&quot;wrap_content&quot; android:layout_height=&quot;wrap_content&quot;
android:text=&quot;@string/first&quot;&gt;
&lt;/Button&gt;
&lt;Button android:id=&quot;@+id/goto_last&quot;
android:layout_width=&quot;wrap_content&quot; android:layout_height=&quot;wrap_content&quot;
android:text=&quot;@string/last&quot;&gt;
&lt;/Button&gt;
&lt;/LinearLayout&gt;
&lt;/LinearLayout&gt;
</pre>
The <code>R.layout.fragment_pager_list</code>resource containing each individual fragment's layout is:
<pre class="prettyprint lang-xml">
&lt;LinearLayout xmlns:android=&quot;http://schemas.android.com/apk/res/android&quot;
android:orientation=&quot;vertical&quot;
android:layout_width=&quot;match_parent&quot;
android:layout_height=&quot;match_parent&quot;
android:background=&quot;@android:drawable/gallery_thumb&quot;&gt;
&lt;TextView android:id=&quot;@+id/text&quot;
android:layout_width=&quot;match_parent&quot; android:layout_height=&quot;wrap_content&quot;
android:gravity=&quot;center_vertical|center_horizontal&quot;
android:textAppearance=&quot;?android:attr/textAppearanceMedium&quot;
android:text=&quot;@string/hello_world&quot;/&gt;
&lt;!-- The frame layout is here since we will be showing either
the empty view or the list view. --&gt;
&lt;FrameLayout
android:layout_width=&quot;match_parent&quot;
android:layout_height=&quot;0dip&quot;
android:layout_weight=&quot;1&quot; &gt;
&lt;!-- Here is the list. Since we are using a ListActivity, we
have to call it &quot;@android:id/list&quot; so ListActivity will
find it --&gt;
&lt;ListView android:id=&quot;@android:id/list&quot;
android:layout_width=&quot;match_parent&quot;
android:layout_height=&quot;match_parent&quot;
android:drawSelectorOnTop=&quot;false&quot;/&gt;
&lt;!-- Here is the view to show if the list is empty --&gt;
&lt;TextView android:id=&quot;@android:id/empty&quot;
android:layout_width=&quot;match_parent&quot;
android:layout_height=&quot;match_parent&quot;
android:textAppearance=&quot;?android:attr/textAppearanceMedium&quot;
android:text=&quot;No items.&quot;/&gt;
&lt;/FrameLayout&gt;
&lt;/LinearLayout&gt;
</pre>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Constants</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>static&nbsp;final int</code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()">BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT</a> = 1</code></div>
<p>Indicates that only the current fragment will be in the <code><a href="/reference/androidx/lifecycle/Lifecycle.State.RESUMED.html">RESUMED</a></code> state.</p>
</td>
</tr>
<tr>
<td><code>static&nbsp;final int</code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_SET_USER_VISIBLE_HINT()">BEHAVIOR_SET_USER_VISIBLE_HINT</a> = 0</code></div>
<p><strong>This field is deprecated.</strong>
<p>This behavior relies on the deprecated <code><a href="/reference/androidx/fragment/app/Fragment.html#setUserVisibleHint(boolean)">setUserVisibleHint</a></code> API.</p>
</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public constructors</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code><span><del><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager)">FragmentStatePagerAdapter</a></del></span>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/fragment/app/FragmentManager.html">FragmentManager</a>&nbsp;fm)</code></div>
<p><strong>This method is deprecated.</strong>
<p>use <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager,int)">FragmentStatePagerAdapter</a></code> with <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()">BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT</a></code></p>
</p>
</td>
</tr>
<tr>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager,int)">FragmentStatePagerAdapter</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/fragment/app/FragmentManager.html">FragmentManager</a>&nbsp;fm,&nbsp;int&nbsp;behavior)</code></div>
<p>Constructor for <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html">FragmentStatePagerAdapter</a></code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>void</code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#destroyItem(android.view.ViewGroup,int,java.lang.Object)">destroyItem</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;position,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;object<br>)</code></div>
</td>
</tr>
<tr>
<td><code>void</code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#finishUpdate(android.view.ViewGroup)">finishUpdate</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container)</code></div>
</td>
</tr>
<tr>
<td><code>abstract @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/fragment/app/Fragment.html">Fragment</a></code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#getItem(int)">getItem</a>(int&nbsp;position)</code></div>
<p>Return the Fragment associated with a specified position.</p>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a></code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#instantiateItem(android.view.ViewGroup,int)">instantiateItem</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container,&nbsp;int&nbsp;position)</code></div>
</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#isViewFromObject(android.view.View,java.lang.Object)">isViewFromObject</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/View.html">View</a>&nbsp;view,&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;object)</code></div>
</td>
</tr>
<tr>
<td><code>void</code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#restoreState(android.os.Parcelable,java.lang.ClassLoader)">restoreState</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/android/os/Parcelable.html">Parcelable</a>&nbsp;state,&nbsp;@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/ClassLoader.html">ClassLoader</a>&nbsp;loader)</code></div>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/android/os/Parcelable.html">Parcelable</a></code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#saveState()">saveState</a>()</code></div>
</td>
</tr>
<tr>
<td><code>void</code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#setPrimaryItem(android.view.ViewGroup,int,java.lang.Object)">setPrimaryItem</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;position,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;object<br>)</code></div>
</td>
</tr>
<tr>
<td><code>void</code></td>
<td>
<div><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#startUpdate(android.view.ViewGroup)">startUpdate</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive" id="inhmethods">
<thead>
<tr>
<th colspan="100%"><h3>Inherited Constants</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><devsite-expandable><span class="expand-control">From <a href="/reference/androidx/viewpager/widget/PagerAdapter.html">androidx.viewpager.widget.PagerAdapter</a></span>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<tbody class="list">
<tr>
<td><code>static&nbsp;final int</code></td>
<td>
<div><code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#POSITION_NONE()">POSITION_NONE</a> = -2</code></div>
</td>
</tr>
<tr>
<td><code>static&nbsp;final int</code></td>
<td>
<div><code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#POSITION_UNCHANGED()">POSITION_UNCHANGED</a> = -1</code></div>
</td>
</tr>
</tbody>
</table>
</div>
</devsite-expandable> </td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive" id="inhmethods">
<thead>
<tr>
<th colspan="100%"><h3>Inherited methods</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><devsite-expandable><span class="expand-control">From <a href="/reference/androidx/viewpager/widget/PagerAdapter.html">androidx.viewpager.widget.PagerAdapter</a></span>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<tbody class="list">
<tr>
<td><code>abstract int</code></td>
<td>
<div><code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#getCount()">getCount</a>()</code></div>
</td>
</tr>
<tr>
<td><code>int</code></td>
<td>
<div><code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#getItemPosition(java.lang.Object)">getItemPosition</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;object)</code></div>
</td>
</tr>
<tr>
<td><code><a href="https://developer.android.com/reference/java/lang/CharSequence.html">CharSequence</a></code></td>
<td>
<div><code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#getPageTitle(int)">getPageTitle</a>(int&nbsp;position)</code></div>
</td>
</tr>
<tr>
<td><code>float</code></td>
<td>
<div><code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#getPageWidth(int)">getPageWidth</a>(int&nbsp;position)</code></div>
</td>
</tr>
<tr>
<td><code>void</code></td>
<td>
<div><code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#notifyDataSetChanged()">notifyDataSetChanged</a>()</code></div>
</td>
</tr>
<tr>
<td><code>void</code></td>
<td>
<div><code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#registerDataSetObserver(android.database.DataSetObserver)">registerDataSetObserver</a>(<a href="https://developer.android.com/reference/android/database/DataSetObserver.html">DataSetObserver</a>&nbsp;observer)</code></div>
</td>
</tr>
<tr>
<td><code>void</code></td>
<td>
<div><code><a href="/reference/androidx/viewpager/widget/PagerAdapter.html#unregisterDataSetObserver(android.database.DataSetObserver)">unregisterDataSetObserver</a>(<a href="https://developer.android.com/reference/android/database/DataSetObserver.html">DataSetObserver</a>&nbsp;observer)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
</devsite-expandable> </td>
</tr>
</tbody>
</table>
</div>
<div class="list">
<h2>Constants</h2>
<div class="api-item"><a name="getBEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()"></a><a name="setBEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()"></a><a name="getBEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT--"></a><a name="setBEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT--"></a>
<div class="api-name-block">
<div>
<h3 id="BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()">BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.1.0</div>
<div id="deprecated-in">Deprecated in 1.3.0</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;int&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()">BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT</a> = 1</pre>
<p>Indicates that only the current fragment will be in the <code><a href="/reference/androidx/lifecycle/Lifecycle.State.RESUMED.html">RESUMED</a></code> state. All other Fragments are capped at <code><a href="/reference/androidx/lifecycle/Lifecycle.State.STARTED.html">STARTED</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">See also</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager,int)">FragmentStatePagerAdapter</a></code></td>
<td></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="api-item"><a name="getBEHAVIOR_SET_USER_VISIBLE_HINT()"></a><a name="setBEHAVIOR_SET_USER_VISIBLE_HINT()"></a><a name="getBEHAVIOR_SET_USER_VISIBLE_HINT--"></a><a name="setBEHAVIOR_SET_USER_VISIBLE_HINT--"></a>
<div class="api-name-block">
<div>
<h3 id="BEHAVIOR_SET_USER_VISIBLE_HINT()">BEHAVIOR_SET_USER_VISIBLE_HINT</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.1.0</div>
<div id="deprecated-in">Deprecated in 1.1.0</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;int&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_SET_USER_VISIBLE_HINT()">BEHAVIOR_SET_USER_VISIBLE_HINT</a> = 0</pre>
<aside class="caution"><strong>This field is deprecated.</strong><br>
<p>This behavior relies on the deprecated <code><a href="/reference/androidx/fragment/app/Fragment.html#setUserVisibleHint(boolean)">setUserVisibleHint</a></code> API. Use <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()">BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT</a></code> to switch to its replacement, <code><a href="/reference/androidx/fragment/app/FragmentTransaction.html#setMaxLifecycle(androidx.fragment.app.Fragment,androidx.lifecycle.Lifecycle.State)">setMaxLifecycle</a></code>.</p>
</aside>
<p>Indicates that <code><a href="/reference/androidx/fragment/app/Fragment.html#setUserVisibleHint(boolean)">setUserVisibleHint</a></code> will be called when the current fragment changes.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">See also</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager,int)">FragmentStatePagerAdapter</a></code></td>
<td></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="FragmentStatePagerAdapter-androidx.fragment.app.FragmentManager-"></a><a name="fragmentstatepageradapter"></a>
<div class="api-name-block">
<div>
<h3 id="FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager)">FragmentStatePagerAdapter</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.1.0</div>
<div id="deprecated-in">Deprecated in 1.1.0</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;<span><del><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager)">FragmentStatePagerAdapter</a></del></span>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/fragment/app/FragmentManager.html">FragmentManager</a>&nbsp;fm)</pre>
<aside class="caution"><strong>This method is deprecated.</strong><br>
<p>use <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager,int)">FragmentStatePagerAdapter</a></code> with <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()">BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT</a></code></p>
</aside>
<p>Constructor for <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html">FragmentStatePagerAdapter</a></code> that sets the fragment manager for the adapter. This is the equivalent of calling <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager,int)">FragmentStatePagerAdapter</a></code> and passing in <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_SET_USER_VISIBLE_HINT()">BEHAVIOR_SET_USER_VISIBLE_HINT</a></code>. </p>
<p>Fragments will have <code><a href="/reference/androidx/fragment/app/Fragment.html#setUserVisibleHint(boolean)">setUserVisibleHint</a></code> called whenever the current Fragment changes.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/fragment/app/FragmentManager.html">FragmentManager</a>&nbsp;fm</code></td>
<td>
<p>fragment manager that will interact with this adapter</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="api-item"><a name="FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager, int)"></a><a name="FragmentStatePagerAdapter-androidx.fragment.app.FragmentManager-int-"></a><a name="fragmentstatepageradapter"></a>
<div class="api-name-block">
<div>
<h3 id="FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager,int)">FragmentStatePagerAdapter</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.1.0</div>
<div id="deprecated-in">Deprecated in 1.3.0</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#FragmentStatePagerAdapter(androidx.fragment.app.FragmentManager,int)">FragmentStatePagerAdapter</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/fragment/app/FragmentManager.html">FragmentManager</a>&nbsp;fm,&nbsp;int&nbsp;behavior)</pre>
<p>Constructor for <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html">FragmentStatePagerAdapter</a></code>. If <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT()">BEHAVIOR_RESUME_ONLY_CURRENT_FRAGMENT</a></code> is passed in, then only the current Fragment is in the <code><a href="/reference/androidx/lifecycle/Lifecycle.State.RESUMED.html">RESUMED</a></code> state, while all other fragments are capped at <code><a href="/reference/androidx/lifecycle/Lifecycle.State.STARTED.html">STARTED</a></code>. If <code><a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#BEHAVIOR_SET_USER_VISIBLE_HINT()">BEHAVIOR_SET_USER_VISIBLE_HINT</a></code> is passed, all fragments are in the <code><a href="/reference/androidx/lifecycle/Lifecycle.State.RESUMED.html">RESUMED</a></code> state and there will be callbacks to <code><a href="/reference/androidx/fragment/app/Fragment.html#setUserVisibleHint(boolean)">setUserVisibleHint</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/fragment/app/FragmentManager.html">FragmentManager</a>&nbsp;fm</code></td>
<td>
<p>fragment manager that will interact with this adapter</p>
</td>
</tr>
<tr>
<td><code>int&nbsp;behavior</code></td>
<td>
<p>determines if only current fragments are in a resumed state</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="list">
<h2>Public methods</h2>
<div class="api-item"><a name="destroyItem(android.view.ViewGroup, int, java.lang.Object)"></a><a name="destroyItem-android.view.ViewGroup-int-java.lang.Object-"></a><a name="destroyitem"></a>
<div class="api-name-block">
<div>
<h3 id="destroyItem(android.view.ViewGroup,int,java.lang.Object)">destroyItem</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.7.0-alpha02</div>
<div id="deprecated-in">Deprecated in 1.7.0-alpha02</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;void&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#destroyItem(android.view.ViewGroup,int,java.lang.Object)">destroyItem</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;position,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;object<br>)</pre>
</div>
<div class="api-item"><a name="finishUpdate-android.view.ViewGroup-"></a><a name="finishupdate"></a>
<div class="api-name-block">
<div>
<h3 id="finishUpdate(android.view.ViewGroup)">finishUpdate</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.7.0-alpha02</div>
<div id="deprecated-in">Deprecated in 1.7.0-alpha02</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;void&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#finishUpdate(android.view.ViewGroup)">finishUpdate</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container)</pre>
</div>
<div class="api-item"><a name="getItem-int-"></a><a name="getitem"></a>
<div class="api-name-block">
<div>
<h3 id="getItem(int)">getItem</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.1.0</div>
<div id="deprecated-in">Deprecated in 1.3.0</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;abstract&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/fragment/app/Fragment.html">Fragment</a>&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#getItem(int)">getItem</a>(int&nbsp;position)</pre>
<p>Return the Fragment associated with a specified position.</p>
</div>
<div class="api-item"><a name="instantiateItem(android.view.ViewGroup, int)"></a><a name="instantiateItem-android.view.ViewGroup-int-"></a><a name="instantiateitem"></a>
<div class="api-name-block">
<div>
<h3 id="instantiateItem(android.view.ViewGroup,int)">instantiateItem</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.7.0-alpha02</div>
<div id="deprecated-in">Deprecated in 1.7.0-alpha02</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#instantiateItem(android.view.ViewGroup,int)">instantiateItem</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container,&nbsp;int&nbsp;position)</pre>
</div>
<div class="api-item"><a name="isViewFromObject(android.view.View, java.lang.Object)"></a><a name="isViewFromObject-android.view.View-java.lang.Object-"></a><a name="isviewfromobject"></a>
<div class="api-name-block">
<div>
<h3 id="isViewFromObject(android.view.View,java.lang.Object)">isViewFromObject</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.1.0</div>
<div id="deprecated-in">Deprecated in 1.3.0</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;boolean&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#isViewFromObject(android.view.View,java.lang.Object)">isViewFromObject</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/View.html">View</a>&nbsp;view,&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;object)</pre>
</div>
<div class="api-item"><a name="restoreState(android.os.Parcelable, java.lang.ClassLoader)"></a><a name="restoreState-android.os.Parcelable-java.lang.ClassLoader-"></a><a name="restorestate"></a>
<div class="api-name-block">
<div>
<h3 id="restoreState(android.os.Parcelable,java.lang.ClassLoader)">restoreState</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.7.0-alpha02</div>
<div id="deprecated-in">Deprecated in 1.7.0-alpha02</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;void&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#restoreState(android.os.Parcelable,java.lang.ClassLoader)">restoreState</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/android/os/Parcelable.html">Parcelable</a>&nbsp;state,&nbsp;@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/java/lang/ClassLoader.html">ClassLoader</a>&nbsp;loader)</pre>
</div>
<div class="api-item"><a name="saveState--"></a><a name="savestate"></a>
<div class="api-name-block">
<div>
<h3 id="saveState()">saveState</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.7.0-alpha02</div>
<div id="deprecated-in">Deprecated in 1.7.0-alpha02</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/android/os/Parcelable.html">Parcelable</a>&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#saveState()">saveState</a>()</pre>
</div>
<div class="api-item"><a name="setPrimaryItem(android.view.ViewGroup, int, java.lang.Object)"></a><a name="setPrimaryItem-android.view.ViewGroup-int-java.lang.Object-"></a><a name="setprimaryitem"></a>
<div class="api-name-block">
<div>
<h3 id="setPrimaryItem(android.view.ViewGroup,int,java.lang.Object)">setPrimaryItem</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.7.0-alpha02</div>
<div id="deprecated-in">Deprecated in 1.7.0-alpha02</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;void&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#setPrimaryItem(android.view.ViewGroup,int,java.lang.Object)">setPrimaryItem</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;position,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;object<br>)</pre>
</div>
<div class="api-item"><a name="startUpdate-android.view.ViewGroup-"></a><a name="startupdate"></a>
<div class="api-name-block">
<div>
<h3 id="startUpdate(android.view.ViewGroup)">startUpdate</h3>
</div>
<div id="metadata-info-block">
<div id="version-metadata">
<div id="added-in">Added in 1.7.0-alpha02</div>
<div id="deprecated-in">Deprecated in 1.7.0-alpha02</div>
</div>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;void&nbsp;<a href="/reference/androidx/fragment/app/FragmentStatePagerAdapter.html#startUpdate(android.view.ViewGroup)">startUpdate</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/android/view/ViewGroup.html">ViewGroup</a>&nbsp;container)</pre>
</div>
</div>
</body>
</html>