android.view
public
abstract
class
android.view.Window
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.
Nested Classes
Summary
Constants
Public Constructors
Public Methods
abstract |
|
|
|
|
void |
addContentView(View view, ViewGroup.LayoutParams params) |
|
|
|
|
|
void |
addFlags(int flags) |
|
|
|
|
|
void |
clearFlags(int flags) |
abstract |
|
|
|
|
void |
closeAllPanels() |
abstract |
|
|
|
|
void |
closePanel(int featureId) |
|
|
|
|
|
View |
findViewById(int id) |
|
|
final |
|
|
WindowManager.LayoutParams |
getAttributes() |
|
|
final |
|
|
Window.Callback |
getCallback() |
|
|
final |
|
|
Window |
getContainer() |
|
|
final |
|
|
Context |
getContext() |
abstract |
|
|
|
|
View |
getCurrentFocus() |
abstract |
|
|
|
|
View |
getDecorView() |
abstract |
|
|
|
|
LayoutInflater |
getLayoutInflater() |
abstract |
|
|
|
|
int |
getVolumeControlStream() |
|
|
|
|
|
WindowManager |
getWindowManager() |
|
|
final |
|
|
TypedArray |
getWindowStyle() |
|
|
final |
|
|
boolean |
hasChildren() |
|
|
final |
|
|
boolean |
isActive() |
abstract |
|
|
|
|
boolean |
isFloating() |
abstract |
|
|
|
|
boolean |
isShortcutKey(int keyCode, KeyEvent event) |
|
|
final |
|
|
void |
makeActive() |
abstract |
|
|
|
|
void |
onConfigurationChanged(Configuration newConfig) |
abstract |
|
|
|
|
void |
openPanel(int featureId, KeyEvent event) |
abstract |
|
|
|
|
View |
peekDecorView() |
abstract |
|
|
|
|
boolean |
performContextMenuIdentifierAction(int id, int flags) |
abstract |
|
|
|
|
boolean |
performPanelIdentifierAction(int featureId, int id, int flags) |
abstract |
|
|
|
|
boolean |
performPanelShortcut(int featureId, int keyCode, KeyEvent event, int flags) |
|
|
|
|
|
boolean |
requestFeature(int featureId) |
abstract |
|
|
|
|
void |
restoreHierarchyState(Bundle savedInstanceState) |
abstract |
|
|
|
|
Bundle |
saveHierarchyState() |
|
|
|
|
|
void |
setAttributes(WindowManager.LayoutParams a) |
abstract |
|
|
|
|
void |
setBackgroundDrawable(Drawable drawable) |
|
|
|
|
|
void |
setBackgroundDrawableResource(int resid) |
|
|
|
|
|
void |
setCallback(Window.Callback callback) |
abstract |
|
|
|
|
void |
setChildDrawable(int featureId, Drawable drawable) |
abstract |
|
|
|
|
void |
setChildInt(int featureId, int value) |
|
|
|
|
|
void |
setContainer(Window container) |
abstract |
|
|
|
|
void |
setContentView(View view, ViewGroup.LayoutParams params) |
abstract |
|
|
|
|
void |
setContentView(View view) |
abstract |
|
|
|
|
void |
setContentView(int layoutResID) |
abstract |
|
|
|
|
void |
setFeatureDrawable(int featureId, Drawable drawable) |
abstract |
|
|
|
|
void |
setFeatureDrawableAlpha(int featureId, int alpha) |
abstract |
|
|
|
|
void |
setFeatureDrawableResource(int featureId, int resId) |
abstract |
|
|
|
|
void |
setFeatureDrawableUri(int featureId, Uri uri) |
abstract |
|
|
|
|
void |
setFeatureInt(int featureId, int value) |
|
|
|
|
|
void |
setFlags(int flags, int mask) |
|
|
|
|
|
void |
setFormat(int format) |
|
|
|
|
|
void |
setGravity(int gravity) |
|
|
|
|
|
void |
setLayout(int width, int height) |
abstract |
|
|
|
|
void |
setTitle(CharSequence title) |
abstract |
|
|
|
|
void |
setTitleColor(int textColor) |
|
|
|
|
|
void |
setType(int type) |
abstract |
|
|
|
|
void |
setVolumeControlStream(int streamType) |
|
|
|
|
|
void |
setWindowManager(WindowManager wm, IBinder appToken, String appName) |
abstract |
|
|
|
|
boolean |
superDispatchKeyEvent(KeyEvent event) |
abstract |
|
|
|
|
boolean |
superDispatchTouchEvent(MotionEvent event) |
abstract |
|
|
|
|
boolean |
superDispatchTrackballEvent(MotionEvent event) |
abstract |
|
|
|
|
void |
takeKeyEvents(boolean get) |
abstract |
|
|
|
|
void |
togglePanel(int featureId, KeyEvent event) |
Protected Methods
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Constants
protected
static
final
int
DEFAULT_FEATURES
The default features enabled
Constant Value:
65
(0x00000041)
public
static
final
int
FEATURE_CONTEXT_MENU
Flag for the context menu. This is enabled by default.
Constant Value:
6
(0x00000006)
public
static
final
int
FEATURE_CUSTOM_TITLE
Flag for custom title. You cannot combine this feature with other title features.
Constant Value:
7
(0x00000007)
public
static
final
int
FEATURE_INDETERMINATE_PROGRESS
Flag for indeterminate progress
Constant Value:
5
(0x00000005)
public
static
final
int
FEATURE_LEFT_ICON
Flag for having an icon on the left side of the title bar
Constant Value:
3
(0x00000003)
public
static
final
int
FEATURE_NO_TITLE
Flag for the "no title" feature, turning off the title at the top
of the screen.
Constant Value:
1
(0x00000001)
public
static
final
int
FEATURE_OPENGL
Flag for asking for an OpenGL enabled window. All 2D graphics will be handled by OpenGL ES
Constant Value:
8
(0x00000008)
public
static
final
int
FEATURE_OPTIONS_PANEL
Flag for the "options panel" feature. This is enabled by default.
Constant Value:
0
(0x00000000)
public
static
final
int
FEATURE_PROGRESS
Flag for the progress indicator feature
Constant Value:
2
(0x00000002)
public
static
final
int
FEATURE_RIGHT_ICON
Flag for having an icon on the right side of the title bar
Constant Value:
4
(0x00000004)
public
static
final
int
ID_ANDROID_CONTENT
The ID that the main layout in the XML layout file should have.
Constant Value:
16908290
(0x01020002)
public
static
final
int
PROGRESS_END
Ending value for the (primary) progress
Constant Value:
10000
(0x00002710)
public
static
final
int
PROGRESS_INDETERMINATE_OFF
Flag for setting the progress bar's indeterminate mode off
Constant Value:
-4
(0xfffffffc)
public
static
final
int
PROGRESS_INDETERMINATE_ON
Flag for setting the progress bar's indeterminate mode on
Constant Value:
-3
(0xfffffffd)
public
static
final
int
PROGRESS_SECONDARY_END
Highest possible value for the secondary progress
Constant Value:
30000
(0x00007530)
public
static
final
int
PROGRESS_SECONDARY_START
Lowest possible value for the secondary progress
Constant Value:
20000
(0x00004e20)
public
static
final
int
PROGRESS_START
Starting value for the (primary) progress
Constant Value:
0
(0x00000000)
public
static
final
int
PROGRESS_VISIBILITY_OFF
Flag for setting the progress bar's visibility to GONE
Constant Value:
-2
(0xfffffffe)
public
static
final
int
PROGRESS_VISIBILITY_ON
Flag for setting the progress bar's visibility to VISIBLE
Constant Value:
-1
(0xffffffff)
Public Constructors
Public Methods
Variation on
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.
Parameters
view
| The desired content to display. |
params
| Layout parameters for the view.
|
public
void
addFlags(int flags)
Convenience function to set the flag bits as specified in flags, as
per
setFlags(int, int).
Parameters
flags
| The flag bits to be set. |
public
void
clearFlags(int flags)
Convenience function to clear the flag bits as specified in flags, as
per
setFlags(int, int).
Parameters
flags
| The flag bits to be cleared. |
public
abstract
void
closeAllPanels()
public
abstract
void
closePanel(int featureId)
public
View
findViewById(int id)
Finds a view that was identified by the id attribute from the XML that
was processed in
onCreate(Bundle). This will
implicitly call
getDecorView() for you, with all of the
associated side-effects.
Returns
- The view if found or null otherwise.
Retrieve the current window attributes associated with this panel.
Returns
- WindowManager.LayoutParams Either the existing window
attributes object, or a freshly created one if there is none.
Return the current Callback interface for this window.
public
final
Window
getContainer()
Return the container for this Window.
Returns
- Window The containing window, or null if this is a
top-level window.
public
final
Context
getContext()
Return the Context this window policy is running in, for retrieving
resources and other information.
Returns
- Context The Context that was supplied to the constructor.
public
abstract
View
getCurrentFocus()
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.
Returns
- View The current View with focus or null.
public
abstract
View
getDecorView()
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
setContentView(View, android.view.ViewGroup.LayoutParams).
Returns
- Returns the top-level window decor view.
public
abstract
LayoutInflater
getLayoutInflater()
Quick access to the
LayoutInflater instance that this Window
retrieved from its Context.
Returns
- LayoutInflater The shared LayoutInflater.
public
abstract
int
getVolumeControlStream()
Return the window manager allowing this Window to display its own
windows.
Returns
- WindowManager The ViewManager.
public
final
TypedArray
getWindowStyle()
Return the
Window attributes from this
window's theme.
public
final
boolean
hasChildren()
public
final
boolean
isActive()
public
abstract
boolean
isFloating()
Return whether this window is being displayed with a floating style
(based on the
windowIsFloating attribute in
the style/theme).
Returns
- Returns true if the window is configured to be displayed floating
on top of whatever is behind it.
public
abstract
boolean
isShortcutKey(int keyCode, KeyEvent event)
Is a keypress one of the defined shortcut keys for this window.
Parameters
keyCode
| the key code from KeyEvent to check. |
event
| the KeyEvent to use to help check.
|
public
final
void
makeActive()
public
abstract
void
onConfigurationChanged(Configuration newConfig)
Should be called when the configuration is changed.
Parameters
newConfig
| The new configuration.
|
public
abstract
void
openPanel(int featureId, KeyEvent event)
public
abstract
View
peekDecorView()
Retrieve the current decor view, but only if it has already been created;
otherwise returns null.
Returns
- Returns the top-level window decor or null.
public
abstract
boolean
performContextMenuIdentifierAction(int id, int flags)
public
abstract
boolean
performPanelIdentifierAction(int featureId, int id, int flags)
public
abstract
boolean
performPanelShortcut(int featureId, int keyCode, KeyEvent event, int flags)
public
boolean
requestFeature(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
FEATURE_CUSTOM_TITLE.
Parameters
featureId
| The desired features, defined as constants by Window. |
Returns
- The features that are now set.
public
abstract
void
restoreHierarchyState(Bundle savedInstanceState)
public
abstract
Bundle
saveHierarchyState()
Specify custom window attributes.
Parameters
a
| The new window attributes, which will completely override any
current values.
|
public
abstract
void
setBackgroundDrawable(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.)
Parameters
drawable
| The new Drawable to use for this window's background.
|
public
void
setBackgroundDrawableResource(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.)
Parameters
resid
| The resource identifier of a drawable resource which will be
installed as the new background.
|
public
void
setCallback(Window.Callback callback)
Set the Callback interface for this window, used to intercept key
events and other dynamic operations in the window.
Parameters
callback
| The desired Callback interface.
|
public
abstract
void
setChildDrawable(int featureId, Drawable drawable)
public
abstract
void
setChildInt(int featureId, int value)
public
void
setContainer(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.
Parameters
container
| The desired containing Window.
|
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 requestFeature(int),
and certain window flags as described in setFlags(int, int).
Parameters
view
| The desired content to display. |
params
| Layout parameters for the view.
|
public
abstract
void
setContentView(View view)
public
abstract
void
setContentView(int layoutResID)
public
abstract
void
setFeatureDrawable(int featureId, Drawable drawable)
Set an explicit Drawable value for feature of this window. You must
have called requestFeature(featureId) before calling this function.
Parameters
featureId
| The desired drawable feature to change.
Features are constants defined by Window. |
drawable
| A Drawable object to display.
|
public
abstract
void
setFeatureDrawableAlpha(int featureId, int alpha)
Set a custom alpha value for the given drawale feature, controlling how
much the background is visible through it.
Parameters
featureId
| The desired drawable feature to change.
Features are constants defined by Window. |
alpha
| The alpha amount, 0 is completely transparent and 255 is
completely opaque.
|
public
abstract
void
setFeatureDrawableResource(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.
Parameters
featureId
| The desired drawable feature to change, defined as a
constant by Window. |
resId
| Resource identifier of the desired image.
|
public
abstract
void
setFeatureDrawableUri(int featureId, 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.
Parameters
featureId
| The desired drawable feature to change. Features are
constants defined by Window. |
uri
| The desired URI.
|
public
abstract
void
setFeatureInt(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.
Parameters
featureId
| The desired feature to change.
Features are constants defined by Window. |
value
| The value for the feature. The interpretation of this
value is feature-specific.
|
public
void
setFlags(int flags, int mask)
public
void
setFormat(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.
Parameters
format
| The new window format (see PixelFormat). Use
PixelFormat.UNKNOWN to allow the Window to select
the format. |
public
void
setGravity(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.
Parameters
gravity
| The desired gravity constant. |
public
void
setLayout(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.
Parameters
width
| The desired layout width of the window. |
height
| The desired layout height of the window.
|
public
abstract
void
setTitleColor(int textColor)
public
void
setType(int type)
Set the type of the window, as per the WindowManager.LayoutParams
types.
Parameters
type
| The new window type (see WindowManager.LayoutParams).
|
public
abstract
void
setVolumeControlStream(int streamType)
public
void
setWindowManager(WindowManager wm, IBinder appToken, 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.
Parameters
wm
| The ViewManager for adding new windows.
|
public
abstract
boolean
superDispatchKeyEvent(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
boolean
superDispatchTouchEvent(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
boolean
superDispatchTrackballEvent(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
void
takeKeyEvents(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
void
togglePanel(int featureId, KeyEvent event)
Protected Methods
protected
final
int
getFeatures()
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.
protected
final
int
getForcedWindowFlags()
Return the window flags that have been explicitly set by the client,
so will not be modified by
getDecorView().
protected
final
int
getLocalFeatures()
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.
protected
abstract
void
onActive()
protected
void
setDefaultWindowFormat(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();
Parameters
format
| The new window format (see PixelFormat). |