Nokia JAD and JAR manifest attributes

Nokia的S60和S40系列jad和jar manifest的属性列表见下,也可参见原文

The following JAD and JAR manifest attributes are specified for
Symbian devices.

 

Table: Nokia-proprietary
manifest attributes for Symbian

Attribute name

Since Symbian Edition

Description

Value

MIDlet-Data-Size

S60 3rd Edition FP1

Used at installation time to determine whether the destination
drive has capacity for accommodating both the application files and
the RMS space needed to run the application.

The amount of RMS
space defined by MIDlet-Data-Size is not guaranteed
to be available for the application. The required space is not pre-allocated
for the application.

Installation is allowed only to drives
with enough free space. The amount of needed space is calculated from
the attributes MIDlet-Jar-Size and MIDlet-Data-Size.

S60 3rd Edition FP1 and earlier: The maximum value is 1MB
and is checked during installation. RMS implementation also allocates
space from file system according to this attribute.

S60 3rd
Edition FP2 – S60 5th Edition: The maximum value is 1MB and is checked
during installation. No reserve file is made.

Symbian^3 and
later (JRT2.1 onwards): No maximum value. No reservation file is made..

Nokia-Forward-Lock

Symbian^3 (Java Runtime 2.1)

Specifies whether the MIDlet suite in the MIDlet Message
is installed as forward-locked. Forward-locked means that the MIDlet
suite JAR file from the MIDlet Message is DRM-encrypted during installation.

If this attribute is set to true, the MIDlet
suite is installed as forward-locked. The default value is false.

This is an optional attribute.

For
more information, see MIDlet Message.

Possible values:

  • true

  • false (default)

Example:

Nokia-Forward-Lock: true

 Nokia-MIDlet-App-Orientation

S60 5th Edition

Allows MIDlet to force either portrait or landscape UI orientation.
The orientation is only fixed on devices that support the specific
layout.

portrait or landscape

 Nokia-MIDlet-Background-Event

S60 3rd Edition FP 2

Specifies MIDlet behavior to background event.

If
value is pause, pauseApp() is called when 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.

Note: When designing the MIDlet, take into account that startApp() can be called many times.

pause or run

Example:

Nokia-MIDlet-Background-Event: pause

Nokia-MIDlet-Block-Uninstall

S60 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-Canvas-Scaling-Orientation-Switch

S60 3rd Edition FP 2

Nokia-MIDlet-Canvas-Scaling-Orientation-Switch is always used together with Nokia-MIDlet-Original-Display-Size (see above). As Nokia-MIDlet-Original-Display-Size is used to indicate a fixed resolution that full screen Canvas content of the MIDlet is designed for, then additionally
specifying Nokia-MIDlet-Canvas-Scaling-Orientation-Switch to true indicates that the MIDlet can also
support the given resolution in both portrait and landscape resolutions.

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

Note: Behavior of combination Nokia-MIDlet-Canvas-Scaling-Orientation-Switch: true and
set Nokia-MIDlet-Target-Display-Size is undefined.
You should avoid using these two attributes together.

true or false

Example:

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

Nokia-MIDlet-Category

S60 2nd Edition

Defines localized installation folder for MIDlet.

Possible values:

  • Application (S60 1st Edition MIDlets use
    this)

  • Game

 Nokia-MIDlet-Delete-Confirm-<locale>

Symbian^3 (Java Runtime 2.1)

Specifies the localized confirmation prompt shown by the Application Management
Software (AMS)
when the user selects to remove the MIDlet or
MIDlet suite.

For a list of supported locales, see section Supported locales.

For
the non-localized version of this attribute, see MIDlet-Delete-Confirm.

Examples:

Nokia-MIDlet-Delete-Confirm-en:
Are you sure you want to delete this MIDlet?

Nokia-MIDlet-Delete-Confirm-fi-FI: Haluatko varmasti poistaa tämän
MIDletin?

Nokia-MIDlet-Flip-Close

S60 3rd Edition FP 2

Specifies MIDlet behavior on flip-close event.

If
value is pause, pauseApp() is called when the flip is closed. If the flip is then 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 a MIDlet is already in background, it does
not get any notification about flip close event.

Note: In some cases, MIDlets may remain in background when the flip
is opened. In these cases, the user needs to bring MIDlet to foreground,
by using the ShowNotify() call in Canvas or using an Options menu Command with a call
to resumeRequest() in a Form based MIDlet.

Attribute Nokia-Background-Event (see below) with value pause can be used as
well.

pause or run

Example:

Nokia-MIDlet-Flip-Close: pause

Nokia-MIDlet-Launch-Params

Symbian^3 (Java Runtime 2.1)

Specifies the set of parameters that the application supports
when launched using launchapp: or javaapp: URI platform request

For more information, see Launching a MIDlet
from another MIDlet
.

Comma separated list of property names.

Example:

Nokia-MIDlet-Launch-Params: sounds,difficulty,wizard_mode

Nokia-MIDlet-Name-<locale>

Symbian^3 (Java Runtime 2.1)

The localized name of the MIDlet suite for the specified
locale.

For more information, see MIDlet name localization

Examples:

Nokia-MIDlet-Name-es-MX: HolaMundo

Nokia-MIDlet-Name-en: HelloWorld

Nokia-MIDlet-<n>-<locale>

Symbian^3 (Java Runtime 2.1)

The localized name of the MIDlet.

For more information,
see MIDlet
name localization

Examples:

Nokia-MIDlet-1-en-GB: LocalisedMIDlet

Nokia-MIDlet-1-en-US: LocalizedMIDlet

 Nokia-MIDlet-No-Exit

S60 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-On-Screen-Keypad

S60 5th Edition

Specifies the on-screen keypad for a Canvas application.

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

no, gameactions, or navigationkeys.

Example:

Nokia-MIDlet-On-Screen-Keypad: gameactions

 Nokia-MIDlet-On-Screen-Softkeys-Position

S60 5th Edition (Java Runtime 1.4)

Defines where softkeys are placed on the screen when using
the on-screen
keypad
on devices that have no physical softkeys.

right or bottom

Nokia-MIDlet-Original-Display-Size

S60 3rd Edition

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

<width,height>

Example:

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

 Nokia-MIDlet-S60-Selection-Key-Compatibility

S60 3rd Edition FP 2

This attribute changes the default Selection key behavior
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 Symbian 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-Splash-Screen-Image

Symbian^3 (Java Runtime 2.1)

Defines the custom start-up screen ("splash screen") used by the MIDlet. This attribute can also be
used to define multiple custom start-up screens for the device to
choose from or to disable ("suppress") the start-up screen for the
MIDlet.

Examples:

Nokia-MIDlet-Splash-Screen-Image:
splash_300x300.png

Nokia-MIDlet-Splash-Screen-Image:
portrait_300x600.jpg, landscape_600x300.jpg, splash_300x300.png

Nokia-MIDlet-Splash-Screen-Image: suppress

 Nokia-MIDlet-Tap-Detection-Options

S60 5th Edition (Java Runtime 1.4)

Sets the size of tap detection area and tap time-out on Touch UI devices. If the pointer stays pressed
within the detection area and does not surpass the time-out value,
the event is considered a single tap. If the pointer leaves the detection
area or the time-out passes, drag events start being generated.

The detection area is a rectangle, measured in twips. The entered value is half the length of one side of the rectangle.

Size of the detection rectangle in twips and time-out value
in milliseconds, separated by a comma

Example:

Nokia-MIDlet-Tap-Detection-Options:100,250

 Nokia-MIDlet-Target-Display-Size

S60 3rd Edition

Specifies the target size for the MIDlet. This is usually
the same as the screen size of the target device. This attribute is
usually used in conjunction with the Nokia-MIDlet-Original-Display-Size (see below). Scaling applies to full screen LCDUI Canvases only.

<width,height>

Example:

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

Nokia-MIDlet-UID-<n>

S60 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-Scalable-Icon

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

S60 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-UI-Enhancement

S60 3rd Edition FP 2

Specifies the following:

  • Theme (skin) behavior 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 the MIDlet does
    not render all the pixels of a given clip region in the paint method,
    the theme background is shown.

  • Receiving media key events while the MIDlet is running.

  • Setting TextBox as a pop-up TextBox.

  • Replacing the default pop-up TextBox with a full-screen TextBox.

  • Disabling
    automatic audio muting
    for the Meeting and Silent profiles.
    This feature is only supported from Java Runtime 2.1 onwards.

Note: The attribute value is a comma-separated list, so several
values can be specified.

Examples:

Nokia-UI-Enhancement: CanvasHasBackground

Nokia-UI-Enhancement: MusicKeysSupported

Nokia-UI-Enhancement: PopUpTextBox

Nokia-UI-Enhancement: FullScreenTextBox

Nokia-UI-Enhancement: IgnoreProfilesBasedSoundMuting

The following JAD and JAR manifest attributes are specified for
Series 40 devices.

 

Table: Nokia-proprietary
manifest attributes for Series 40

Attribute name

Since Series 40 Edition

Description

Value

Nokia-MIDlet-Background-Exit-Confirm-<locale>

Series 40 6th Edition

Prompt to use in a confirmation before stopping a background
MIDlet prior when freeing heap space.

Note: Background MIDlets
are enabled only for operator and manufacturer domains.

Example:

Nokia-MIDlet-Background-Exit-Confirm-en
: Don't stop me please

Nokia-MIDlet-bg-launchpad

Series 40 5th Edition FP 1

Indicates MIDlet-n in the suite that is a launchpad MIDlet
(JAR explorer).

Note: Background MIDlets are enabled only for
operator and manufacturer domains.

Example:

Nokia-MIDlet-bg-launchpad: 2

Nokia-MIDlet-bg-memory-size

Series 40 3rd Edition FP 2

Indicates that the MIDlet can run in the background and
defines the amount of heap it is allowed in the background in kb.

Note: Background MIDlets are enabled only for operator and manufacturer
domains.

Integer

Example:

Nokia-MIDlet-bg-memory-size:
256

Nokia-MIDlet-bg-server

Series 40 5th Edition FP 1

Indicates MIDlet-n in the suite that is a BG server.

Note: Background MIDlets are enabled only for operator and manufacturer
domains.

Example:

Nokia-MIDlet-bg-server: 1

Nokia-MIDlet-bg-user-disable

Series 40 5th Edition FP 1

Indicates if the MIDlet can be stopped by the user to free
background heap for another MIDlet to start. Note: true or absence of this attribute means the MIDlet can be stopped.

Note: Background MIDlets are enabled only for operator and manufacturer
domains.

true or false

Example:

Nokia-MIDlet-bg-user-disable: true

Nokia-MIDlet-bg-version

Series 40 6th Edition

Indicates the background API version required to run the
MIDlet.

Note: Background MIDlets are enabled only for operator
and manufacturer domains.

Example:

Nokia-MIDlet-bg-version: 1.0

Nokia-MIDlet-Category

Series 40 6th Edition

Used to determine the folder to which MIDlets are stored
following an OTA Download.

Note: This is a JAD only attribute
and applicable only to BG MIDlets. The value is case sensitive.

Possible values:

  • Nokia-MIDlet-Category: Application

  • Nokia-MIDlet-Category: Commerce

  • Nokia-MIDlet-Category: Game

  • Nokia-MIDlet-Category: Messaging

  • Nokia-MIDlet-Category: Screensaver

Nokia-MIDlet-Category

Series 40 6th Edition

IdleScreen – Identifies a MIDlet that
is capable of displaying content on the idle screen.

PassiveIdleScreen – Identifies a MIDlet that is capable
of running as an idle skin application (taking over the whole main
zone).

Search – Identifies a MIDlet that
provides search capabilities used by a native idle search application.

Example:

Nokia-MIDlet-Category: IdleScreen

Nokia-MIDlet-Close-Gprs-Context

Series 40 5th Edition FP 1

If set totrue, after all HTTP connections
are closed, there is a time-out of 10 seconds before shutting down
GPRS context . By default there is no time out, which means the GPRS
context will be kept till the MIDlet exits.

Example:

Nokia-MIDlet-Close-Gprs-Context:
true

Nokia-MIDlet-Connectionsettings

Series 40 6th Edition Lite

Provides an identifier string for provisioned connection
settings. It specifies provisioned proxy or access point settings
to be used when the MIDlet is accessing the network (over HTTP or
TCP/UDP).

The given identifier provides one-to-one mapping
to the connection settings. The identifier has to conform with OMA
DM and WAP Provisioning standards.

The identifier strings are
specific to the manufacturer or operator.

If settings are not
specified, default settings are used.

Nokia-MIDlet-Connectionsettings: specialProxy

Nokia-MIDlet-Name-<locale>

Series 40 3rd Edition

Localized MIDlet suite name

For more information,
see MIDlet
name localization

Example:

Nokia-MIDlet-Name-en: Bounce

Nokia-MIDlet-Name-n-<locale>

Series 40 3rd Edition

Localized MIDlet name for MIDlets in the suite

For
more information, see MIDlet name localization

Example:

Nokia-MIDlet-1-en: Bounce

Nokia-MIDlet-national-digit-display

Series 40 5th Edition

Used to enable national rather than Latin digit display.

Example:

Nokia-MIDlet-national-digit-display:
true

Nokia-MIDlet-no-exit

Series 40 3rd Edition FP 2

Indicates a MIDlet that cannot exit once started.

true or false

Example:

Nokia-MIDlet-no-exit: true

Nokia-MIDlet-Save-Location

Series 40 5th Edition FP 1

Used to determine download folder (currently only supports
the root (predefjava) folder).

Example:

Nokia-MIDlet-Save-Location: Root

Nokia-Service

Series 40 5th Edition FP 1

Used to indicate an upload service. Upload services are
downloaded with different UI to other MIDlets.

true or false

Example:

Nokia-Service: true

Nokia-UI-Enhancement

Series 40 3rd Edition

Specifies the following:

  • Theme (skin) behavior 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 the MIDlet does
    not render all the pixels of a given clip region in the paint method,
    the theme background is shown.

  • Receiving media key events while the MIDlet is running.

Note: The attribute value is a comma-separated list, so several
values can be specified.

Examples:

Nokia-UI-Enhancement: CanvasHasBackground

Nokia-UI-Enhancement: MusicKeysSupported

Nokia-Update

Series 40 3rd Edition

Version update URL, used when doing Update Check. If no
URL then Update Check is disabled.

Example:

Nokia-Update: http://myserver.com/Bounce.jad

progressive_download

Series 40 3rd Edition FP 2

Set to enabled to enable JSR-135 progressive
playback.

Example:

progressive_download: enabled

Background
MIDlets

Background MIDlets are enabled for operator and
manufacturer domains only. The number of MIDlets that can run concurrently
is determined by product configuration that takes into account the
amount of RAM that can be made available for the Java heap. The ability
of the device to run MIDlets in the background is a key enabler for
services such as Email and IM that need to remain in contact with a remote server even when not
on display. MIDlets that run in the background are pre-allocated heap
space from the available background heap. The amount allocated is
determined by the Nokia-MIDlet-BG-memory-size attribute in their JAD file.