Package com.nokia.mid.ui.orientation

Orientation API

See:
Description

Interface Summary

OrientationListener

Listener interface for applications interested in orientation related events in the system.

Class Summary

Orientation

Orientation class is used for getting and setting UI orientation.

Package com.nokia.mid.ui.orientation Description

Orientation API

This document defines the Nokia Orientation API.

This API provides applications access to display orientation and to control applications own UI orientation. Using this API, applications can:

• Get the current display orientation.
• Get the application's current UI orientation.
• Set the application's UI orientation.
• Register to be notified when display orientation has changed.

Any MIDlet that wishes to adapt its UI orientation to be portrait, landscape or manually adjusted, following tag must be declared in the JAD file:
Nokia-MIDlet-App-Orientation: [value]

Possible values for JAD tag are:

• portrait
  The MIDlet supports portrait mode only. MIDlet cannot set its UI orientation using method setAppOrientation.
• landscape
  The MIDlet supports landscape mode only. MIDlet cannot set its UI orientation using method setAppOrientation.
• manual
  The MIDlet can support either portrait or landscape mode and therefore its default orientation can match the display orientation. When the MIDlet is started its orientation will initially follow device's display orientation. If the MIDlet wishes to adjust its orientation, it must do so manually through the Orientation API using setAppOrientation method. Java platform does not support automatic orientation so that the MIDlets UI automatically follows display orientation.

Orientation capability is used by the java platform to set MIDlet orientation at launch time. This also affects MIDlet splash screen and if MIDlet has splash screen defined, its image orientation follows the value of the JAD tag.

The tag is not mandatory, and if missing, the MIDlet is assumed to support default display orientation only, which may vary between devices. In the absence of JAD tag, method setAppOrientation cannot be used. However methods for getting application and display orientations and registering orientation listener for display orientation changes can be used regardless of the JAD tag value.

The version string of Orientation API is determined by the system property com.nokia.mid.ui.orientation.version. If Orientation API is not present in the device, null is returned as version string.

Current version of Orientation API is 1.0