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 com.android.internal.view.menu;
18 
19 import com.android.internal.view.menu.MenuBuilder;
20 import com.android.internal.view.menu.MenuItemImpl;
21 
22 import android.annotation.UnsupportedAppUsage;
23 import android.graphics.drawable.Drawable;
24 
25 /**
26  * Minimal interface for a menu view.  {@link #initialize(MenuBuilder)} must be called for the
27  * menu to be functional.
28  *
29  * @hide
30  */
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     public 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      */
44     @UnsupportedAppUsage
getWindowAnimations()45     public int getWindowAnimations();
46 
47     /**
48      * Minimal interface for a menu item view.  {@link #initialize(MenuItemImpl, int)} must be called
49      * for the item to be functional.
50      */
51     public interface ItemView {
52         /**
53          * Initializes with the provided MenuItemData.  This should be called after the view is
54          * inflated.
55          * @param itemData The item that this ItemView should display.
56          * @param menuType The type of this menu, one of
57          *            {@link MenuBuilder#TYPE_ICON}, {@link MenuBuilder#TYPE_EXPANDED},
58          *            {@link MenuBuilder#TYPE_DIALOG}).
59          */
initialize(MenuItemImpl itemData, int menuType)60         public void initialize(MenuItemImpl itemData, int menuType);
61 
62         /**
63          * Gets the item data that this view is displaying.
64          * @return the item data, or null if there is not one
65          */
66         @UnsupportedAppUsage
getItemData()67         public MenuItemImpl getItemData();
68 
69         /**
70          * Sets the title of the item view.
71          * @param title The title to set.
72          */
setTitle(CharSequence title)73         public void setTitle(CharSequence title);
74 
75         /**
76          * Sets the enabled state of the item view.
77          * @param enabled Whether the item view should be enabled.
78          */
setEnabled(boolean enabled)79         public void setEnabled(boolean enabled);
80 
81         /**
82          * Displays the checkbox for the item view.  This does not ensure the item view will be
83          * checked, for that use {@link #setChecked}.
84          * @param checkable Whether to display the checkbox or to hide it
85          */
setCheckable(boolean checkable)86         public void setCheckable(boolean checkable);
87 
88         /**
89          * Checks the checkbox for the item view.  If the checkbox is hidden, it will NOT be
90          * made visible, call {@link #setCheckable(boolean)} for that.
91          * @param checked Whether the checkbox should be checked
92          */
setChecked(boolean checked)93         public void setChecked(boolean checked);
94 
95         /**
96          * Sets the shortcut for the item.
97          * @param showShortcut Whether a shortcut should be shown(if false, the value of
98          * shortcutKey should be ignored).
99          * @param shortcutKey The shortcut key that should be shown on the ItemView.
100          */
setShortcut(boolean showShortcut, char shortcutKey)101         public void setShortcut(boolean showShortcut, char shortcutKey);
102 
103         /**
104          * Set the icon of this item view.
105          * @param icon The icon of this item. null to hide the icon.
106          */
setIcon(Drawable icon)107         public void setIcon(Drawable icon);
108 
109         /**
110          * Whether this item view prefers displaying the condensed title rather
111          * than the normal title. If a condensed title is not available, the
112          * normal title will be used.
113          *
114          * @return Whether this item view prefers displaying the condensed
115          *         title.
116          */
prefersCondensedTitle()117         public boolean prefersCondensedTitle();
118 
119         /**
120          * Whether this item view shows an icon.
121          *
122          * @return Whether this item view shows an icon.
123          */
showsIcon()124         public boolean showsIcon();
125     }
126 }
127