Android
android.view
public static class

android.view.WindowManager.LayoutParams

java.lang.Object
android.view.ViewGroup.LayoutParams
android.view.WindowManager.LayoutParams Parcelable

Summary

XML Attributes inherited from class android.view.ViewGroup.LayoutParams

Constants

      Value  
int  ALPHA_CHANGED    128  0x00000080 
int  ANIMATION_CHANGED    16  0x00000010 
Creator<WindowManager.LayoutParams CREATOR       
int  DIM_AMOUNT_CHANGED    32  0x00000020 
int  FIRST_APPLICATION_WINDOW  Start of window types that represent normal application windows.  0x00000001 
int  FIRST_SUB_WINDOW  Start of types of sub-windows.  1000  0x000003e8 
int  FIRST_SYSTEM_WINDOW  Start of system-specific window types.  2000  0x000007d0 
int  FLAGS_CHANGED    0x00000004 
int  FLAG_BLUR_BEHIND  Window flag: blur everything behind this window.  0x00000004 
int  FLAG_DIM_BEHIND  Window flag: everything behind this window will be dimmed.  0x00000002 
int  FLAG_DITHER  Window flag: turn on dithering when compositing this window to the screen.  4096  0x00001000 
int  FLAG_FORCE_NOT_FULLSCREEN  Window flag: Override {@link #FLAG_FULLSCREEN and force the screen decorations (such as status bar) to be shown.  2048  0x00000800 
int  FLAG_FULLSCREEN  Window flag: Hide all screen decorations (e.g.  1024  0x00000400 
int  FLAG_IGNORE_CHEEK_PRESSES  Window flag: intended for windows that will often be used when the user is holding the screen against their face, it will aggressively filter the event stream to prevent unintended presses in this situation that may not be desired for a particular window, when such an event stream is detected, the application will receive a CANCEL motion event to indicate this so applications can handle this accordingly by taking no action on the event until the finger is released.  32768  0x00008000 
int  FLAG_KEEP_SCREEN_ON  Window flag: as long as this window is visible to the user, keep the device's screen turned on and bright.  128  0x00000080 
int  FLAG_LAYOUT_INSET_DECOR  Window flag: a special option only for use in combination with FLAG_LAYOUT_IN_SCREEN 65536  0x00010000 
int  FLAG_LAYOUT_IN_SCREEN  Window flag: place the window within the entire screen, ignoring decorations around the border (a.k.a.  256  0x00000100 
int  FLAG_LAYOUT_NO_LIMITS  Window flag: allow window to extend outside of the screen.  512  0x00000200 
int  FLAG_NOT_FOCUSABLE  Window flag: this window won't ever get focus.  0x00000008 
int  FLAG_NOT_TOUCHABLE  Window flag: this window can never receive touch events.  16  0x00000010 
int  FLAG_NOT_TOUCH_MODAL  Window flag: Even when this window is focusable (its {@link #FLAG_NOT_FOCUSABLE is not set), allow any pointer events outside of the window to be sent to the windows behind it.  32  0x00000020 
int  FLAG_SCALED  Window flag: a special mode where the layout parameters are used to perform scaling of the surface when it is composited to the screen.  16384  0x00004000 
int  FLAG_SECURE  Window flag: don't allow screen shots while this window is displayed.  8192  0x00002000 
int  FLAG_TOUCHABLE_WHEN_WAKING  Window flag: When set, if the device is asleep when the touch screen is pressed, you will receive this first touch event.  64  0x00000040 
int  FORMAT_CHANGED    0x00000008 
int  LAST_APPLICATION_WINDOW  End of types of application windows.  99  0x00000063 
int  LAST_SUB_WINDOW  End of types of sub-windows.  1999  0x000007cf 
int  LAST_SYSTEM_WINDOW  End of types of system windows.  2999  0x00000bb7 
int  LAYOUT_CHANGED    0x00000001 
int  MEMORY_TYPE_CHANGED    256  0x00000100 
int  MEMORY_TYPE_GPU  Memory type: The window's surface is configured to be accessible by graphics accelerators.  0x00000002 
int  MEMORY_TYPE_HARDWARE  Memory type: The window's surface is configured to be accessible by DMA engines and hardware accelerators.  0x00000001 
int  MEMORY_TYPE_NORMAL  Memory type: The window's surface is allocated in main memory.  0x00000000 
int  MEMORY_TYPE_PUSH_BUFFERS  Memory type: The window's surface doesn't own its buffers and therefore cannot be locked.  0x00000003 
int  TITLE_CHANGED    64  0x00000040 
int  TYPE_APPLICATION  Window type: a normal application window.  0x00000002 
int  TYPE_APPLICATION_MEDIA  Window type: window for showing media (e.g.  1001  0x000003e9 
int  TYPE_APPLICATION_PANEL  Window type: a panel on top of an application window.  1000  0x000003e8 
int  TYPE_APPLICATION_STARTING  Window type: special application window that is displayed while the application is starting.  0x00000003 
int  TYPE_APPLICATION_SUB_PANEL  Window type: a sub-panel on top of an application window.  1002  0x000003ea 
int  TYPE_BASE_APPLICATION  Window type: an application window that serves as the "base" window of the overall application; all other application windows will appear on top of it.  0x00000001 
int  TYPE_CHANGED    0x00000002 
int  TYPE_KEYGUARD  Window type: keyguard window.  2004  0x000007d4 
int  TYPE_KEYGUARD_DIALOG  Window type: dialogs that the keyguard shows   2009  0x000007d9 
int  TYPE_PHONE  Window type: phone.  2002  0x000007d2 
int  TYPE_PRIORITY_PHONE  Window type: priority phone UI, which needs to be displayed even if the keyguard is active.  2007  0x000007d7 
int  TYPE_SEARCH_BAR  Window type: the search bar.  2001  0x000007d1 
int  TYPE_STATUS_BAR  Window type: the status bar.  2000  0x000007d0 
int  TYPE_STATUS_BAR_PANEL  Window type: panel that slides out from the status bar   2008  0x000007d8 
int  TYPE_SYSTEM_ALERT  Window type: system window, such as low power alert.  2003  0x000007d3 
int  TYPE_SYSTEM_DIALOG  Window type: panel that slides out from the status bar   2008  0x000007d8 
int  TYPE_SYSTEM_ERROR  Window type: internal system error windows, appear on top of everything they can.  2010  0x000007da 
int  TYPE_SYSTEM_OVERLAY  Window type: system overlay windows, which need to be displayed on top of everything else.  2006  0x000007d6 
int  TYPE_TOAST  Window type: transient notifications.  2005  0x000007d5 
Constants inherited from class android.view.ViewGroup.LayoutParams
Constants inherited from interface android.os.Parcelable

Fields

public      float  alpha  An alpha value to apply to this entire window. 
public      float  dimAmount  When FLAG_DIM_BEHIND is set, this is the amount of dimming to apply. 
public      int  flags  Various behavioral options/flags. 
public      int  format  The desired bitmap format. 
public      int  gravity  Placement of window within the screen as per Gravity 
public      float  horizontalMargin  The horizontal margin, as a percentage of the container's width, between the container and the widget. 
public      float  horizontalWeight  Indicates how much of the extra space will be allocated horizontally to the view associated with these LayoutParams. 
public      int  memoryType  Specifies what type of memory buffers should be used by this window. 
public      String  packageName  Name of the package owning this window. 
public      IBinder  token  Identifier for this window. 
public      int  type  The general type of window. 
public      float  verticalMargin  The vertical margin, as a percentage of the container's height, between the container and the widget. 
public      float  verticalWeight  Indicates how much of the extra space will be allocated vertically to the view associated with these LayoutParams. 
public      int  windowAnimations  A style resource defining the animations to use for this window. 
public      int  x  X position for this window. 
public      int  y  Y position for this window. 
Fields inherited from class android.view.ViewGroup.LayoutParams

Public Constructors

            WindowManager.LayoutParams()
            WindowManager.LayoutParams(int _type)
            WindowManager.LayoutParams(int _type, int _flags)
            WindowManager.LayoutParams(int _type, int _flags, int _format)
            WindowManager.LayoutParams(int w, int h, int _type, int _flags, int _format)
            WindowManager.LayoutParams(int w, int h, int xpos, int ypos, int _type, int _flags, int _format)
            WindowManager.LayoutParams(Parcel in)

Public Methods

    final      int  copyFrom(WindowManager.LayoutParams o)
          String  debug(String output)
Returns a String representation of this set of layout parameters.
          int  describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
    final      CharSequence  getTitle()
    final      void  setTitle(CharSequence title)
          String  toString()
Returns a string containing a concise, human-readable description of the receiver.
          void  writeToParcel(Parcel out, int parcelableFlags)
Flatten this object in to a Parcel.
Methods inherited from class android.view.ViewGroup.LayoutParams
Methods inherited from class java.lang.Object
Methods inherited from interface android.os.Parcelable

Details

Constants

public static final int ALPHA_CHANGED

Constant Value: 128 (0x00000080)

public static final int ANIMATION_CHANGED

Constant Value: 16 (0x00000010)

public static final Creator<WindowManager.LayoutParams> CREATOR

public static final int DIM_AMOUNT_CHANGED

Constant Value: 32 (0x00000020)

public static final int FIRST_APPLICATION_WINDOW

Start of window types that represent normal application windows.
Constant Value: 1 (0x00000001)

public static final int FIRST_SUB_WINDOW

Start of types of sub-windows. The token of these windows must be set to the window they are attached to. These types of windows are kept next to their attached window in Z-order, and their coordinate space is relative to their attached window.
Constant Value: 1000 (0x000003e8)

public static final int FIRST_SYSTEM_WINDOW

Start of system-specific window types. These are not normally created by applications.
Constant Value: 2000 (0x000007d0)

public static final int FLAGS_CHANGED

Constant Value: 4 (0x00000004)

public static final int FLAG_BLUR_BEHIND

Window flag: blur everything behind this window.
Constant Value: 4 (0x00000004)

public static final int FLAG_DIM_BEHIND

Window flag: everything behind this window will be dimmed. Use dimAmount to control the amount of dim.
Constant Value: 2 (0x00000002)

public static final int FLAG_DITHER

Window flag: turn on dithering when compositing this window to the screen.
Constant Value: 4096 (0x00001000)

public static final int FLAG_FORCE_NOT_FULLSCREEN

Window flag: Override {@link #FLAG_FULLSCREEN and force the screen decorations (such as status bar) to be shown.
Constant Value: 2048 (0x00000800)

public static final int FLAG_FULLSCREEN

Window flag: Hide all screen decorations (e.g. status bar) while this window is displayed. This allows the window to use the entire display space for itself -- the status bar will be hidden when an app window with this flag set is on the top layer.
Constant Value: 1024 (0x00000400)

public static final int FLAG_IGNORE_CHEEK_PRESSES

Window flag: intended for windows that will often be used when the user is holding the screen against their face, it will aggressively filter the event stream to prevent unintended presses in this situation that may not be desired for a particular window, when such an event stream is detected, the application will receive a CANCEL motion event to indicate this so applications can handle this accordingly by taking no action on the event until the finger is released.
Constant Value: 32768 (0x00008000)

public static final int FLAG_KEEP_SCREEN_ON

Window flag: as long as this window is visible to the user, keep the device's screen turned on and bright.
Constant Value: 128 (0x00000080)

public static final int FLAG_LAYOUT_INSET_DECOR

Window flag: a special option only for use in combination with FLAG_LAYOUT_IN_SCREEN. When requesting layout in the screen your window may appear on top of or behind screen decorations such as the status bar. By also including this flag, the window manager will report the inset rectangle needed to ensure your content is not covered by screen decorations. This flag is normally set for you by Window as described in setFlags(int, int).
Constant Value: 65536 (0x00010000)

public static final int FLAG_LAYOUT_IN_SCREEN

Window flag: place the window within the entire screen, ignoring decorations around the border (a.k.a. the status bar). The window must correctly position its contents to take the screen decoration into account. This flag is normally set for you by Window as described in setFlags(int, int).
Constant Value: 256 (0x00000100)

public static final int FLAG_LAYOUT_NO_LIMITS

Window flag: allow window to extend outside of the screen.
Constant Value: 512 (0x00000200)

public static final int FLAG_NOT_FOCUSABLE

Window flag: this window won't ever get focus.
Constant Value: 8 (0x00000008)

public static final int FLAG_NOT_TOUCHABLE

Window flag: this window can never receive touch events.
Constant Value: 16 (0x00000010)

public static final int FLAG_NOT_TOUCH_MODAL

Window flag: Even when this window is focusable (its {@link #FLAG_NOT_FOCUSABLE is not set), allow any pointer events outside of the window to be sent to the windows behind it. Otherwise it will consume all pointer events itself, regardless of whether they are inside of the window.
Constant Value: 32 (0x00000020)

public static final int FLAG_SCALED

Window flag: a special mode where the layout parameters are used to perform scaling of the surface when it is composited to the screen.
Constant Value: 16384 (0x00004000)

public static final int FLAG_SECURE

Window flag: don't allow screen shots while this window is displayed.
Constant Value: 8192 (0x00002000)

public static final int FLAG_TOUCHABLE_WHEN_WAKING

Window flag: When set, if the device is asleep when the touch screen is pressed, you will receive this first touch event. Usually the first touch event is consumed by the system since the user can not see what they are pressing on.
Constant Value: 64 (0x00000040)

public static final int FORMAT_CHANGED

Constant Value: 8 (0x00000008)

public static final int LAST_APPLICATION_WINDOW

End of types of application windows.
Constant Value: 99 (0x00000063)

public static final int LAST_SUB_WINDOW

End of types of sub-windows.
Constant Value: 1999 (0x000007cf)

public static final int LAST_SYSTEM_WINDOW

End of types of system windows.
Constant Value: 2999 (0x00000bb7)

public static final int LAYOUT_CHANGED

Constant Value: 1 (0x00000001)

public static final int MEMORY_TYPE_CHANGED

Constant Value: 256 (0x00000100)

public static final int MEMORY_TYPE_GPU

Memory type: The window's surface is configured to be accessible by graphics accelerators.
Constant Value: 2 (0x00000002)

public static final int MEMORY_TYPE_HARDWARE

Memory type: The window's surface is configured to be accessible by DMA engines and hardware accelerators.
Constant Value: 1 (0x00000001)

public static final int MEMORY_TYPE_NORMAL

Memory type: The window's surface is allocated in main memory.
Constant Value: 0 (0x00000000)

public static final int MEMORY_TYPE_PUSH_BUFFERS

Memory type: The window's surface doesn't own its buffers and therefore cannot be locked. Instead the buffers are pushed to it through native binder calls.
Constant Value: 3 (0x00000003)

public static final int TITLE_CHANGED

Constant Value: 64 (0x00000040)

public static final int TYPE_APPLICATION

Window type: a normal application window. The token must be an Activity token identifying who the window belongs to.
Constant Value: 2 (0x00000002)

public static final int TYPE_APPLICATION_MEDIA

Window type: window for showing media (e.g. video). These windows are displayed behind their attached window.
Constant Value: 1001 (0x000003e9)

public static final int TYPE_APPLICATION_PANEL

Window type: a panel on top of an application window. These windows appear on top of their attached window.
Constant Value: 1000 (0x000003e8)

public static final int TYPE_APPLICATION_STARTING

Window type: special application window that is displayed while the application is starting. Not for use by applications themselves; this is used by the system to display something until the application can show its own windows.
Constant Value: 3 (0x00000003)

public static final int TYPE_APPLICATION_SUB_PANEL

Window type: a sub-panel on top of an application window. These windows are displayed on top their attached window and any TYPE_APPLICATION_PANEL panels.
Constant Value: 1002 (0x000003ea)

public static final int TYPE_BASE_APPLICATION

Window type: an application window that serves as the "base" window of the overall application; all other application windows will appear on top of it.
Constant Value: 1 (0x00000001)

public static final int TYPE_CHANGED

Constant Value: 2 (0x00000002)

public static final int TYPE_KEYGUARD

Window type: keyguard window.
Constant Value: 2004 (0x000007d4)

public static final int TYPE_KEYGUARD_DIALOG

Window type: dialogs that the keyguard shows
Constant Value: 2009 (0x000007d9)

public static final int TYPE_PHONE

Window type: phone. These are non-application windows providing user interaction with the phone (in particular incoming calls). These windows are normally placed above all applications, but behind the status bar.
Constant Value: 2002 (0x000007d2)

public static final int TYPE_PRIORITY_PHONE

Window type: priority phone UI, which needs to be displayed even if the keyguard is active. These windows must not take input focus, or they will interfere with the keyguard.
Constant Value: 2007 (0x000007d7)

public static final int TYPE_SEARCH_BAR

Window type: the search bar. There can be only one search bar window; it is placed at the top of the screen.
Constant Value: 2001 (0x000007d1)

public static final int TYPE_STATUS_BAR

Window type: the status bar. There can be only one status bar window; it is placed at the top of the screen, and all other windows are shifted down so they are below it.
Constant Value: 2000 (0x000007d0)

public static final int TYPE_STATUS_BAR_PANEL

Window type: panel that slides out from the status bar
Constant Value: 2008 (0x000007d8)

public static final int TYPE_SYSTEM_ALERT

Window type: system window, such as low power alert. These windows are always on top of application windows.
Constant Value: 2003 (0x000007d3)

public static final int TYPE_SYSTEM_DIALOG

Window type: panel that slides out from the status bar
Constant Value: 2008 (0x000007d8)

public static final int TYPE_SYSTEM_ERROR

Window type: internal system error windows, appear on top of everything they can.
Constant Value: 2010 (0x000007da)

public static final int TYPE_SYSTEM_OVERLAY

Window type: system overlay windows, which need to be displayed on top of everything else. These windows must not take input focus, or they will interfere with the keyguard.
Constant Value: 2006 (0x000007d6)

public static final int TYPE_TOAST

Window type: transient notifications.
Constant Value: 2005 (0x000007d5)

Fields

public float alpha

An alpha value to apply to this entire window. An alpha of 1.0 means fully opaque and 0.0 means fully transparent

public float dimAmount

When FLAG_DIM_BEHIND is set, this is the amount of dimming to apply. Range is from 1.0 for completely opaque to 0.0 for no dim.

public int format

The desired bitmap format. May be one of the constants in PixelFormat. Default is OPAQUE.

public int gravity

Placement of window within the screen as per Gravity

See Also

public float horizontalMargin

The horizontal margin, as a percentage of the container's width, between the container and the widget.

public float horizontalWeight

Indicates how much of the extra space will be allocated horizontally to the view associated with these LayoutParams. Specify 0 if the view should not be stretched. Otherwise the extra pixels will be pro-rated among all views whose weight is greater than 0.

public int memoryType

Specifies what type of memory buffers should be used by this window. Default is normal.

public String packageName

Name of the package owning this window.

public IBinder token

Identifier for this window. This will usually be filled in for you.

public int type

The general type of window. There are three main classes of window types:
  • Application windows (ranging from FIRST_APPLICATION_WINDOW to LAST_APPLICATION_WINDOW) are normal top-level application windows. For these types of windows, the token must be set to the token of the activity they are a part of (this will normally be done for you if token is null).
  • Sub-windows (ranging from FIRST_SUB_WINDOW to LAST_SUB_WINDOW) are associated with another top-level window. For these types of windows, the token must be the token of the window it is attached to.
  • System windows (ranging from FIRST_SYSTEM_WINDOW to LAST_SYSTEM_WINDOW) are special types of windows for use by the system for specific purposes. They should not normally be used by applications, and a special permission is required to use them.

public float verticalMargin

The vertical margin, as a percentage of the container's height, between the container and the widget.

public float verticalWeight

Indicates how much of the extra space will be allocated vertically to the view associated with these LayoutParams. Specify 0 if the view should not be stretched. Otherwise the extra pixels will be pro-rated among all views whose weight is greater than 0.

public int windowAnimations

A style resource defining the animations to use for this window. This must be a system resource; it can not be an application resource because the window manager does not have access to applications.

public int x

X position for this window. With the default gravity it is ignored. When using LEFT or RIGHT it provides an offset from the given edge.

public int y

Y position for this window. With the default gravity it is ignored. When using TOP or BOTTOM it provides an offset from the given edge.

Public Constructors

public WindowManager.LayoutParams()

public WindowManager.LayoutParams(int _type)

public WindowManager.LayoutParams(int _type, int _flags)

public WindowManager.LayoutParams(int _type, int _flags, int _format)

public WindowManager.LayoutParams(int w, int h, int _type, int _flags, int _format)

public WindowManager.LayoutParams(int w, int h, int xpos, int ypos, int _type, int _flags, int _format)

public WindowManager.LayoutParams(Parcel in)

Public Methods

public final int copyFrom(WindowManager.LayoutParams o)

public String debug(String output)

Returns a String representation of this set of layout parameters.

Parameters

output the String to prepend to the internal representation

Returns

  • a String with the following format: output + "ViewGroup.LayoutParams={ width=WIDTH, height=HEIGHT }"

public int describeContents()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

public final CharSequence getTitle()

public final void setTitle(CharSequence title)

public String toString()

Returns a string containing a concise, human-readable description of the receiver.

Returns

  • String a printable representation for the receiver.

public void writeToParcel(Parcel out, int parcelableFlags)

Flatten this object in to a Parcel.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48