{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}
class FragmentContainerView
FragmentContainerView is a customized Layout designed specifically for Fragments. It extends FrameLayout, so it can reliably handle Fragment Transactions, and it also has additional features to coordinate with fragment behavior.
FragmentContainerView should be used as the container for Fragments, commonly set in the xml layout of an activity, e.g.:
<androidx.fragment.app.FragmentContainerView xmlns:android="http://schemas.android.com/apk/res/android" xmlns:app="http://schemas.android.com/apk/res-auto" android:id="@+id/fragment_container_view" android:layout_width="match_parent" android:layout_height="match_parent"> </androidx.fragment.app.FragmentContainerView>
FragmentContainerView can also be used to add a Fragment by using the android:name
attribute. FragmentContainerView will perform a one time operation that:
Fragment#onInflate(Context, AttributeSet, Bundle)
You can optionally include an android:tag
which allows you to use FragmentManager#findFragmentByTag(String)
to retrieve the added Fragment.
<androidx.fragment.app.FragmentContainerView xmlns:android="http://schemas.android.com/apk/res/android" xmlns:app="http://schemas.android.com/apk/res-auto" android:id="@+id/fragment_container_view" android:layout_width="match_parent" android:layout_height="match_parent" android:name="com.example.MyFragment" android:tag="my_tag"> </androidx.fragment.app.FragmentContainerView>
FragmentContainerView should not be used as a replacement for other ViewGroups (FrameLayout, LinearLayout, etc) outside of Fragment use cases.
FragmentContainerView will only allow views returned by a Fragment's Fragment#onCreateView(LayoutInflater, ViewGroup, Bundle)
. Attempting to add any other view will result in an IllegalStateException
.
Layout animations and transitions are disabled for FragmentContainerView for APIs above 17. Otherwise, Animations should be done through FragmentTransaction#setCustomAnimations(int, int, int, int)
. If animateLayoutChanges is set to true
or setLayoutTransition
is called directly an UnsupportedOperationException
will be thrown.
Fragments using exit animations are drawn before all others for FragmentContainerView. This ensures that exiting Fragments do not appear on top of the view.
Public constructors |
|
---|---|
FragmentContainerView(context: Context) |
|
FragmentContainerView(context: Context, attrs: AttributeSet?) Do not call this constructor directly. |
|
FragmentContainerView( Do not call this constructor directly. |
Public functions |
|
---|---|
Unit |
FragmentContainerView will only allow views returned by a Fragment's |
Unit |
endViewTransition(view: View) |
WindowInsets |
onApplyWindowInsets(insets: WindowInsets) The sys ui flags must be set to enable extending the layout into the window insets. |
Unit |
|
Unit |
removeView(view: View) |
Unit |
removeViewAt(index: Int) |
Unit |
removeViewInLayout(view: View) |
Unit |
removeViews(start: Int, count: Int) |
Unit |
removeViewsInLayout(start: Int, count: Int) |
Unit |
setLayoutTransition(transition: LayoutTransition?) When called, this method throws a |
Unit |
startViewTransition(view: View) |
FragmentContainerView(context: Context, attrs: AttributeSet?)
Do not call this constructor directly. Doing so will result in an UnsupportedOperationException
.
FragmentContainerView(
context: Context,
attrs: AttributeSet?,
defStyleAttr: Int
)
Do not call this constructor directly. Doing so will result in an UnsupportedOperationException
.
fun addView(child: View, index: Int, params: LayoutParams?): Unit
FragmentContainerView will only allow views returned by a Fragment's Fragment#onCreateView(LayoutInflater, ViewGroup, Bundle)
. Attempting to add any other view will result in an IllegalStateException
.
fun onApplyWindowInsets(insets: WindowInsets): WindowInsets
The sys ui flags must be set to enable extending the layout into the window insets.
fun setLayoutTransition(transition: LayoutTransition?): Unit
When called, this method throws a UnsupportedOperationException
on APIs above 17. On APIs 17 and below, it calls FrameLayout#setLayoutTransition(LayoutTransition) This can be called either explicitly, or implicitly by setting animateLayoutChanges to true
.
View animations and transitions are disabled for FragmentContainerView for APIs above 17. Use FragmentTransaction#setCustomAnimations(int, int, int, int)
and FragmentTransaction#setTransition(int)
.
Parameters | |
---|---|
transition: LayoutTransition? |
The LayoutTransition object that will animated changes in layout. A value of |