SHOW Signed
 

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:
JDE 4.6.0

Method Summary
 Category: Signed  ApplicationIndicator getApplicationIndicator()
          Retrieves application indicator previously registered through register() method call.
 Category: Signed static ApplicationIndicatorRegistry getInstance()
          Retrieves registry instance.
 Category: Signed  ApplicationIndicator register(ApplicationIcon icon, boolean iconOnly, boolean visible)
          Registers an application indicator with given icon.
 Category: Signed  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

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
Since:
JDE 4.6.0
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.

getInstance

public static ApplicationIndicatorRegistry getInstance()
Retrieves registry instance.
Returns:
registry instance
Since:
JDE 4.6.0
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.

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:
IllegalArgumentException - if given icon size is very big
IllegalStateException - if no indicator manager is found
Since:
JDE 4.6.0
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.

unregister

public void unregister()
Unregisters indicator of the current application.
Since:
JDE 4.6.0
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.



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.