| /* |
| * 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; |
| |
| import androidx.annotation.NonNull; |
| import androidx.annotation.Nullable; |
| |
| /** |
| * 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. |
| */ |
| @Nullable |
| View onFocusSearch(@Nullable 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, |
| @Nullable Rect previouslyFocusedRect); |
| /** |
| * See {@link android.view.ViewGroup#requestChildFocus( |
| * android.view.View, android.view.View)}. |
| */ |
| void onRequestChildFocus(@Nullable View child, @Nullable View focused); |
| } |
| |
| public BrowseFrameLayout(@NonNull Context context) { |
| this(context, null, 0); |
| } |
| |
| public BrowseFrameLayout(@NonNull Context context, @Nullable AttributeSet attrs) { |
| this(context, attrs, 0); |
| } |
| |
| public BrowseFrameLayout(@NonNull Context context, @Nullable AttributeSet attrs, int defStyle) { |
| super(context, attrs, defStyle); |
| } |
| |
| private OnFocusSearchListener mListener; |
| private OnChildFocusListener mOnChildFocusListener; |
| private OnKeyListener mOnDispatchKeyListener; |
| |
| /** |
| * Sets a {@link OnFocusSearchListener}. |
| */ |
| public void setOnFocusSearchListener(@Nullable OnFocusSearchListener listener) { |
| mListener = listener; |
| } |
| |
| /** |
| * Returns the {@link OnFocusSearchListener}. |
| */ |
| @Nullable |
| public OnFocusSearchListener getOnFocusSearchListener() { |
| return mListener; |
| } |
| |
| /** |
| * Sets a {@link OnChildFocusListener}. |
| */ |
| public void setOnChildFocusListener(@Nullable OnChildFocusListener listener) { |
| mOnChildFocusListener = listener; |
| } |
| |
| /** |
| * Returns the {@link OnChildFocusListener}. |
| */ |
| @Nullable |
| public OnChildFocusListener getOnChildFocusListener() { |
| return mOnChildFocusListener; |
| } |
| |
| @Override |
| protected boolean onRequestFocusInDescendants(int direction, |
| @Nullable Rect previouslyFocusedRect) { |
| if (mOnChildFocusListener != null) { |
| if (mOnChildFocusListener.onRequestFocusInDescendants(direction, |
| previouslyFocusedRect)) { |
| return true; |
| } |
| } |
| return super.onRequestFocusInDescendants(direction, previouslyFocusedRect); |
| } |
| |
| @Override |
| public View focusSearch(@Nullable 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(@Nullable OnKeyListener listener) { |
| this.mOnDispatchKeyListener = listener; |
| } |
| } |