Tutorial Widgets Android

Publicado por el

Tutorial Widgets Android

En este tutorial construiremos un widget estático muy básico para entender claramente la estructura interna de un componente de este tipo. Consiste en un simple marco rectangular verde con un mensaje de texto predeterminado (“Mi Widget Basico“). La sencillez del ejemplo nos permitirá centrarnos en los pasos principales de la construcción de un widget Android.
widget basico

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

1. Definición de su interfaz gráfica (layout)

Se crea un nuevo layout "miwidget.xml" el cual va a definir la interfaz gráfica del widget:
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="fill_parent"
     android:layout_height="fill_parent"
     android:orientation="horizontal"
        android:background="#4D4D4D"
        android:padding="10dp" >

        <FrameLayout
            android:layout_width="fill_parent"
            android:layout_height="fill_parent"
            android:background="#A4C639"
            android:padding="5dp" >

            <TextView
                android:id="@+id/txtMensaje"
                android:layout_width="fill_parent"
                android:layout_height="wrap_content"
                android:text="Mi WidGet Basico"
                android:textColor="#FFFFFF"
                android:textSize="18sp" />
        </FrameLayout>
</FrameLayout>


Para definir la interfaz de un widget se pueden usar solo los siguientes controles:
  • Contenedores: FrameLayout, LinearLayout, RelativeLayout y GridLayout (éste último a partir de Android 4). 
  • Controles: Button, ImageButton, ImageView, TextView, ProgressBar,Chronometer, AnalogClock y ViewFlipper. A partir de Android 3 también podemos utilizar ListView, GridView, StackView y AdapterViewFlipper



2. Configuración XML del widget (AppWidgetProviderInfo).

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="mi_widget_basico"
    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).







Definir el alto y ancho del widget, 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.




    

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

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




3. Implementación de la funcionalidad del widget (AppWidgetProvider) , especialmente su evento de actualización.







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






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
 }
}










4. Declaración del widget en el Android Manifest de la aplicación. 





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 Widget Basico">
        <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.







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.




















































Comentarios











Publicar un comentario