net.rim.device.api.system
Class Branding

java.lang.Object
  extended by net.rim.device.api.system.Branding

public final class Branding
extends Object

Provides access to various branding information. Use this class to view branding data loaded onto a BlackBerry device. Branding data is contained in a branding file. Typically there is a branding file for each carrier.

Since:
BlackBerry API 4.0.0

Field Summary
static int FIELD_BITMAP_1_DATA
          A filename for the splash screen bitmap.
static int FIELD_BITMAP_1_TIMEOUT
          The number of milliseconds to show BITMAP_1 for.
static int FIELD_BITMAP_2_DATA
          A filename for the BB Vertical theme background bitmap.
static int FIELD_BRANDING_BROWSER_ICON_0
          An additional .png file.
static int FIELD_BRANDING_BROWSER_ICON_1
          An additional .png file.
static int FIELD_BRANDING_BROWSER_ICON_2
          An additional .png file.
static int FIELD_BRANDING_BROWSER_ICON_3
          An additional .png file.
static int FIELD_BRANDING_BROWSER_ICON_4
          An additional .png file.
static int FIELD_BRANDING_BROWSER_ICON_5
          An additional .png file.
static int FIELD_BRANDING_BROWSER_ICON_6
          An additional .png file.
static int FIELD_BRANDING_BROWSER_ICON_7
          An additional .png file.
static int FIELD_BRANDING_BROWSER_ICON_8
          An additional .png file.
static int FIELD_BRANDING_BROWSER_ICON_9
          An additional .png file.
static int FIELD_BRANDING_IGNORE_INTEL_SPLASH
           
static int FIELD_BRANDING_TUNE
          A midi file to use as a default ring tone.
static int FIELD_BRANDING_TUNE_CONTENT_DATA
           
static int FIELD_BRANDING_TUNE_CONTENT_TYPE
          The content type of the Branding tune data.
static int FIELD_BRANDING_TUNE_MIDI
          A copy of the midi file to use as a default ring tone.
static int FIELD_BRANDING_TUNE_NAME
          The name of the default ring tone.
static int FIELD_BRANDING_WAP_ICON
          A .png file used by the WAP Browser on the Home screen.
static int FIELD_BRANDING_WAP_SPLASH
          A filename for the WAP splash screen bitmap.
static int FIELD_DEVICE_MESSAGE_BODY
          Text for the Licensee Device Message 'Body' field.
static int FIELD_DEVICE_MESSAGE_FROM
          Text for the Licensee Device Message 'From' field.
static int FIELD_DEVICE_MESSAGE_SUBJECT
          Text for the Licensee Device Message 'Subject' field.
static int FIELD_ESCREEN_HELP_MSG
           
static int FIELD_HELP_WMLC
           
static int FIELD_IDLESCREEN_CONTENT_DATA
          Deprecated.  
static int FIELD_IDLESCREEN_CONTENT_TYPE
          Deprecated.  
static int FIELD_TOP_TIPS_MESSAGE_BODY
          Text for the Licensee Tips Message 'Body' field.
static int FIELD_TOP_TIPS_MESSAGE_FROM
          Text for the Licensee Tips Message 'From' field.
static int FIELD_TOP_TIPS_MESSAGE_SUBJECT
          Text for the Licensee Tips Message 'Subject' field.
static int FIELD_WELCOME_MESSAGE_BODY
          Text for the welcome message 'Body' field.
static int FIELD_WELCOME_MESSAGE_BODY_ISO8859
          Text for the welcome message 'Body' field.
static int FIELD_WELCOME_MESSAGE_FROM
          Text for the welcome message 'From' field.
static int FIELD_WELCOME_MESSAGE_FROM_ISO8859
          Text for the welcome message 'From' field.
static int FIELD_WELCOME_MESSAGE_SUBJECT
          Text for the welcome message 'Subject' field.
static int FIELD_WELCOME_MESSAGE_SUBJECT_ISO8859
          Text for the welcome message 'Subject' field.
 
Method Summary
static byte[] getData(int field)
          Retrieves data from the branding NV sector.
static boolean getFlag(int flag)
          Returns the boolean value of the specified flag.
static boolean getFlag(int field, int flag)
          Returns the boolean value of the specified flag.
static int getVendorId()
          Retrieves the vendor ID from the branding NV sector.
static int getVersion()
          Retrieves the version number of the branding data.
static boolean isDataSigned()
          Determines if the branding NV data is signed by RIM.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

FIELD_BITMAP_1_DATA

public static final int FIELD_BITMAP_1_DATA
A filename for the splash screen bitmap. The bitmap must be in PNG format.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BITMAP_1_TIMEOUT

public static final int FIELD_BITMAP_1_TIMEOUT
The number of milliseconds to show BITMAP_1 for.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BITMAP_2_DATA

public static final int FIELD_BITMAP_2_DATA
A filename for the BB Vertical theme background bitmap. The bitmap must be in PNG format.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.2

FIELD_WELCOME_MESSAGE_SUBJECT_ISO8859

public static final int FIELD_WELCOME_MESSAGE_SUBJECT_ISO8859
Text for the welcome message 'Subject' field. No longer used; see FIELD_WELCOME_MESSAGE_SUBJECT.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_WELCOME_MESSAGE_BODY_ISO8859

public static final int FIELD_WELCOME_MESSAGE_BODY_ISO8859
Text for the welcome message 'Body' field. No longer used; see FIELD_WELCOME_MESSAGE_BODY.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_WELCOME_MESSAGE_FROM_ISO8859

public static final int FIELD_WELCOME_MESSAGE_FROM_ISO8859
Text for the welcome message 'From' field. No longer used; see FIELD_WELCOME_MESSAGE_FROM.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_WELCOME_MESSAGE_SUBJECT

public static final int FIELD_WELCOME_MESSAGE_SUBJECT
Text for the welcome message 'Subject' field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_WELCOME_MESSAGE_BODY

public static final int FIELD_WELCOME_MESSAGE_BODY
Text for the welcome message 'Body' field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_WELCOME_MESSAGE_FROM

public static final int FIELD_WELCOME_MESSAGE_FROM
Text for the welcome message 'From' field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_DEVICE_MESSAGE_SUBJECT

public static final int FIELD_DEVICE_MESSAGE_SUBJECT
Text for the Licensee Device Message 'Subject' field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_DEVICE_MESSAGE_BODY

public static final int FIELD_DEVICE_MESSAGE_BODY
Text for the Licensee Device Message 'Body' field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_DEVICE_MESSAGE_FROM

public static final int FIELD_DEVICE_MESSAGE_FROM
Text for the Licensee Device Message 'From' field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_TOP_TIPS_MESSAGE_SUBJECT

public static final int FIELD_TOP_TIPS_MESSAGE_SUBJECT
Text for the Licensee Tips Message 'Subject' field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_TOP_TIPS_MESSAGE_BODY

public static final int FIELD_TOP_TIPS_MESSAGE_BODY
Text for the Licensee Tips Message 'Body' field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_TOP_TIPS_MESSAGE_FROM

public static final int FIELD_TOP_TIPS_MESSAGE_FROM
Text for the Licensee Tips Message 'From' field.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_ESCREEN_HELP_MSG

public static final int FIELD_ESCREEN_HELP_MSG
See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_WAP_ICON

public static final int FIELD_BRANDING_WAP_ICON
A .png file used by the WAP Browser on the Home screen.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_TUNE

public static final int FIELD_BRANDING_TUNE
A midi file to use as a default ring tone. The midi content will be transcoded into RIM tone/duration note values.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_TUNE_NAME

public static final int FIELD_BRANDING_TUNE_NAME
The name of the default ring tone.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_TUNE_MIDI

public static final int FIELD_BRANDING_TUNE_MIDI
A copy of the midi file to use as a default ring tone. The midi content is not yet transcoded. This tag is generated automatically.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_WAP_SPLASH

public static final int FIELD_BRANDING_WAP_SPLASH
A filename for the WAP splash screen bitmap. Use this if the screen is to be different than the BITMAP_1_DATA file. If this field is contained in the data; the BITMAP_1_DATA field will be used instead. The bitmap must be in PNG format.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_TUNE_CONTENT_DATA

public static final int FIELD_BRANDING_TUNE_CONTENT_DATA
See Also:
Constant Field Values
Since:
BlackBerry API 4.2.0

FIELD_BRANDING_TUNE_CONTENT_TYPE

public static final int FIELD_BRANDING_TUNE_CONTENT_TYPE
The content type of the Branding tune data.

See Also:
Constant Field Values
Since:
BlackBerry API 4.2.0

FIELD_BRANDING_BROWSER_ICON_0

public static final int FIELD_BRANDING_BROWSER_ICON_0
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_BROWSER_ICON_1

public static final int FIELD_BRANDING_BROWSER_ICON_1
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_BROWSER_ICON_2

public static final int FIELD_BRANDING_BROWSER_ICON_2
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_BROWSER_ICON_3

public static final int FIELD_BRANDING_BROWSER_ICON_3
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_BROWSER_ICON_4

public static final int FIELD_BRANDING_BROWSER_ICON_4
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_BROWSER_ICON_5

public static final int FIELD_BRANDING_BROWSER_ICON_5
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_BROWSER_ICON_6

public static final int FIELD_BRANDING_BROWSER_ICON_6
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_BROWSER_ICON_7

public static final int FIELD_BRANDING_BROWSER_ICON_7
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_BROWSER_ICON_8

public static final int FIELD_BRANDING_BROWSER_ICON_8
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_BROWSER_ICON_9

public static final int FIELD_BRANDING_BROWSER_ICON_9
An additional .png file.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_IDLESCREEN_CONTENT_TYPE

public static final int FIELD_IDLESCREEN_CONTENT_TYPE
Deprecated. 
The content-type of the idle screen data. Currently supported types: application/x-vnd.rim.pme image/pme image

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_IDLESCREEN_CONTENT_DATA

public static final int FIELD_IDLESCREEN_CONTENT_DATA
Deprecated. 
A file that contains the idle screen data. Note that both fields must either be present or absent.

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

FIELD_BRANDING_IGNORE_INTEL_SPLASH

public static final int FIELD_BRANDING_IGNORE_INTEL_SPLASH
See Also:
Constant Field Values
Since:
BlackBerry API 4.2.0

FIELD_HELP_WMLC

public static final int FIELD_HELP_WMLC
See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0


Method Detail

isDataSigned

public static boolean isDataSigned()
Determines if the branding NV data is signed by RIM.

Returns:
true if the branding NV data is signed by RIM.
Since:
BlackBerry API 4.0.0

getVersion

public static int getVersion()
Retrieves the version number of the branding data.

Returns:
The branding data version number.
Since:
BlackBerry API 4.0.0

getVendorId

public static int getVendorId()
Retrieves the vendor ID from the branding NV sector.

Returns:
The vendor ID.
Since:
BlackBerry API 4.0.0

getData

public static byte[] getData(int field)
Retrieves data from the branding NV sector.

Parameters:
field - The field to return data for.
Returns:
Data from the branding NV sector.
Since:
BlackBerry API 4.0.0

getFlag

public static boolean getFlag(int flag)
Returns the boolean value of the specified flag.

Parameters:
flag - one of the Branding.FIELD_* constants, known in advance to be stored as a boolean flag.
Returns:
true if the field is present and it has zero length or its first byte is non-zero; false otherwise
Since:
BlackBerry API 4.7.0

getFlag

public static boolean getFlag(int field,
                              int flag)
Returns the boolean value of the specified flag.

Parameters:
Branding.FIELD_* - constant that consist of known bit flags.
Branding.FLAG_* - known in advance to be stored as a boolean flag.
Returns:
true if the field is present and has the corresponding FLAG_ bit set; false otherwise
Since:
BlackBerry API 5.0.0





Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.