public abstract class

BaseLeanbackPreferenceFragment

extends PreferenceFragment

 java.lang.Object

↳android.app.Fragment

androidx.preference.PreferenceFragment

↳androidx.leanback.preference.BaseLeanbackPreferenceFragment

Subclasses:

LeanbackPreferenceFragment

Gradle dependencies

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

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

Artifact androidx.leanback:leanback-preference:1.2.0-alpha04 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.BaseLeanbackPreferenceFragment android.support.v17.preference.BaseLeanbackPreferenceFragment

Overview

This fragment provides a preference fragment with leanback-style behavior, suitable for embedding into broader UI elements.

Summary

Fields
from PreferenceFragmentARG_PREFERENCE_ROOT
Constructors
publicBaseLeanbackPreferenceFragment()

Methods
public android.app.FragmentgetCallbackFragment()

A wrapper for getParentFragment which is v17+.

public RecyclerViewonCreateRecyclerView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState)

Creates the RecyclerView used to display the preferences.

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

Constructors

public BaseLeanbackPreferenceFragment()

Methods

public RecyclerView onCreateRecyclerView(LayoutInflater inflater, ViewGroup parent, Bundle savedInstanceState)

Deprecated: Use PreferenceFragmentCompat instead

Creates the RecyclerView used to display the preferences. Subclasses may override this to return a customized RecyclerView.

Parameters:

inflater: The LayoutInflater object that can be used to inflate the RecyclerView.
parent: The parent view that the RecyclerView will be attached to. This method should not add the view itself, but this can be used to generate the layout params of the view.
savedInstanceState: If non-null, this view is being re-constructed from a previous saved state as given here.

Returns:

A new RecyclerView object to be placed into the view hierarchy

public android.app.Fragment getCallbackFragment()

A wrapper for getParentFragment which is v17+. Used by the leanback preference library.

Returns:

The to possibly use as a callback

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 static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX;

import android.app.Fragment;
import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.ViewGroup;

import androidx.annotation.RestrictTo;
import androidx.leanback.widget.VerticalGridView;
import androidx.preference.PreferenceFragment;
import androidx.preference.PreferenceRecyclerViewAccessibilityDelegate;
import androidx.recyclerview.widget.RecyclerView;

/**
 * This fragment provides a preference fragment with leanback-style behavior, suitable for
 * embedding into broader UI elements.
 * @deprecated Use {@link BaseLeanbackPreferenceFragmentCompat}
 */
@Deprecated
public abstract class BaseLeanbackPreferenceFragment extends PreferenceFragment {

    @Override
    public RecyclerView onCreateRecyclerView(LayoutInflater inflater, ViewGroup parent,
            Bundle savedInstanceState) {
        VerticalGridView verticalGridView = (VerticalGridView) inflater
                .inflate(R.layout.leanback_preferences_list, parent, false);
        verticalGridView.setWindowAlignment(VerticalGridView.WINDOW_ALIGN_BOTH_EDGE);
        verticalGridView.setFocusScrollStrategy(VerticalGridView.FOCUS_SCROLL_ALIGNED);
        verticalGridView.setAccessibilityDelegateCompat(
                new PreferenceRecyclerViewAccessibilityDelegate(verticalGridView));
        return verticalGridView;
    }

    /**
     */
    @RestrictTo(LIBRARY_GROUP_PREFIX)
    @Override
    public Fragment getCallbackFragment() {
        return getParentFragment();
    }
}