AppWidget简介

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

AppWidget使用流程

1、新建class继承自AppWidgetProvider,并根据需要覆写方法

2、由于Widget本质上是一个广播接受者,所以需要在AndroidManifest.xml中进行注册(与广播相同),只不过有一点特殊配置。

3、在/res/xml/下新建一个xml文件对Widget进行配置,比如刷新时间等。

AppWidget主要的相关类介绍

  • AppWidgetProvider

AppWidgetProvider 继承自 BroadcastReceiver,它能接收与 widget 相关的广播,例如 widget 的更新、删除、开启和禁用等。本质上AppWidget是基于Broadcast来实现的。

AppWidgetProvider中的广播处理函数如下:

onUpdate()

当 widget 更新时被执行。

同样,当用户首次添加 widget 时,onUpdate() 也会被调用,这样 widget 就能进行必要的设置工作(如果需要的话) 。但是,如果定义了 widget 的 configure属性(即android:config,后面会介绍),那么当用户首次添加 widget 时,onUpdate()不会被调用;之后更新 widget 时,onUpdate才会被调用。

onAppWidgetOptionsChanged()

当 widget 被初次添加 或者 当 widget 的大小被改变时,执行onAppWidgetOptionsChanged()。

你可以在该函数中,根据 widget 的大小来显示/隐藏某些内容。可以通过 getAppWidgetOptions() 来返回 Bundle 对象以读取 widget 的大小信息,Bundle中包括以下信息:

OPTION_APPWIDGET_MIN_WIDTH — 包含 widget 当前宽度的下限,以dp为单位。

OPTION_APPWIDGET_MIN_HEIGHT — 包含 widget 当前高度的下限,以dp为单位。

OPTION_APPWIDGET_MAX_WIDTH — 包含 widget 当前宽度的上限,以dp为单位。

OPTION_APPWIDGET_MAX_HEIGHT — 包含 widget 当前高度的上限,以dp为单位。

onAppWidgetOptionsChanged() 是 Android 4.1 引入的。

onDeleted(Context, int[])

当 widget 被删除时被触发。参数为上下文对象和被删除的AppWidget的编号.

onEnabled(Context)

当第1个 widget 的实例被创建时触发

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

onDisabled(Context)

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

onReceive(Context, Intent)

接收到任意广播时触发,并且会在上述的方法之前被调用。因为AppWidget是基于广播的,所以在onReceive中进行广播处理,然后根据处理的结果去调用不同的回调函数。下面贴出onReceiver的源码。

  • AppWidgetProviderInfo

AppWidgetProviderInfo描述一个App Widget元数据,比如App Widget的布局,更新频率,以及AppWidgetProvider 类。这个应该在XML里定义。下面以XML示例来对AppWidgetProviderInfo中常用的类型进行说明。

示例XML:

示例说明:

minWidth 和minHeight

它们指定了App Widget布局需要的最小区域。缺省的App Widgets所在窗口的桌面位置基于有确定高度和宽度的单元网格中。如果App Widget的最小长度或宽度和这些网格单元的尺寸不匹配,那么这个App Widget将上舍入(上舍入即取比该值大的最接近的整数)到最接近的单元尺寸。

updatePeriodMillis

它定义了 widget 的更新频率。实际的更新时机不一定是精确的按照这个时间发生的。建议更新尽量不要太频繁,最好是低于1小时一次。 或者可以在配置 Activity 里面供用户对更新频率进行配置。 实际上,当updatePeriodMillis的值小于30分钟时,系统会自动将更新频率设为30分钟!

注意: 当更新时机到达时,如果设备正在休眠,那么设备将会被唤醒以执行更新。如果更新频率不超过1小时一次,那么对电池寿命应该不会造成多大的影响。 如果你需要比较频繁的更新,或者你不希望在设备休眠的时候执行更新,那么可以使用基于 alarm 的更新来替代 widget 自身的刷新机制。将 alarm 类型设置为 ELAPSED_REALTIME 或 RTC,将不会唤醒休眠的设备,同时请将 updatePeriodMillis 设为 0。

previewImage

指定预览图,该预览图在用户选择 widget 时出现,如果没有提供,则会显示应用的图标。该字段对应在 AndroidManifest.xml 中 receiver 的 android:previewImage 字段。由 Android 3.0 引入。

initialLayout

指定AppWidget加载的布局。

configure

可选属性,定义了 widget 的配置 Activity。如果定义了该项,那么当 widget 创建时,会自动启动该 Activity。

resizeMode

指定了 widget 的调整尺寸的规则。可取的值有: “horizontal”, “vertical”, “none”。”horizontal”意味着widget可以水平拉伸,“vertical”意味着widget可以竖值拉伸,“none”意味着widget不能拉伸;默认值是”none”。Android 3.1 引入。

widgetCategory

指定了 widget 能显示的地方:能否显示在 home Screen 或 lock screen 或 两者都可以。它的取值包括:”home_screen” 和 “keyguard”。Android 4.2 引入。

initialKeyguardLayout

指向 widget 位于 lockscreen 中的布局资源文件。Android 4.2 引入。

App Widget支持的布局和控件

Widget并不支持所有的布局和控件,而仅仅只是支持Android布局和控件的一个子集。

  • App Widget支持的布局:FrameLayout、LinearLayout、RelativeLayout、GridLayout
  • App Widget支持的控件:AnalogClock、Button、Chronometer、ImageButton、ImageView、ProgressBar、TextView、ViewFlipper、ListView、GridView、StackView、AdapterViewFlipper

参考链接 : skywang12345官方文档

最后修改日期: 2017年11月13日

作者

留言

撰写回覆或留言

发布留言必须填写的电子邮件地址不会公开。