android.app.Dialog
Summary
Fields
Public Constructors
Protected Constructors
Public Methods
|
|
|
|
|
void |
addContentView(View view, ViewGroup.LayoutParams params) |
|
|
|
|
|
void |
cancel() |
|
|
|
|
|
void |
closeOptionsMenu() |
|
|
|
|
|
void |
dismiss() |
|
|
|
|
|
boolean |
dispatchKeyEvent(KeyEvent event) |
|
|
|
|
|
boolean |
dispatchTouchEvent(MotionEvent ev) |
|
|
|
|
|
boolean |
dispatchTrackballEvent(MotionEvent ev) |
|
|
|
|
|
View |
findViewById(int id) |
|
|
final |
|
|
Context |
getContext() |
|
|
|
|
|
View |
getCurrentFocus() |
|
|
|
|
|
LayoutInflater |
getLayoutInflater() |
|
|
final |
|
|
Activity |
getOwnerActivity() |
|
|
final |
|
|
int |
getVolumeControlStream() |
|
|
|
|
|
Window |
getWindow() |
|
|
|
|
|
void |
hide() |
|
|
|
|
|
boolean |
isShowing() |
|
|
|
|
|
void |
onContentChanged() |
|
|
|
|
|
boolean |
onContextItemSelected(MenuItem item) |
|
|
|
|
|
void |
onContextMenuClosed(Menu menu) |
|
|
|
|
|
void |
onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo) |
|
|
|
|
|
boolean |
onCreateOptionsMenu(Menu menu) |
|
|
|
|
|
boolean |
onCreatePanelMenu(int featureId, Menu menu) |
|
|
|
|
|
View |
onCreatePanelView(int featureId) |
|
|
|
|
|
boolean |
onKeyDown(int keyCode, KeyEvent event) |
|
|
|
|
|
boolean |
onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) |
|
|
|
|
|
boolean |
onKeyUp(int keyCode, KeyEvent event) |
|
|
|
|
|
boolean |
onMenuItemSelected(int featureId, MenuItem item) |
|
|
|
|
|
boolean |
onMenuOpened(int featureId, Menu menu) |
|
|
|
|
|
boolean |
onOptionsItemSelected(MenuItem item) |
|
|
|
|
|
void |
onOptionsMenuClosed(Menu menu) |
|
|
|
|
|
void |
onPanelClosed(int featureId, Menu menu) |
|
|
|
|
|
boolean |
onPrepareOptionsMenu(Menu menu) |
|
|
|
|
|
boolean |
onPreparePanel(int featureId, View view, Menu menu) |
|
|
|
|
|
void |
onRestoreInstanceState(Bundle savedInstanceState) |
|
|
|
|
|
Bundle |
onSaveInstanceState() |
|
|
|
|
|
boolean |
onSearchRequested() |
|
|
|
|
|
boolean |
onTouchEvent(MotionEvent event) |
|
|
|
|
|
boolean |
onTrackballEvent(MotionEvent event) |
|
|
|
|
|
void |
onWindowAttributesChanged(WindowManager.LayoutParams params) |
|
|
|
|
|
void |
onWindowFocusChanged(boolean hasFocus) |
|
|
|
|
|
void |
openContextMenu(View view) |
|
|
|
|
|
void |
openOptionsMenu() |
|
|
|
|
|
void |
registerForContextMenu(View view) |
|
|
final |
|
|
boolean |
requestWindowFeature(int featureId) |
|
|
|
|
|
void |
setCancelMessage(Message msg) |
|
|
|
|
|
void |
setCancelable(boolean flag) |
|
|
|
|
|
void |
setCanceledOnTouchOutside(boolean cancel) |
|
|
|
|
|
void |
setContentView(View view, ViewGroup.LayoutParams params) |
|
|
|
|
|
void |
setContentView(View view) |
|
|
|
|
|
void |
setContentView(int layoutResID) |
|
|
|
|
|
void |
setDismissMessage(Message msg) |
|
|
final |
|
|
void |
setFeatureDrawable(int featureId, Drawable drawable) |
|
|
final |
|
|
void |
setFeatureDrawableAlpha(int featureId, int alpha) |
|
|
final |
|
|
void |
setFeatureDrawableResource(int featureId, int resId) |
|
|
final |
|
|
void |
setFeatureDrawableUri(int featureId, Uri uri) |
|
|
|
|
|
void |
setOnCancelListener(DialogInterface.OnCancelListener listener) |
|
|
|
|
|
void |
setOnDismissListener(DialogInterface.OnDismissListener listener) |
|
|
|
|
|
void |
setOnKeyListener(DialogInterface.OnKeyListener onKeyListener) |
|
|
final |
|
|
void |
setOwnerActivity(Activity activity) |
|
|
|
|
|
void |
setTitle(int titleId) |
|
|
|
|
|
void |
setTitle(CharSequence title) |
|
|
final |
|
|
void |
setVolumeControlStream(int streamType) |
|
|
|
|
|
void |
show() |
|
|
|
|
|
void |
takeKeyEvents(boolean get) |
|
|
|
|
|
void |
unregisterForContextMenu(View view) |
Protected Methods
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
dispatchKeyEvent,
dispatchTouchEvent,
dispatchTrackballEvent,
onContentChanged,
onCreatePanelMenu,
onCreatePanelView,
onMenuItemSelected,
onMenuOpened,
onPanelClosed,
onPreparePanel,
onSearchRequested,
onWindowAttributesChanged,
onWindowFocusChanged
Details
Fields
protected
boolean
mCancelable
Public Constructors
public
Dialog(Context context)
Create a Dialog window that uses the default dialog frame style.
Parameters
context
| The Context the Dialog is to run it. In particular, it
uses the window manager and theme in this context to
present its UI.
|
public
Dialog(Context context, int theme)
Create a Dialog window that uses a custom dialog style.
Parameters
context
| The Context in which the Dialog should run. In particular, it
uses the window manager and theme from this context to
present its UI. |
theme
| A style resource describing the theme to use for the
window. See Style
and Theme Resources for more information about defining and using
styles. This theme is applied on top of the current theme in
context. If 0, the default dialog theme will be used.
|
Protected Constructors
protected
Dialog(Context context, boolean cancelable, Message cancelCallback)
Public Methods
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
closeOptionsMenu()
public
void
dismiss()
Dismiss this dialog, removing it from the screen. This method can be
invoked safely from any thread. Note that you should not override this
method to do cleanup when the dialog is dismissed, instead implement
that in
onStop().
public
boolean
dispatchKeyEvent(KeyEvent event)
Called to process key events. You can override this to intercept all
key events before they are dispatched to the window. Be sure to call
this implementation for key events that should be handled normally.
Returns
- boolean Return true if this event was consumed.
public
boolean
dispatchTouchEvent(MotionEvent ev)
Called to process touch screen events. You can override this to
intercept all touch screen events before they are dispatched to the
window. Be sure to call this implementation for touch screen events
that should be handled normally.
Parameters
ev
| The touch screen event. |
Returns
- boolean Return true if this event was consumed.
public
boolean
dispatchTrackballEvent(MotionEvent ev)
Called to process trackball events. You can override this to
intercept all trackball events before they are dispatched to the
window. Be sure to call this implementation for trackball events
that should be handled normally.
Returns
- boolean Return true if this event was consumed.
public
View
findViewById(int id)
Finds a view that was identified by the id attribute from the XML that
was processed in
onStart().
Parameters
id
| the identifier of the view to find |
Returns
- The view if found or null otherwise.
public
final
Context
getContext()
Retrieve the Context this Dialog is running in.
Returns
- Context The Context that was supplied to the constructor.
public
View
getCurrentFocus()
Call
getCurrentFocus() on the
Window if this Activity to return the currently focused view.
Returns
- View The current View with focus or null.
public
final
Activity
getOwnerActivity()
Returns the Activity that owns this Dialog. For example, if
showDialog(int) is used to show this Dialog, that
Activity will be the owner (by default). Depending on how this dialog was
created, this may return null.
Returns
- The Activity that owns this Dialog.
public
final
int
getVolumeControlStream()
public
Window
getWindow()
Retrieve the current Window for the activity. This can be used to
directly access parts of the Window API that are not available
through Activity/Screen.
Returns
- Window The current window, or null if the activity is not
visual.
public
void
hide()
Hide the dialog, but do not dismiss it.
public
boolean
isShowing()
Returns
- Whether the dialog is currently showing.
public
void
onContentChanged()
This hook is called whenever the content view of the screen changes
(due to a call to setContentView().
public
boolean
onContextItemSelected(MenuItem item)
public
void
onContextMenuClosed(Menu menu)
Called when the context menu for this view is being built. It is not
safe to hold onto the menu after this method returns.
public
boolean
onCreateOptionsMenu(Menu menu)
It is usually safe to proxy this call to the owner activity's
onCreateOptionsMenu(Menu) if the client desires the same
menu for this Dialog.
public
boolean
onCreatePanelMenu(int featureId, Menu menu)
Initialize the contents of the menu for panel 'featureId'. This is
called if onCreatePanelView() returns null, giving you a standard
menu in which you can place your items. It is only called once for
the panel, the first time it is shown.
You can safely hold on to menu (and any items created
from it), making modifications to it as desired, until the next
time onCreatePanelMenu() is called for this feature.
public
View
onCreatePanelView(int featureId)
Instantiate the view to display in the panel for 'featureId'.
You can return null, in which case the default content (typically
a menu) will be created for you.
public
boolean
onKeyDown(int keyCode, KeyEvent event)
A key was pressed down.
If the focused view didn't want this event, this method is called.
The default implementation handles KEYCODE_BACK to close the
dialog.
public
boolean
onKeyMultiple(int keyCode, int repeatCount, KeyEvent event)
public
boolean
onKeyUp(int keyCode, KeyEvent event)
public
boolean
onMenuItemSelected(int featureId, MenuItem item)
Called when a panel's menu item has been selected by the user.
public
boolean
onMenuOpened(int featureId, Menu menu)
Called when a panel's menu is opened by the user. This may also be
called when the menu is changing from one type to another (for
example, from the icon menu to the expanded menu).
public
boolean
onOptionsItemSelected(MenuItem item)
public
void
onOptionsMenuClosed(Menu menu)
public
void
onPanelClosed(int featureId, Menu menu)
Called when a panel is being closed. If another logical subsequent
panel is being opened (and this panel is being closed to make room for the subsequent
panel), this method will NOT be called.
public
boolean
onPrepareOptionsMenu(Menu menu)
It is usually safe to proxy this call to the owner activity's
onPrepareOptionsMenu(Menu) if the client desires the
same menu for this Dialog.
public
boolean
onPreparePanel(int featureId, View view, Menu menu)
Prepare a panel to be displayed. This is called right before the
panel window is shown, every time it is shown.
public
void
onRestoreInstanceState(Bundle savedInstanceState)
Restore the state of the dialog from a previously saved bundle.
The default implementation restores the state of the dialog's view
hierarchy that was saved in the default implementation of
onSaveInstanceState(),
so be sure to call through to super when overriding unless you want to
do all restoring of state yourself.
public
Bundle
onSaveInstanceState()
Saves the state of the dialog into a bundle.
The default implementation saves the state of its view hierarchy, so you'll
likely want to call through to super if you override this to save additional
state.
Returns
- A bundle with the state of the dialog.
public
boolean
onSearchRequested()
This hook is called when the user signals the desire to start a search.
public
boolean
onTouchEvent(MotionEvent event)
Called when a touch screen event was not handled by any of the views
under it. This is most useful to process touch events that happen outside
of your window bounds, where there is no view to receive it.
Parameters
event
| The touch screen event being processed. |
Returns
- Return true if you have consumed the event, false if you haven't.
The default implementation will cancel the dialog when a touch
happens outside of the window bounds.
public
boolean
onTrackballEvent(MotionEvent event)
Called when the trackball was moved and not handled by any of the
views inside of the activity. So, for example, if the trackball moves
while focus is on a button, you will receive a call here because
buttons do not normally do anything with trackball events. The call
here happens
before trackball movements are converted to
DPAD key events, which then get sent back to the view hierarchy, and
will be processed at the point for things like focus navigation.
Parameters
event
| The trackball event being processed. |
Returns
- Return true if you have consumed the event, false if you haven't.
The default implementation always returns false.
This is called whenever the current window attributes change.
public
void
onWindowFocusChanged(boolean hasFocus)
This hook is called whenever the window focus changes.
public
void
openContextMenu(View view)
public
void
openOptionsMenu()
public
void
registerForContextMenu(View view)
public
final
boolean
requestWindowFeature(int featureId)
Enable extended window features. This is a convenience for calling
getWindow().requestFeature().
Parameters
featureId
| The desired feature as defined in
Window. |
Returns
- Returns true if the requested feature is supported and now
enabled.
public
void
setCancelMessage(Message msg)
Set a message to be sent when the dialog is canceled.
Parameters
msg
| The msg to send when the dialog is canceled. |
public
void
setCancelable(boolean flag)
Sets whether this dialog is cancelable with the
BACK key.
public
void
setCanceledOnTouchOutside(boolean cancel)
Sets whether this dialog is canceled when touched outside the window's
bounds. If setting to true, the dialog is set to be cancelable if not
already set.
Parameters
cancel
| Whether the dialog should be canceled when touched outside
the 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 hierarhcy.
Parameters
view
| The desired content to display. |
params
| Layout parameters for the view.
|
public
void
setContentView(View view)
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.
Parameters
view
| The desired content to display.
|
public
void
setContentView(int layoutResID)
Set the screen content from a layout resource. The resource will be
inflated, adding all top-level views to the screen.
Parameters
layoutResID
| Resource ID to be inflated.
|
public
void
setDismissMessage(Message msg)
Set a message to be sent when the dialog is dismissed.
Parameters
msg
| The msg to send when the dialog is dismissed.
|
public
final
void
setFeatureDrawable(int featureId, Drawable drawable)
public
final
void
setFeatureDrawableAlpha(int featureId, int alpha)
public
final
void
setFeatureDrawableResource(int featureId, int resId)
public
final
void
setFeatureDrawableUri(int featureId, Uri uri)
Set a listener to be invoked when the dialog is dismissed.
Sets the callback that will be called if a key is dispatched to the dialog.
public
final
void
setOwnerActivity(Activity activity)
Sets the Activity that owns this dialog. An example use: This Dialog will
use the suggested volume control stream of the Activity.
Parameters
activity
| The Activity that owns this dialog.
|
public
void
setTitle(int titleId)
Set the title text for this dialog's window. The text is retrieved
from the resources with the supplied identifier.
Parameters
titleId
| the title's text resource identifier
|
public
void
setTitle(CharSequence title)
Set the title text for this dialog's window.
Parameters
title
| The new text to display in the title.
|
public
final
void
setVolumeControlStream(int streamType)
By default, this will use the owner Activity's suggested stream type.
public
void
show()
Start the dialog and display it on screen. The window is placed in the
application layer and opaque. Note that you should not override this
method to do initialization when the dialog is shown, instead implement
that in
onStart().
public
void
takeKeyEvents(boolean get)
Request that key events come to this dialog. Use this if your
dialog has no views with focus, but the dialog still wants
a chance to process key events.
Parameters
get
| true if the dialog should receive key events, false otherwise |
public
void
unregisterForContextMenu(View view)
Protected Methods
protected
void
onCreate(Bundle savedInstanceState)
Similar to
onCreate(Bundle), you should initialized your dialog
in this method, including calling
setContentView(View).
Parameters
savedInstanceState
| If this dialog is being reinitalized after a
the hosting activity was previously shut down, holds the result from
the most recent call to onSaveInstanceState(), or null if this
is the first time.
|
protected
void
onStart()
Called when the dialog is starting.
protected
void
onStop()
Called to tell you that you're stopping.