public class AppWidgetProviderInfo extends Object implements Parcelable
<appwidget-provider>
xml tag.Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>
Modifier and Type | Field and Description |
---|---|
int |
autoAdvanceViewId
The view id of the AppWidget subview which should be auto-advanced by the widget's host.
|
ComponentName |
configure
The activity to launch that will configure the AppWidget.
|
static Parcelable.Creator<AppWidgetProviderInfo> |
CREATOR
Parcelable.Creator that instantiates AppWidgetProviderInfo objects
|
int |
icon
The icon to display for this AppWidget in the AppWidget picker.
|
int |
initialKeyguardLayout
The resource id of the initial layout for this AppWidget when it is displayed on keyguard.
|
int |
initialLayout
The resource id of the initial layout for this AppWidget.
|
String |
label
Deprecated.
|
int |
minHeight
The default height of the widget when added to a host, in dp.
|
int |
minResizeHeight
Minimum height (in dp) which the widget can be resized to.
|
int |
minResizeWidth
Minimum width (in dp) which the widget can be resized to.
|
int |
minWidth
The default height of the widget when added to a host, in dp.
|
int |
previewImage
A preview of what the AppWidget will look like after it's configured.
|
ComponentName |
provider
Identity of this AppWidget component.
|
ActivityInfo |
providerInfo |
static int |
RESIZE_BOTH
Widget is resizable in both the horizontal and vertical axes.
|
static int |
RESIZE_HORIZONTAL
Widget is resizable in the horizontal axis only.
|
static int |
RESIZE_NONE
Widget is not resizable.
|
static int |
RESIZE_VERTICAL
Widget is resizable in the vertical axis only.
|
int |
resizeMode
The rules by which a widget can be resized.
|
int |
updatePeriodMillis
How often, in milliseconds, that this AppWidget wants to be updated.
|
static int |
WIDGET_CATEGORY_HOME_SCREEN
Indicates that the widget can be displayed on the home screen.
|
static int |
WIDGET_CATEGORY_KEYGUARD
Indicates that the widget can be displayed on the keyguard.
|
static int |
WIDGET_CATEGORY_SEARCHBOX
Indicates that the widget can be displayed within a space reserved for the search box.
|
int |
widgetCategory
Determines whether this widget can be displayed on the home screen, the keyguard, or both.
|
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_ELIDE_DUPLICATES, PARCELABLE_WRITE_RETURN_VALUE
Constructor and Description |
---|
AppWidgetProviderInfo() |
AppWidgetProviderInfo(Parcel in)
Unflatten the AppWidgetProviderInfo from a parcel.
|
Modifier and Type | Method and Description |
---|---|
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.
|
UserHandle |
getProfile()
Gets the user profile in which the provider resides.
|
Drawable |
loadIcon(Context context,
int density)
Loads the icon to display for this AppWidget in the AppWidget picker.
|
String |
loadLabel(PackageManager packageManager)
Loads the localized label to display to the user in the AppWidget picker.
|
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.
|
public static final int RESIZE_NONE
public static final int RESIZE_HORIZONTAL
public static final int RESIZE_VERTICAL
public static final int RESIZE_BOTH
public static final int WIDGET_CATEGORY_HOME_SCREEN
public static final int WIDGET_CATEGORY_KEYGUARD
public static final int WIDGET_CATEGORY_SEARCHBOX
public ComponentName provider
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.
public int minWidth
This field corresponds to the android:minWidth
attribute in
the AppWidget meta-data file.
public int minHeight
This field corresponds to the android:minHeight
attribute in
the AppWidget meta-data file.
public int minResizeWidth
resizeMode
).
This field corresponds to the android:minResizeWidth
attribute in
the AppWidget meta-data file.
public int minResizeHeight
resizeMode
).
This field corresponds to the android:minResizeHeight
attribute in
the AppWidget meta-data file.
public int updatePeriodMillis
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.
public int initialLayout
This field corresponds to the android:initialLayout
attribute in
the AppWidget meta-data file.
public int initialKeyguardLayout
widgetCategory
.
This field corresponds to the android:initialKeyguardLayout
attribute in
the AppWidget meta-data file.
public ComponentName configure
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.
@Deprecated public String label
loadLabel(android.content.pm.PackageManager)
.public int icon
This field corresponds to the android:icon
attribute in
the <receiver>
element in the AndroidManifest.xml file.
public int autoAdvanceViewId
This field corresponds to the android:autoAdvanceViewId
attribute in
the AppWidget meta-data file.
public int previewImage
This field corresponds to the android:previewImage
attribute in
the <receiver>
element in the AndroidManifest.xml file.
public int resizeMode
RESIZE_NONE
,
RESIZE_NONE
, RESIZE_HORIZONTAL
,
RESIZE_VERTICAL
, RESIZE_BOTH
.
This field corresponds to the android:resizeMode
attribute in
the AppWidget meta-data file.
public int widgetCategory
This field corresponds to the widgetCategory
attribute in
the AppWidget meta-data file.
public ActivityInfo providerInfo
public static final Parcelable.Creator<AppWidgetProviderInfo> CREATOR
public AppWidgetProviderInfo()
public AppWidgetProviderInfo(Parcel in)
public final String loadLabel(PackageManager packageManager)
packageManager
- Package manager instance for loading resources.public final Drawable loadIcon(Context context, int density)
DisplayMetrics.DENSITY_LOW
DisplayMetrics.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.
context
- Context for accessing resources.density
- The optional desired density as per
DisplayMetrics.densityDpi
.public final Drawable loadPreviewImage(Context context, int density)
DisplayMetrics.DENSITY_LOW
DisplayMetrics.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.
context
- Context for accessing resources.density
- The optional desired density as per
DisplayMetrics.densityDpi
.public final UserHandle getProfile()
public void writeToParcel(Parcel out, int flags)
Parcelable
writeToParcel
in interface Parcelable
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.PARCELABLE_WRITE_RETURN_VALUE
.public AppWidgetProviderInfo clone()
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.
public int describeContents()
Parcelable
Parcelable.writeToParcel(Parcel, int)
,
the return value of this method must include the
Parcelable.CONTENTS_FILE_DESCRIPTOR
bit.describeContents
in interface Parcelable
Parcelable.CONTENTS_FILE_DESCRIPTOR
public String toString()
Object
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())