Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

PackageItemInfo

extends Object
java.lang.Object
   ↳ android.content.pm.PackageItemInfo
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Base class containing information common to all package items held by the package manager. This provides a very common basic set of attributes: a label, icon, and meta-data. This class is not intended to be used by itself; it is simply here to share common definitions between all items returned by the package manager. As such, it does not itself implement Parcelable, but does provide convenience methods to assist in the implementation of Parcelable in subclasses.

Summary

Nested Classes
class PackageItemInfo.DisplayNameComparator  
Fields
public int banner A drawable resource identifier (in the package's resources) of this component's banner.
public int icon A drawable resource identifier (in the package's resources) of this component's icon.
public int labelRes A string resource identifier (in the package's resources) of this component's label.
public int logo A drawable resource identifier (in the package's resources) of this component's logo.
public Bundle metaData Additional meta-data associated with this component.
public String name Public name of this item.
public CharSequence nonLocalizedLabel The string provided in the AndroidManifest file, if any.
public String packageName Name of the package that this item is in.
Public Constructors
PackageItemInfo ()
PackageItemInfo ( PackageItemInfo orig)
Protected Constructors
PackageItemInfo ( Parcel source)
Public Methods
Drawable loadBanner ( PackageManager pm)
Retrieve the current graphical banner associated with this item.
Drawable loadIcon ( PackageManager pm)
Retrieve the current graphical icon associated with this item.
CharSequence loadLabel ( PackageManager pm)
Retrieve the current textual label associated with this item.
Drawable loadLogo ( PackageManager pm)
Retrieve the current graphical logo associated with this item.
XmlResourceParser loadXmlMetaData ( PackageManager pm, String name)
Load an XML resource attached to the meta-data of this item.
void writeToParcel ( Parcel dest, int parcelableFlags)
Protected Methods
void dumpBack ( Printer pw, String prefix)
void dumpFront ( Printer pw, String prefix)
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public int banner

Added in API level 20

A drawable resource identifier (in the package's resources) of this component's banner. From the "banner" attribute or, if not set, 0.

public int icon

Added in API level 1

A drawable resource identifier (in the package's resources) of this component's icon. From the "icon" attribute or, if not set, 0.

public int labelRes

Added in API level 1

A string resource identifier (in the package's resources) of this component's label. From the "label" attribute or, if not set, 0.

public int logo

Added in API level 9

A drawable resource identifier (in the package's resources) of this component's logo. Logos may be larger/wider than icons and are displayed by certain UI elements in place of a name or name/icon combination. From the "logo" attribute or, if not set, 0.

public Bundle metaData

Added in API level 1

Additional meta-data associated with this component. This field will only be filled in if you set the GET_META_DATA flag when requesting the info.

public String name

Added in API level 1

Public name of this item. From the "android:name" attribute.

public CharSequence nonLocalizedLabel

Added in API level 1

The string provided in the AndroidManifest file, if any. You probably don't want to use this. You probably want getApplicationLabel(ApplicationInfo)

public String packageName

Added in API level 1

Name of the package that this item is in.

Public Constructors

public PackageItemInfo ()

Added in API level 1

public PackageItemInfo ( PackageItemInfo orig)

Added in API level 1

Protected Constructors

protected PackageItemInfo ( Parcel source)

Added in API level 1

Public Methods

public Drawable loadBanner ( PackageManager pm)

Retrieve the current graphical banner associated with this item. This will call back on the given PackageManager to load the banner from the application.

Parameters
pm A PackageManager from which the banner can be loaded; usually the PackageManager from which you originally retrieved this item.
Returns
  • Returns a Drawable containing the item's banner. If the item does not have a banner, this method will return null.

public Drawable loadIcon ( PackageManager pm)

Added in API level 1

Retrieve the current graphical icon associated with this item. This will call back on the given PackageManager to load the icon from the application.

Parameters
pm A PackageManager from which the icon can be loaded; usually the PackageManager from which you originally retrieved this item.
Returns
  • Returns a Drawable containing the item's icon. If the item does not have an icon, the item's default icon is returned such as the default activity icon.

public CharSequence loadLabel ( PackageManager pm)

Added in API level 1

Retrieve the current textual label associated with this item. This will call back on the given PackageManager to load the label from the application.

Parameters
pm A PackageManager from which the label can be loaded; usually the PackageManager from which you originally retrieved this item.
Returns
  • Returns a CharSequence containing the item's label. If the item does not have a label, its name is returned.

public Drawable loadLogo ( PackageManager pm)

Added in API level 9

Retrieve the current graphical logo associated with this item. This will call back on the given PackageManager to load the logo from the application.

Parameters
pm A PackageManager from which the logo can be loaded; usually the PackageManager from which you originally retrieved this item.
Returns
  • Returns a Drawable containing the item's logo. If the item does not have a logo, this method will return null.

public XmlResourceParser loadXmlMetaData ( PackageManager pm, String name)

Added in API level 1

Load an XML resource attached to the meta-data of this item. This will retrieved the name meta-data entry, and if defined call back on the given PackageManager to load its XML file from the application.

Parameters
pm A PackageManager from which the XML can be loaded; usually the PackageManager from which you originally retrieved this item.
name Name of the meta-date you would like to load.
Returns
  • Returns an XmlPullParser you can use to parse the XML file assigned as the given meta-data. If the meta-data name is not defined or the XML resource could not be found, null is returned.

public void writeToParcel ( Parcel dest, int parcelableFlags)

Added in API level 1

Protected Methods

protected void dumpBack ( Printer pw, String prefix)

Added in API level 1

protected void dumpFront ( Printer pw, String prefix)

Added in API level 1