java.lang.Object | |
↳ | android.appwidget.AppWidgetProviderInfo |
Describes the meta data for an installed AppWidget provider. The fields in this class
correspond to the fields in the <appwidget-provider>
xml tag.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | RESIZE_BOTH | Widget is resizable in both the horizontal and vertical axes. | |||||||||
int | RESIZE_HORIZONTAL | Widget is resizable in the horizontal axis only. | |||||||||
int | RESIZE_NONE | Widget is not resizable. | |||||||||
int | RESIZE_VERTICAL | Widget is resizable in the vertical axis only. | |||||||||
int | WIDGET_CATEGORY_HOME_SCREEN | Indicates that the widget can be displayed on the home screen. | |||||||||
int | WIDGET_CATEGORY_KEYGUARD | Indicates that the widget can be displayed on the keyguard. | |||||||||
int | WIDGET_CATEGORY_RECENTS | Indicates that the widget can be displayed within recents. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CREATOR | Parcelable.Creator that instantiates AppWidgetProviderInfo objects | ||||||||||
autoAdvanceViewId | The view id of the AppWidget subview which should be auto-advanced by the widget's host. | ||||||||||
configure | The activity to launch that will configure the AppWidget. | ||||||||||
icon | The icon to display for this AppWidget in the AppWidget picker. | ||||||||||
initialKeyguardLayout | The resource id of the initial layout for this AppWidget when it is displayed on keyguard. | ||||||||||
initialLayout | The resource id of the initial layout for this AppWidget. | ||||||||||
label | The label to display to the user in the AppWidget picker. | ||||||||||
minHeight | The default height of the widget when added to a host, in dp. | ||||||||||
minResizeHeight | Minimum height (in dp) which the widget can be resized to. | ||||||||||
minResizeWidth | Minimum width (in dp) which the widget can be resized to. | ||||||||||
minWidth | The default height of the widget when added to a host, in dp. | ||||||||||
previewImage | A preview of what the AppWidget will look like after it's configured. | ||||||||||
provider | Identity of this AppWidget component. | ||||||||||
resizeMode | The rules by which a widget can be resized. | ||||||||||
updatePeriodMillis | How often, in milliseconds, that this AppWidget wants to be updated. | ||||||||||
widgetCategory | Determines whether this widget can be displayed on the home screen, the keyguard, or both. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Unflatten the AppWidgetProviderInfo from a parcel.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates and returns a copy of this
Object . | |||||||||||
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
| |||||||||||
Returns a string containing a concise, human-readable description of this
object.
| |||||||||||
Flatten this object in to a Parcel.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
android.os.Parcelable
|
Widget is resizable in both the horizontal and vertical axes.
Widget is resizable in the horizontal axis only.
Widget is not resizable.
Widget is resizable in the vertical axis only.
Indicates that the widget can be displayed on the home screen. This is the default value.
Indicates that the widget can be displayed on the keyguard.
Indicates that the widget can be displayed within recents.
Parcelable.Creator that instantiates AppWidgetProviderInfo objects
The view id of the AppWidget subview which should be auto-advanced by the widget's host.
This field corresponds to the android:autoAdvanceViewId
attribute in
the AppWidget meta-data file.
The activity to launch that will configure the AppWidget.
This class name of field corresponds to the android:configure
attribute in
the AppWidget meta-data file. The package name always corresponds to the package containing
the AppWidget provider.
The icon to display for this AppWidget in the AppWidget picker. If not supplied in the xml, the application icon will be used.
This field corresponds to the android:icon
attribute in
the <receiver>
element in the AndroidManifest.xml file.
The resource id of the initial layout for this AppWidget when it is displayed on keyguard.
This parameter only needs to be provided if the widget can be displayed on the keyguard,
see widgetCategory
.
This field corresponds to the android:initialKeyguardLayout
attribute in
the AppWidget meta-data file.
The resource id of the initial layout for this AppWidget. This should be displayed until the RemoteViews for the AppWidget is available.
This field corresponds to the android:initialLayout
attribute in
the AppWidget meta-data file.
The label to display to the user in the AppWidget picker. If not supplied in the xml, the application label will be used.
This field corresponds to the android:label
attribute in
the <receiver>
element in the AndroidManifest.xml file.
The default height of the widget when added to a host, in dp. The widget will get at least this height, and will often be given more, depending on the host.
This field corresponds to the android:minHeight
attribute in
the AppWidget meta-data file.
Minimum height (in dp) which the widget can be resized to. This field has no effect if it
is greater than minHeight or if vertical resizing isn't enabled (see resizeMode
).
This field corresponds to the android:minResizeHeight
attribute in
the AppWidget meta-data file.
Minimum width (in dp) which the widget can be resized to. This field has no effect if it
is greater than minWidth or if horizontal resizing isn't enabled (see resizeMode
).
This field corresponds to the android:minResizeWidth
attribute in
the AppWidget meta-data file.
The default height of the widget when added to a host, in dp. The widget will get at least this width, and will often be given more, depending on the host.
This field corresponds to the android:minWidth
attribute in
the AppWidget meta-data file.
A preview of what the AppWidget will look like after it's configured. If not supplied, the AppWidget's icon will be used.
This field corresponds to the android:previewImage
attribute in
the <receiver>
element in the AndroidManifest.xml file.
Identity of this AppWidget component. This component should be a BroadcastReceiver
, and it will be sent the AppWidget intents
as described in the AppWidget package documentation
.
This field corresponds to the android:name
attribute in
the <receiver>
element in the AndroidManifest.xml file.
The rules by which a widget can be resized. See RESIZE_NONE
,
RESIZE_NONE
, RESIZE_HORIZONTAL
,
RESIZE_VERTICAL
, RESIZE_BOTH
.
This field corresponds to the android:resizeMode
attribute in
the AppWidget meta-data file.
How often, in milliseconds, that this AppWidget wants to be updated. The AppWidget manager may place a limit on how often a AppWidget is updated.
This field corresponds to the android:updatePeriodMillis
attribute in
the AppWidget meta-data file.
Note: Updates requested with updatePeriodMillis
will not be delivered more than once every 30 minutes.
Determines whether this widget can be displayed on the home screen, the keyguard, or both. A widget which is displayed on both needs to ensure that it follows the design guidelines for both widget classes. This can be achieved by querying the AppWidget options in its widget provider's update method.
This field corresponds to the widgetCategory
attribute in
the AppWidget meta-data file.
Unflatten the AppWidgetProviderInfo from a parcel.
Creates and returns a copy of this Object
. The default
implementation returns a so-called "shallow" copy: It creates a new
instance of the same class and then copies the field values (including
object references) from this instance to the new instance. A "deep" copy,
in contrast, would also recursively clone nested objects. A subclass that
needs to implement this kind of cloning should call super.clone()
to create the new instance and then create deep copies of the nested,
mutable objects.
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())
See Writing a useful
toString
method
if you intend implementing your own toString
method.
Flatten this object in to a Parcel.
out | The Parcel in which the object should be written. |
---|---|
flags | Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE .
|