net.rim.blackberry.api.messagelist
Class ApplicationIndicatorRegistry

java.lang.Object
  net.rim.blackberry.api.messagelist.ApplicationIndicatorRegistry

public class ApplicationIndicatorRegistry
extends Object

Application indicator registry. Provides registration operations for application indicators.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0

Method Summary
	ApplicationIndicator	getApplicationIndicator() Retrieves application indicator previously registered through register() method call.
	static ApplicationIndicatorRegistry	getInstance() Retrieves registry instance.
	ApplicationIndicator	register(ApplicationIcon icon, boolean iconOnly, boolean visible) Registers an application indicator with given icon.
	void	unregister() Unregisters indicator of the current application.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static ApplicationIndicatorRegistry getInstance()

Retrieves registry instance.

Returns:

registry instance

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0

register

public ApplicationIndicator register(ApplicationIcon icon,
                                     boolean iconOnly,
                                     boolean visible)
                              throws IllegalArgumentException,
                                     IllegalStateException

Registers an application indicator with given icon.

Parameters:

icon - an icon to be displayed in the indicators area

iconOnly - specifies if indicator should have icon representation only and no value

visible - specifies whether indicator has to be visible initially

Returns:

a registered indicator

Throws:

NullPointerException - if icon is null

IllegalArgumentException - if given icon size is very big

IllegalStateException - if no indicator manager is found

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0

unregister

public void unregister()

Unregisters indicator of the current application.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0

getApplicationIndicator

public ApplicationIndicator getApplicationIndicator()

Retrieves application indicator previously registered through register() method call. The indicator is associated with current application.

Returns:

instance of ApplicationIndicator if previously registered, null otherwise

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0