1 /*
2  * Copyright (C) 2006 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package androidx.appcompat.view.menu;
18 
19 import static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX;
20 
21 import android.graphics.drawable.Drawable;
22 
23 import androidx.annotation.RestrictTo;
24 
25 /**
26  * Minimal interface for a menu view.  {@link #initialize(MenuBuilder)} must be called for the
27  * menu to be functional.
28  *
29  */
30 @RestrictTo(LIBRARY_GROUP_PREFIX)
31 public interface MenuView {
32     /**
33      * Initializes the menu to the given menu. This should be called after the
34      * view is inflated.
35      *
36      * @param menu The menu that this MenuView should display.
37      */
initialize(MenuBuilder menu)38     void initialize(MenuBuilder menu);
39 
40     /**
41      * Returns the default animations to be used for this menu when entering/exiting.
42      * @return A resource ID for the default animations to be used for this menu.
43      */
getWindowAnimations()44     int getWindowAnimations();
45 
46     /**
47      * Minimal interface for a menu item view.  {@link #initialize(MenuItemImpl, int)} must be called
48      * for the item to be functional.
49      */
50     interface ItemView {
51         /**
52          * Initializes with the provided MenuItemData.  This should be called after the view is
53          * inflated.
54          * @param itemData The item that this ItemView should display.
55          * @param menuType The type of this menu, one of
56          *            {@link MenuBuilder#TYPE_ICON}, {@link MenuBuilder#TYPE_EXPANDED},
57          *            {@link MenuBuilder#TYPE_DIALOG}).
58          */
initialize(MenuItemImpl itemData, int menuType)59         void initialize(MenuItemImpl itemData, int menuType);
60 
61         /**
62          * Gets the item data that this view is displaying.
63          * @return the item data, or null if there is not one
64          */
getItemData()65         MenuItemImpl getItemData();
66 
67         /**
68          * Sets the title of the item view.
69          * @param title The title to set.
70          */
setTitle(CharSequence title)71         void setTitle(CharSequence title);
72 
73         /**
74          * Sets the enabled state of the item view.
75          * @param enabled Whether the item view should be enabled.
76          */
setEnabled(boolean enabled)77         void setEnabled(boolean enabled);
78 
79         /**
80          * Displays the checkbox for the item view.  This does not ensure the item view will be
81          * checked, for that use {@link #setChecked}.
82          * @param checkable Whether to display the checkbox or to hide it
83          */
setCheckable(boolean checkable)84         void setCheckable(boolean checkable);
85 
86         /**
87          * Checks the checkbox for the item view.  If the checkbox is hidden, it will NOT be
88          * made visible, call {@link #setCheckable(boolean)} for that.
89          * @param checked Whether the checkbox should be checked
90          */
setChecked(boolean checked)91         void setChecked(boolean checked);
92 
93         /**
94          * Sets the shortcut for the item.
95          * @param showShortcut Whether a shortcut should be shown(if false, the value of
96          * shortcutKey should be ignored).
97          * @param shortcutKey The shortcut key that should be shown on the ItemView.
98          */
setShortcut(boolean showShortcut, char shortcutKey)99         void setShortcut(boolean showShortcut, char shortcutKey);
100 
101         /**
102          * Set the icon of this item view.
103          * @param icon The icon of this item. null to hide the icon.
104          */
setIcon(Drawable icon)105         void setIcon(Drawable icon);
106 
107         /**
108          * Whether this item view prefers displaying the condensed title rather
109          * than the normal title. If a condensed title is not available, the
110          * normal title will be used.
111          *
112          * @return Whether this item view prefers displaying the condensed
113          *         title.
114          */
prefersCondensedTitle()115         boolean prefersCondensedTitle();
116 
117         /**
118          * Whether this item view shows an icon.
119          *
120          * @return Whether this item view shows an icon.
121          */
showsIcon()122         boolean showsIcon();
123     }
124 }
125