Dialog

Dialog

Dialog (Context context)

Creates a dialog window that uses the default dialog theme.

The supplied context is used to obtain the window manager and base theme used to present the dialog.

Dialog

Dialog (Context context, 
                int themeResId)

Creates a dialog window that uses a custom dialog style.

The supplied context is used to obtain the window manager and base theme used to present the dialog.

The supplied theme is applied on top of the context's theme. See Style and Theme Resources for more information about defining and using styles.

Dialog

Dialog (Context context, 
                boolean cancelable, 
                DialogInterface.OnCancelListener cancelListener)

addContentView

void addContentView (View view, 
                ViewGroup.LayoutParams params)

Add an additional content view to the screen. Added after any existing ones in the screen -- existing views are NOT removed.

cancel

void cancel ()

Cancel the dialog. This is essentially the same as calling dismiss(), but it will also call your DialogInterface.OnCancelListener (if registered).

closeOptionsMenu

void closeOptionsMenu ()

create

void create ()

Forces immediate creation of the dialog.

Note that you should not override this method to perform dialog creation. Rather, override onCreate(Bundle).

dismiss

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().

dispatchGenericMotionEvent

boolean dispatchGenericMotionEvent (MotionEvent ev)

Called to process generic motion events. You can override this to intercept all generic motion events before they are dispatched to the window. Be sure to call this implementation for generic motion events that should be handled normally.

dispatchKeyEvent

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.

dispatchKeyShortcutEvent

boolean dispatchKeyShortcutEvent (KeyEvent event)

Called to process a key shortcut event. You can override this to intercept all key shortcut events before they are dispatched to the window. Be sure to call this implementation for key shortcut events that should be handled normally.

dispatchPopulateAccessibilityEvent

boolean dispatchPopulateAccessibilityEvent (AccessibilityEvent event)

Called to process population of AccessibilityEvents.

dispatchTouchEvent

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.

dispatchTrackballEvent

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.

findViewById

T findViewById (int id)

Finds the first descendant view with the given ID or null if the ID is invalid (< 0), there is no matching view in the hierarchy, or the dialog has not yet been fully created (for example, via show() or create()).

Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.

getActionBar

ActionBar getActionBar ()

Retrieve the ActionBar attached to this dialog, if present.

getContext

Context getContext ()

Retrieve the Context this Dialog is running in.

getCurrentFocus

View getCurrentFocus ()

Call getCurrentFocus() on the Window if this Activity to return the currently focused view.

getLayoutInflater

LayoutInflater getLayoutInflater ()

getOwnerActivity

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.

getSearchEvent

SearchEvent getSearchEvent ()

During the onSearchRequested() callbacks, this function will return the SearchEvent that triggered the callback, if it exists.

getVolumeControlStream

int getVolumeControlStream ()

getWindow

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.

hide

void hide ()

Hide the dialog, but do not dismiss it.

invalidateOptionsMenu

void invalidateOptionsMenu ()

isShowing

boolean isShowing ()

onActionModeFinished

void onActionModeFinished (ActionMode mode)

Called when an action mode has been finished. The appropriate mode callback method will have already been invoked. Note that if you override this method you should always call through to the superclass implementation by calling super.onActionModeFinished(mode).

If you override this method you must call through to the superclass implementation.

onActionModeStarted

void onActionModeStarted (ActionMode mode)

Called when an action mode has been started. The appropriate mode callback method will have already been invoked. Note that if you override this method you should always call through to the superclass implementation by calling super.onActionModeStarted(mode).

If you override this method you must call through to the superclass implementation.

onAttachedToWindow

void onAttachedToWindow ()

Called when the window has been attached to the window manager. See View.onAttachedToWindow() for more information.

onBackPressed

void onBackPressed ()

Called when the dialog has detected the user's press of the back key. The default implementation simply cancels the dialog (only if it is cancelable), but you can override this to do whatever you want.

onContentChanged

void onContentChanged ()

This hook is called whenever the content view of the screen changes (due to a call to Window.setContentView or Window.addContentView).

onContextItemSelected

boolean onContextItemSelected (MenuItem item)

onContextMenuClosed

void onContextMenuClosed (Menu menu)

onCreateContextMenu

void onCreateContextMenu (ContextMenu menu, 
                View v, 
                ContextMenu.ContextMenuInfo menuInfo)

Called when the context menu for this view is being built. It is not safe to hold onto the menu after this method returns.

onCreateOptionsMenu

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.

onCreatePanelMenu

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.

onCreatePanelView

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.

onDetachedFromWindow

void onDetachedFromWindow ()

Called when the window has been attached to the window manager. See View.onDetachedFromWindow() for more information.

onGenericMotionEvent

boolean onGenericMotionEvent (MotionEvent event)

Called when a generic motion event was not handled by any of the views inside of the dialog.

Generic motion events describe joystick movements, mouse hovers, track pad touches, scroll wheel movements and other input events. The source of the motion event specifies the class of input that was received. Implementations of this method must examine the bits in the source before processing the event. The following code example shows how this is done.

Generic motion events with source class SOURCE_CLASS_POINTER are delivered to the view under the pointer. All other generic motion events are delivered to the focused view.

See onGenericMotionEvent(MotionEvent) for an example of how to handle this event.

onKeyDown

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 consumed the KEYCODE_BACK to later handle it in onKeyUp(int, KeyEvent).

onKeyLongPress

boolean onKeyLongPress (int keyCode, 
                KeyEvent event)

Default implementation of KeyEvent.Callback.onKeyLongPress(): always returns false (doesn't handle the event).

onKeyMultiple

boolean onKeyMultiple (int keyCode, 
                int repeatCount, 
                KeyEvent event)

Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).

onKeyShortcut

boolean onKeyShortcut (int keyCode, 
                KeyEvent event)

Called when a key shortcut event is not handled by any of the views in the Dialog. Override this method to implement global key shortcuts for the Dialog. Key shortcuts can also be implemented by setting the shortcut property of menu items.

onKeyUp

boolean onKeyUp (int keyCode, 
                KeyEvent event)

A key was released.

The default implementation handles KEYCODE_BACK to close the dialog.

onMenuItemSelected

boolean onMenuItemSelected (int featureId, 
                MenuItem item)

Called when a panel's menu item has been selected by the user.

onMenuOpened

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).

onOptionsItemSelected

boolean onOptionsItemSelected (MenuItem item)

onOptionsMenuClosed

void onOptionsMenuClosed (Menu menu)

onPanelClosed

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.

onPrepareOptionsMenu

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.

onPreparePanel

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.

onRestoreInstanceState

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.

onSaveInstanceState

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.

onSearchRequested

boolean onSearchRequested (SearchEvent searchEvent)

This hook is called when the user signals the desire to start a search.

onSearchRequested

boolean onSearchRequested ()

This hook is called when the user signals the desire to start a search.

onTouchEvent

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.

onTrackballEvent

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.

onWindowAttributesChanged

void onWindowAttributesChanged (WindowManager.LayoutParams params)

This is called whenever the current window attributes change.

onWindowFocusChanged

void onWindowFocusChanged (boolean hasFocus)

This hook is called whenever the window focus changes. See View.onWindowFocusChangedNotLocked(boolean) for more information.

onWindowStartingActionMode

ActionMode onWindowStartingActionMode (ActionMode.Callback callback)

Called when an action mode is being started for this window. Gives the callback an opportunity to handle the action mode in its own unique and beautiful way. If this method returns null the system can choose a way to present the mode or choose not to start the mode at all. This is equivalent to onWindowStartingActionMode(android.view.ActionMode.Callback, int) with type TYPE_PRIMARY.

onWindowStartingActionMode

ActionMode onWindowStartingActionMode (ActionMode.Callback callback, 
                int type)

Called when an action mode is being started for this window. Gives the callback an opportunity to handle the action mode in its own unique and beautiful way. If this method returns null the system can choose a way to present the mode or choose not to start the mode at all.

openContextMenu

void openContextMenu (View view)

openOptionsMenu

void openOptionsMenu ()

registerForContextMenu

void registerForContextMenu (View view)

requestWindowFeature

boolean requestWindowFeature (int featureId)

Enable extended window features. This is a convenience for calling getWindow().requestFeature().

setCancelMessage

void setCancelMessage (Message msg)

Set a message to be sent when the dialog is canceled.

setCancelable

void setCancelable (boolean flag)

Sets whether this dialog is cancelable with the BACK key.

setCanceledOnTouchOutside

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.

setContentView

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.

setContentView

void setContentView (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.

setContentView

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 hierarchy.

setDismissMessage

void setDismissMessage (Message msg)

Set a message to be sent when the dialog is dismissed.

setFeatureDrawable

void setFeatureDrawable (int featureId, 
                Drawable drawable)

Convenience for calling setFeatureDrawable(int, Drawable).

setFeatureDrawableAlpha

void setFeatureDrawableAlpha (int featureId, 
                int alpha)

Convenience for calling setFeatureDrawableAlpha(int, int).

setFeatureDrawableResource

void setFeatureDrawableResource (int featureId, 
                int resId)

Convenience for calling setFeatureDrawableResource(int, int).

setFeatureDrawableUri

void setFeatureDrawableUri (int featureId, 
                Uri uri)

Convenience for calling setFeatureDrawableUri(int, Uri).

setOnCancelListener

void setOnCancelListener (DialogInterface.OnCancelListener listener)

Set a listener to be invoked when the dialog is canceled.

This will only be invoked when the dialog is canceled. Cancel events alone will not capture all ways that the dialog might be dismissed. If the creator needs to know when a dialog is dismissed in general, use setOnDismissListener(DialogInterface.OnDismissListener).

setOnDismissListener

void setOnDismissListener (DialogInterface.OnDismissListener listener)

Set a listener to be invoked when the dialog is dismissed.

setOnKeyListener

void setOnKeyListener (DialogInterface.OnKeyListener onKeyListener)

Sets the callback that will be called if a key is dispatched to the dialog.

setOnShowListener

void setOnShowListener (DialogInterface.OnShowListener listener)

Sets a listener to be invoked when the dialog is shown.

setOwnerActivity

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.

setTitle

void setTitle (CharSequence title)

Set the title text for this dialog's window.

setTitle

void setTitle (int titleId)

Set the title text for this dialog's window. The text is retrieved from the resources with the supplied identifier.

setVolumeControlStream

void setVolumeControlStream (int streamType)

By default, this will use the owner Activity's suggested stream type.

show

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().

takeKeyEvents

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.

unregisterForContextMenu

void unregisterForContextMenu (View view)

onCreate

void onCreate (Bundle savedInstanceState)

Similar to onCreate(Bundle), you should initialize your dialog in this method, including calling setContentView(View).

onStart

void onStart ()

Called when the dialog is starting.

onStop

void onStop ()

Called to tell you that you're stopping.