FileDocCategorySizeDatePackage
Window.javaAPI DocAndroid 1.5 API37326Wed May 06 22:41:56 BST 2009android.view

Window

public abstract class Window extends Object
Abstract base class for a top-level window look and behavior policy. An instance of this class should be used as the top-level view added to the window manager. It provides standard UI policies such as a background, title area, default key processing, etc.

The only existing implementation of this abstract class is android.policy.PhoneWindow, which you should instantiate when needing a Window. Eventually that class will be refactored and a factory method added for creating Window instances without knowing about a particular implementation.

Fields Summary
public static final int
FEATURE_OPTIONS_PANEL
Flag for the "options panel" feature. This is enabled by default.
public static final int
FEATURE_NO_TITLE
Flag for the "no title" feature, turning off the title at the top of the screen.
public static final int
FEATURE_PROGRESS
Flag for the progress indicator feature
public static final int
FEATURE_LEFT_ICON
Flag for having an icon on the left side of the title bar
public static final int
FEATURE_RIGHT_ICON
Flag for having an icon on the right side of the title bar
public static final int
FEATURE_INDETERMINATE_PROGRESS
Flag for indeterminate progress
public static final int
FEATURE_CONTEXT_MENU
Flag for the context menu. This is enabled by default.
public static final int
FEATURE_CUSTOM_TITLE
Flag for custom title. You cannot combine this feature with other title features.
private static final int
FEATURE_OPENGL
public static final int
PROGRESS_VISIBILITY_ON
Flag for setting the progress bar's visibility to VISIBLE
public static final int
PROGRESS_VISIBILITY_OFF
Flag for setting the progress bar's visibility to GONE
public static final int
PROGRESS_INDETERMINATE_ON
Flag for setting the progress bar's indeterminate mode on
public static final int
PROGRESS_INDETERMINATE_OFF
Flag for setting the progress bar's indeterminate mode off
public static final int
PROGRESS_START
Starting value for the (primary) progress
public static final int
PROGRESS_END
Ending value for the (primary) progress
public static final int
PROGRESS_SECONDARY_START
Lowest possible value for the secondary progress
public static final int
PROGRESS_SECONDARY_END
Highest possible value for the secondary progress
protected static final int
DEFAULT_FEATURES
The default features enabled
public static final int
ID_ANDROID_CONTENT
The ID that the main layout in the XML layout file should have.
private final android.content.Context
mContext
private android.content.res.TypedArray
mWindowStyle
private Callback
mCallback
private WindowManager
mWindowManager
private android.os.IBinder
mAppToken
private String
mAppName
private Window
mContainer
private Window
mActiveChild
private boolean
mIsActive
private boolean
mHasChildren
private int
mForcedWindowFlags
private int
mFeatures
private int
mLocalFeatures
private boolean
mHaveWindowFormat
private int
mDefaultWindowFormat
private boolean
mHasSoftInputMode
private final WindowManager.LayoutParams
mWindowAttributes
Constructors Summary
public Window(android.content.Context context)


                              
       
                                                     
           

                                                        
           
        
                                                     
           
        
                                                                
           

                                                                                                                                    
             

                                                                                                                  
               

                                                                                              
             
        
                                                                                          
             

                          
           

                                           
          

                                  
           

                                                                                       
             
        
                                           
          
    

       
        mContext = context;
    
Methods Summary
public abstract voidaddContentView(View view, ViewGroup.LayoutParams params)
Variation on {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} to add an additional content view to the screen. Added after any existing ones in the screen -- existing views are NOT removed.

param
view The desired content to display.
param
params Layout parameters for the view.

public voidaddFlags(int flags)
Convenience function to set the flag bits as specified in flags, as per {@link #setFlags}.

param
flags The flag bits to be set.
see
#setFlags

        setFlags(flags, flags);
    
public voidclearFlags(int flags)
Convenience function to clear the flag bits as specified in flags, as per {@link #setFlags}.

param
flags The flag bits to be cleared.
see
#setFlags

        setFlags(0, flags);
    
public abstract voidcloseAllPanels()

public abstract voidclosePanel(int featureId)

public ViewfindViewById(int id)
Finds a view that was identified by the id attribute from the XML that was processed in {@link android.app.Activity#onCreate}. This will implicitly call {@link #getDecorView} for you, with all of the associated side-effects.

return
The view if found or null otherwise.

        return getDecorView().findViewById(id);
    
public final WindowManager.LayoutParamsgetAttributes()
Retrieve the current window attributes associated with this panel.

return
WindowManager.LayoutParams Either the existing window attributes object, or a freshly created one if there is none.

        return mWindowAttributes;
    
public final android.view.Window$CallbackgetCallback()
Return the current Callback interface for this window.

        return mCallback;
    
public final android.view.WindowgetContainer()
Return the container for this Window.

return
Window The containing window, or null if this is a top-level window.

        return mContainer;
    
public final android.content.ContextgetContext()
Return the Context this window policy is running in, for retrieving resources and other information.

return
Context The Context that was supplied to the constructor.

        return mContext;
    
public abstract ViewgetCurrentFocus()
Return the view in this Window that currently has focus, or null if there are none. Note that this does not look in any containing Window.

return
View The current View with focus or null.

public abstract ViewgetDecorView()
Retrieve the top-level window decor view (containing the standard window frame/decorations and the client's content inside of that), which can be added as a window to the window manager.

Note that calling this function for the first time "locks in" various window characteristics as described in {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}.

return
Returns the top-level window decor view.

protected final intgetFeatures()
Return the feature bits that are enabled. This is the set of features that were given to requestFeature(), and are being handled by this Window itself or its container. That is, it is the set of requested features that you can actually use.

To do: add a public version of this API that allows you to check for features by their feature ID.

return
int The feature bits.

        return mFeatures;
    
protected final intgetForcedWindowFlags()
Return the window flags that have been explicitly set by the client, so will not be modified by {@link #getDecorView}.

        return mForcedWindowFlags;
    
public abstract LayoutInflatergetLayoutInflater()
Quick access to the {@link LayoutInflater} instance that this Window retrieved from its Context.

return
LayoutInflater The shared LayoutInflater.

protected final intgetLocalFeatures()
Return the feature bits that are being implemented by this Window. This is the set of features that were given to requestFeature(), and are being handled by only this Window itself, not by its containers.

return
int The feature bits.

        return mLocalFeatures;
    
public abstract intgetVolumeControlStream()

see
android.app.Activity#getVolumeControlStream()

public WindowManagergetWindowManager()
Return the window manager allowing this Window to display its own windows.

return
WindowManager The ViewManager.

        return mWindowManager;
    
public final android.content.res.TypedArraygetWindowStyle()
Return the {@link android.R.styleable#Window} attributes from this window's theme.

        synchronized (this) {
            if (mWindowStyle == null) {
                mWindowStyle = mContext.obtainStyledAttributes(
                        com.android.internal.R.styleable.Window);
            }
            return mWindowStyle;
        }
    
public final booleanhasChildren()

        return mHasChildren;
    
protected final booleanhasSoftInputMode()
Has the app specified their own soft input mode?

        return mHasSoftInputMode;
    
public final booleanisActive()

        return mIsActive;
    
public abstract booleanisFloating()
Return whether this window is being displayed with a floating style (based on the {@link android.R.attr#windowIsFloating} attribute in the style/theme).

return
Returns true if the window is configured to be displayed floating on top of whatever is behind it.

public abstract booleanisShortcutKey(int keyCode, KeyEvent event)
Is a keypress one of the defined shortcut keys for this window.

param
keyCode the key code from {@link android.view.KeyEvent} to check.
param
event the {@link android.view.KeyEvent} to use to help check.

public final voidmakeActive()

        if (mContainer != null) {
            if (mContainer.mActiveChild != null) {
                mContainer.mActiveChild.mIsActive = false;
            }
            mContainer.mActiveChild = this;
        }
        mIsActive = true;
        onActive();
    
protected abstract voidonActive()

public abstract voidonConfigurationChanged(android.content.res.Configuration newConfig)
Should be called when the configuration is changed.

param
newConfig The new configuration.

public abstract voidopenPanel(int featureId, KeyEvent event)

public abstract ViewpeekDecorView()
Retrieve the current decor view, but only if it has already been created; otherwise returns null.

return
Returns the top-level window decor or null.
see
#getDecorView

public abstract booleanperformContextMenuIdentifierAction(int id, int flags)

public abstract booleanperformPanelIdentifierAction(int featureId, int id, int flags)

public abstract booleanperformPanelShortcut(int featureId, int keyCode, KeyEvent event, int flags)

public booleanrequestFeature(int featureId)
Enable extended screen features. This must be called before setContentView(). May be called as many times as desired as long as it is before setContentView(). If not called, no extended features will be available. You can not turn off a feature once it is requested. You canot use other title features with {@link #FEATURE_CUSTOM_TITLE}.

param
featureId The desired features, defined as constants by Window.
return
The features that are now set.

        final int flag = 1<<featureId;
        mFeatures |= flag;
        mLocalFeatures |= mContainer != null ? (flag&~mContainer.mFeatures) : flag;
        return (mFeatures&flag) != 0;
    
public abstract voidrestoreHierarchyState(android.os.Bundle savedInstanceState)

public abstract android.os.BundlesaveHierarchyState()

public voidsetAttributes(WindowManager.LayoutParams a)
Specify custom window attributes. PLEASE NOTE: the layout params you give here should generally be from values previously retrieved with {@link #getAttributes()}; you probably do not want to blindly create and apply your own, since this will blow away any values set by the framework that you are not interested in.

param
a The new window attributes, which will completely override any current values.

        mWindowAttributes.copyFrom(a);
        if (mCallback != null) {
            mCallback.onWindowAttributesChanged(mWindowAttributes);
        }
    
public abstract voidsetBackgroundDrawable(android.graphics.drawable.Drawable drawable)
Change the background of this window to a custom Drawable. Setting the background to null will make the window be opaque. To make the window transparent, you can use an empty drawable (for instance a ColorDrawable with the color 0 or the system drawable android:drawable/empty.)

param
drawable The new Drawable to use for this window's background.

public voidsetBackgroundDrawableResource(int resid)
Change the background of this window to a Drawable resource. Setting the background to null will make the window be opaque. To make the window transparent, you can use an empty drawable (for instance a ColorDrawable with the color 0 or the system drawable android:drawable/empty.)

param
resid The resource identifier of a drawable resource which will be installed as the new background.

        setBackgroundDrawable(mContext.getResources().getDrawable(resid));
    
public voidsetCallback(android.view.Window$Callback callback)
Set the Callback interface for this window, used to intercept key events and other dynamic operations in the window.

param
callback The desired Callback interface.

        mCallback = callback;
    
public abstract voidsetChildDrawable(int featureId, android.graphics.drawable.Drawable drawable)

public abstract voidsetChildInt(int featureId, int value)

public voidsetContainer(android.view.Window container)
Set the container for this window. If not set, the DecorWindow operates as a top-level window; otherwise, it negotiates with the container to display itself appropriately.

param
container The desired containing Window.

        mContainer = container;
        if (container != null) {
            // Embedded screens never have a title.
            mFeatures |= 1<<FEATURE_NO_TITLE;
            mLocalFeatures |= 1<<FEATURE_NO_TITLE;
            container.mHasChildren = true;
        }
    
public abstract voidsetContentView(int layoutResID)
Convenience for {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} to set the screen content from a layout resource. The resource will be inflated, adding all top-level views to the screen.

param
layoutResID Resource ID to be inflated.
see
#setContentView(View, android.view.ViewGroup.LayoutParams)

public abstract voidsetContentView(View view)
Convenience for {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} set the screen content to an explicit view. This view is placed directly into the screen's view hierarchy. It can itself be a complex view hierarhcy.

param
view The desired content to display.
see
#setContentView(View, android.view.ViewGroup.LayoutParams)

public abstract voidsetContentView(View view, ViewGroup.LayoutParams params)
Set the screen content to an explicit view. This view is placed directly into the screen's view hierarchy. It can itself be a complex view hierarchy.

Note that calling this function "locks in" various characteristics of the window that can not, from this point forward, be changed: the features that have been requested with {@link #requestFeature(int)}, and certain window flags as described in {@link #setFlags(int, int)}.

param
view The desired content to display.
param
params Layout parameters for the view.

protected voidsetDefaultWindowFormat(int format)
Set the default format of window, as per the PixelFormat types. This is the format that will be used unless the client specifies in explicit format with setFormat();

param
format The new window format (see PixelFormat).
see
#setFormat
see
PixelFormat

        mDefaultWindowFormat = format;
        if (!mHaveWindowFormat) {
            final WindowManager.LayoutParams attrs = getAttributes();
            attrs.format = format;
            if (mCallback != null) {
                mCallback.onWindowAttributesChanged(attrs);
            }
        }
    
public abstract voidsetFeatureDrawable(int featureId, android.graphics.drawable.Drawable drawable)
Set an explicit Drawable value for feature of this window. You must have called requestFeature(featureId) before calling this function.

param
featureId The desired drawable feature to change. Features are constants defined by Window.
param
drawable A Drawable object to display.

public abstract voidsetFeatureDrawableAlpha(int featureId, int alpha)
Set a custom alpha value for the given drawale feature, controlling how much the background is visible through it.

param
featureId The desired drawable feature to change. Features are constants defined by Window.
param
alpha The alpha amount, 0 is completely transparent and 255 is completely opaque.

public abstract voidsetFeatureDrawableResource(int featureId, int resId)
Set the value for a drawable feature of this window, from a resource identifier. You must have called requestFeauture(featureId) before calling this function.

see
android.content.res.Resources#getDrawable(int)
param
featureId The desired drawable feature to change, defined as a constant by Window.
param
resId Resource identifier of the desired image.

public abstract voidsetFeatureDrawableUri(int featureId, android.net.Uri uri)
Set the value for a drawable feature of this window, from a URI. You must have called requestFeature(featureId) before calling this function.

The only URI currently supported is "content:", specifying an image in a content provider.

see
android.widget.ImageView#setImageURI
param
featureId The desired drawable feature to change. Features are constants defined by Window.
param
uri The desired URI.

public abstract voidsetFeatureInt(int featureId, int value)
Set the integer value for a feature. The range of the value depends on the feature being set. For FEATURE_PROGRESSS, it should go from 0 to 10000. At 10000 the progress is complete and the indicator hidden.

param
featureId The desired feature to change. Features are constants defined by Window.
param
value The value for the feature. The interpretation of this value is feature-specific.

public voidsetFlags(int flags, int mask)
Set the flags of the window, as per the {@link WindowManager.LayoutParams WindowManager.LayoutParams} flags.

Note that some flags must be set before the window decoration is created (by the first call to {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} or {@link #getDecorView()}: {@link WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN} and {@link WindowManager.LayoutParams#FLAG_LAYOUT_INSET_DECOR}. These will be set for you based on the {@link android.R.attr#windowIsFloating} attribute.

param
flags The new window flags (see WindowManager.LayoutParams).
param
mask Which of the window flag bits to modify.

        final WindowManager.LayoutParams attrs = getAttributes();
        attrs.flags = (attrs.flags&~mask) | (flags&mask);
        mForcedWindowFlags |= mask;
        if (mCallback != null) {
            mCallback.onWindowAttributesChanged(attrs);
        }
    
public voidsetFormat(int format)
Set the format of window, as per the PixelFormat types. This overrides the default format that is selected by the Window based on its window decorations.

param
format The new window format (see PixelFormat). Use PixelFormat.UNKNOWN to allow the Window to select the format.
see
PixelFormat

        final WindowManager.LayoutParams attrs = getAttributes();
        if (format != PixelFormat.UNKNOWN) {
            attrs.format = format;
            mHaveWindowFormat = true;
        } else {
            attrs.format = mDefaultWindowFormat;
            mHaveWindowFormat = false;
        }
        if (mCallback != null) {
            mCallback.onWindowAttributesChanged(attrs);
        }
    
public voidsetGravity(int gravity)
Set the gravity of the window, as per the Gravity constants. This controls how the window manager is positioned in the overall window; it is only useful when using WRAP_CONTENT for the layout width or height.

param
gravity The desired gravity constant.
see
Gravity
see
#setLayout

        final WindowManager.LayoutParams attrs = getAttributes();
        attrs.gravity = gravity;
        if (mCallback != null) {
            mCallback.onWindowAttributesChanged(attrs);
        }
    
public voidsetLayout(int width, int height)
Set the width and height layout parameters of the window. The default for both of these is FILL_PARENT; you can change them to WRAP_CONTENT to make a window that is not full-screen.

param
width The desired layout width of the window.
param
height The desired layout height of the window.

        final WindowManager.LayoutParams attrs = getAttributes();
        attrs.width = width;
        attrs.height = height;
        if (mCallback != null) {
            mCallback.onWindowAttributesChanged(attrs);
        }
    
public voidsetSoftInputMode(int mode)
Specify an explicit soft input mode to use for the window, as per {@link WindowManager.LayoutParams#softInputMode WindowManager.LayoutParams.softInputMode}. Providing anything besides "unspecified" here will override the input mode the window would normally retrieve from its theme.

        final WindowManager.LayoutParams attrs = getAttributes();
        if (mode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
            attrs.softInputMode = mode;
            mHasSoftInputMode = true;
        } else {
            mHasSoftInputMode = false;
        }
        if (mCallback != null) {
            mCallback.onWindowAttributesChanged(attrs);
        }
    
public abstract voidsetTitle(java.lang.CharSequence title)

public abstract voidsetTitleColor(int textColor)

public voidsetType(int type)
Set the type of the window, as per the WindowManager.LayoutParams types.

param
type The new window type (see WindowManager.LayoutParams).

        final WindowManager.LayoutParams attrs = getAttributes();
        attrs.type = type;
        if (mCallback != null) {
            mCallback.onWindowAttributesChanged(attrs);
        }
    
public abstract voidsetVolumeControlStream(int streamType)

see
android.app.Activity#setVolumeControlStream(int)

public voidsetWindowAnimations(int resId)
Specify custom animations to use for the window, as per {@link WindowManager.LayoutParams#windowAnimations WindowManager.LayoutParams.windowAnimations}. Providing anything besides 0 here will override the animations the window would normally retrieve from its theme.

        final WindowManager.LayoutParams attrs = getAttributes();
        attrs.windowAnimations = resId;
        if (mCallback != null) {
            mCallback.onWindowAttributesChanged(attrs);
        }
    
public voidsetWindowManager(WindowManager wm, android.os.IBinder appToken, java.lang.String appName)
Set the window manager for use by this Window to, for example, display panels. This is not used for displaying the Window itself -- that must be done by the client.

param
wm The ViewManager for adding new windows.

        mAppToken = appToken;
        mAppName = appName;
        if (wm == null) {
            wm = WindowManagerImpl.getDefault();
        }
        mWindowManager = new LocalWindowManager(wm);
    
public abstract booleansuperDispatchKeyEvent(KeyEvent event)
Used by custom windows, such as Dialog, to pass the key press event further down the view hierarchy. Application developers should not need to implement or call this.

public abstract booleansuperDispatchTouchEvent(MotionEvent event)
Used by custom windows, such as Dialog, to pass the touch screen event further down the view hierarchy. Application developers should not need to implement or call this.

public abstract booleansuperDispatchTrackballEvent(MotionEvent event)
Used by custom windows, such as Dialog, to pass the trackball event further down the view hierarchy. Application developers should not need to implement or call this.

public abstract voidtakeKeyEvents(boolean get)
Request that key events come to this activity. Use this if your activity has no views with focus, but the activity still wants a chance to process key events.

public abstract voidtogglePanel(int featureId, KeyEvent event)