桌面widget详解(一)——基本demo构建

一、概述

App Widget是应用程序窗口小部件(Widget)是微型的应用程序视图,它可以被嵌入到其它应用程序中(比如桌面)并接收周期性的更新。你可以通过一个App Widget Provider来发布一个Widget。官方文档地址:《App Widgets》

这里涉及到两个方面的内容:AppWidgetProvider类和appwidget-provider标签;
 

1、appwidget-provider标签:

这个玩意是用来定义桌面widget的大小,初始状态等等信息的,它的位置应该放在res/xml文件夹下,具体的xml参数如下:

  • android:minWidth : 最小宽度
  • android:minHeight : 最小高度
  • android:updatePeriodMillis : 更新widget的时间间隔(ms),"86400000"为1个小时
  • android:previewImage : 预览图片
  • android:initialLayout : 加载到桌面时对应的布局文件
  • android:resizeMode : widget可以被拉伸的方向。horizontal表示可以水平拉伸,vertical表示可以竖直拉伸
  • android:widgetCategory : widget可以被显示的位置。home_screen表示可以将widget添加到桌面,keyguard表示widget可以被添加到锁屏界面。
  • android:initialKeyguardLayout : 加载到锁屏界面时对应的布局文件
     

至于具体怎么用,等下实战的时候会讲。

2、AppWidgetProvider类:

上面我们通过appwidget-provider标签就可以得到初始化的布局,视图等,但我们的widget要实时更新怎么办,要响应用户操作怎么办,这就需要额外的类来辅助处理了,这个类就是AppWidgetProvider。

由于AppWidgetProvider要接收到当前widget的状态(是否被添加,是否被删除等),所以要接收通知,必然是派生自BroadcastReceiver。
 

AppWidgetProvider中的广播处理函数如下:(根据不同的使用情况,重写不同的函数)

onUpdate():

在3种情况下会调用OnUpdate()。onUpdate()是在main线程中进行,因此如果处理需要花费时间多于10秒,处理应在service中完成。(第二篇会讲为什么还要有service)
(1)在时间间隔到时调用,时间间隔在widget定义的android:updatePeriodMillis中设置;
(2)用户拖拽到主页,widget实例生成。无论有没有设置Configure activity,我们在Android4.4的测试中,当用户拖拽图片至主页时,widget实例生成,会触发onUpdate(),然后再显示activity(如果有)。这点和资料说的不一样,资料认为如果设置了Configure acitivity,就不会在一开始调用onUpdate(),而实验显示当实例生成(包括创建和重启时恢复),都会先调用onUpate()。在本例,由于此时在preference尚未有相关数据,创建实例时不能有效进行数据设置。
(3)机器重启,实例在主页上显示,会再次调用onUpdate()
 

onDeleted(Context, int[]):

当 widget 被删除时被触发。

onEnabled(Context):

当第1个 widget 的实例被创建时触发。也就是说,如果用户对同一个 widget 增加了两次(两个实例),那么onEnabled()只会在第一次增加widget时触发。

onDisabled(Context):

当最后1个 widget 的实例被删除时触发。

onReceive(Context, Intent):

在接收到广播时,调用。

二、实战

先看一下显示效果:

就这么一个桌面widget,一个音乐播放器,这一篇只是显示出来,后面我们会慢慢完善它的功能。

1、appwidget-provider及布局文件

前面我们讲过,appwidget-provider提供了桌面widget的初始化显示状态、默认图标、大小等功能,但它必须放在res/xml文件夹下,看看这里的代码:

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:initialLayout="@layout/example_appwidget"
    android:minHeight="60dp"
    android:minWidth="180dp"
    android:previewImage="@drawable/preview"
    android:resizeMode="horizontal|vertical"
    android:widgetCategory="home_screen|keyguard" >
 
</appwidget-provider>

这里有几个参数:

prviewImage:就是添加桌面控件时,我们的控件在列表中的显示状态,如下图所示,下面这个丑娃娃就是我们的显示图标……

android:initialLayout="@layout/example_appwidget":这个就是指定初始化显示时,应该显示的布局;

下面看看这个布局文件:example_appwidget.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="#33000000"
    android:gravity="center"
    android:orientation="horizontal" >
    
    <TextView 
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginRight="8dip"
        android:background="@drawable/car_musiccard_up"/>
    
    <TextView 
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginRight="8dip"
        android:background="@drawable/car_musiccard_play"/>
    
    <TextView 
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:background="@drawable/car_musiccard_down"/>
 
</LinearLayout>

这个布局就是最上头显示出来的那个播放器的布局。

2、ExampleAppWidgetProvider extends AppWidgetProvider

在布局成功之后,下面就是根据通知实现逻辑了,这篇我们只接收通知,逻辑下篇再说。首先新建一个类ExampleAppWidgetProvider,将其派生自AppWidgetProvider;然后就会有下面的代码:

public class ExampleAppWidgetProvider extends AppWidgetProvider {
 
	 /*
	  * 在3种情况下会调用OnUpdate()。onUpdate()是在main线程中进行,因此如果处理需要花费时间多于10秒,处理应在service中完成。
	  *(1)在时间间隔到时调用,时间间隔在widget定义的android:updatePeriodMillis中设置; 
	  *(2)用户拖拽到主页,widget实例生成。无论有没有设置Configure activity,我们在Android4.4的测试中,当用户拖拽图片至主页时,widget实例生成,会触发onUpdate(),然后再显示activity(如果有)。这点和资料说的不一样,资料认为如果设置了Configure acitivity,就不会在一开始调用onUpdate(),而实验显示当实例生成(包括创建和重启时恢复),都会先调用onUpate()。在本例,由于此时在preference尚未有相关数据,创建实例时不能有效进行数据设置。
	  *(3)机器重启,实例在主页上显示,会再次调用onUpdate()
	  */ 
	@Override
	public void onUpdate(Context context, AppWidgetManager appWidgetManager,
			int[] appWidgetIds) {
 
		super.onUpdate(context, appWidgetManager, appWidgetIds);
	}
 
	// widget被删除时调用
	@Override
	public void onDeleted(Context context, int[] appWidgetIds) {
		Log.d(TAG, "onDeleted(): appWidgetIds.length=" + appWidgetIds.length);
 
		super.onDeleted(context, appWidgetIds);
	}
 
	// 最后一个widget被删除时调用
	@Override
	public void onDisabled(Context context) {
		Log.d(TAG, "onDisabled");
 
		super.onDisabled(context);
	}
 
	// 第一个widget被创建时调用
	@Override
	public void onEnabled(Context context) {
 
		super.onEnabled(context);
	}
 
	// 接收广播的回调函数
	@Override
	public void onReceive(Context context, Intent intent) {
 
		super.onReceive(context, intent);
	}
}

这里不是继承接口,这几个函数并不是需要全部重写的,根据需要,要用到哪个可以重写哪个。

3、注册ExampleAppWidgetProvider

前面我们讲到AppWidgetProvider派生自BroadcastReciver,所以要提前注册,有关BroadcastReciver的注册有两种方法,静态注册和动态注册,因为这里要接收来自的消息,而且在程序启动时就开始自动监听,所以,这里需要静态注册。

<!-- 声明widget对应的AppWidgetProvider -->
<receiver android:name=".ExampleAppWidgetProvider" >
    <intent-filter>
	<action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
    </intent-filter>
    <meta-data android:name="android.appwidget.provider"
	android:resource="@xml/example_appwidget_info" />
</receiver>

(1)接收的action定义为:"android.appwidget.action.APPWIDGET_UPDATE"这表明接收系统发来的有关这个app的所有widget的消息(主要是增加、删除)。

(2)<meta-data> 指定了 AppWidgetProviderInfo 对应的资源文件
android:name -- 指定metadata名,指定为android.appwidget.provider表示这个data中的数据是AppWidgetProviderInfo 类型的
android:resource -- 指定 AppWidgetProviderInfo 对应的资源路径。即,xml/example_appwidget_info.xml。

三、可能出现的错误:

1、有关布局错误

在构造Widget布局时,App Widget支持的布局和控件非常有限,有如下几个:

App Widget支持的布局:

  •   FrameLayout
  •   LinearLayout
  •   RelativeLayout
  •   GridLayout

 App Widget支持的控件:

  •   AnalogClock
  •   Button            
  •   Chronometer
  •   ImageButton
  •   ImageView
  •   ProgressBar
  •   TextView
  •   ViewFlipper
  •   ListView
  •   GridView
  •   StackView
  •   AdapterViewFlipper

除此之外的所有控件(包括自定义控件)都无法显示,无法显示时,添加出来的widget会显示“加载布局出错”

2、appwidget-provider出现错误

如果appwidget-provider页面出现错误提示:error: No resource identifier found for attribute 'widgetCategory' in package 

'android'

这是由于build target应该在17以上,有两种方法解决:

方法1:找到工程中的project.properties文件将target=android-14改为target=android-17   

方法2:工程上右键-》properties  选择Android,将Project Build Target改为17或以上,如图:(改完之后rebuild一下工程)

发布了234 篇原创文章 · 获赞 77 · 访问量 13万+

猜你喜欢

转载自blog.csdn.net/lwzhang1101/article/details/101429143