public class

BrowseFrameLayout

extends FrameLayout

 java.lang.Object

↳FrameLayout

↳androidx.leanback.widget.BrowseFrameLayout

Gradle dependencies

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

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

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

Androidx artifact mapping:

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

Androidx class mapping:

androidx.leanback.widget.BrowseFrameLayout android.support.v17.leanback.widget.BrowseFrameLayout

Overview

A ViewGroup for managing focus behavior between overlapping views.

Summary

Constructors
publicBrowseFrameLayout(Context context)

publicBrowseFrameLayout(Context context, AttributeSet attrs)

publicBrowseFrameLayout(Context context, AttributeSet attrs, int defStyle)

Methods
public booleandispatchKeyEvent(KeyEvent event)

public ViewfocusSearch(View focused, int direction)

public BrowseFrameLayout.OnChildFocusListenergetOnChildFocusListener()

Returns the BrowseFrameLayout.OnChildFocusListener.

public BrowseFrameLayout.OnFocusSearchListenergetOnFocusSearchListener()

Returns the BrowseFrameLayout.OnFocusSearchListener.

protected booleanonRequestFocusInDescendants(int direction, Rect previouslyFocusedRect)

public voidrequestChildFocus(View child, View focused)

public voidsetOnChildFocusListener(BrowseFrameLayout.OnChildFocusListener listener)

Sets a BrowseFrameLayout.OnChildFocusListener.

public voidsetOnDispatchKeyListener(OnKeyListener listener)

Sets the on this view.

public voidsetOnFocusSearchListener(BrowseFrameLayout.OnFocusSearchListener listener)

Sets a BrowseFrameLayout.OnFocusSearchListener.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public BrowseFrameLayout(Context context)

public BrowseFrameLayout(Context context, AttributeSet attrs)

public BrowseFrameLayout(Context context, AttributeSet attrs, int defStyle)

Methods

public void setOnFocusSearchListener(BrowseFrameLayout.OnFocusSearchListener listener)

Sets a BrowseFrameLayout.OnFocusSearchListener.

public BrowseFrameLayout.OnFocusSearchListener getOnFocusSearchListener()

Returns the BrowseFrameLayout.OnFocusSearchListener.

public void setOnChildFocusListener(BrowseFrameLayout.OnChildFocusListener listener)

Sets a BrowseFrameLayout.OnChildFocusListener.

public BrowseFrameLayout.OnChildFocusListener getOnChildFocusListener()

Returns the BrowseFrameLayout.OnChildFocusListener.

protected boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect)

public View focusSearch(View focused, int direction)

public void requestChildFocus(View child, View focused)

public boolean dispatchKeyEvent(KeyEvent event)

public void setOnDispatchKeyListener(OnKeyListener listener)

Sets the on this view. This listener would fire only for unhandled s. We need to provide an external key listener to handle back button clicks when we are in full screen video mode because View doesn't fire as the focus is not on this view.

Source

/*
 * Copyright (C) 2014 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.widget;

import android.content.Context;
import android.graphics.Rect;
import android.util.AttributeSet;
import android.view.KeyEvent;
import android.view.View;
import android.widget.FrameLayout;

/**
 * A ViewGroup for managing focus behavior between overlapping views.
 */
public class BrowseFrameLayout extends FrameLayout {

    /**
     * Interface for selecting a focused view in a BrowseFrameLayout when the system focus finder
     * couldn't find a view to focus.
     */
    public interface OnFocusSearchListener {
        /**
         * Returns the view where focus should be requested given the current focused view and
         * the direction of focus search.
         */
        View onFocusSearch(View focused, int direction);
    }

    /**
     * Interface for managing child focus in a BrowseFrameLayout.
     */
    public interface OnChildFocusListener {
        /**
         * See {@link android.view.ViewGroup#onRequestFocusInDescendants(
         * int, android.graphics.Rect)}.
         * @return True if handled by listener, otherwise returns {@link
         * android.view.ViewGroup#onRequestFocusInDescendants(int, android.graphics.Rect)}.
         */
        boolean onRequestFocusInDescendants(int direction,
                Rect previouslyFocusedRect);
        /**
         * See {@link android.view.ViewGroup#requestChildFocus(
         * android.view.View, android.view.View)}.
         */
        void onRequestChildFocus(View child, View focused);
    }

    public BrowseFrameLayout(Context context) {
        this(context, null, 0);
    }

    public BrowseFrameLayout(Context context, AttributeSet attrs) {
        this(context, attrs, 0);
    }

    public BrowseFrameLayout(Context context, AttributeSet attrs, int defStyle) {
        super(context, attrs, defStyle);
    }

    private OnFocusSearchListener mListener;
    private OnChildFocusListener mOnChildFocusListener;
    private OnKeyListener mOnDispatchKeyListener;

    /**
     * Sets a {@link OnFocusSearchListener}.
     */
    public void setOnFocusSearchListener(OnFocusSearchListener listener) {
        mListener = listener;
    }

    /**
     * Returns the {@link OnFocusSearchListener}.
     */
    public OnFocusSearchListener getOnFocusSearchListener() {
        return mListener;
    }

    /**
     * Sets a {@link OnChildFocusListener}.
     */
    public void setOnChildFocusListener(OnChildFocusListener listener) {
        mOnChildFocusListener = listener;
    }

    /**
     * Returns the {@link OnChildFocusListener}.
     */
    public OnChildFocusListener getOnChildFocusListener() {
        return mOnChildFocusListener;
    }

    @Override
    protected boolean onRequestFocusInDescendants(int direction,
            Rect previouslyFocusedRect) {
        if (mOnChildFocusListener != null) {
            if (mOnChildFocusListener.onRequestFocusInDescendants(direction,
                    previouslyFocusedRect)) {
                return true;
            }
        }
        return super.onRequestFocusInDescendants(direction, previouslyFocusedRect);
    }

    @Override
    public View focusSearch(View focused, int direction) {
        if (mListener != null) {
            View view = mListener.onFocusSearch(focused, direction);
            if (view != null) {
                return view;
            }
        }
        return super.focusSearch(focused, direction);
    }

    @Override
    public void requestChildFocus(View child, View focused) {
        if (mOnChildFocusListener != null) {
            mOnChildFocusListener.onRequestChildFocus(child, focused);
        }
        super.requestChildFocus(child, focused);
    }

    @Override
    public boolean dispatchKeyEvent(KeyEvent event) {
        boolean consumed = super.dispatchKeyEvent(event);
        if (mOnDispatchKeyListener != null) {
            if (!consumed) {
                return mOnDispatchKeyListener.onKey(getRootView(), event.getKeyCode(), event);
            }
        }
        return consumed;
    }

    /**
     * Sets the {@link android.view.View.OnKeyListener} on this view. This listener would fire
     * only for unhandled {@link KeyEvent}s. We need to provide an external key listener to handle
     * back button clicks when we are in full screen video mode because
     * {@link View#setOnKeyListener(OnKeyListener)} doesn't fire as the focus is not on this view.
     */
    public void setOnDispatchKeyListener(OnKeyListener listener) {
        this.mOnDispatchKeyListener = listener;
    }
}