AppBarLayout は、垂直方向の LinearLayout であり、Material Design のデザインガイドラインに準拠したステータスバーの機能を実装しています。例えば、スクロールジェスチャーなどです。
通常、AppBarLayout は CoordinatorLayout の直接の子要素として使用されます。もし AppBarLayout が他のレイアウト内で使用される場合、そのほとんどの機能は無効になります。AppBarLayout はスクロールビューがいつスクロールするかを知るために、識別子が必要です。この識別子は、AppBarLayout.ScrollingViewBehavior クラスをバインドすることで行われます。つまり、スクロールビューの動作を AppBarLayout.ScrollingViewBehavior のインスタンスに設定する必要があります。具体的には、完全なクラス名を含む文字列リソースを設定します。以下のようになります:
//layout_behavior属性を設定する
<android.support.v4.widget.NestedScrollView
android:layout_width="match_parent"
android:layout_height="match_parent"
app:layout_behavior="@string/appbar_scrolling_view_behavior">
<!-- スクロールするコンテンツ -->
</android.support.v4.widget.NestedScrollView>
AppBarLayout の子ビューは、スクロール可能な動作を設定する必要があります。これは、コードと XML 属性の両方で設定できます。具体的には以下のようになります:
//コード
setScrollFlags(int)
//XML属性
app:layout_scrollFlags
layout_scrollFlags 属性は、AppBarLayout の子ビューがスクロールジェスチャーが変化したときにどのような動作を実行するかを指定します。layout_scrollFlags 属性には 5 つの値があります:
- scroll
- enterAlways
- enterAlwaysCollapsed
- exitUntilCollapsed
- snap
これらの属性値の効果を説明する前に、以下のレイアウト効果を例に説明します。レイアウトは次のようになります:
<?xml version="1.0" encoding="utf-8"?>
<android.support.design.widget.CoordinatorLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context="com.manu.materialdesignsamples.samples.SampleCoordinatorAppBarActivity">
<!--AppBarLayoutの子ビューにlayout_scrollFlags属性を設定する-->
<android.support.design.widget.AppBarLayout
android:id="@+id/ablBar"
android:layout_width="match_parent"
android:layout_height="wrap_content">
<android.support.v7.widget.Toolbar
android:id="@+id/toolbar"
android:layout_width="match_parent"
android:layout_height="70dp"
android:minHeight="?attr/actionBarSize"
app:layout_scrollFlags="scroll">
</android.support.v7.widget.Toolbar>
</android.support.design.widget.AppBarLayout>
<!--NestedScrollViewにlayout_behavior属性を設定する-->
<android.support.v4.widget.NestedScrollView
android:layout_width="match_parent"
android:layout_height="match_parent"
app:layout_behavior="@string/appbar_scrolling_view_behavior">
<android.support.v7.widget.RecyclerView
android:id="@+id/rvAppBarData"
android:clipToPadding="true"
android:layout_width="match_parent"
android:layout_height="wrap_content"/>
</android.support.v4.widget.NestedScrollView>
</android.support.design.widget.CoordinatorLayout>
scroll: layout_scrollFlags 属性を次のように設定すると:
app:layout_scrollFlags="scroll"
上スワイプすると、まず AppBarLayout が非表示になり、その後スクロールが開始されます。下スワイプすると、スクロールビューのトップが表示されるまで AppBarLayout は表示されません。効果は以下のようになります:
enterAlways: enterAlways は、scroll と組み合わせて使用する必要があります。layout_scrollFlags 属性を次のように設定すると:
app:layout_scrollFlags="scroll|enterAlways"
上スワイプすると、まず AppBarLayout が非表示になり、その後スクロールが開始されます。下スワイプすると、まず AppBarLayout が表示され、その後スクロールが開始されます。効果は以下のようになります:
enterAlwaysCollapsed: enterAlwaysCollapsed 属性値を使用する場合、scroll と enterAlways と組み合わせて使用する必要があります。さらに、AppBarLayout の子ビュー(ここでは Toolbar)に最小の高さを設定して、enterAlwaysCollapsed の機能をサポートする必要があります。layout_scrollFlags 属性を次のように設定すると:
app:layout_scrollFlags="scroll|enterAlways|enterAlwaysCollapsed"
上スワイプすると、まず AppBarLayout が非表示になり、その後スクロールが開始されます。下スワイプすると、AppBarLayout は最初に子ビューの最小の高さを表示し、その後スクロールビューのトップが表示されるまで AppBarLayout が完全に表示されます。効果は以下のようになります:
exitUntilCollapsed: exitUntilCollapsed 属性値を使用する場合、scroll と組み合わせて使用する必要があります。さらに、AppBarLayout の子ビュー(ここでは Toolbar)に最小の高さを設定して、exitUntilCollapsed の機能をサポートする必要があります。layout_scrollFlags 属性を次のように設定すると:
app:layout_scrollFlags="scroll|exitUntilCollapsed"
上スワイプすると、まず AppBarLayout が最小の高さまで非表示になり、その後スクロールが開始されます。下スワイプすると、スクロールビューのトップが表示されるまで AppBarLayout が表示されません。効果は以下のようになります:
snap: snap 属性値を使用する場合、scroll と組み合わせて使用する必要があります。主な目的は、スクロールが終了したときに、伸縮ビューが部分的に表示されている場合、自動的に最も近いエッジまでスクロールすることです。layout_scrollFlags 属性を次のように設定すると:
app:layout_scrollFlags="scroll|snap"
伸縮ビュー(ここでは Toolbar)が部分的に表示されている場合、伸縮ビューは自動的に最も近いエッジまでスクロールされます。つまり、非表示または表示されます。効果は以下のようになります:
layout_scrollFlags 属性については以上です。もちろん、上記は属性値の効果を説明するためのものであり、CollapsingToolbarLayout などの他の Material Design の実装と組み合わせて、さらにクールな効果を実現することができます。上記はレイアウトファイルで layout_scrollFlags 属性を設定する方法について説明しましたが、コードで layout_scrollFlags 属性を設定する方法についても説明します。具体的には以下のようになります:
AppBarLayout.LayoutParams params = (AppBarLayout.LayoutParams) appBarLayout
.getChildAt(0).getLayoutParams();
//上スワイプすると、まずAppBarLayoutが非表示になり、その後スクロールが開始されます。下スワイプすると、まずAppBarLayoutが表示され、その後スクロールが開始されます。
params.setScrollFlags(
AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL |
AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS);
//...
AppBarLayout の使用方法と重要な属性について説明しました。実際の開発ではもっと複雑になるでしょうが、上記の内容がお役に立てれば幸いです。良い週末をお過ごしください。