Caixas de diálogo

Teste o Compose
O Jetpack Compose é o kit de ferramentas de interface recomendado para Android. Aprenda a adicionar componentes no Compose.

Uma caixa de diálogo é uma pequena janela que solicita que o usuário tome uma decisão ou insira outras informações. Elas não preenchem a tela e normalmente são usadas para eventos modais que exigem que os usuários realizem uma ação antes de continuar.

Imagem mostrando uma caixa de diálogo básica
Figura 1. Uma caixa de diálogo básica.

A classe Dialog é a classe de base para caixas de diálogo, mas não instancia o Dialog diretamente. Em vez disso, use uma das subclasses a seguir:

AlertDialog
Uma caixa de diálogo que pode mostrar um título, até três botões, uma lista de itens selecionáveis ou um layout personalizado.
DatePickerDialog ou TimePickerDialog
Uma caixa de diálogo com uma interface predefinida que permite ao usuário selecionar uma data ou hora.

Essas classes definem o estilo e a estrutura da caixa de diálogo. Você também precisa de um DialogFragment como contêiner para sua caixa de diálogo. A classe DialogFragment fornece todos os controles necessários para criar a caixa de diálogo e gerenciar a aparência dela, em vez de chamar métodos no objeto Dialog.

O uso de DialogFragment para gerenciar a caixa de diálogo faz com que ela processe corretamente eventos de ciclo de vida, como quando o usuário toca no botão "Voltar" ou gira a tela. A classe DialogFragment também permite reutilizar a interface da caixa de diálogo como um componente incorporável em uma interface maior, assim como um Fragment tradicional, como quando você quer que a interface da caixa de diálogo apareça de forma diferente em telas grandes e pequenas.

As seções a seguir neste documento descrevem como usar um DialogFragment em combinação com um objeto AlertDialog. Se você quiser criar um seletor de data ou hora, leia Adicionar seletores ao seu app.

Criar um fragmento de caixa de diálogo

É possível realizar uma ampla variedade de designs de caixas de diálogo, incluindo layouts personalizados e aqueles descritos em Caixas de diálogo do Material Design, estendendo DialogFragment e criando um AlertDialog no método de callback onCreateDialog().

Por exemplo, confira um AlertDialog básico gerenciado em uma DialogFragment:

Kotlin

class StartGameDialogFragment : DialogFragment() {
    override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
        return activity?.let {
            // Use the Builder class for convenient dialog construction.
            val builder = AlertDialog.Builder(it)
            builder.setMessage("Start game")
                .setPositiveButton("Start") { dialog, id ->
                    // START THE GAME!
                }
                .setNegativeButton("Cancel") { dialog, id ->
                    // User cancelled the dialog.
                }
            // Create the AlertDialog object and return it.
            builder.create()
        } ?: throw IllegalStateException("Activity cannot be null")
    }
}

class OldXmlActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_old_xml)

        StartGameDialogFragment().show(supportFragmentManager, "GAME_DIALOG")
    }
}

Java

public class StartGameDialogFragment extends DialogFragment {
    @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_start_game)
               .setPositiveButton(R.string.start, new DialogInterface.OnClickListener() {
                   public void onClick(DialogInterface dialog, int id) {
                       // START THE GAME!
                   }
               })
               .setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
                   public void onClick(DialogInterface dialog, int id) {
                       // User cancels the dialog.
                   }
               });
        // Create the AlertDialog object and return it.
        return builder.create();
    }
}
// ...

StartGameDialogFragment().show(supportFragmentManager, "GAME_DIALOG");

Quando você cria uma instância dessa classe e chama show() nesse objeto, a caixa de diálogo aparece conforme mostrado na figura abaixo.

Imagem mostrando uma caixa de diálogo básica com dois botões de ação
Figura 2. Uma caixa de diálogo com uma mensagem e dois botões de ação.

A próxima seção fornece mais detalhes sobre o uso das APIs AlertDialog.Builder para criar a caixa de diálogo.

Dependendo da complexidade da caixa de diálogo, é possível implementar vários outros métodos de callback no DialogFragment, incluindo todos os métodos básicos do ciclo de vida do fragmento.

Criar uma caixa de diálogo de alerta

A classe AlertDialog permite criar uma variedade de designs de caixas de diálogo e geralmente é a única classe de caixa de diálogo de que você precisa. Como mostrado na figura abaixo, há três regiões de uma caixa de diálogo de alerta:

  • Título:é opcional e usado apenas quando a área do conteúdo é ocupada por uma mensagem detalhada, uma lista ou um layout personalizado. Se você precisar declarar uma mensagem ou pergunta simples, o título não é necessário.
  • Área de conteúdo:pode mostrar uma mensagem, uma lista ou outro layout personalizado.
  • Botões de ação:pode haver até três botões de ação em uma caixa de diálogo.

A classe AlertDialog.Builder fornece APIs que permitem criar um AlertDialog com esses tipos de conteúdo, incluindo um layout personalizado.

Para criar um AlertDialog, faça o seguinte:

Kotlin

val builder: AlertDialog.Builder = AlertDialog.Builder(context)
builder
    .setMessage("I am the message")
    .setTitle("I am the title")

val dialog: AlertDialog = builder.create()
dialog.show()

Java

// 1. Instantiate an AlertDialog.Builder with its constructor.
AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());

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

// 3. Get the AlertDialog.
AlertDialog dialog = builder.create();

O snippet de código anterior gera esta caixa de diálogo:

Uma imagem mostrando uma caixa de diálogo com título, área de conteúdo e dois botões de ação.
Figura 3. O layout de uma caixa de diálogo de alerta básica.

Adicionar botões

Para adicionar botões de ação como os da Figura 2, chame os métodos setPositiveButton() e setNegativeButton():

Kotlin

val builder: AlertDialog.Builder = AlertDialog.Builder(context)
builder
    .setMessage("I am the message")
    .setTitle("I am the title")
    .setPositiveButton("Positive") { dialog, which ->
        // Do something.
    }
    .setNegativeButton("Negative") { dialog, which ->
        // Do something else.
    }

val dialog: AlertDialog = builder.create()
dialog.show()

Java

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 taps OK button.
           }
       });
builder.setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
           public void onClick(DialogInterface dialog, int id) {
               // User cancels the dialog.
           }
       });
// Set other dialog properties.
...

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

Os métodos set...Button() exigem um título para o botão, fornecido por um recurso de string, e um DialogInterface.OnClickListener que defina a ação a ser realizada quando o usuário tocar no botão.

Você pode adicionar três botões de ação:

  • Positivo:use para aceitar e continuar com a ação (a ação "OK").
  • Negativo:use para cancelar a ação.
  • Neutro:use quando o usuário não quiser continuar a ação, mas não necessariamente cancelá-la. Ele aparece entre os botões positivo e negativo. Por exemplo, a ação pode ser "Lembrar mais tarde".

Somente é possível adicionar um dos tipos de cada botão a um AlertDialog. Por exemplo, não é possível ter mais de um botão "positivo".

O snippet de código anterior oferece uma caixa de diálogo de alerta como esta:

Uma imagem mostrando uma caixa de diálogo de alerta com título, mensagem e dois botões de ação.
Figura 4. Uma caixa de diálogo de alerta com título, mensagem e dois botões de ação.

Adicionar uma lista

Há três tipos de listas disponíveis nas APIs AlertDialog:

  • Uma lista de escolha única tradicional.
  • Uma lista de escolha única persistente (botões de opção).
  • Uma lista de múltipla escolha persistente (caixas de seleção).

Para criar uma lista de escolha única como a da Figura 5, use o método setItems():


Kotlin

val builder: AlertDialog.Builder = AlertDialog.Builder(context)
builder
    .setTitle("I am the title")
    .setPositiveButton("Positive") { dialog, which ->
        // Do something.
    }
    .setNegativeButton("Negative") { dialog, which ->
        // Do something else.
    }
    .setItems(arrayOf("Item One", "Item Two", "Item Three")) { dialog, which ->
        // Do something on item tapped.
    }

val dialog: AlertDialog = builder.create()
dialog.show()

Java

@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();
}

O snippet de código abaixo gera uma caixa de diálogo como esta:

Imagem que mostra uma caixa de diálogo com um título e uma lista.
Figura 5. Uma caixa de diálogo com um título e uma lista.

Como a lista aparece na área de conteúdo da caixa de diálogo, ela não pode mostrar uma mensagem e uma lista. Defina um título para a caixa de diálogo com setTitle(). Para especificar os itens da lista, chame setItems(), transmitindo uma matriz. Como alternativa, é possível especificar uma lista usando setAdapter(). Isso permite retroceder a lista com dados dinâmicos, como de um banco de dados, usando um ListAdapter.

Se você fizer backup da lista com um ListAdapter, use sempre um Loader para que o conteúdo carregue de forma assíncrona. Isso é descrito mais detalhadamente em Criar layouts com um adaptador e Carregadores.

Adicionar uma lista de escolha única ou de múltipla escolha persistente

Para adicionar uma lista de itens de múltipla escolha (caixas de seleção) ou itens de escolha única (botões de opção), use os métodos setMultiChoiceItems() ou setSingleChoiceItems(), respectivamente.

Por exemplo, confira como criar uma lista de múltipla escolha como a mostrada na Figura 6, que salva os itens selecionados em uma ArrayList:

Kotlin

val builder: AlertDialog.Builder = AlertDialog.Builder(context)
builder
    .setTitle("I am the title")
    .setPositiveButton("Positive") { dialog, which ->
        // Do something.
    }
    .setNegativeButton("Negative") { dialog, which ->
        // Do something else.
    }
    .setMultiChoiceItems(
        arrayOf("Item One", "Item Two", "Item Three"), null) { dialog, which, isChecked ->
        // Do something.
    }

val dialog: AlertDialog = builder.create()
dialog.show()

Java

@Override
public Dialog onCreateDialog(Bundle savedInstanceState) {
    selectedItems = 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() {
               @Override
               public void onClick(DialogInterface dialog, int which,
                       boolean isChecked) {
                   if (isChecked) {
                       // If the user checks the item, add it to the selected
                       // items.
                       selectedItems.add(which);
                   } else if (selectedItems.contains(which)) {
                       // If the item is already in the array, remove it.
                       selectedItems.remove(which);
                   }
               }
           })
    // Set the action buttons
           .setPositiveButton(R.string.ok, new DialogInterface.OnClickListener() {
               @Override
               public void onClick(DialogInterface dialog, int id) {
                   // User taps OK, so save the selectedItems results
                   // somewhere or return them to the component that opens the
                   // dialog.
                   ...
               }
           })
           .setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
               @Override
               public void onClick(DialogInterface dialog, int id) {
                   ...
               }
           });

    return builder.create();
}
Imagem mostrando uma caixa de diálogo com uma lista de itens de múltipla escolha.
Figura 6. Uma lista de itens de múltipla escolha.

Uma caixa de diálogo de alerta de escolha única pode ser recebida assim:

Kotlin

val builder: AlertDialog.Builder = AlertDialog.Builder(context)
builder
    .setTitle("I am the title")
    .setPositiveButton("Positive") { dialog, which ->
        // Do something.
    }
    .setNegativeButton("Negative") { dialog, which ->
        // Do something else.
    }
    .setSingleChoiceItems(
        arrayOf("Item One", "Item Two", "Item Three"), 0
    ) { dialog, which ->
        // Do something.
    }

val dialog: AlertDialog = builder.create()
dialog.show()

Java

        String[] choices = {"Item One", "Item Two", "Item Three"};
        
        AlertDialog.Builder builder = AlertDialog.Builder(context);
        builder
                .setTitle("I am the title")
                .setPositiveButton("Positive", (dialog, which) -> {

                })
                .setNegativeButton("Negative", (dialog, which) -> {

                })
                .setSingleChoiceItems(choices, 0, (dialog, which) -> {

                });

        AlertDialog dialog = builder.create();
        dialog.show();

Isso resulta no seguinte exemplo:

Imagem mostrando uma caixa de diálogo com uma lista de itens de escolha única.
Figura 7. Uma lista de itens de escolha única.

Criar um layout personalizado

Se você quiser um layout personalizado em uma caixa de diálogo, crie um layout e o adicione a um AlertDialog chamando setView() no objeto AlertDialog.Builder.

Imagem mostrando um layout personalizado de caixa de diálogo.
Figura 8. Layout personalizado da caixa de diálogo.

Por padrão, o layout personalizado preenche a janela da caixa de diálogo, mas você ainda pode usar métodos AlertDialog.Builder para adicionar botões e um título.

Por exemplo, este é o arquivo do layout da caixa de diálogo personalizada anterior:

res/layout/dialog_signin.xml

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content">
    <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" />
    <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" />
    <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"/>
</LinearLayout>

Para inflar o layout na DialogFragment, acesse um LayoutInflater com getLayoutInflater() e chame inflate(). O primeiro parâmetro é o ID do recurso de layout, e o segundo é uma visualização mãe do layout. Você pode chamar setView() para colocar o layout na caixa de diálogo. Esta chamada é mostrada no exemplo abaixo.

Kotlin

override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
    return activity?.let {
        val builder = AlertDialog.Builder(it)
        // Get the layout inflater.
        val inflater = requireActivity().layoutInflater;

        // Inflate and set the layout for the dialog.
        // Pass null as the parent view because it's going in the dialog
        // layout.
        builder.setView(inflater.inflate(R.layout.dialog_signin, null))
                // Add action buttons.
                .setPositiveButton(R.string.signin,
                        DialogInterface.OnClickListener { dialog, id ->
                            // Sign in the user.
                        })
                .setNegativeButton(R.string.cancel,
                        DialogInterface.OnClickListener { dialog, id ->
                            getDialog().cancel()
                        })
        builder.create()
    } ?: throw IllegalStateException("Activity cannot be null")
}

Java

@Override
public Dialog onCreateDialog(Bundle savedInstanceState) {
    AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());
    // Get the layout inflater.
    LayoutInflater inflater = requireActivity().getLayoutInflater();

    // Inflate and set the layout for the dialog.
    // Pass null as the parent view because it's going in the dialog layout.
    builder.setView(inflater.inflate(R.layout.dialog_signin, null))
    // Add action buttons
           .setPositiveButton(R.string.signin, new DialogInterface.OnClickListener() {
               @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();
}

Se você quiser uma caixa de diálogo personalizada, pode mostrar um Activity como uma caixa de diálogo em vez de usar as APIs Dialog. Crie uma atividade e defina o tema como Theme.Holo.Dialog no elemento de manifesto <activity>:

<activity android:theme="@android:style/Theme.Holo.Dialog" >

Agora a atividade é exibida em uma janela da caixa de diálogo em vez de tela cheia.

Transmitir eventos de volta ao host da caixa de diálogo

Quando o usuário toca em um dos botões de ação da caixa de diálogo ou seleciona um item da lista, o DialogFragment pode executar a ação necessária por conta própria, mas geralmente você quer enviar o evento à atividade ou ao fragmento que abre a caixa de diálogo. Para isso, defina uma interface com um método para cada tipo de evento de clique. Em seguida, implemente essa interface no componente host que recebe os eventos de ação da caixa de diálogo.

Por exemplo, veja um DialogFragment que define uma interface pela qual entrega os eventos de volta à atividade do host:

Kotlin

class NoticeDialogFragment : DialogFragment() {
    // Use this instance of the interface to deliver action events.
    internal lateinit var listener: NoticeDialogListener

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

    // Override the Fragment.onAttach() method to instantiate the
    // NoticeDialogListener.
    override fun onAttach(context: Context) {
        super.onAttach(context)
        // Verify that the host activity implements the callback interface.
        try {
            // Instantiate the NoticeDialogListener so you can send events to
            // the host.
            listener = context as NoticeDialogListener
        } catch (e: ClassCastException) {
            // The activity doesn't implement the interface. Throw exception.
            throw ClassCastException((context.toString() +
                    " must implement NoticeDialogListener"))
        }
    }
}

Java

public class NoticeDialogFragment extends DialogFragment {

    // The activity that creates an instance of this dialog fragment must
    // implement this interface 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 listener;

    // Override the Fragment.onAttach() method to instantiate the
    // NoticeDialogListener.
    @Override
    public void onAttach(Context context) {
        super.onAttach(context);
        // Verify that the host activity implements the callback interface.
        try {
            // Instantiate the NoticeDialogListener so you can send events to
            // the host.
            listener = (NoticeDialogListener) context;
        } catch (ClassCastException e) {
            // The activity doesn't implement the interface. Throw exception.
            throw new ClassCastException(activity.toString()
                    + " must implement NoticeDialogListener");
        }
    }
    ...
}

A atividade que hospeda a caixa de diálogo cria uma instância dela com o construtor do fragmento da caixa de diálogo e recebe os eventos dela por uma implementação da interface NoticeDialogListener:

Kotlin

class MainActivity : FragmentActivity(),
        NoticeDialogFragment.NoticeDialogListener {

    fun showNoticeDialog() {
        // Create an instance of the dialog fragment and show it.
        val dialog = NoticeDialogFragment()
        dialog.show(supportFragmentManager, "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.
    override fun onDialogPositiveClick(dialog: DialogFragment) {
        // User taps the dialog's positive button.
    }

    override fun onDialogNegativeClick(dialog: DialogFragment) {
        // User taps the dialog's negative button.
    }
}

Java

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.
    @Override
    public void onDialogPositiveClick(DialogFragment dialog) {
        // User taps the dialog's positive button.
        ...
    }

    @Override
    public void onDialogNegativeClick(DialogFragment dialog) {
        // User taps the dialog's negative button.
        ...
    }
}

Como a atividade do host implementa o NoticeDialogListener, que é aplicado pelo método de callback onAttach() mostrado no exemplo anterior, o fragmento da caixa de diálogo pode usar os métodos de callback da interface para entregar eventos de clique à atividade:

Kotlin

    override fun onCreateDialog(savedInstanceState: Bundle): Dialog {
        return activity?.let {
            // Build the dialog and set up the button click handlers.
            val builder = AlertDialog.Builder(it)

            builder.setMessage(R.string.dialog_start_game)
                    .setPositiveButton(R.string.start,
                            DialogInterface.OnClickListener { dialog, id ->
                                // Send the positive button event back to the
                                // host activity.
                                listener.onDialogPositiveClick(this)
                            })
                    .setNegativeButton(R.string.cancel,
                            DialogInterface.OnClickListener { dialog, id ->
                                // Send the negative button event back to the
                                // host activity.
                                listener.onDialogNegativeClick(this)
                            })

            builder.create()
        } ?: throw IllegalStateException("Activity cannot be null")
    }

Java

public class NoticeDialogFragment extends DialogFragment {
    ...
    @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_start_game)
               .setPositiveButton(R.string.start, new DialogInterface.OnClickListener() {
                   public void onClick(DialogInterface dialog, int id) {
                       // Send the positive button event back to the host activity.
                       listener.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.
                       listener.onDialogNegativeClick(NoticeDialogFragment.this);
                   }
               });
        return builder.create();
    }
}

Mostrar uma caixa de diálogo

Quando quiser mostrar a caixa de diálogo, crie uma instância de DialogFragment e chame show(), transmitindo o FragmentManager e um nome de tag para o fragmento da caixa de diálogo.

Para receber o FragmentManager, chame getSupportFragmentManager() no FragmentActivity ou chame getParentFragmentManager() de um Fragment. Confira o exemplo a seguir:

Kotlin

fun confirmStartGame() {
    val newFragment = StartGameDialogFragment()
    newFragment.show(supportFragmentManager, "game")
}

Java

public void confirmStartGame() {
    DialogFragment newFragment = new StartGameDialogFragment();
    newFragment.show(getSupportFragmentManager(), "game");
}

O segundo argumento, "game", é um nome de tag exclusivo que o sistema usa para salvar e restaurar o estado do fragmento quando necessário. A tag também permite que você gere um identificador para o fragmento chamando findFragmentByTag().

Mostrar uma caixa de diálogo em tela cheia ou como um fragmento incorporado

Talvez você queira que uma parte do design da interface apareça como uma caixa de diálogo em algumas situações e como um fragmento de tela cheia ou incorporado em outras. Você também pode querer que ela apareça de maneira diferente, dependendo do tamanho da tela do dispositivo. A classe DialogFragment oferece flexibilidade para fazer isso, porque pode se comportar como um Fragment incorporável.

No entanto, não é possível usar AlertDialog.Builder ou outros objetos Dialog para criar a caixa de diálogo nesse caso. Se você quiser que o DialogFragment seja incorporável, defina a interface da caixa de diálogo em um layout e carregue o layout no callback onCreateView().

Confira um exemplo de DialogFragment que pode aparecer como uma caixa de diálogo ou um fragmento incorporável, usando um layout chamado purchase_items.xml:

Kotlin

class CustomDialogFragment : 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.
    override fun onCreateView(
            inflater: LayoutInflater,
            container: ViewGroup?,
            savedInstanceState: Bundle?
    ): View {
        // Inflate the layout to use as a 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.
    override fun onCreateDialog(savedInstanceState: Bundle): Dialog {
        // The only reason you might override this method when using
        // onCreateView() is to modify the dialog characteristics. For example,
        // the dialog includes a title by default, but your custom layout might
        // not need it. Here, you can remove the dialog title, but you must
        // call the superclass to get the Dialog.
        val dialog = super.onCreateDialog(savedInstanceState)
        dialog.requestWindowFeature(Window.FEATURE_NO_TITLE)
        return dialog
    }
}

Java

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.
    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
            Bundle savedInstanceState) {
        // Inflate the layout to use as a 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.
    @Override
    public Dialog onCreateDialog(Bundle savedInstanceState) {
        // The only reason you might override this method when using
        // onCreateView() is to modify the dialog characteristics. For example,
        // the dialog includes a title by default, but your custom layout might
        // not need it. 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;
    }
}

O exemplo a seguir determina se o fragmento será exibido como uma caixa de diálogo ou uma interface em tela cheia com base no tamanho da tela:

Kotlin

fun showDialog() {
    val fragmentManager = supportFragmentManager
    val newFragment = CustomDialogFragment()
    if (isLargeLayout) {
        // 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.
        val transaction = fragmentManager.beginTransaction()
        // For a polished look, 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()
    }
}

Java

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

    if (isLargeLayout) {
        // 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 polished look, 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();
    }
}

Para mais informações sobre como realizar transações de fragmentos, consulte Fragmentos.

Nesse exemplo, o booleano mIsLargeLayout especifica se o dispositivo atual precisa usar o design de layout grande do app e mostrar esse fragmento como uma caixa de diálogo em vez de tela cheia. A melhor maneira de definir esse tipo de booleano é declarar um valor de recurso bool com um valor de recurso alternativo para diferentes tamanhos de tela. Por exemplo, veja duas versões de recurso bool para diferentes tamanhos de tela:

res/values/bools.xml

<!-- Default boolean values -->
<resources>
    <bool name="large_layout">false</bool>
</resources>

res/values-large/bools.xml

<!-- Large screen boolean values -->
<resources>
    <bool name="large_layout">true</bool>
</resources>

Em seguida, você pode inicializar o valor mIsLargeLayout durante o método onCreate() da atividade, conforme mostrado no exemplo a seguir.

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    isLargeLayout = resources.getBoolean(R.bool.large_layout)
}

Java

boolean isLargeLayout;

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

    isLargeLayout = getResources().getBoolean(R.bool.large_layout);
}

Mostrar uma atividade como uma caixa de diálogo em telas grandes

Em vez de mostrar uma caixa de diálogo como uma interface de tela cheia em telas pequenas, é possível conseguir o mesmo resultado mostrando um Activity como uma caixa de diálogo em telas grandes. A abordagem escolhida depende do design do app, mas mostrar uma atividade como caixa de diálogo geralmente é útil quando o app é projetado para telas pequenas e você quer melhorar a experiência em tablets mostrando uma atividade de curta duração como uma caixa de diálogo.

Para mostrar uma atividade como uma caixa de diálogo apenas em telas grandes, aplique o tema Theme.Holo.DialogWhenLarge ao elemento <activity> do manifesto:

<activity android:theme="@android:style/Theme.Holo.DialogWhenLarge" >

Para saber mais sobre como estilizar suas atividades com temas, consulte Estilos e temas.

Dispensar uma caixa de diálogo

Quando o usuário toca em um botão de ação criado com uma AlertDialog.Builder, o sistema dispensa a caixa de diálogo.

O sistema também dispensa a caixa de diálogo quando o usuário toca em um item em uma lista da caixa de diálogo, exceto quando a lista usa botões de opção ou caixas de seleção. Caso contrário, é possível dispensar manualmente a caixa de diálogo chamando dismiss() em DialogFragment.

Caso seja necessário realizar determinadas ações quando a caixa de diálogo desaparece, é possível implementar o método onDismiss() no DialogFragment.

Também é possível cancelar uma caixa de diálogo. Esse é um evento especial que indica que o usuário está saindo da caixa de diálogo sem concluir a tarefa. Isso ocorre se o usuário tocar no botão "Voltar" ou na tela fora da área da caixa de diálogo, ou se você chamar explicitamente cancel() no Dialog, como em resposta a um botão "Cancelar" na caixa de diálogo.

Conforme mostrado no exemplo anterior, é possível responder ao evento de cancelamento implementando onCancel() na classe DialogFragment.