public abstract class

LeanbackPreferenceFragment

extends BaseLeanbackPreferenceFragment

 java.lang.Object

↳android.app.Fragment

androidx.preference.PreferenceFragment

androidx.leanback.preference.BaseLeanbackPreferenceFragment

↳androidx.leanback.preference.LeanbackPreferenceFragment

Gradle dependencies

compile group: 'androidx.leanback', name: 'leanback-preference', version: '1.2.0-alpha02'

  • groupId: androidx.leanback
  • artifactId: leanback-preference
  • version: 1.2.0-alpha02

Artifact androidx.leanback:leanback-preference:1.2.0-alpha02 it located at Google repository (https://maven.google.com/)

Androidx artifact mapping:

androidx.leanback:leanback-preference com.android.support:preference-leanback-v17

Androidx class mapping:

androidx.leanback.preference.LeanbackPreferenceFragment android.support.v17.preference.LeanbackPreferenceFragment

Overview

This fragment provides a fully decorated leanback-style preference fragment, including a list background and header.

The following sample code shows a simple leanback preference fragment that is populated from a resource. The resource it loads is:

frameworks/support/samples/SupportPreferenceDemos/src/main/res/xml/preferences.xml preferences

The fragment needs only to implement PreferenceFragment.onCreatePreferences(Bundle, String) to populate the list of preference objects:

frameworks/support/samples/SupportPreferenceDemos/src/main/java/com/example/androidx/preference/LeanbackPreferences.java leanback_preferences

Summary

Fields
from PreferenceFragmentARG_PREFERENCE_ROOT
Constructors
publicLeanbackPreferenceFragment()

Methods
public ViewonCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

public voidonViewCreated(View view, Bundle savedInstanceState)

public voidsetTitle(java.lang.CharSequence title)

Set the title to be shown above the preference list

from BaseLeanbackPreferenceFragmentgetCallbackFragment, onCreateRecyclerView
from PreferenceFragmentaddPreferencesFromResource, findPreference, getListView, getPreferenceManager, getPreferenceScreen, onBindPreferences, onCreate, onCreateAdapter, onCreateLayoutManager, onCreatePreferences, onDestroyView, onDisplayPreferenceDialog, onNavigateToScreen, onPreferenceTreeClick, onSaveInstanceState, onStart, onStop, onUnbindPreferences, scrollToPreference, scrollToPreference, setDivider, setDividerHeight, setPreferenceScreen, setPreferencesFromResource
from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public LeanbackPreferenceFragment()

Methods

public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

public void onViewCreated(View view, Bundle savedInstanceState)

public void setTitle(java.lang.CharSequence title)

Set the title to be shown above the preference list

Parameters:

title: Title text to be shown

Source

/*
 * Copyright (C) 2015 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 androidx.leanback.preference;

import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.TextView;

/**
 * This fragment provides a fully decorated leanback-style preference fragment, including a
 * list background and header.
 *
 * <p>The following sample code shows a simple leanback preference fragment that is
 * populated from a resource.  The resource it loads is:</p>
 *
 * {@sample frameworks/support/samples/SupportPreferenceDemos/src/main/res/xml/preferences.xml preferences}
 *
 * <p>The fragment needs only to implement {@link #onCreatePreferences(Bundle, String)} to populate
 * the list of preference objects:</p>
 *
 * {@sample frameworks/support/samples/SupportPreferenceDemos/src/main/java/com/example/androidx/preference/LeanbackPreferences.java leanback_preferences}
 * @deprecated Use {@link LeanbackPreferenceFragmentCompat}
 */
@Deprecated
public abstract class LeanbackPreferenceFragment extends BaseLeanbackPreferenceFragment {

    public LeanbackPreferenceFragment() {
        LeanbackPreferenceFragmentTransitionHelperApi21.addTransitions(this);
    }

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
            Bundle savedInstanceState) {
        final View innerView = super.onCreateView(inflater, container, savedInstanceState);
        // parent class would create a themed context based the preferenceTheme attr.
        LayoutInflater themedInflater = LayoutInflater.from(innerView.getContext());
        final View view = themedInflater.inflate(R.layout.leanback_preference_fragment, container,
                false);
        final ViewGroup innerContainer = (ViewGroup) view.findViewById(R.id.main_frame);
        if (innerView != null) {
            innerContainer.addView(innerView);
        }
        return view;
    }

    @Override
    public void onViewCreated(View view, Bundle savedInstanceState) {
        super.onViewCreated(view, savedInstanceState);
        setTitle(getPreferenceScreen().getTitle());
    }

    /**
     * Set the title to be shown above the preference list
     * @param title Title text to be shown
     */
    public void setTitle(CharSequence title) {
        final View view = getView();
        final TextView decorTitle = view == null
                ? null : (TextView) view.findViewById(R.id.decor_title);
        if (decorTitle != null) {
            decorTitle.setText(title);
        }
    }
}