SHOW Signed
 

net.rim.blackberry.api.messagelist
Class ApplicationIcon

java.lang.Object
  |
  +--net.rim.blackberry.api.messagelist.ApplicationIcon

public class ApplicationIcon
extends Object

Application icon class is used in conjunction with application indicator and application messages. It incapsulates image and its painting properties.

Application icon can be scaled to better fit the target area. However, if no scaling enabled and the source image is bigger than the painting area then the icon will be truncated.

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

Constructor Summary
 Category: Signed ApplicationIcon(EncodedImage icon)
          Creates an application icon based on the encoded image.
 Category: Signed ApplicationIcon(EncodedImage icon, boolean scalingEnabled)
          Creates an application icon based on the encoded image and scaling attribute.
 
Method Summary
 Category: Signed  boolean isScalingEnabled()
          Returns if icon can be scaled
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ApplicationIcon

public ApplicationIcon(EncodedImage icon)
Creates an application icon based on the encoded image. All properties are set to default. By default application icon will be scaled to better fit the target area.
Parameters:
icon - image to use as icon
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.

ApplicationIcon

public ApplicationIcon(EncodedImage icon,
                       boolean scalingEnabled)
Creates an application icon based on the encoded image and scaling attribute.
Parameters:
icon - image to use as icon
scalingEnabled - specifies if the icon image can be scaled to better fit the target area
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.
Method Detail

isScalingEnabled

public boolean isScalingEnabled()
Returns if icon can be scaled
Returns:
true if icon can be scaled false 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.



Copyright 1999-2008 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.