Home Android Interfaz de usuario en Android: Widgets (I)

Interfaz de usuario en Android: Widgets (I)

by sgoliver

En los dos próximos artículos del Curso de Programación Android vamos a describir cómo crear un widget de escritorio (home screen widget).

En esta primera parte construiremos un widget estático (no será interactivo, ni contendrá datos actualizables, ni responderá a eventos) muy básico para entender claramente la estructura interna de un componente de este tipo, y en el siguiente artículo completaremos el ejercicio añadiendo una ventana de configuración inicial para el widget, añadiremos algún dato que podamos actualizar periodicamente, y haremos que responda a pulsaciones del usuario.

Como hemos dicho, en esta primera parte vamos a crear un widget muy básico, consistente en un simple marco rectangular negro con un mensaje de texto predeterminado («Mi Primer Widget«). La sencillez del ejemplo nos permitirá centrarnos en los pasos principales de la construcción de un widget Android y olvidarnos de otros detalles que nada tienen que ver con el tema que nos ocupa (gráficos, datos, …). Para que os hagáis una idea, éste será el aspecto final de nuestro widget de ejemplo:

vista-previa-widget

Los pasos principales para la creación de un widget Android son los siguientes:

  1. Definición de su interfaz gráfica (layout).
  2. Configuración XML del widget (AppWidgetProviderInfo).
  3. Implementación de la funcionalidad del widget (AppWidgetProvider) , especialmente su evento de actualización.
  4. Declaración del widget en el Android Manifest de la aplicación.

En el primer paso no nos vamos a detener mucho ya que es análogo a cualquier definición de layout de las que hemos visto hasta ahora en el curso. En esta ocasión, la interfaz del widget estará compuesta únicamente por un par de frames (FrameLayout), uno negro exterior y uno blanco interior algo más pequeño para simular el marco, y una etiqueta de texto (TextView) que albergará el mensaje a mostrar. Veamos cómo queda el layout xml, que para este ejemplo llamaremos «miwidget.xml«:

<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="#000000"
    android:padding="10dp"
    android:layout_margin="5dp" >

    <FrameLayout android:id="@+id/frmWidget"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="#FFFFFF"
        android:padding="5dp" >

        <TextView android:id="@+id/txtMensaje"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:textColor="#000000"
            android:text="@string/mi_primer_widget" />

    </FrameLayout>

</FrameLayout>

Cabe destacar aquí que, debido a que el layout de los widgets de Android está basado en un tipo especial de componentes llamados RemoteViews, no es posible utilizar en su interfaz todos los contenedores y controles que hemos visto en artículos anteriores sino sólo unos pocos básicos que se indican a continuación:

  • Contenedores: FrameLayout, LinearLayout, RelativeLayout y GridLayout (éste último a partir de Android 4).
  • Controles: Button, ImageButton, ImageView, TextView, ProgressBar, ChronometerAnalogClock y ViewFlipper. A partir de Android 3 también podemos utilizar ListView, GridView, StackView y AdapterViewFlipper, aunque su uso tiene algunas particularidades. En este artículo no trataremos este último caso, pero si necesitas información puedes empezar por la documentación oficial sobre el tema.

Aunque la lista de controles soportados no deja de ser curiosa (al menos en mi humilde opinión), debería ser suficiente para crear todo tipo de widgets.

Como segundo paso del proceso de construcción vamos a crear un nuevo fichero XML donde definiremos un conjunto de propiedades del widget, como por ejemplo su tamaño en pantalla o su frecuencia de actualización. Este XML se deberá crear en la carpeta \res\xml de nuestro proyecto. En nuestro caso de ejemplo lo llamaremos «miwidget_wprovider.xml» y tendrá la siguiente estructura:

<?xml version="1.0" encoding="utf-8"?>
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:initialLayout="@layout/miwidget"
    android:minWidth="110dip"
    android:minHeight="40dip"
    android:label="@string/mi_primer_widget"
    android:updatePeriodMillis="3600000"
/>

Para nuestro widget estamos definiendo las siguientes propiedades:

  • initialLayout: referencia al layout XML que hemos creado en el paso anterior.
  • minWidth: ancho mínimo del widget en pantalla, en dp (density-independent pixels).
  • minHeight: alto mínimo del widget en pantalla, en dp (density-independent pixels).
  • label: nombre del widget que semostrará en el menú de selección de Android.
  • updatePeriodMillis: frecuencia de actualización del widget, en milisegundos.

Existen varias propiedades más que se pueden definir, por ejemplo el icono de vista previa del widget (android:previewImage, sólo para Android >3.0) o el indicativo de si el widget será redimensionable (android:resizeMode, sólo para Android >3.1) o la actividad de configuración del widget (android:configure). En el siguiente artículo utilizaremos alguna de ellas, el resto se pueden consultar en la documentación oficial de la clase AppWidgetProviderInfo.

Como sabemos, la pantalla inicial de Android se divide en un mínimo de 4×4 celdas (según el dispositivo pueden ser más) donde se pueden colocar aplicaciones, accesos directos y widgets. Teniendo en cuenta las diferentes dimensiones de estas celdas según el dispositivo y la orientación de la pantalla, existe una fórmula sencilla para ajustar las dimensiones de nuestro widget para que ocupe un número determinado de celdas sea cual sea la orientación:

  • ancho_mínimo = (num_celdas * 70) – 30
  • alto_mínimo = (num_celdas * 70) – 30

Atendiendo a esta fórmula, si queremos que nuestro widget ocupe por ejemplo un tamaño mínimo de 2 celdas de ancho por 1 celda de alto, deberemos indicar unas dimensiones de 110dp x 40dp.

Vamos ahora con el tercer paso. Éste consiste en implementar la funcionalidad de nuestro widget en su clase java asociada. Esta clase deberá heredar de AppWidgetProvider, que a su vez no es más que una clase auxiliar derivada de BroadcastReceiver, ya que los widgets de Android no son más que un caso particular de este tipo de componentes.

En esta clase deberemos implementar los mensajes a los que vamos a responder desde nuestro widget, entre los que destacan:

  • onEnabled(): lanzado cuando se crea la primera instancia de un widget.
  • onUpdate(): lanzado periodicamente cada vez que se debe actualizar un widget, por ejemplo cada vez que se cumple el periodo de tiempo definido por el parámetro updatePeriodMillis antes descrito, o cuando se añade el widget al escritorio.
  • onDeleted(): lanzado cuando se elimina del escritorio una instancia de un widget.
  • onDisabled(): lanzado cuando se elimina del escritorio la última instancia de un widget.

En la mayoría de los casos, tendremos que implementar como mínimo el evento onUpdate(). El resto de métodos dependerán de la funcionalidad de nuestro widget. En nuestro caso particular no nos hará falta ninguno de ellos ya que el widget que estamos creando no contiene ningún dato actualizable, por lo que crearemos la clase, llamada MiWidget, pero dejaremos vacío por el momento el método onUpdate(). En el siguiente artículo veremos qué cosas podemos hacer dentro de estos métodos.

package net.sgoliver.android.widgets;

import android.appwidget.AppWidgetManager;
import android.appwidget.AppWidgetProvider;
import android.content.Context;

public class MiWidget extends AppWidgetProvider {
	@Override
    public void onUpdate(Context context,
                 AppWidgetManager appWidgetManager,
                 int[] appWidgetIds) {
        //Actualizar el widget
        //...
    }
}

El último paso del proceso será declarar el widget dentro del manifest de nuestra aplicación. Para ello, editaremos el fichero AndroidManifest.xml para incluir la siguiente declaración dentro del elemento <application>:

<application>
        ...
	<receiver android:name=".MiWidget" android:label="Mi Primer Widget">
		<intent-filter>
		   <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
		</intent-filter>
		<meta-data
		   android:name="android.appwidget.provider"
		   android:resource="@xml/miwidget_wprovider" />
	</receiver>
</application>

El widget se declarará como un elemento <receiver> y deberemos aportar la siguiente información:

  • Atributo name: Referencia a la clase java de nuestro widget, creada en el paso anterior.
  • Elemento <intent-filter>, donde indicaremos los «eventos» a los que responderá nuestro widget, normalmente añadiremos el evento APPWIDGET_UPDATE, para detectar la acción de actualización.
  • Elemento <meta-data>, donde haremos referencia con su atributo resource al XML de configuración que creamos en el segundo paso del proceso.

Con esto habríamos terminado de escribir los distintos elementos necesarios para hacer funcionar nuestro widget básico de ejemplo. Para probarlo, podemos ejecutar el proyecto de Eclipse en el emulador de Android, esperar a que se ejecute la aplicación principal (que estará vacía, ya que no hemos incluido ninguna funcionalidad para ella), ir a la pantalla principal del emulador y añadir nuestro widget al escritorio tal cómo lo haríamos en nuestro dispositivo físico:

  • En Android 2: pulsación larga sobre el escritorio o tecla Menú, seleccionar la opción Widgets, y por último seleccionar nuestro Widget.
  • En Android 4:  accedemos al menú principal, pulsamos la pestaña Widgets, buscamos el nuestro en la lista y realizamos sobre él una pulsación larga hasta que el sistema nos deja arrastrarlo y colocarlo sobre el escritorio.

Con esto ya hemos conseguido la funcionalidad básica de un widget, es posible añadir varias instancias al escritorio, desplazarlos por la pantalla y eliminarlos enviándolos a la papelera.

En el próximo artículo veremos cómo podemos mejorar este widget añadiendo una pantalla de configuración inicial, mostraremos algún dato que se actualice periódicamente, y añadiremos la posibilidad de capturar eventos de pulsación sobre el widget.

Puedes consultar y/o descargar el código completo de los ejemplos desarrollados en este artículo accediendo a la pagina del curso en GitHub.

Curso de Programación Android en PDF

Este curso también está disponible en PDF. Descubre cómo conseguirlo…

¿Te ha sido de utilidad el Curso de Programación Android? ¿Quieres colaborar de forma económica con el proyecto? Puedes contribuir con cualquier cantidad, unos céntimos, unos euros, cualquier aportación será bienvenida. Además, si tu aportación es superior a una pequeña cantidad simbólica recibirás como agradecimiento un documento con la última versión del curso disponible en formato PDF. Sea como sea, muchas gracias por colaborar!

Más información:

You may also like

21 comments

Desarrollo en Android | sgoliver.net blog 23/02/2011 - 16:31

[…] Interfaz de usuario en Android: Widgets (I) [Nuevo!] […]

Reply
@searetseltev 05/03/2011 - 19:34

Al fin entiendo los widgets ^_^. Tras la mezcla de todo lo que he buscado, este ha sido el texto que me ha unido todas las piezas y al fin me aclaro jeje. Muy bien explicado :D

Genial todo el curso, no puedo esperar a la siguiente entrega :)~~

Reply
vikcbr 05/03/2011 - 19:40

Se puede limitar el numero de widgets a mostrar? O sea, solo quiero una instancia instalada en el desktop y no dejar instalar mas.

Gracias!

Reply
Enric 16/04/2011 - 19:11

Idem, he mirado varios ejemplos y porsupuesto el tuto de android developers, tu tutorial es el unico con el que me he aclarado, realmente se entiene bien gracias por hcerlo nene!!

Reply
cristian 10/06/2011 - 6:58

Muy bueno el tutorial!!!
el mejor de toda la web
felicitaciones y muchas gracias por toda la info!
Saludos

Reply
Carlos Eduardo 19/10/2011 - 0:01

Muchas gracias por este tuto. Aunque me parece que son los ejemplos de Sams Teach Yourself Android Development in 24 hours. Saludos.

Reply
sgoliver 19/10/2011 - 19:39

Lo siento, desconozco el libro que indicas, pero te puedo asegurar que los ejemplos de este artículo son de cosecha propia para simplificar al máximo las cosas, y además en español. Algunos libros complican innecesariamente los ejemplos que utilizan, verdad?

Reply
Andrés Rodriguez 25/10/2012 - 19:06

Muy buen tutorial, sería bueno que explicaras que parte del código es el encargado de que el widget que se creó aparezca en el menú de widget.

Reply
Yaroslav Prokhorov 25/11/2012 - 12:32

Hola! Tengo la misma duda, la del comentario anterior. Que es lo q hace que el widget aparezca en la lista de widgets instalados? No consigo q mi widget salga en esta lista, después de su instalación en el terminal.

Reply
Esther 18/12/2012 - 15:49

He comprobado que si no se incluye el el widget no aparece en la lista de widgest para instalar.
Es decir, que el filtro es necesario aunque en este ejemplo no actualicemos el widget en ningún momento

Reply
Yaroslav Prokhorov 21/01/2013 - 15:09

Hola, Esther. Con lo del filtro te refieres al ??? Si es que sí, lo tengo tal cual. El código copiado de ese ejemplo. Y el widget se instala sin problemas pero no aparece en la lista de widgets disponibles

Sigo sin saber a que se debe.
Muchas gracias de todos modos

Reply
Silo´pez 16/04/2013 - 5:28

Tengo una duda, sera q me puede explicar que es lo de las celdas???

Reply
Interfaz de usuario en Android: Widgets (II) | sgoliver.net blog 18/04/2013 - 10:46

[…] un artículo anterior del curso ya vimos cómo construir un widget básico para Android, y prometimos que dedicaríamos un artículo adicional a comentar algunas […]

Reply
MdOS 20/04/2013 - 21:54

Termine el proyecto, le doy en: Run as… > Android Application

Se inicia el emulador con android 4.2.1, me voy a la seccion de Widgets, y aparecen lo que traen por defecto, nunca aparece el que se hizo aqui…

Como puedo ver que efectivamente funciona e Widget??

Reply
sgoliver 21/04/2013 - 10:08

¿Cuando se inicia el proyecto en el emulador te aparece primero la actividad principal de la aplicación (vacía, porque no hemos añadido nada)? Si no es así es que no se esta ejecutando correctamente. Prueba a lanzar otra vez el proyecto con el emulador ya abierto. Y también mira el log por si hubiera algún error. Saludos.

Reply
Mariangela Salcedo 15/06/2013 - 18:20

Hola, me funciona todo perfectamente. No me arroja errores y se ejecuta normal en el emulador. Pero yo tampoco he conseguido el widget en la lista de los instalados..

Alguien que haya solucionado este detalle?????? Por favor!

Reply
Diego Jesus 28/06/2013 - 9:00

Hola.

He seguido el tutorial y todo bien hasta que se me presenta un problema con el tamaño del widget.

He usado la formula que indicas y he definido mi widget con un tamaño de 4×3. Para los smarthphones, se ve bien pero a la hora de ejecutarlo en una tablet se ve muy pequeño de 3×3 y por tanto todos los elementos subidos uno arriba de otro.

¿Cómo podría hacer para solucionar esto y que se vea bien en todos los tamaños de pantalla? Necesitaría que para los smartphones sea de 4×3 y pata las tablet como de 7×5

Reply
carlos_sf 11/09/2013 - 12:53

Hola. Estoy muy interesado en este curso y he empezado hacerlo,
Pero me ha salido un problema :

error: Error: No resource found that matches the given name (at ‘resource’ with value ‘@xml/miwidget_wprovider’).

pero en mi carpeta layaut ya existe miwidget_wprovider.xml, ¿porque no lo reconoce?.

Muchas gracias

Reply
carlos_sf 11/09/2013 - 17:26

ya he solucionado el problema. La carpeta se llama layout , he sustituido @xml/ por @layout/ y me ha funcionado

Reply
Manu 08/11/2014 - 22:13

Estoy probando a hacer el widget pero me da un problema cuando lo ejecuto que dice: Unfortunately, MiWidget has stopped
Solo he copiado y pegado todas las cosas y no he cambiado nada por lo que no lo entiendo.

Reply
Pablo 01/10/2015 - 2:00

Muy bueno! Muchas gracias genio! :)

Reply

Leave a Comment

Uso de cookies

Este sitio web utiliza cookies para que usted tenga la mejor experiencia de usuario. Si continúa navegando está dando su consentimiento para la aceptación de las mencionadas cookies y la aceptación de nuestra política de cookies, pinche el enlace para mayor información.plugin cookies

ACEPTAR
Aviso de cookies