JAD and JAR manifest attributes

The following S60 specific JAD and JAR manifest parameters are specified for the S60 platform.

Note: The common optional JAD attribute MIDlet-Delete-Confirm is not supported in S60 platforms.

Table: Nokia proprietary JAD/MANIFEST attributes

Attribute Name

Since S60 Edition

Description

Value

Nokia-MIDlet-Category

Always included

Category defines localized installation folder for MIDlet.

Category can be one of the following:


  • Application

  • Game

Nokia-MIDlet-Original-Display-Size

3rd Edition

Specifies the screen for which the MIDlet was designed. This is used to adapt the MIDlet for full-screen mode on a mobile device. Scaling applies to full screen LCDUI Canvases only.

<width,height>

Example:

Nokia-MIDlet-Original-Display-Size: 176,208

Nokia-MIDlet-Target-Display-Size

3rd Edition

Specifies the target size for the MIDlet. This usually same as target device’s screen size. This attribute is usually used in conjunction with the above. Scaling applies to full screen LCDUI Canvases only.

<width,height>

Example:

Nokia-MIDlet-Target-Display-Size: 240,320

Nokia-Scalable-Icon

(and Nokia-Scalable-Icon-MIDlet-<n>)

3rd Edition FP 2

Specifies scalable MIDlet icon support.

When developing MIDlet suites, the MIDlet specific attributes MIDlet-n and Nokia-Scalable-Icon-MIDlet-<n> must be used.

For more information, see Scalable icon support.

<link to svg icon>

Example:

Nokia-Scalable-Icon: /icons/gamesuite.svg

Nokia-MIDlet-UID-<n>

3rd Edition FP 2

Predefined UID (Unique IDentifier) for a MIDlet. The value of <n> must match to MIDlet-<n> attribute.

UID can be from following ranges:


  • Unprotected range 0xA0000000 - 0xAFFFFFFF

  • Protected range 0x20000000 - 0x2FFFFFFF

  • Test range 0xE0000000 - 0xEFFFFFFF

Note: In the case the UID is from protected range, the MIDlet Suite must be signed and the UID must be specified in both the JAD and the JAR manifest file. For more details, see section Pre-defined UID attributes

For more information on UID values in MIDlet development, see Symbian signed process web page.

Examples:

Nokia-MIDlet-UID-1: 0xE0000000

Nokia-MIDlet-UID-2: 0xE0000001

Nokia-UI-Enhancement

3rd Edition FP 2

Specifies the following:


  • Theme (skin) behaviour on a normal mode Canvas (not full screen) component. The background image is shown if the attribute value is CanvasHasBackground. If the attribute is not defined, by default the background is white (corresponds to Display.getColor(COLOR_BACKGROUND)). If MIDlet does not render all the pixels of given clip region in paint method, theme background is shown.

  • Receiving media key events while MIDlet is running

Examples:

Nokia-UI-Enhancement: CanvasHasBackground

or

Nokia-UI-Enhancement: MusicKeysSupported

Nokia-MIDlet-Canvas-Scaling-Orientation-Switch

3rd Edition FP 2

Used when MIDlet needs to indicate that it wants to allow change of original MIDlet size (Nokia-MIDlet-Original-Display-Size) orientation when switching from portrait to landscape mode. After resolution switch the MIDlet is notified via sizeChanged() function of LCDUI Canvas and it is responsible for redrawing its content.

For an illustration, see figure LCDUI Canvas scaling on orientation switch.

true or false

Example:

Nokia-MIDlet-Canvas-Scaling-Orientation-Switch: true

Nokia-MIDlet-No-Exit

3rd Edition FP 2

Prevents the MIDlet from closing via pressing the End key. Instead of closing the MIDlet it is put to the background. The MIDlet can be still closed from the list of open applications.

true or false

Example:

Nokia-MIDlet-No-Exit: true

Nokia-MIDlet-Flip-Close

3rd Edition FP 2

Specifies MIDlet behaviour on flip-close event.

If value is pause, pauseApp() is called if flip is closed. If flip then is opened, startApp() is called.

By default the attribute value is run and therefore pauseApp() and startApp() are not called when flip is closed.

Note: if MIDlet is already in background it does not get any notification about flip close event.

pause or run

Example:

Nokia-MIDlet-Flip-Close: pause

Nokia-MIDlet-Background-Event

3rd Edition FP 2

Specifies MIDlet behavior to background event.

If value is pause, pauseApp() is called if on to background event takes place. If on to foreground event takes place, startApp() is called.

By default the attribute value is run and therefore pauseApp() and startApp() are not called when on to background event takes place.

pause or run

Example:

Nokia-MIDlet-Background-Event: pause

Nokia-MIDlet-Block-Uninstall

3rd Edition FP 2

Prevents uninstallation of the MIDlet Suite if value of this attribute is true.

Only Manufacturer or Operator signed applications are able to use this attribute.

Note: This attribute must be specified in the JAR manifest file.

true or false

Example:

Nokia-MIDlet-Block-Uninstall: true

Nokia-MIDlet-S60-Selection-Key-Compatibility

3rd Edition FP 2

This attribute changes the default Selection key behaviour in Canvas and CustomItem elements.

By default, normal mode Canvas and CustomItem do not get low level key events for Selection key even if there is no CommandListener defined. For backward compatibility to S60 Editions prior to S60 3rd Edition FP 2, it is possible to enable low-level key event triggering from Selection key in CustomItem, normal mode Canvas and in full screen Canvas with Commands and CommandListener defined.

If this attribute is set as true, no Commands are mapped to Selection key, instead the relevant low-level key event is triggered (-5). Note that in a full screen mode Canvas without any Commands and CommandListener defined, this feature does not have any effect as low level key events are triggered from all softkeys in any case.

true or false Example: Nokia-MIDlet-S60-Selection-Key-Compatibility: true

Nokia-MIDlet-On-Screen-Keypad

5th Edition

Specifies the on-screen keypad for a Canvas application.

This attribute is valid only in touch-enabled devices that have limited hard key availability.

no, gameactions or navigationkeys.

Example:

Nokia-MIDlet-On-Screen-Keyboard: gameactions
© Nokia 2008.