summaryrefslogtreecommitdiff
path: root/main/src/com/google/android/setupdesign/GlifPreferenceLayout.java
blob: 166254ccca885a69ba0ba5348a317cffca405513 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
 * Copyright (C) 2016 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 com.google.android.setupdesign;

import android.content.Context;
import android.os.Bundle;
import androidx.recyclerview.widget.RecyclerView;
import android.util.AttributeSet;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import com.google.android.setupdesign.template.RecyclerMixin;
import com.google.android.setupdesign.util.MessageWarning;

/**
 * A layout to be used with {@code PreferenceFragment} in v14 support library. This can be specified
 * as the {@code android:layout} in the {@code app:preferenceFragmentStyle} in {@code
 * app:preferenceTheme}.
 *
 * <p>Example:
 *
 * <pre>{@code
 * &lt;style android:name="MyActivityTheme">
 *     &lt;item android:name="preferenceTheme">@style/MyPreferenceTheme&lt;/item>
 * &lt;/style>
 *
 * &lt;style android:name="MyPreferenceTheme">
 *     &lt;item android:name="preferenceFragmentStyle">@style/MyPreferenceFragmentStyle&lt;/item>
 * &lt;/style>
 *
 * &lt;style android:name="MyPreferenceFragmentStyle">
 *     &lt;item android:name="android:layout">@layout/my_preference_layout&lt;/item>
 * &lt;/style>
 * }</pre>
 *
 * where {@code my_preference_layout} is a layout that contains {@link
 * com.google.android.setupdesign.GlifPreferenceLayout}.
 *
 * <p>Example:
 *
 * <pre>{@code
 * &lt;com.google.android.setupdesign.GlifPreferenceLayout
 *     xmlns:android="http://schemas.android.com/apk/res/android"
 *     android:id="@id/list_container"
 *     android:layout_width="match_parent"
 *     android:layout_height="match_parent" />
 * }</pre>
 *
 * <p>Fragments using this layout <em>must</em> delegate {@code onCreateRecyclerView} to the
 * implementation in this class: {@link #onCreateRecyclerView(android.view.LayoutInflater,
 * android.view.ViewGroup, android.os.Bundle)}
 */
public class GlifPreferenceLayout extends GlifRecyclerLayout {

  public GlifPreferenceLayout(Context context) {
    super(context);
  }

  public GlifPreferenceLayout(Context context, int template, int containerId) {
    super(context, template, containerId);
  }

  public GlifPreferenceLayout(Context context, AttributeSet attrs) {
    super(context, attrs);
  }

  public GlifPreferenceLayout(Context context, AttributeSet attrs, int defStyleAttr) {
    super(context, attrs, defStyleAttr);
  }

  @Override
  protected ViewGroup findContainer(int containerId) {
    if (containerId == 0) {
      containerId = R.id.sud_layout_content;
    }
    return super.findContainer(containerId);
  }

  /** This method must be called in {@code PreferenceFragment#onCreateRecyclerView}. */
  public RecyclerView onCreateRecyclerView(
      LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState) {
    return recyclerMixin.getRecyclerView();
  }

  @Override
  protected View onInflateTemplate(LayoutInflater inflater, int template) {
    if (template == 0) {
      // TODO : use "values-land-v31" folder for sud_glif_preference_template_s
      // directly.
      if (MessageWarning.isAtLeastS()) {
        template = R.layout.sud_glif_preference_template_s;
      } else {
        template = R.layout.sud_glif_preference_template;
      }
    }
    return super.onInflateTemplate(inflater, template);
  }

  @Override
  protected void onTemplateInflated() {
    // Inflate the recycler view here, so attributes on the decoration views can be applied
    // immediately.
    final LayoutInflater inflater = LayoutInflater.from(getContext());
    RecyclerView recyclerView;
    // TODO : use "layout-land-v31" folder for sud_glif_preference_recycler_view
    // directly.
    if (MessageWarning.isAtLeastS()) {
      recyclerView =
          (RecyclerView)
              inflater.inflate(R.layout.sud_glif_preference_recycler_view_s, this, false);
    } else {
      recyclerView =
          (RecyclerView) inflater.inflate(R.layout.sud_glif_preference_recycler_view, this, false);
    }
    recyclerMixin = new RecyclerMixin(this, recyclerView);
  }
}