Tu aplicación puede mostrarles a los usuarios tareas de varios pasos. Por ejemplo, es posible que tu app necesite guiar a los usuarios para que compren contenido adicional, establezcan una configuración compleja o simplemente confirmen una decisión. Todas estas tareas requieren guiar a los usuarios a través de uno o más pasos o decisiones ordenadas.
La biblioteca de androidx.Leanback brinda clases que permiten implementar tareas de varios pasos para los usuarios. En esta página, se analiza cómo usar la clase GuidedStepSupportFragment
para guiar a un usuario a través de una serie de decisiones que le permitirán completar una tarea. GuidedStepSupportFragment
usa las prácticas recomendadas de la IU de TV para facilitar la comprensión de las tareas de varios pasos y la navegación en dispositivos de TV.
Cómo proporcionar detalles para un paso
Una GuidedStepSupportFragment
representa un solo paso en una serie de pasos. Visualmente, proporciona una vista de guía con una lista de acciones o decisiones posibles para el paso.
Para cada paso de tu tarea de varios pasos, extiende GuidedStepSupportFragment
y proporciona información de contexto sobre el paso y las acciones que puede realizar el usuario. Anula onCreateGuidance()
y muestra un GuidanceStylist.Guidance
nuevo que contenga información de contexto, como el título del paso, la descripción y el ícono, tal como se indica en el siguiente ejemplo:
Kotlin
override fun onCreateGuidance(savedInstanceState: Bundle?): GuidanceStylist.Guidance { return GuidanceStylist.Guidance( getString(R.string.guidedstep_first_title), getString(R.string.guidedstep_first_description), getString(R.string.guidedstep_first_breadcrumb), activity.getDrawable(R.drawable.guidedstep_main_icon_1) ) }
Java
@Override public GuidanceStylist.Guidance onCreateGuidance(Bundle savedInstanceState) { String title = getString(R.string.guidedstep_first_title); String breadcrumb = getString(R.string.guidedstep_first_breadcrumb); String description = getString(R.string.guidedstep_first_description); Drawable icon = getActivity().getDrawable(R.drawable.guidedstep_main_icon_1); return new GuidanceStylist.Guidance(title, description, breadcrumb, icon); }
Para agregar la subclase GuidedStepSupportFragment
a la actividad deseada, llama a GuidedStepSupportFragment.add()
en el método onCreate()
de tu actividad.
Si tu actividad contiene solo objetos GuidedStepSupportFragment
, usa GuidedStepSupportFragment.addAsRoot()
en lugar de add()
para agregar la primera GuidedStepSupportFragment
. El uso de addAsRoot()
ayuda a garantizar que, si el usuario presiona el botón Atrás en el control remoto de la TV cuando se ve el primer GuidedStepSupportFragment
, se cierren tanto GuidedStepSupportFragment
como la actividad principal.
Nota: Agrega objetos GuidedStepSupportFragment
de manera programática, no en tus archivos en formato XML de diseño.
Cómo crear y administrar acciones de usuarios
Anula onCreateActions()
para agregar acciones del usuario.
En tu anulación, agrega un GuidedAction
nuevo para cada elemento de acción y proporciona la cadena de acción, la descripción y el ID. Usa GuidedAction.Builder
para agregar nuevas acciones.
Kotlin
override fun onCreateActions(actions: MutableList<GuidedAction>, savedInstanceState: Bundle?) { super.onCreateActions(actions, savedInstanceState) // Add "Continue" user action for this step actions.add(GuidedAction.Builder() .id(CONTINUE) .title(getString(R.string.guidedstep_continue)) .description(getString(R.string.guidedstep_letsdoit)) .hasNext(true) .build()) ...
Java
@Override public void onCreateActions(List<GuidedAction> actions, Bundle savedInstanceState) { // Add "Continue" user action for this step actions.add(new GuidedAction.Builder() .id(CONTINUE) .title(getString(R.string.guidedstep_continue)) .description(getString(R.string.guidedstep_letsdoit)) .hasNext(true) .build()); ...
Las acciones no se limitan a selecciones de una sola línea. A continuación, se incluyen tipos adicionales de acciones que puedes crear:
-
Configura
infoOnly(true)
para agregar una acción de etiqueta de información a fin de proporcionar información adicional sobre las opciones del usuario. CuandoinfoOnly
es verdadero, los usuarios no pueden seleccionar la acción. -
Configura
editable(true)
para agregar una acción de texto editable. Cuandoeditable
es verdadero, el usuario puede ingresar texto en una acción seleccionada con el control remoto o un teclado conectado. AnulaonGuidedActionEditedAndProceed()
para obtener el texto modificado que ingresó el usuario. También puedes anularonGuidedActionEditCanceled()
para saber cuándo el usuario cancela la entrada. -
Agrega un conjunto de acciones que se comporten como botones de selección que se pueden marcar mediante
checkSetId()
con un valor de ID común para agrupar acciones en un conjunto. Todas las acciones que aparecen en la misma lista con el mismo ID de conjunto de verificación se consideran vinculadas. Cuando el usuario selecciona una de las acciones de ese conjunto, esa acción se marca y se desmarcan todas las demás. -
Agrega una acción de selector de fecha con
GuidedDatePickerAction.Builder
en lugar deGuidedAction.Builder
enonCreateActions()
. AnulaonGuidedActionEditedAndProceed()
para obtener el valor de fecha modificado que ingresó el usuario. - Agrega una acción que use subacciones para que el usuario pueda elegir entre una lista extendida de opciones. Las subacciones se describen en la sección Cómo agregar subacciones.
- Agrega una acción de botón que aparezca a la derecha de la lista de acciones y de fácil acceso. Las acciones de botones se describen en la sección Cómo agregar acciones de botones.
También puedes agregar un indicador visual de que la selección de una acción lleva a un nuevo paso si configuras hasNext(true)
.
Para ver todos los atributos diferentes que puedes configurar, consulta GuidedAction
.
Para responder a las acciones, anula onGuidedActionClicked()
y procesa el GuidedAction
pasado. Examina GuidedAction.getId()
para identificar la acción seleccionada.
Cómo agregar subacciones
Algunas acciones podrían requerir que le des al usuario un conjunto adicional de opciones. Un GuidedAction
puede especificar una lista de subacciones que se muestra como un menú de acciones secundarias.
La lista de subacciones puede contener acciones normales o de botones de selección, pero no acciones de selector de fecha ni acciones de texto editables. Además, una subacción no puede tener su propio conjunto de subacciones, ya que el sistema no admite más de un nivel de subacciones.
Para agregar subacciones, primero crea y propaga una lista de objetos GuidedAction
que actúen como subacciones, como se muestra en el siguiente ejemplo:
Kotlin
subActions.add(GuidedAction.Builder() .id(SUBACTION1) .title(getString(R.string.guidedstep_subaction1_title)) .description(getString(R.string.guidedstep_subaction1_desc)) .build()) ...
Java
List<GuidedAction> subActions = new ArrayList<GuidedAction>(); subActions.add(new GuidedAction.Builder() .id(SUBACTION1) .title(getString(R.string.guidedstep_subaction1_title)) .description(getString(R.string.guidedstep_subaction1_desc)) .build()); ...
En onCreateActions()
, crea un GuidedAction
de nivel superior que muestre la lista de subacciones cuando se selecciona:
Kotlin
... actions.add(GuidedAction.Builder() .id(SUBACTIONS) .title(getString(R.string.guidedstep_subactions_title)) .description(getString(R.string.guidedstep_subactions_desc)) .subActions(subActions) .build()) ...
Java
@Override public void onCreateActions(List<GuidedAction> actions, Bundle savedInstanceState) { ... actions.add(new GuidedAction.Builder() .id(SUBACTIONS) .title(getString(R.string.guidedstep_subactions_title)) .description(getString(R.string.guidedstep_subactions_desc)) .subActions(subActions) .build()); ... }
Por último, anula onSubGuidedActionClicked()
para responder a las selecciones de subacciones:
Kotlin
override fun onSubGuidedActionClicked(action: GuidedAction): Boolean { // Check for which action was clicked and handle as needed when(action.id) { SUBACTION1 -> { // Subaction 1 selected } } // Return true to collapse the subactions menu or // false to keep the menu expanded return true }
Java
@Override public boolean onSubGuidedActionClicked(GuidedAction action) { // Check for which action was clicked and handle as needed if (action.getId() == SUBACTION1) { // Subaction 1 selected } // Return true to collapse the subactions menu or // false to keep the menu expanded return true; }
Cómo agregar acciones de botones
Si tu paso guiado tiene una lista larga de acciones, es posible que los usuarios tengan que desplazarse por la lista para acceder a las acciones más usadas. Usa acciones de botones para separar las acciones de uso frecuente de la lista de acciones. Las acciones de botones aparecen junto a la lista de acciones y son fáciles de navegar.
Las acciones de botones se crean y manejan como las acciones normales, pero creas acciones de botones en onCreateButtonActions()
en lugar de onCreateActions()
. Responde a las acciones de botones en onGuidedActionClicked()
.
Usa las acciones de botones para acciones simples, como las de navegación entre pasos. No uses acciones de selección de fechas o editables como acciones de botones. Ten en cuenta que las acciones de botones no pueden tener subacciones.
Cómo agrupar pasos guiados en una secuencia guiada
Un GuidedStepSupportFragment
representa un solo paso. Para crear una secuencia ordenada de pasos, agrupa varios objetos GuidedStepSupportFragment
usando GuidedStepSupportFragment.add()
para agregar el siguiente paso en la secuencia a la pila de fragmentos.
Kotlin
override fun onGuidedActionClicked(action: GuidedAction) { val fm = fragmentManager when(action.id) { CONTINUE -> GuidedStepSupportFragment.add(fm, SecondStepFragment()) } }
Java
@Override public void onGuidedActionClicked(GuidedAction action) { FragmentManager fm = getFragmentManager(); if (action.getId() == CONTINUE) { GuidedStepSupportFragment.add(fm, new SecondStepFragment()); } ...
Si el usuario presiona el botón Atrás en el control remoto de la TV, el dispositivo mostrará el GuidedStepSupportFragment
anterior en la pila de fragmentos. Si proporcionas tu propio objeto GuidedAction
que regresa al paso anterior, puedes implementar el comportamiento del botón Atrás llamando a getFragmentManager().popBackStack()
.
Si necesitas que el usuario regrese a un paso anterior de la secuencia, usa popBackStackToGuidedStepSupportFragment()
para regresar a un GuidedStepSupportFragment
específico en la pila de fragmentos.
Cuando el usuario finalice el último paso de la secuencia, usa finishGuidedStepSupportFragments()
para quitar todas las instancias de GuidedStepSupportFragment
de la pila actual y volver a la actividad superior original. Si se agrega el primer GuidedStepSupportFragment
con addAsRoot()
, llamar a finishGuidedStepSupportFragments()
también cierra la actividad superior.
Cómo personalizar una presentación de pasos
La clase GuidedStepSupportFragment
puede usar temas personalizados que controlen aspectos de presentación, como el formato del texto del título o las animaciones de transición de pasos. Los temas personalizados se deben heredar de Theme_Leanback_GuidedStep
y pueden proporcionar valores de anulación para los atributos definidos en GuidanceStylist
y GuidedActionsStylist
.
Para aplicar un tema personalizado a tu GuidedStepSupportFragment
, realiza una de las siguientes acciones:
-
Para aplicar el tema a la actividad superior, configura el atributo
android:theme
en el elemento de la actividad en el manifiesto de Android. La configuración de este atributo aplica el tema a todas las vistas secundarias y es la forma más directa de aplicar un tema personalizado si la actividad principal contiene solo objetosGuidedStepSupportFragment
. -
Si tu actividad ya usa un tema personalizado y no quieres aplicar estilos de
GuidedStepSupportFragment
a otras vistas de la actividad, agrega el atributoLeanbackGuidedStepTheme_guidedStepTheme
a tu tema de actividad personalizado existente. Este atributo apunta al tema personalizado que solo usan los objetosGuidedStepSupportFragment
de tu actividad. -
Si usas objetos
GuidedStepSupportFragment
en diferentes actividades que forman parte de la misma tarea de varios pasos general y deseas usar un tema visual coherente en todos los pasos, anulaGuidedStepSupportFragment.onProvideTheme()
y muestra tu tema personalizado.
Si deseas obtener más información para agregar estilos y temas, consulta Estilos y temas.
La clase GuidedStepSupportFragment
usa clases de estilo especiales para acceder a los atributos del tema y aplicarlos.
La clase GuidanceStylist
usa la información del tema para controlar la presentación de la vista de guía izquierda, mientras que la clase GuidedActionsStylist
usa la información del tema para controlar la presentación de acciones de la derecha.
Para personalizar el estilo visual de tus pasos más allá de lo que proporciona la personalización del tema, crea la subclase GuidanceStylist
o GuidedActionsStylist
y muestra tu subclase en GuidedStepSupportFragment.onCreateGuidanceStylist()
o GuidedStepSupportFragment.onCreateActionsStylist()
.
Para obtener detalles sobre lo que puedes personalizar en estas subclases, consulta la documentación sobre GuidanceStylist
y GuidedActionsStylist
.