topics/ui/dialogs.jd

page.title=
page.tags=alertdialog,dialogfragment

@jd:body


<div id="qv-wrapper">
  <div id="qv">
    <h2></h2>
<ol>
  <li><a href="#DialogFragment"></a></li>
  <li><a href="#AlertDialog"></a>
    <ol>
      <li><a href="#AddingButtons"></a></li>
      <li><a href="#AddingAList"></a></li>
      <li><a href="#CustomLayout"></a></li>
    </ol>
  </li>
  <li><a href="#PassingEvents"></a></li>
  <li><a href="#ShowingADialog"></a></li>
  <li><a href="#FullscreenDialog"></a>
    <ol>
      <li><a href="#ActivityAsDialog"> Activity </a></li>
    </ol>
  </li>
  <li><a href="#DismissingADialog"></a></li>
</ol>

    <h2></h2>
    <ol>
      <li>{@link android.app.DialogFragment}</li>
      <li>{@link android.app.AlertDialog}</li>
    </ol>

    <h2></h2>
    <ol>
      <li><a href="{@docRoot}design/building-blocks/dialogs.html"></a></li>
      <li><a href="{@docRoot}guide/topics/ui/controls/pickers.html"></a> (/)</li>
    </ol>
  </div>
</div>

<p>

</p>

<div class="note design">
<p><strong></strong></p>
  <p><a href="{@docRoot}design/building-blocks/dialogs.html"></a>
</p>
</div>

<img src="{@docRoot}images/ui/dialogs.png" />

<p>{@link android.app.Dialog}  {@link android.app.Dialog}

</p>
<dl>
  <dt>{@link android.app.AlertDialog}</dt>
  <dd>
</dd>
  <dt>{@link android.app.DatePickerDialog}  {@link android.app.TimePickerDialog}</dt>
  <dd> UI</dd>
</dl>

<div class="sidebox">
<h2> ProgressDialog</h2>
<p>Android
{@link android.app.ProgressDialog} <a href="{@docRoot}design/building-blocks/progress.html"> Activity</a>  {@link android.widget.ProgressBar}


</p>
</div>

<p> {@link android.support.v4.app.DialogFragment}
{@link android.support.v4.app.DialogFragment}  {@link android.app.Dialog}


</p>

<p> {@link android.support.v4.app.DialogFragment}  []<em></em>

{@link
android.support.v4.app.DialogFragment}  {@link
android.support.v4.app.Fragment}  UI UI  ()

</p>

<p> {@link android.app.AlertDialog}  {@link
android.support.v4.app.DialogFragment}
<a href="{@docRoot}guide/topics/ui/controls/pickers.html"></a>
</p>

<p class="note"><strong></strong>{@link android.app.DialogFragment}  Android 3.0 (API  11) <a href="{@docRoot}tools/support-library/index.html"></a> {@link
android.support.v4.app.DialogFragment}

 Android 1.6  {@link android.support.v4.app.DialogFragment}  API

 API  11  {@link
android.app.DialogFragment} API

 <code>android.support.v4.app.DialogFragment</code> <em></em><code>android.app.DialogFragment</code>

</p>


<h2 id="DialogFragment"></h2>

<p> &mdash; <a href="{@docRoot}design/building-blocks/dialogs.html"></a> &mdash;
{@link android.support.v4.app.DialogFragment}
{@link android.support.v4.app.DialogFragment#onCreateDialog
onCreateDialog()}  {@link android.app.AlertDialog}

</p>

<p> {@link android.support.v4.app.DialogFragment}
{@link android.app.AlertDialog}</p>

<pre>
public class FireMissilesDialogFragment extends DialogFragment {
    &#64;Override
    public Dialog onCreateDialog(Bundle savedInstanceState) {
        // Use the Builder class for convenient dialog construction
        AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());
        builder.setMessage(R.string.dialog_fire_missiles)
               .setPositiveButton(R.string.fire, new DialogInterface.OnClickListener() {
                   public void onClick(DialogInterface dialog, int id) {
                       // FIRE ZE MISSILES!
                   }
               })
               .setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
                   public void onClick(DialogInterface dialog, int id) {
                       // User cancelled the dialog
                   }
               });
        // Create the AlertDialog object and return it
        return builder.create();
    }
}
</pre>

<div class="figure" style="width:290px;margin:0 0 0 20px">
<img src="{@docRoot}images/ui/dialog_buttons.png" alt="" />
<p class="img-caption"><strong> 1.</strong>
</p>
</div>

<p> {@link
android.support.v4.app.DialogFragment#show show()} 1
</p>

<p> {@link android.app.AlertDialog.Builder} API
</p>

<p> {@link android.support.v4.app.DialogFragment} <a href="{@docRoot}guide/components/fragments.html#Lifecycle"></a>


<h2 id="AlertDialog"></h2>


<p>{@link android.app.AlertDialog}  2  3

</p>

<div class="figure" style="width:311px;margin-top:0">
<img src="{@docRoot}images/ui/dialogs_regions.png" alt="" style="margin-bottom:0" />
<p class="img-caption"><strong> 2.</strong></p>
</div>

<ol>
<li><b></b>
  <p>
 ( 1 )
</li>
<li><b></b>
  <p></p></li>
<li><b></b>
  <p> 3 </p></li>
</ol>

<p>{@link android.app.AlertDialog.Builder}  API  ()  {@link android.app.AlertDialog}

</p>

<p> {@link android.app.AlertDialog}</p>

<pre>
<b>// 1. Instantiate an {@link android.app.AlertDialog.Builder} with its constructor</b>
AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());

<b>// 2. Chain together various setter methods to set the dialog characteristics</b>
builder.setMessage(R.string.dialog_message)
       .setTitle(R.string.dialog_title);

<b>// 3. Get the {@link android.app.AlertDialog} from {@link android.app.AlertDialog.Builder#create()}</b>
AlertDialog dialog = builder.create();
</pre>

<p> {@link android.app.AlertDialog.Builder}
</p>


<h3 id="AddingButtons"></h3>

<p> 2  {@link android.app.AlertDialog.Builder#setPositiveButton setPositiveButton()}
{@link android.app.AlertDialog.Builder#setNegativeButton setNegativeButton()}
</p>

<pre style="clear:right">
AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());
// Add the buttons
builder.setPositiveButton(R.string.ok, new DialogInterface.OnClickListener() {
           public void onClick(DialogInterface dialog, int id) {
               // User clicked OK button
           }
       });
builder.setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
           public void onClick(DialogInterface dialog, int id) {
               // User cancelled the dialog
           }
       });
// Set other dialog properties
...

// Create the AlertDialog
AlertDialog dialog = builder.create();
</pre>

<p><code>set...Button()</code> <a href="{@docRoot}guide/topics/resources/string-resource.html"></a>{@link android.content.DialogInterface.OnClickListener}


</p>

<p> 3 </p>
<dl>
  <dt></dt>
  <dd> ()</dd>
  <dt></dt>
  <dd></dd>
  <dt></dt>
  <dd>

[] </dd>
</dl>

<p> {@link
android.app.AlertDialog}</p>


<div class="figure" style="width:290px;margin:0 0 0 40px">
<img src="{@docRoot}images/ui/dialog_list.png" alt="" />
<p class="img-caption"><strong> 3.</strong>
</p>
</div>

<h3 id="AddingAList"></h3>

<p>{@link android.app.AlertDialog} API  3 </p>
<ul>
<li></li>
<li> ()</li>
<li> ()</li>
</ul>

<p> 3  {@link android.app.AlertDialog.Builder#setItems setItems()}
</p>

<pre style="clear:right">
&#64;Override
public Dialog onCreateDialog(Bundle savedInstanceState) {
    AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());
    builder.setTitle(R.string.pick_color)
           .setItems(R.array.colors_array, new DialogInterface.OnClickListener() {
               public void onClick(DialogInterface dialog, int which) {
               // The 'which' argument contains the index position
               // of the selected item
           }
    });
    return builder.create();
}
</pre>

<p> {@link android.app.AlertDialog.Builder#setTitle setTitle()}

 {@link
android.app.AlertDialog.Builder#setItems setItems()}  {@link
android.app.AlertDialog.Builder#setAdapter setAdapter()}

 {@link android.widget.ListAdapter}  ()
</p>

<p> {@link android.widget.ListAdapter} {@link android.support.v4.content.Loader}

<a href="{@docRoot}guide/topics/ui/declaring-layout.html#AdapterViews"></a><a href="{@docRoot}guide/components/loaders.html"></a>


</p>

<p class="note"><strong></strong>
</p>

<div class="figure" style="width:290px;margin:-30px 0 0 40px">
<img src="{@docRoot}images/ui/dialog_checkboxes.png" />
<p class="img-caption"><strong> 4.</strong>
</p>
</div>


<h4 id="Checkboxes"></h4>

<p> ()  ()
{@link android.app.AlertDialog.Builder#setMultiChoiceItems(Cursor,String,String,
DialogInterface.OnMultiChoiceClickListener) setMultiChoiceItems()}
{@link android.app.AlertDialog.Builder#setSingleChoiceItems(int,int,DialogInterface.OnClickListener)
setSingleChoiceItems()}
</p>

<p> 4  {@link java.util.ArrayList}

</p>

<pre style="clear:right">
&#64;Override
public Dialog onCreateDialog(Bundle savedInstanceState) {
    mSelectedItems = new ArrayList();  // Where we track the selected items
    AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());
    // Set the dialog title
    builder.setTitle(R.string.pick_toppings)
    // Specify the list array, the items to be selected by default (null for none),
    // and the listener through which to receive callbacks when items are selected
           .setMultiChoiceItems(R.array.toppings, null,
                      new DialogInterface.OnMultiChoiceClickListener() {
               &#64;Override
               public void onClick(DialogInterface dialog, int which,
                       boolean isChecked) {
                   if (isChecked) {
                       // If the user checked the item, add it to the selected items
                       mSelectedItems.add(which);
                   } else if (mSelectedItems.contains(which)) {
                       // Else, if the item is already in the array, remove it
                       mSelectedItems.remove(Integer.valueOf(which));
                   }
               }
           })
    // Set the action buttons
           .setPositiveButton(R.string.ok, new DialogInterface.OnClickListener() {
               &#64;Override
               public void onClick(DialogInterface dialog, int id) {
                   // User clicked OK, so save the mSelectedItems results somewhere
                   // or return them to the component that opened the dialog
                   ...
               }
           })
           .setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
               &#64;Override
               public void onClick(DialogInterface dialog, int id) {
                   ...
               }
           });

    return builder.create();
}
</pre>

<p> {@link
android.app.AlertDialog.Builder#setSingleChoiceItems(int,int,DialogInterface.OnClickListener)
setSingleChoiceItems()}


</p>


<h3 id="CustomLayout"></h3>

<div class="figure" style="width:290px;margin:-30px 0 0 40px">
<img src="{@docRoot}images/ui/dialog_custom.png" alt="" />
<p class="img-caption"><strong> 5.</strong></p>
</div>

<p> {@link
android.app.AlertDialog.Builder}  {@link
android.app.AlertDialog.Builder#setView setView()} {@link android.app.AlertDialog}
</p>

<p> {@link android.app.AlertDialog.Builder}
</p>

<p> 5 </p>

<p style="clear:right" class="code-caption">res/layout/dialog_signin.xml</p>
<pre>
&lt;LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content">
    &lt;ImageView
        android:src="@drawable/header_logo"
        android:layout_width="match_parent"
        android:layout_height="64dp"
        android:scaleType="center"
        android:background="#FFFFBB33"
        android:contentDescription="@string/app_name" />
    &lt;EditText
        android:id="@+id/username"
        android:inputType="textEmailAddress"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="16dp"
        android:layout_marginLeft="4dp"
        android:layout_marginRight="4dp"
        android:layout_marginBottom="4dp"
        android:hint="@string/username" />
    &lt;EditText
        android:id="@+id/password"
        android:inputType="textPassword"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="4dp"
        android:layout_marginLeft="4dp"
        android:layout_marginRight="4dp"
        android:layout_marginBottom="16dp"
        android:fontFamily="sans-serif"
        android:hint="@string/password"/>
&lt;/LinearLayout>
</pre>

<p class="note"><strong></strong> {@link android.widget.EditText}  {@code "textPassword"}  {@code "sans-serif"}


</p>

<p> {@link android.support.v4.app.DialogFragment}  {@link android.app.Activity#getLayoutInflater()}  {@link android.view.LayoutInflater}{@link android.view.LayoutInflater#inflate inflate()} ( ID) {@link android.app.AlertDialog#setView setView()}


</p>

<pre>
&#64;Override
public Dialog onCreateDialog(Bundle savedInstanceState) {
    AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());
    // Get the layout inflater
    LayoutInflater inflater = getActivity().getLayoutInflater();

    // Inflate and set the layout for the dialog
    // Pass null as the parent view because its going in the dialog layout
    builder.setView(inflater.inflate(R.layout.dialog_signin, null))
    // Add action buttons
           .setPositiveButton(R.string.signin, new DialogInterface.OnClickListener() {
               &#64;Override
               public void onClick(DialogInterface dialog, int id) {
                   // sign in the user ...
               }
           })
           .setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
               public void onClick(DialogInterface dialog, int id) {
                   LoginDialogFragment.this.getDialog().cancel();
               }
           });
    return builder.create();
}
</pre>

<div class="note">
<p><strong></strong> {@link android.app.Activity}  {@link android.app.Dialog} API

 Activity  <a href="{@docRoot}guide/topics/manifest/activity-element.html">{@code
&lt;activity&gt;}</a>
{@link android.R.style#Theme_Holo_Dialog Theme.Holo.Dialog}
</p>

<pre>
&lt;activity android:theme="&#64;android:style/Theme.Holo.Dialog" >
</pre>
<p>Activity </p>
</div>


<h2 id="PassingEvents"></h2>

<p> {@link android.support.v4.app.DialogFragment}  Activity


</p>

<p> Activity  {@link android.support.v4.app.DialogFragment}
</p>

<pre>
public class NoticeDialogFragment extends DialogFragment {

    /* The activity that creates an instance of this dialog fragment must
     * implement this interface in order to receive event callbacks.
     * Each method passes the DialogFragment in case the host needs to query it. */
    public interface NoticeDialogListener {
        public void onDialogPositiveClick(DialogFragment dialog);
        public void onDialogNegativeClick(DialogFragment dialog);
    }

    // Use this instance of the interface to deliver action events
    NoticeDialogListener mListener;

    // Override the Fragment.onAttach() method to instantiate the NoticeDialogListener
    &#64;Override
    public void onAttach(Activity activity) {
        super.onAttach(activity);
        // Verify that the host activity implements the callback interface
        try {
            // Instantiate the NoticeDialogListener so we can send events to the host
            mListener = (NoticeDialogListener) activity;
        } catch (ClassCastException e) {
            // The activity doesn't implement the interface, throw exception
            throw new ClassCastException(activity.toString()
                    + " must implement NoticeDialogListener");
        }
    }
    ...
}
</pre>

<p> Activity  {@code NoticeDialogListener}

</p>

<pre>
public class MainActivity extends FragmentActivity
                          implements NoticeDialogFragment.NoticeDialogListener{
    ...

    public void showNoticeDialog() {
        // Create an instance of the dialog fragment and show it
        DialogFragment dialog = new NoticeDialogFragment();
        dialog.show(getSupportFragmentManager(), "NoticeDialogFragment");
    }

    // The dialog fragment receives a reference to this Activity through the
    // Fragment.onAttach() callback, which it uses to call the following methods
    // defined by the NoticeDialogFragment.NoticeDialogListener interface
    &#64;Override
    public void onDialogPositiveClick(DialogFragment dialog) {
        // User touched the dialog's positive button
        ...
    }

    &#64;Override
    public void onDialogNegativeClick(DialogFragment dialog) {
        // User touched the dialog's negative button
        ...
    }
}
</pre>

<p> Activity  {@code NoticeDialogListener} &mdash;  {@link android.support.v4.app.Fragment#onAttach onAttach()}  Activity &mdash;  Activity


</p>

<pre>
public class NoticeDialogFragment extends DialogFragment {
    ...

    &#64;Override
    public Dialog onCreateDialog(Bundle savedInstanceState) {
        // Build the dialog and set up the button click handlers
        AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());
        builder.setMessage(R.string.dialog_fire_missiles)
               .setPositiveButton(R.string.fire, new DialogInterface.OnClickListener() {
                   public void onClick(DialogInterface dialog, int id) {
                       // Send the positive button event back to the host activity
                       mListener.onDialogPositiveClick(NoticeDialogFragment.this);
                   }
               })
               .setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
                   public void onClick(DialogInterface dialog, int id) {
                       // Send the negative button event back to the host activity
                       mListener.onDialogNegativeClick(NoticeDialogFragment.this);
                   }
               });
        return builder.create();
    }
}
</pre>


<h2 id="ShowingADialog"></h2>

<p> {@link
android.support.v4.app.DialogFragment}  {@link android.support.v4.app.DialogFragment#show
show()}  {@link android.support.v4.app.FragmentManager}
</p>

<p> {@link android.support.v4.app.FragmentManager}
{@link android.support.v4.app.FragmentActivity}
{@link android.support.v4.app.FragmentActivity#getSupportFragmentManager()}  {@link
android.support.v4.app.Fragment}  {@link
android.support.v4.app.Fragment#getFragmentManager()}</p>

<pre>
public void confirmFireMissiles() {
    DialogFragment newFragment = new FireMissilesDialogFragment();
    newFragment.show(getSupportFragmentManager(), "missiles");
}
</pre>

<p> {@code "missiles"}

 {@link android.support.v4.app.FragmentManager#findFragmentByTag
findFragmentByTag()} </p>


<h2 id="FullscreenDialog"></h2>

<p> UI  UI  ()

{@link android.support.v4.app.DialogFragment}  {@link
android.support.v4.app.Fragment}
</p>

<p> {@link android.app.AlertDialog.Builder AlertDialog.Builder}  {@link android.app.Dialog}
 {@link android.support.v4.app.DialogFragment} UI {@link android.support.v4.app.DialogFragment#onCreateView
onCreateView()}


</p>

<p> {@link android.support.v4.app.DialogFragment}  ( <code>purchase_items.xml</code> )
</p>

<pre>
public class CustomDialogFragment extends DialogFragment {
    /** The system calls this to get the DialogFragment's layout, regardless
        of whether it's being displayed as a dialog or an embedded fragment. */
    &#64;Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
            Bundle savedInstanceState) {
        // Inflate the layout to use as dialog or embedded fragment
        return inflater.inflate(R.layout.purchase_items, container, false);
    }

    /** The system calls this only when creating the layout in a dialog. */
    &#64;Override
    public Dialog onCreateDialog(Bundle savedInstanceState) {
        // The only reason you might override this method when using onCreateView() is
        // to modify any dialog characteristics. For example, the dialog includes a
        // title by default, but your custom layout might not need it. So here you can
        // remove the dialog title, but you must call the superclass to get the Dialog.
        Dialog dialog = super.onCreateDialog(savedInstanceState);
        dialog.requestWindowFeature(Window.FEATURE_NO_TITLE);
        return dialog;
    }
}
</pre>

<p> UI
</p>

<pre>
public void showDialog() {
    FragmentManager fragmentManager = getSupportFragmentManager();
    CustomDialogFragment newFragment = new CustomDialogFragment();

    if (mIsLargeLayout) {
        // The device is using a large layout, so show the fragment as a dialog
        newFragment.show(fragmentManager, "dialog");
    } else {
        // The device is smaller, so show the fragment fullscreen
        FragmentTransaction transaction = fragmentManager.beginTransaction();
        // For a little polish, specify a transition animation
        transaction.setTransition(FragmentTransaction.TRANSIT_FRAGMENT_OPEN);
        // To make it fullscreen, use the 'content' root view as the container
        // for the fragment, which is always the root view for the activity
        transaction.add(android.R.id.content, newFragment)
                   .addToBackStack(null).commit();
    }
}
</pre>

<p><a href="{@docRoot}guide/components/fragments.html"></a>
</p>

<p><code>mIsLargeLayout</code>  ()

<a href="{@docRoot}guide/topics/resources/providing-resources.html#AlternativeResources"></a><a href="{@docRoot}guide/topics/resources/more-resources.html#Bool"></a>

 2
</p>

<p class="code-caption">res/values/bools.xml</p>
<pre>
&lt;!-- Default boolean values -->
&lt;resources>
    &lt;bool name="large_layout">false&lt;/bool>
&lt;/resources>
</pre>

<p class="code-caption">res/values-large/bools.xml</p>
<pre>
&lt;!-- Large screen boolean values -->
&lt;resources>
    &lt;bool name="large_layout">true&lt;/bool>
&lt;/resources>
</pre>

<p> Activity  {@link android.app.Activity#onCreate onCreate()}  {@code mIsLargeLayout}
</p>

<pre>
boolean mIsLargeLayout;

&#64;Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    mIsLargeLayout = getResources().getBoolean(R.bool.large_layout);
}
</pre>


<h3 id="ActivityAsDialog"> Activity </h3>

<p> {@link android.app.Activity}  UI

 Activity  Activity


</p>

<p> Activity  <a href="{@docRoot}guide/topics/manifest/activity-element.html">{@code
&lt;activity&gt;}</a>  {@link android.R.style#Theme_Holo_DialogWhenLarge Theme.Holo.DialogWhenLarge}

</p>

<pre>
&lt;activity android:theme="&#64;android:style/Theme.Holo.DialogWhenLarge" >
</pre>

<p> Activity <a href="{@docRoot}guide/topics/ui/themes.html"></a></p>


<h2 id="DismissingADialog"></h2>

<p> {@link android.app.AlertDialog.Builder}
</p>

<p>
 {@link
android.support.v4.app.DialogFragment}  {@link android.support.v4.app.DialogFragment#dismiss()}
</p>

<p> {@link
android.support.v4.app.DialogFragment}  {@link
android.support.v4.app.DialogFragment#onDismiss onDismiss()}
</p>

<p><em></em>
 []<em></em>  {@link
android.app.Dialog}  {@link android.app.Dialog#cancel()} ( [] )

</p>

<p> {@link
android.support.v4.app.DialogFragment}  {@link android.support.v4.app.DialogFragment#onCancel onCancel()}
</p>

<p class="note"><strong></strong> {@link android.support.v4.app.DialogFragment#onCancel onCancel()}
{@link android.support.v4.app.DialogFragment#onDismiss onDismiss()}
 {@link android.app.Dialog#dismiss Dialog.dismiss()}  {@link
android.support.v4.app.DialogFragment#dismiss DialogFragment.dismiss()} {@link android.support.v4.app.DialogFragment#onDismiss onDismiss()}<em></em>{@link android.support.v4.app.DialogFragment#onCancel onCancel()}


<em></em> {@link android.support.v4.app.DialogFragment#dismiss dismiss()}

</p>