public class AppWidgetProviderInfo
extends Object
implements Parcelable
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_SEARCHBOX Indicates that the widget can be displayed within a space reserved for the search box. |
Inherited constants |
---|
![]() android.os.Parcelable
|
Fields |
|
---|---|
public static final Creator<AppWidgetProviderInfo> |
CREATOR Parcelable.Creator that instantiates AppWidgetProviderInfo objects |
public int |
autoAdvanceViewId The view id of the AppWidget subview which should be auto-advanced by the widget's host. |
public ComponentName |
configure The activity to launch that will configure the AppWidget. |
public int |
icon The icon to display for this AppWidget in the AppWidget picker. |
public int |
initialKeyguardLayout The resource id of the initial layout for this AppWidget when it is displayed on keyguard. |
public int |
initialLayout The resource id of the initial layout for this AppWidget. |
public String |
label This field was deprecated in API level 21. Use |
public int |
minHeight The default height of the widget when added to a host, in dp. |
public int |
minResizeHeight Minimum height (in dp) which the widget can be resized to. |
public int |
minResizeWidth Minimum width (in dp) which the widget can be resized to. |
public int |
minWidth The default height of the widget when added to a host, in dp. |
public int |
previewImage A preview of what the AppWidget will look like after it's configured. |
public ComponentName |
provider Identity of this AppWidget component. |
public int |
resizeMode The rules by which a widget can be resized. |
public int |
updatePeriodMillis How often, in milliseconds, that this AppWidget wants to be updated. |
public int |
widgetCategory Determines whether this widget can be displayed on the home screen, the keyguard, or both. |
Public constructors |
|
---|---|
AppWidgetProviderInfo() |
|
AppWidgetProviderInfo(Parcel in) Unflatten the AppWidgetProviderInfo from a parcel. |
Public methods |
|
---|---|
AppWidgetProviderInfo |
clone() Creates and returns a copy of this object. |
int |
describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
final UserHandle |
getProfile() Gets the user profile in which the provider resides. |
final Drawable |
loadIcon(Context context, int density) Loads the icon to display for this AppWidget in the AppWidget picker. |
final String |
loadLabel(PackageManager packageManager) Loads the localized label to display to the user in the AppWidget picker. |
final Drawable |
loadPreviewImage(Context context, int density) Loads a preview of what the AppWidget will look like after it's configured. |
String |
toString() Returns a string representation of the object. |
void |
writeToParcel(Parcel out, int flags) Flatten this object in to a Parcel. |
Inherited methods |
|
---|---|
![]() java.lang.Object
|
|
![]() android.os.Parcelable
|
int RESIZE_BOTH
Widget is resizable in both the horizontal and vertical axes.
Constant Value: 3 (0x00000003)
int RESIZE_HORIZONTAL
Widget is resizable in the horizontal axis only.
Constant Value: 1 (0x00000001)
int RESIZE_NONE
Widget is not resizable.
Constant Value: 0 (0x00000000)
int RESIZE_VERTICAL
Widget is resizable in the vertical axis only.
Constant Value: 2 (0x00000002)
int WIDGET_CATEGORY_HOME_SCREEN
Indicates that the widget can be displayed on the home screen. This is the default value.
Constant Value: 1 (0x00000001)
int WIDGET_CATEGORY_KEYGUARD
Indicates that the widget can be displayed on the keyguard.
Constant Value: 2 (0x00000002)
int WIDGET_CATEGORY_SEARCHBOX
Indicates that the widget can be displayed within a space reserved for the search box.
Constant Value: 4 (0x00000004)
Creator<AppWidgetProviderInfo> CREATOR
Parcelable.Creator that instantiates AppWidgetProviderInfo objects
int autoAdvanceViewId
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.
ComponentName configure
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.
int icon
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.
int initialKeyguardLayout
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.
int initialLayout
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.
String label
This field was deprecated in API level 21.
Use loadLabel(android.content.pm.PackageManager)
.
The label to display to the user in the AppWidget picker.
int minHeight
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.
int minResizeHeight
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.
int minResizeWidth
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.
int minWidth
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.
int previewImage
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.
ComponentName provider
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.
int resizeMode
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.
int updatePeriodMillis
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.
int widgetCategory
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.
AppWidgetProviderInfo (Parcel in)
Unflatten the AppWidgetProviderInfo from a parcel.
Parameters | |
---|---|
in |
Parcel
|
AppWidgetProviderInfo clone ()
Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x
, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true
, but these are not absolute requirements. While it is typically the case that:
will bex.clone().equals(x)
true
, this is not an absolute requirement.
By convention, the returned object should be obtained by calling super.clone
. If a class and all of its superclasses (except Object
) obey this convention, it will be the case that x.clone().getClass() == x.getClass()
.
By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone
before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone
need to be modified.
The method clone
for class Object
performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable
, then a CloneNotSupportedException
is thrown. Note that all arrays are considered to implement the interface Cloneable
and that the return type of the clone
method of an array type T[]
is T[]
where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object
does not itself implement the interface Cloneable
, so calling the clone
method on an object whose class is Object
will result in throwing an exception at run time.
Returns | |
---|---|
AppWidgetProviderInfo |
a clone of this instance. |
int describeContents ()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int)
, the return value of this method must include the CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
UserHandle getProfile ()
Gets the user profile in which the provider resides.
Returns | |
---|---|
UserHandle |
The hosting user profile. |
Drawable loadIcon (Context context, int density)
Loads the icon to display for this AppWidget in the AppWidget picker. If not supplied in the xml, the application icon will be used. A client can optionally provide a desired density such as DENSITY_LOW
DENSITY_MEDIUM
, etc. If no density is provided, the density of the current display will be used.
The loaded icon corresponds to the android:icon
attribute in the <receiver>
element in the AndroidManifest.xml file.
Parameters | |
---|---|
context |
Context : Context for accessing resources. |
density |
int : The optional desired density as per densityDpi . |
Returns | |
---|---|
Drawable |
The provider icon. |
String loadLabel (PackageManager packageManager)
Loads the localized label to display to the user in the AppWidget picker.
Parameters | |
---|---|
packageManager |
PackageManager : Package manager instance for loading resources. |
Returns | |
---|---|
String |
The label for the current locale. |
Drawable loadPreviewImage (Context context, int density)
Loads a preview of what the AppWidget will look like after it's configured. A client can optionally provide a desired density such as DENSITY_LOW
DENSITY_MEDIUM
, etc. If no density is provided, the density of the current display will be used.
The loaded image corresponds to the android:previewImage
attribute in the <receiver>
element in the AndroidManifest.xml file.
Parameters | |
---|---|
context |
Context : Context for accessing resources. |
density |
int : The optional desired density as per densityDpi . |
Returns | |
---|---|
Drawable |
The widget preview image or null if preview image is not available. |
String toString ()
Returns a string representation of the object. In general, the toString
method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@
', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |
void writeToParcel (Parcel out, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
out |
Parcel : The Parcel in which the object should be written. |
flags |
int : Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE . |