src.com.android.setupwizardlib.SetupWizardPreferenceLayout Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-all Show documentation
A library jar that provides APIs for Applications written for the Google Android Platform.
There is a newer version: 15-robolectric-12650502
/*
 * 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.android.setupwizardlib;

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.android.setupwizardlib.template.RecyclerMixin;

/**
 * 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}.
 *
 * Example:
 *
 * 
{@code
 * <style android:name="MyActivityTheme">
 *     <item android:name="preferenceTheme">@style/MyPreferenceTheme</item>
 * </style>
 *
 * <style android:name="MyPreferenceTheme">
 *     <item android:name="preferenceFragmentStyle">@style/MyPreferenceFragmentStyle</item>
 * </style>
 *
 * <style android:name="MyPreferenceFragmentStyle">
 *     <item android:name="android:layout">@layout/my_preference_layout</item>
 * </style>
 * }
 *
 * where {@code my_preference_layout} is a layout that contains {@link
 * com.android.setupwizardlib.SetupWizardPreferenceLayout}.
 *
 * Example:
 *
 * 
{@code
 * <com.android.setupwizardlib.SetupWizardPreferenceLayout
 *     xmlns:android="http://schemas.android.com/apk/res/android"
 *     android:id="@id/list_container"
 *     android:layout_width="match_parent"
 *     android:layout_height="match_parent" />
 * }
 *
 * Fragments using this layout must delegate {@code onCreateRecyclerView} to the
 * implementation in this class: {@link #onCreateRecyclerView}
 */
public class SetupWizardPreferenceLayout extends SetupWizardRecyclerLayout {

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

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

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

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

  @Override
  protected ViewGroup findContainer(int containerId) {
    if (containerId == 0) {
      containerId = R.id.suw_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 mRecyclerMixin.getRecyclerView();
  }

  @Override
  protected View onInflateTemplate(LayoutInflater inflater, int template) {
    if (template == 0) {
      template = R.layout.suw_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 =
        (RecyclerView) inflater.inflate(R.layout.suw_preference_recycler_view, this, false);
    mRecyclerMixin = new RecyclerMixin(this, recyclerView);
  }
}