|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.rim.device.api.system.ApplicationDescriptor
public final class ApplicationDescriptor
Encapsulates descriptive information for an application.
Application,
ApplicationManager| Field Summary | ||
|---|---|---|
static int |
DO_NOT_POWER_ON
If the device is off, DO NOT power on the device when this application is scheduled to be run. |
|
static byte |
FLAG_AUTO_RESTART
Automatically restart this application if it exits. |
|
static byte |
FLAG_RUN_ON_STARTUP
Run this application on device startup. |
|
static byte |
FLAG_SYSTEM
Do not present this application on the device's ribbon. |
|
static int |
POWER_ON
If the device is off, power on the device when this application is scheduled to be run. |
|
static int |
POWER_ON_ALWAYS
If the device is off, power on the device when this application is scheduled to be run, only if it's in a list of preregistered applications that are to power on. |
|
static int |
POWER_ON_FOR_AUTO_ON
If the device is off, power on the device when this application is scheduled to be run, only if it's in a list of preregistered applications that are to power on. |
|
| Constructor Summary | ||
|---|---|---|
ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args)
Constructs a new ApplicationDescriptor with the specified
name using another ApplicationDescriptor as a template. |
||
ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
int position,
String nameResourceBundle,
int nameResourceId)
Constructs a new ApplicationDescriptor instance with the
specified name and initial settings using another
ApplicationDescriptor as a template. |
||
ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
int position,
String nameResourceBundle,
int nameResourceId,
int flags)
Constructs a new ApplicationDescriptor instance with the
specified name and initial settings using another
ApplicationDescriptor as a template. |
||
ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
int position,
String nameResourceBundle,
int nameResourceId,
int flags,
String folderName)
Constructs a new ApplicationDescriptor instance with the
specified name and initial settings using another
ApplicationDescriptor as a template. |
||
ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
Bitmap icon,
int position,
String nameResourceBundle,
int nameResourceId)
Deprecated. The caching of icon Bitmap objects is no longer
supported. Use
ApplicationDescriptor.ApplicationDescriptor(ApplicationDescriptor,String,String[],int,String,int)
instead. |
||
ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
Bitmap icon,
int position,
String nameResourceBundle,
int nameResourceId,
int flags)
Deprecated. The caching of icon Bitmap objects is no longer
supported. Use
ApplicationDescriptor.ApplicationDescriptor(ApplicationDescriptor,String,String[],int,String,int,int)
instead. |
||
ApplicationDescriptor(ApplicationDescriptor original,
String[] args)
Constructs a new ApplicationDescriptor instance using
another ApplicationDescriptor as a template. |
||
| Method Summary | ||
|---|---|---|
static ApplicationDescriptor |
currentApplicationDescriptor()
Retrieves the descriptor for the application that started the current process. |
|
boolean |
equals(Object o)
Compares this descriptor to another object for equivalency. |
|
String[] |
getArgs()
Retrieves the argument array from this descriptor. |
|
StringProvider |
getDescription()
Retrieves the StringProvider object containing the
description of the application. |
|
EncodedImage |
getEncodedIcon()
Retrieves the icon from this descriptor. |
|
int |
getFlags()
Retrieves the flags from this descriptor. |
|
String |
getFolderName()
Returns the suggested folder name to place this application in. |
|
Bitmap |
getIcon()
Deprecated. Use ApplicationDescriptor.getEncodedIcon() instead. |
|
int |
getIndex()
Retrieves the application index from this descriptor. |
|
StringProvider |
getKeywords()
Retrieves the StringProvider object containing the
keywords for the application. |
|
String |
getKeywordsResourceBundle()
Retrieves the keywords resource bundle from this descriptor. |
|
int |
getKeywordsResourceId()
Retrieves the keywords resource ID from this descriptor. |
|
String |
getLocalizedName()
Retrieves the localized name of the application. |
|
int |
getModuleHandle()
Retrieves the handle for this descriptor's code module. |
|
String |
getModuleName()
Retrieves the name of this descriptor's code module. |
|
String |
getName()
Retrieves the application name from this descriptor. |
|
String |
getNameResourceBundle()
Retrieves the resource bundle from this descriptor. |
|
int |
getNameResourceId()
Retrieves the resource ID from this descriptor. |
|
int |
getPosition()
Returns the application's suggested position on the Home screen. |
|
int |
getPowerOnBehavior()
Retrieves the application's "power on" behavior. |
|
StringProvider |
getTitle()
Retrieves the StringProvider object containing the name of
the application. |
|
String |
getVersion()
Retrieves the version from this descriptor. |
|
void |
setPowerOnBehavior(int behavior)
Sets the application's "power on" behavior. |
|
| Methods inherited from class java.lang.Object |
|---|
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int DO_NOT_POWER_ON
public static final int POWER_ON
public static final int POWER_ON_FOR_AUTO_ON
public static final int POWER_ON_ALWAYS
public static final byte FLAG_RUN_ON_STARTUP
public static final byte FLAG_SYSTEM
Applications that should hide from the ribbon because they're not really meant for user interaction can use this flag.
public static final byte FLAG_AUTO_RESTART
| Constructor Detail |
|---|
public ApplicationDescriptor(ApplicationDescriptor original,
String[] args)
ApplicationDescriptor instance using
another ApplicationDescriptor as a template.
This method builds a new application descriptor but does not provide it with a name.
original - The application descriptor from which to build this
new one.args - The initial arguments for this new descriptor.
public ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args)
ApplicationDescriptor with the specified
name using another ApplicationDescriptor as a template.
original - The application descriptor from which to build this
new one.name - The name for this new descriptor.args - The initial arguments for this new descriptor.
public ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
Bitmap icon,
int position,
String nameResourceBundle,
int nameResourceId)
Bitmap objects is no longer
supported. Use
ApplicationDescriptor.ApplicationDescriptor(ApplicationDescriptor,String,String[],int,String,int)
instead.
ApplicationDescriptor instance with the
specified name and initial settings using another
ApplicationDescriptor as a template.
original - The application descriptor from which to build this
new one.name - The name for this new descriptor.args - The initial arguments for this new descriptor.icon - The display icon for this new descriptor.position - The Home screen position for this new descriptor's icon.nameResourceBundle - The resource bundle containing a localized
version of this descriptor's name.nameResourceId - The resource ID containing a localized version of
this descriptor's name.
public ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
Bitmap icon,
int position,
String nameResourceBundle,
int nameResourceId,
int flags)
Bitmap objects is no longer
supported. Use
ApplicationDescriptor.ApplicationDescriptor(ApplicationDescriptor,String,String[],int,String,int,int)
instead.
ApplicationDescriptor instance with the
specified name and initial settings using another
ApplicationDescriptor as a template.
original - The application descriptor from which to build this
new one.name - The name for this new descriptor.args - The initial arguments for this new descriptor.icon - The display icon for this new descriptor.position - The Home screen position for this new descriptor's icon.nameResourceBundle - The resource bundle containing a localized
version of this descriptor's name.nameResourceId - The resource ID containing a localized version of
this descriptor's name.flags - The application flags for this new descriptor.
public ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
int position,
String nameResourceBundle,
int nameResourceId)
ApplicationDescriptor instance with the
specified name and initial settings using another
ApplicationDescriptor as a template.
original - The application descriptor from which to build this
new one.name - The name for this new descriptor.args - The initial arguments for this new descriptor.position - The Home screen position for this new descriptor's icon.nameResourceBundle - The resource bundle containing a localized
version of this descriptor's name.nameResourceId - The resource ID containing a localized version of
this descriptor's name.
public ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
int position,
String nameResourceBundle,
int nameResourceId,
int flags)
ApplicationDescriptor instance with the
specified name and initial settings using another
ApplicationDescriptor as a template.
original - The application descriptor from which to build this
new one.name - The name for this new descriptor.args - The initial arguments for this new descriptor.position - The Home screen position for this new descriptor's icon.nameResourceBundle - The resource bundle containing a localized
version of this descriptor's name.nameResourceId - The resource ID containing a localized version of
this descriptor's name.flags - The application flags for this new descriptor.
public ApplicationDescriptor(ApplicationDescriptor original,
String name,
String[] args,
int position,
String nameResourceBundle,
int nameResourceId,
int flags,
String folderName)
ApplicationDescriptor instance with the
specified name and initial settings using another
ApplicationDescriptor as a template.
original - The application descriptor from which to build this
new one.name - The name for this new descriptor.args - The initial arguments for this new descriptor.position - The Home screen position for this new descriptor's icon.nameResourceBundle - The resource bundle containing a localized
version of this descriptor's name.nameResourceId - The resource ID containing a localized version of
this descriptor's name.flags - The application flags for this new descriptor.folderName - The suggested folder location for this new descriptor's
icon.| Method Detail |
|---|
public int getModuleHandle()
public String getModuleName()
public String getName()
public int getIndex()
Each application in a code module has a unique index.
public String getNameResourceBundle()
null if no localized version exists.public int getNameResourceId()
public String getKeywordsResourceBundle()
null if no localized version exists.public int getKeywordsResourceId()
public String[] getArgs()
public String getLocalizedName()
If the user has not set a valid title resource for the application, this method returns the default name.
public StringProvider getDescription()
StringProvider object containing the
description of the application.
StringProvider object containing the description
of the application.public StringProvider getTitle()
StringProvider object containing the name of
the application.
StringProvider object containing the name of the
application.public StringProvider getKeywords()
StringProvider object containing the
keywords for the application.
StringProvider object containing the keywords
for the application.public String getVersion()
public int getFlags()
public Bitmap getIcon()
ApplicationDescriptor.getEncodedIcon() instead.
Bitmap, or null if
there is no application icon.public EncodedImage getEncodedIcon()
EncodedImage, or
null if there is no application icon.public int getPosition()
Applications with identical positions are placed on a first-come, first-serve basis. A lower position value means that the application is placed closer to the start of the Home screen, which is normally the top-left.
public String getFolderName()
null if there is no suggested folder name.public boolean equals(Object o)
The specified object is considered equivalent to this descriptor if the specified object is an application descriptor, has the same module handle, and has the same list of arguments.
equals in class Objecto - The object to compare to this descriptor.
true if the specified object is equivalent to this
descriptor, false otherwise.Boolean.hashCode(),
Hashtablepublic static ApplicationDescriptor currentApplicationDescriptor()
public void setPowerOnBehavior(int behavior)
ApplicationDescriptor.DO_NOT_POWER_ON.
behavior - The application's new "power on" behavior
(one of the POWER_ON behavior flags).ApplicationDescriptor.DO_NOT_POWER_ON,
ApplicationDescriptor.POWER_ON,
ApplicationDescriptor.POWER_ON_FOR_AUTO_ON,
ApplicationDescriptor.POWER_ON_ALWAYSpublic int getPowerOnBehavior()
POWER_ON behavior flags).ApplicationDescriptor.DO_NOT_POWER_ON,
ApplicationDescriptor.POWER_ON,
ApplicationDescriptor.POWER_ON_FOR_AUTO_ON,
ApplicationDescriptor.POWER_ON_ALWAYS
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal