• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 android.view;
18 
19 import android.content.Context;
20 import android.content.res.Configuration;
21 import android.content.res.TypedArray;
22 import android.graphics.PixelFormat;
23 import android.graphics.drawable.Drawable;
24 import android.net.Uri;
25 import android.os.Bundle;
26 import android.os.IBinder;
27 import android.view.accessibility.AccessibilityEvent;
28 
29 /**
30  * Abstract base class for a top-level window look and behavior policy.  An
31  * instance of this class should be used as the top-level view added to the
32  * window manager. It provides standard UI policies such as a background, title
33  * area, default key processing, etc.
34  *
35  * <p>The only existing implementation of this abstract class is
36  * android.policy.PhoneWindow, which you should instantiate when needing a
37  * Window.  Eventually that class will be refactored and a factory method
38  * added for creating Window instances without knowing about a particular
39  * implementation.
40  */
41 public abstract class Window {
42     /** Flag for the "options panel" feature.  This is enabled by default. */
43     public static final int FEATURE_OPTIONS_PANEL = 0;
44     /** Flag for the "no title" feature, turning off the title at the top
45      *  of the screen. */
46     public static final int FEATURE_NO_TITLE = 1;
47     /** Flag for the progress indicator feature */
48     public static final int FEATURE_PROGRESS = 2;
49     /** Flag for having an icon on the left side of the title bar */
50     public static final int FEATURE_LEFT_ICON = 3;
51     /** Flag for having an icon on the right side of the title bar */
52     public static final int FEATURE_RIGHT_ICON = 4;
53     /** Flag for indeterminate progress */
54     public static final int FEATURE_INDETERMINATE_PROGRESS = 5;
55     /** Flag for the context menu.  This is enabled by default. */
56     public static final int FEATURE_CONTEXT_MENU = 6;
57     /** Flag for custom title. You cannot combine this feature with other title features. */
58     public static final int FEATURE_CUSTOM_TITLE = 7;
59     /** Flag for asking for an OpenGL enabled window.
60         All 2D graphics will be handled by OpenGL ES.
61         @hide
62     */
63     public static final int FEATURE_OPENGL = 8;
64     /** Flag for setting the progress bar's visibility to VISIBLE */
65     public static final int PROGRESS_VISIBILITY_ON = -1;
66     /** Flag for setting the progress bar's visibility to GONE */
67     public static final int PROGRESS_VISIBILITY_OFF = -2;
68     /** Flag for setting the progress bar's indeterminate mode on */
69     public static final int PROGRESS_INDETERMINATE_ON = -3;
70     /** Flag for setting the progress bar's indeterminate mode off */
71     public static final int PROGRESS_INDETERMINATE_OFF = -4;
72     /** Starting value for the (primary) progress */
73     public static final int PROGRESS_START = 0;
74     /** Ending value for the (primary) progress */
75     public static final int PROGRESS_END = 10000;
76     /** Lowest possible value for the secondary progress */
77     public static final int PROGRESS_SECONDARY_START = 20000;
78     /** Highest possible value for the secondary progress */
79     public static final int PROGRESS_SECONDARY_END = 30000;
80 
81     /** The default features enabled */
82     @SuppressWarnings({"PointlessBitwiseExpression"})
83     protected static final int DEFAULT_FEATURES = (1 << FEATURE_OPTIONS_PANEL) |
84             (1 << FEATURE_CONTEXT_MENU);
85 
86     /**
87      * The ID that the main layout in the XML layout file should have.
88      */
89     public static final int ID_ANDROID_CONTENT = com.android.internal.R.id.content;
90 
91     private final Context mContext;
92 
93     private TypedArray mWindowStyle;
94     private Callback mCallback;
95     private WindowManager mWindowManager;
96     private IBinder mAppToken;
97     private String mAppName;
98     private Window mContainer;
99     private Window mActiveChild;
100     private boolean mIsActive = false;
101     private boolean mHasChildren = false;
102     private int mForcedWindowFlags = 0;
103 
104     private int mFeatures = DEFAULT_FEATURES;
105     private int mLocalFeatures = DEFAULT_FEATURES;
106 
107     private boolean mHaveWindowFormat = false;
108     private int mDefaultWindowFormat = PixelFormat.OPAQUE;
109 
110     private boolean mHasSoftInputMode = false;
111 
112     // The current window attributes.
113     private final WindowManager.LayoutParams mWindowAttributes =
114         new WindowManager.LayoutParams();
115 
116     /**
117      * API from a Window back to its caller.  This allows the client to
118      * intercept key dispatching, panels and menus, etc.
119      */
120     public interface Callback {
121         /**
122          * Called to process key events.  At the very least your
123          * implementation must call
124          * {@link android.view.Window#superDispatchKeyEvent} to do the
125          * standard key processing.
126          *
127          * @param event The key event.
128          *
129          * @return boolean Return true if this event was consumed.
130          */
dispatchKeyEvent(KeyEvent event)131         public boolean dispatchKeyEvent(KeyEvent event);
132 
133         /**
134          * Called to process touch screen events.  At the very least your
135          * implementation must call
136          * {@link android.view.Window#superDispatchTouchEvent} to do the
137          * standard touch screen processing.
138          *
139          * @param event The touch screen event.
140          *
141          * @return boolean Return true if this event was consumed.
142          */
dispatchTouchEvent(MotionEvent event)143         public boolean dispatchTouchEvent(MotionEvent event);
144 
145         /**
146          * Called to process trackball events.  At the very least your
147          * implementation must call
148          * {@link android.view.Window#superDispatchTrackballEvent} to do the
149          * standard trackball processing.
150          *
151          * @param event The trackball event.
152          *
153          * @return boolean Return true if this event was consumed.
154          */
dispatchTrackballEvent(MotionEvent event)155         public boolean dispatchTrackballEvent(MotionEvent event);
156 
157         /**
158          * Called to process population of {@link AccessibilityEvent}s.
159          *
160          * @param event The event.
161          *
162          * @return boolean Return true if event population was completed.
163          */
dispatchPopulateAccessibilityEvent(AccessibilityEvent event)164         public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event);
165 
166         /**
167          * Instantiate the view to display in the panel for 'featureId'.
168          * You can return null, in which case the default content (typically
169          * a menu) will be created for you.
170          *
171          * @param featureId Which panel is being created.
172          *
173          * @return view The top-level view to place in the panel.
174          *
175          * @see #onPreparePanel
176          */
onCreatePanelView(int featureId)177         public View onCreatePanelView(int featureId);
178 
179         /**
180          * Initialize the contents of the menu for panel 'featureId'.  This is
181          * called if onCreatePanelView() returns null, giving you a standard
182          * menu in which you can place your items.  It is only called once for
183          * the panel, the first time it is shown.
184          *
185          * <p>You can safely hold on to <var>menu</var> (and any items created
186          * from it), making modifications to it as desired, until the next
187          * time onCreatePanelMenu() is called for this feature.
188          *
189          * @param featureId The panel being created.
190          * @param menu The menu inside the panel.
191          *
192          * @return boolean You must return true for the panel to be displayed;
193          *         if you return false it will not be shown.
194          */
onCreatePanelMenu(int featureId, Menu menu)195         public boolean onCreatePanelMenu(int featureId, Menu menu);
196 
197         /**
198          * Prepare a panel to be displayed.  This is called right before the
199          * panel window is shown, every time it is shown.
200          *
201          * @param featureId The panel that is being displayed.
202          * @param view The View that was returned by onCreatePanelView().
203          * @param menu If onCreatePanelView() returned null, this is the Menu
204          *             being displayed in the panel.
205          *
206          * @return boolean You must return true for the panel to be displayed;
207          *         if you return false it will not be shown.
208          *
209          * @see #onCreatePanelView
210          */
onPreparePanel(int featureId, View view, Menu menu)211         public boolean onPreparePanel(int featureId, View view, Menu menu);
212 
213         /**
214          * Called when a panel's menu is opened by the user. This may also be
215          * called when the menu is changing from one type to another (for
216          * example, from the icon menu to the expanded menu).
217          *
218          * @param featureId The panel that the menu is in.
219          * @param menu The menu that is opened.
220          * @return Return true to allow the menu to open, or false to prevent
221          *         the menu from opening.
222          */
onMenuOpened(int featureId, Menu menu)223         public boolean onMenuOpened(int featureId, Menu menu);
224 
225         /**
226          * Called when a panel's menu item has been selected by the user.
227          *
228          * @param featureId The panel that the menu is in.
229          * @param item The menu item that was selected.
230          *
231          * @return boolean Return true to finish processing of selection, or
232          *         false to perform the normal menu handling (calling its
233          *         Runnable or sending a Message to its target Handler).
234          */
onMenuItemSelected(int featureId, MenuItem item)235         public boolean onMenuItemSelected(int featureId, MenuItem item);
236 
237         /**
238          * This is called whenever the current window attributes change.
239          *
240          */
onWindowAttributesChanged(WindowManager.LayoutParams attrs)241         public void onWindowAttributesChanged(WindowManager.LayoutParams attrs);
242 
243         /**
244          * This hook is called whenever the content view of the screen changes
245          * (due to a call to
246          * {@link Window#setContentView(View, android.view.ViewGroup.LayoutParams)
247          * Window.setContentView} or
248          * {@link Window#addContentView(View, android.view.ViewGroup.LayoutParams)
249          * Window.addContentView}).
250          */
onContentChanged()251         public void onContentChanged();
252 
253         /**
254          * This hook is called whenever the window focus changes.  See
255          * {@link View#onWindowFocusChanged(boolean)
256          * View.onWindowFocusChanged(boolean)} for more information.
257          *
258          * @param hasFocus Whether the window now has focus.
259          */
onWindowFocusChanged(boolean hasFocus)260         public void onWindowFocusChanged(boolean hasFocus);
261 
262         /**
263          * Called when the window has been attached to the window manager.
264          * See {@link View#onAttachedToWindow() View.onAttachedToWindow()}
265          * for more information.
266          */
onAttachedToWindow()267         public void onAttachedToWindow();
268 
269         /**
270          * Called when the window has been attached to the window manager.
271          * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()}
272          * for more information.
273          */
onDetachedFromWindow()274         public void onDetachedFromWindow();
275 
276         /**
277          * Called when a panel is being closed.  If another logical subsequent
278          * panel is being opened (and this panel is being closed to make room for the subsequent
279          * panel), this method will NOT be called.
280          *
281          * @param featureId The panel that is being displayed.
282          * @param menu If onCreatePanelView() returned null, this is the Menu
283          *            being displayed in the panel.
284          */
onPanelClosed(int featureId, Menu menu)285         public void onPanelClosed(int featureId, Menu menu);
286 
287         /**
288          * Called when the user signals the desire to start a search.
289          *
290          * @return true if search launched, false if activity refuses (blocks)
291          *
292          * @see android.app.Activity#onSearchRequested()
293          */
onSearchRequested()294         public boolean onSearchRequested();
295     }
296 
Window(Context context)297     public Window(Context context) {
298         mContext = context;
299     }
300 
301     /**
302      * Return the Context this window policy is running in, for retrieving
303      * resources and other information.
304      *
305      * @return Context The Context that was supplied to the constructor.
306      */
getContext()307     public final Context getContext() {
308         return mContext;
309     }
310 
311     /**
312      * Return the {@link android.R.styleable#Window} attributes from this
313      * window's theme.
314      */
getWindowStyle()315     public final TypedArray getWindowStyle() {
316         synchronized (this) {
317             if (mWindowStyle == null) {
318                 mWindowStyle = mContext.obtainStyledAttributes(
319                         com.android.internal.R.styleable.Window);
320             }
321             return mWindowStyle;
322         }
323     }
324 
325     /**
326      * Set the container for this window.  If not set, the DecorWindow
327      * operates as a top-level window; otherwise, it negotiates with the
328      * container to display itself appropriately.
329      *
330      * @param container The desired containing Window.
331      */
setContainer(Window container)332     public void setContainer(Window container) {
333         mContainer = container;
334         if (container != null) {
335             // Embedded screens never have a title.
336             mFeatures |= 1<<FEATURE_NO_TITLE;
337             mLocalFeatures |= 1<<FEATURE_NO_TITLE;
338             container.mHasChildren = true;
339         }
340     }
341 
342     /**
343      * Return the container for this Window.
344      *
345      * @return Window The containing window, or null if this is a
346      *         top-level window.
347      */
getContainer()348     public final Window getContainer() {
349         return mContainer;
350     }
351 
hasChildren()352     public final boolean hasChildren() {
353         return mHasChildren;
354     }
355 
356     /**
357      * Set the window manager for use by this Window to, for example,
358      * display panels.  This is <em>not</em> used for displaying the
359      * Window itself -- that must be done by the client.
360      *
361      * @param wm The ViewManager for adding new windows.
362      */
setWindowManager(WindowManager wm, IBinder appToken, String appName)363     public void setWindowManager(WindowManager wm,
364             IBinder appToken, String appName) {
365         mAppToken = appToken;
366         mAppName = appName;
367         if (wm == null) {
368             wm = WindowManagerImpl.getDefault();
369         }
370         mWindowManager = new LocalWindowManager(wm);
371     }
372 
373     private class LocalWindowManager implements WindowManager {
LocalWindowManager(WindowManager wm)374         LocalWindowManager(WindowManager wm) {
375             mWindowManager = wm;
376             mDefaultDisplay = mContext.getResources().getDefaultDisplay(
377                     mWindowManager.getDefaultDisplay());
378         }
379 
addView(View view, ViewGroup.LayoutParams params)380         public final void addView(View view, ViewGroup.LayoutParams params) {
381             // Let this throw an exception on a bad params.
382             WindowManager.LayoutParams wp = (WindowManager.LayoutParams)params;
383             CharSequence curTitle = wp.getTitle();
384             if (wp.type >= WindowManager.LayoutParams.FIRST_SUB_WINDOW &&
385                 wp.type <= WindowManager.LayoutParams.LAST_SUB_WINDOW) {
386                 if (wp.token == null) {
387                     View decor = peekDecorView();
388                     if (decor != null) {
389                         wp.token = decor.getWindowToken();
390                     }
391                 }
392                 if (curTitle == null || curTitle.length() == 0) {
393                     String title;
394                     if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA) {
395                         title="Media";
396                     } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY) {
397                         title="MediaOvr";
398                     } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_PANEL) {
399                         title="Panel";
400                     } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL) {
401                         title="SubPanel";
402                     } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG) {
403                         title="AtchDlg";
404                     } else {
405                         title=Integer.toString(wp.type);
406                     }
407                     if (mAppName != null) {
408                         title += ":" + mAppName;
409                     }
410                     wp.setTitle(title);
411                 }
412             } else {
413                 if (wp.token == null) {
414                     wp.token = mContainer == null ? mAppToken : mContainer.mAppToken;
415                 }
416                 if ((curTitle == null || curTitle.length() == 0)
417                         && mAppName != null) {
418                     wp.setTitle(mAppName);
419                 }
420            }
421             if (wp.packageName == null) {
422                 wp.packageName = mContext.getPackageName();
423             }
424             mWindowManager.addView(view, params);
425         }
426 
updateViewLayout(View view, ViewGroup.LayoutParams params)427         public void updateViewLayout(View view, ViewGroup.LayoutParams params) {
428             mWindowManager.updateViewLayout(view, params);
429         }
430 
removeView(View view)431         public final void removeView(View view) {
432             mWindowManager.removeView(view);
433         }
434 
removeViewImmediate(View view)435         public final void removeViewImmediate(View view) {
436             mWindowManager.removeViewImmediate(view);
437         }
438 
getDefaultDisplay()439         public Display getDefaultDisplay() {
440             return mDefaultDisplay;
441         }
442 
443         private final WindowManager mWindowManager;
444 
445         private final Display mDefaultDisplay;
446     }
447 
448     /**
449      * Return the window manager allowing this Window to display its own
450      * windows.
451      *
452      * @return WindowManager The ViewManager.
453      */
getWindowManager()454     public WindowManager getWindowManager() {
455         return mWindowManager;
456     }
457 
458     /**
459      * Set the Callback interface for this window, used to intercept key
460      * events and other dynamic operations in the window.
461      *
462      * @param callback The desired Callback interface.
463      */
setCallback(Callback callback)464     public void setCallback(Callback callback) {
465         mCallback = callback;
466     }
467 
468     /**
469      * Return the current Callback interface for this window.
470      */
getCallback()471     public final Callback getCallback() {
472         return mCallback;
473     }
474 
475     /**
476      * Return whether this window is being displayed with a floating style
477      * (based on the {@link android.R.attr#windowIsFloating} attribute in
478      * the style/theme).
479      *
480      * @return Returns true if the window is configured to be displayed floating
481      * on top of whatever is behind it.
482      */
isFloating()483     public abstract boolean isFloating();
484 
485     /**
486      * Set the width and height layout parameters of the window.  The default
487      * for both of these is FILL_PARENT; you can change them to WRAP_CONTENT to
488      * make a window that is not full-screen.
489      *
490      * @param width The desired layout width of the window.
491      * @param height The desired layout height of the window.
492      */
setLayout(int width, int height)493     public void setLayout(int width, int height)
494     {
495         final WindowManager.LayoutParams attrs = getAttributes();
496         attrs.width = width;
497         attrs.height = height;
498         if (mCallback != null) {
499             mCallback.onWindowAttributesChanged(attrs);
500         }
501     }
502 
503     /**
504      * Set the gravity of the window, as per the Gravity constants.  This
505      * controls how the window manager is positioned in the overall window; it
506      * is only useful when using WRAP_CONTENT for the layout width or height.
507      *
508      * @param gravity The desired gravity constant.
509      *
510      * @see Gravity
511      * @see #setLayout
512      */
setGravity(int gravity)513     public void setGravity(int gravity)
514     {
515         final WindowManager.LayoutParams attrs = getAttributes();
516         attrs.gravity = gravity;
517         if (mCallback != null) {
518             mCallback.onWindowAttributesChanged(attrs);
519         }
520     }
521 
522     /**
523      * Set the type of the window, as per the WindowManager.LayoutParams
524      * types.
525      *
526      * @param type The new window type (see WindowManager.LayoutParams).
527      */
setType(int type)528     public void setType(int type) {
529         final WindowManager.LayoutParams attrs = getAttributes();
530         attrs.type = type;
531         if (mCallback != null) {
532             mCallback.onWindowAttributesChanged(attrs);
533         }
534     }
535 
536     /**
537      * Set the format of window, as per the PixelFormat types.  This overrides
538      * the default format that is selected by the Window based on its
539      * window decorations.
540      *
541      * @param format The new window format (see PixelFormat).  Use
542      *               PixelFormat.UNKNOWN to allow the Window to select
543      *               the format.
544      *
545      * @see PixelFormat
546      */
setFormat(int format)547     public void setFormat(int format) {
548         final WindowManager.LayoutParams attrs = getAttributes();
549         if (format != PixelFormat.UNKNOWN) {
550             attrs.format = format;
551             mHaveWindowFormat = true;
552         } else {
553             attrs.format = mDefaultWindowFormat;
554             mHaveWindowFormat = false;
555         }
556         if (mCallback != null) {
557             mCallback.onWindowAttributesChanged(attrs);
558         }
559     }
560 
561     /**
562      * Specify custom animations to use for the window, as per
563      * {@link WindowManager.LayoutParams#windowAnimations
564      * WindowManager.LayoutParams.windowAnimations}.  Providing anything besides
565      * 0 here will override the animations the window would
566      * normally retrieve from its theme.
567      */
setWindowAnimations(int resId)568     public void setWindowAnimations(int resId) {
569         final WindowManager.LayoutParams attrs = getAttributes();
570         attrs.windowAnimations = resId;
571         if (mCallback != null) {
572             mCallback.onWindowAttributesChanged(attrs);
573         }
574     }
575 
576     /**
577      * Specify an explicit soft input mode to use for the window, as per
578      * {@link WindowManager.LayoutParams#softInputMode
579      * WindowManager.LayoutParams.softInputMode}.  Providing anything besides
580      * "unspecified" here will override the input mode the window would
581      * normally retrieve from its theme.
582      */
setSoftInputMode(int mode)583     public void setSoftInputMode(int mode) {
584         final WindowManager.LayoutParams attrs = getAttributes();
585         if (mode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
586             attrs.softInputMode = mode;
587             mHasSoftInputMode = true;
588         } else {
589             mHasSoftInputMode = false;
590         }
591         if (mCallback != null) {
592             mCallback.onWindowAttributesChanged(attrs);
593         }
594     }
595 
596     /**
597      * Convenience function to set the flag bits as specified in flags, as
598      * per {@link #setFlags}.
599      * @param flags The flag bits to be set.
600      * @see #setFlags
601      */
addFlags(int flags)602     public void addFlags(int flags) {
603         setFlags(flags, flags);
604     }
605 
606     /**
607      * Convenience function to clear the flag bits as specified in flags, as
608      * per {@link #setFlags}.
609      * @param flags The flag bits to be cleared.
610      * @see #setFlags
611      */
clearFlags(int flags)612     public void clearFlags(int flags) {
613         setFlags(0, flags);
614     }
615 
616     /**
617      * Set the flags of the window, as per the
618      * {@link WindowManager.LayoutParams WindowManager.LayoutParams}
619      * flags.
620      *
621      * <p>Note that some flags must be set before the window decoration is
622      * created (by the first call to
623      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} or
624      * {@link #getDecorView()}:
625      * {@link WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN} and
626      * {@link WindowManager.LayoutParams#FLAG_LAYOUT_INSET_DECOR}.  These
627      * will be set for you based on the {@link android.R.attr#windowIsFloating}
628      * attribute.
629      *
630      * @param flags The new window flags (see WindowManager.LayoutParams).
631      * @param mask Which of the window flag bits to modify.
632      */
setFlags(int flags, int mask)633     public void setFlags(int flags, int mask) {
634         final WindowManager.LayoutParams attrs = getAttributes();
635         attrs.flags = (attrs.flags&~mask) | (flags&mask);
636         mForcedWindowFlags |= mask;
637         if (mCallback != null) {
638             mCallback.onWindowAttributesChanged(attrs);
639         }
640     }
641 
642     /**
643      * Specify custom window attributes.  <strong>PLEASE NOTE:</strong> the
644      * layout params you give here should generally be from values previously
645      * retrieved with {@link #getAttributes()}; you probably do not want to
646      * blindly create and apply your own, since this will blow away any values
647      * set by the framework that you are not interested in.
648      *
649      * @param a The new window attributes, which will completely override any
650      *          current values.
651      */
setAttributes(WindowManager.LayoutParams a)652     public void setAttributes(WindowManager.LayoutParams a) {
653         mWindowAttributes.copyFrom(a);
654         if (mCallback != null) {
655             mCallback.onWindowAttributesChanged(mWindowAttributes);
656         }
657     }
658 
659     /**
660      * Retrieve the current window attributes associated with this panel.
661      *
662      * @return WindowManager.LayoutParams Either the existing window
663      *         attributes object, or a freshly created one if there is none.
664      */
getAttributes()665     public final WindowManager.LayoutParams getAttributes() {
666         return mWindowAttributes;
667     }
668 
669     /**
670      * Return the window flags that have been explicitly set by the client,
671      * so will not be modified by {@link #getDecorView}.
672      */
getForcedWindowFlags()673     protected final int getForcedWindowFlags() {
674         return mForcedWindowFlags;
675     }
676 
677     /**
678      * Has the app specified their own soft input mode?
679      */
hasSoftInputMode()680     protected final boolean hasSoftInputMode() {
681         return mHasSoftInputMode;
682     }
683 
684     /**
685      * Enable extended screen features.  This must be called before
686      * setContentView().  May be called as many times as desired as long as it
687      * is before setContentView().  If not called, no extended features
688      * will be available.  You can not turn off a feature once it is requested.
689      * You canot use other title features with {@link #FEATURE_CUSTOM_TITLE}.
690      *
691      * @param featureId The desired features, defined as constants by Window.
692      * @return The features that are now set.
693      */
requestFeature(int featureId)694     public boolean requestFeature(int featureId) {
695         final int flag = 1<<featureId;
696         mFeatures |= flag;
697         mLocalFeatures |= mContainer != null ? (flag&~mContainer.mFeatures) : flag;
698         return (mFeatures&flag) != 0;
699     }
700 
makeActive()701     public final void makeActive() {
702         if (mContainer != null) {
703             if (mContainer.mActiveChild != null) {
704                 mContainer.mActiveChild.mIsActive = false;
705             }
706             mContainer.mActiveChild = this;
707         }
708         mIsActive = true;
709         onActive();
710     }
711 
isActive()712     public final boolean isActive()
713     {
714         return mIsActive;
715     }
716 
717     /**
718      * Finds a view that was identified by the id attribute from the XML that
719      * was processed in {@link android.app.Activity#onCreate}.  This will
720      * implicitly call {@link #getDecorView} for you, with all of the
721      * associated side-effects.
722      *
723      * @return The view if found or null otherwise.
724      */
findViewById(int id)725     public View findViewById(int id) {
726         return getDecorView().findViewById(id);
727     }
728 
729     /**
730      * Convenience for
731      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
732      * to set the screen content from a layout resource.  The resource will be
733      * inflated, adding all top-level views to the screen.
734      *
735      * @param layoutResID Resource ID to be inflated.
736      * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
737      */
setContentView(int layoutResID)738     public abstract void setContentView(int layoutResID);
739 
740     /**
741      * Convenience for
742      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
743      * set the screen content to an explicit view.  This view is placed
744      * directly into the screen's view hierarchy.  It can itself be a complex
745      * view hierarhcy.
746      *
747      * @param view The desired content to display.
748      * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
749      */
setContentView(View view)750     public abstract void setContentView(View view);
751 
752     /**
753      * Set the screen content to an explicit view.  This view is placed
754      * directly into the screen's view hierarchy.  It can itself be a complex
755      * view hierarchy.
756      *
757      * <p>Note that calling this function "locks in" various characteristics
758      * of the window that can not, from this point forward, be changed: the
759      * features that have been requested with {@link #requestFeature(int)},
760      * and certain window flags as described in {@link #setFlags(int, int)}.
761      *
762      * @param view The desired content to display.
763      * @param params Layout parameters for the view.
764      */
setContentView(View view, ViewGroup.LayoutParams params)765     public abstract void setContentView(View view, ViewGroup.LayoutParams params);
766 
767     /**
768      * Variation on
769      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
770      * to add an additional content view to the screen.  Added after any existing
771      * ones in the screen -- existing views are NOT removed.
772      *
773      * @param view The desired content to display.
774      * @param params Layout parameters for the view.
775      */
addContentView(View view, ViewGroup.LayoutParams params)776     public abstract void addContentView(View view, ViewGroup.LayoutParams params);
777 
778     /**
779      * Return the view in this Window that currently has focus, or null if
780      * there are none.  Note that this does not look in any containing
781      * Window.
782      *
783      * @return View The current View with focus or null.
784      */
getCurrentFocus()785     public abstract View getCurrentFocus();
786 
787     /**
788      * Quick access to the {@link LayoutInflater} instance that this Window
789      * retrieved from its Context.
790      *
791      * @return LayoutInflater The shared LayoutInflater.
792      */
getLayoutInflater()793     public abstract LayoutInflater getLayoutInflater();
794 
setTitle(CharSequence title)795     public abstract void setTitle(CharSequence title);
796 
setTitleColor(int textColor)797     public abstract void setTitleColor(int textColor);
798 
openPanel(int featureId, KeyEvent event)799     public abstract void openPanel(int featureId, KeyEvent event);
800 
closePanel(int featureId)801     public abstract void closePanel(int featureId);
802 
togglePanel(int featureId, KeyEvent event)803     public abstract void togglePanel(int featureId, KeyEvent event);
804 
performPanelShortcut(int featureId, int keyCode, KeyEvent event, int flags)805     public abstract boolean performPanelShortcut(int featureId,
806                                                  int keyCode,
807                                                  KeyEvent event,
808                                                  int flags);
performPanelIdentifierAction(int featureId, int id, int flags)809     public abstract boolean performPanelIdentifierAction(int featureId,
810                                                  int id,
811                                                  int flags);
812 
closeAllPanels()813     public abstract void closeAllPanels();
814 
performContextMenuIdentifierAction(int id, int flags)815     public abstract boolean performContextMenuIdentifierAction(int id, int flags);
816 
817     /**
818      * Should be called when the configuration is changed.
819      *
820      * @param newConfig The new configuration.
821      */
onConfigurationChanged(Configuration newConfig)822     public abstract void onConfigurationChanged(Configuration newConfig);
823 
824     /**
825      * Change the background of this window to a Drawable resource. Setting the
826      * background to null will make the window be opaque. To make the window
827      * transparent, you can use an empty drawable (for instance a ColorDrawable
828      * with the color 0 or the system drawable android:drawable/empty.)
829      *
830      * @param resid The resource identifier of a drawable resource which will be
831      *              installed as the new background.
832      */
setBackgroundDrawableResource(int resid)833     public void setBackgroundDrawableResource(int resid)
834     {
835         setBackgroundDrawable(mContext.getResources().getDrawable(resid));
836     }
837 
838     /**
839      * Change the background of this window to a custom Drawable. Setting the
840      * background to null will make the window be opaque. To make the window
841      * transparent, you can use an empty drawable (for instance a ColorDrawable
842      * with the color 0 or the system drawable android:drawable/empty.)
843      *
844      * @param drawable The new Drawable to use for this window's background.
845      */
setBackgroundDrawable(Drawable drawable)846     public abstract void setBackgroundDrawable(Drawable drawable);
847 
848     /**
849      * Set the value for a drawable feature of this window, from a resource
850      * identifier.  You must have called requestFeauture(featureId) before
851      * calling this function.
852      *
853      * @see android.content.res.Resources#getDrawable(int)
854      *
855      * @param featureId The desired drawable feature to change, defined as a
856      * constant by Window.
857      * @param resId Resource identifier of the desired image.
858      */
setFeatureDrawableResource(int featureId, int resId)859     public abstract void setFeatureDrawableResource(int featureId, int resId);
860 
861     /**
862      * Set the value for a drawable feature of this window, from a URI. You
863      * must have called requestFeature(featureId) before calling this
864      * function.
865      *
866      * <p>The only URI currently supported is "content:", specifying an image
867      * in a content provider.
868      *
869      * @see android.widget.ImageView#setImageURI
870      *
871      * @param featureId The desired drawable feature to change. Features are
872      * constants defined by Window.
873      * @param uri The desired URI.
874      */
setFeatureDrawableUri(int featureId, Uri uri)875     public abstract void setFeatureDrawableUri(int featureId, Uri uri);
876 
877     /**
878      * Set an explicit Drawable value for feature of this window. You must
879      * have called requestFeature(featureId) before calling this function.
880      *
881      * @param featureId The desired drawable feature to change.
882      * Features are constants defined by Window.
883      * @param drawable A Drawable object to display.
884      */
setFeatureDrawable(int featureId, Drawable drawable)885     public abstract void setFeatureDrawable(int featureId, Drawable drawable);
886 
887     /**
888      * Set a custom alpha value for the given drawale feature, controlling how
889      * much the background is visible through it.
890      *
891      * @param featureId The desired drawable feature to change.
892      * Features are constants defined by Window.
893      * @param alpha The alpha amount, 0 is completely transparent and 255 is
894      *              completely opaque.
895      */
setFeatureDrawableAlpha(int featureId, int alpha)896     public abstract void setFeatureDrawableAlpha(int featureId, int alpha);
897 
898     /**
899      * Set the integer value for a feature.  The range of the value depends on
900      * the feature being set.  For FEATURE_PROGRESSS, it should go from 0 to
901      * 10000. At 10000 the progress is complete and the indicator hidden.
902      *
903      * @param featureId The desired feature to change.
904      * Features are constants defined by Window.
905      * @param value The value for the feature.  The interpretation of this
906      *              value is feature-specific.
907      */
setFeatureInt(int featureId, int value)908     public abstract void setFeatureInt(int featureId, int value);
909 
910     /**
911      * Request that key events come to this activity. Use this if your
912      * activity has no views with focus, but the activity still wants
913      * a chance to process key events.
914      */
takeKeyEvents(boolean get)915     public abstract void takeKeyEvents(boolean get);
916 
917     /**
918      * Used by custom windows, such as Dialog, to pass the key press event
919      * further down the view hierarchy. Application developers should
920      * not need to implement or call this.
921      *
922      */
superDispatchKeyEvent(KeyEvent event)923     public abstract boolean superDispatchKeyEvent(KeyEvent event);
924 
925     /**
926      * Used by custom windows, such as Dialog, to pass the touch screen event
927      * further down the view hierarchy. Application developers should
928      * not need to implement or call this.
929      *
930      */
superDispatchTouchEvent(MotionEvent event)931     public abstract boolean superDispatchTouchEvent(MotionEvent event);
932 
933     /**
934      * Used by custom windows, such as Dialog, to pass the trackball event
935      * further down the view hierarchy. Application developers should
936      * not need to implement or call this.
937      *
938      */
superDispatchTrackballEvent(MotionEvent event)939     public abstract boolean superDispatchTrackballEvent(MotionEvent event);
940 
941     /**
942      * Retrieve the top-level window decor view (containing the standard
943      * window frame/decorations and the client's content inside of that), which
944      * can be added as a window to the window manager.
945      *
946      * <p><em>Note that calling this function for the first time "locks in"
947      * various window characteristics as described in
948      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}.</em></p>
949      *
950      * @return Returns the top-level window decor view.
951      */
getDecorView()952     public abstract View getDecorView();
953 
954     /**
955      * Retrieve the current decor view, but only if it has already been created;
956      * otherwise returns null.
957      *
958      * @return Returns the top-level window decor or null.
959      * @see #getDecorView
960      */
peekDecorView()961     public abstract View peekDecorView();
962 
saveHierarchyState()963     public abstract Bundle saveHierarchyState();
964 
restoreHierarchyState(Bundle savedInstanceState)965     public abstract void restoreHierarchyState(Bundle savedInstanceState);
966 
onActive()967     protected abstract void onActive();
968 
969     /**
970      * Return the feature bits that are enabled.  This is the set of features
971      * that were given to requestFeature(), and are being handled by this
972      * Window itself or its container.  That is, it is the set of
973      * requested features that you can actually use.
974      *
975      * <p>To do: add a public version of this API that allows you to check for
976      * features by their feature ID.
977      *
978      * @return int The feature bits.
979      */
getFeatures()980     protected final int getFeatures()
981     {
982         return mFeatures;
983     }
984 
985     /**
986      * Return the feature bits that are being implemented by this Window.
987      * This is the set of features that were given to requestFeature(), and are
988      * being handled by only this Window itself, not by its containers.
989      *
990      * @return int The feature bits.
991      */
getLocalFeatures()992     protected final int getLocalFeatures()
993     {
994         return mLocalFeatures;
995     }
996 
997     /**
998      * Set the default format of window, as per the PixelFormat types.  This
999      * is the format that will be used unless the client specifies in explicit
1000      * format with setFormat();
1001      *
1002      * @param format The new window format (see PixelFormat).
1003      *
1004      * @see #setFormat
1005      * @see PixelFormat
1006      */
setDefaultWindowFormat(int format)1007     protected void setDefaultWindowFormat(int format) {
1008         mDefaultWindowFormat = format;
1009         if (!mHaveWindowFormat) {
1010             final WindowManager.LayoutParams attrs = getAttributes();
1011             attrs.format = format;
1012             if (mCallback != null) {
1013                 mCallback.onWindowAttributesChanged(attrs);
1014             }
1015         }
1016     }
1017 
setChildDrawable(int featureId, Drawable drawable)1018     public abstract void setChildDrawable(int featureId, Drawable drawable);
1019 
setChildInt(int featureId, int value)1020     public abstract void setChildInt(int featureId, int value);
1021 
1022     /**
1023      * Is a keypress one of the defined shortcut keys for this window.
1024      * @param keyCode the key code from {@link android.view.KeyEvent} to check.
1025      * @param event the {@link android.view.KeyEvent} to use to help check.
1026      */
isShortcutKey(int keyCode, KeyEvent event)1027     public abstract boolean isShortcutKey(int keyCode, KeyEvent event);
1028 
1029     /**
1030      * @see android.app.Activity#setVolumeControlStream(int)
1031      */
setVolumeControlStream(int streamType)1032     public abstract void setVolumeControlStream(int streamType);
1033 
1034     /**
1035      * @see android.app.Activity#getVolumeControlStream()
1036      */
getVolumeControlStream()1037     public abstract int getVolumeControlStream();
1038 
1039 }
1040