Orientation API


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 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:

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:

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 If Orientation API is not present in the device, null is returned as version string.

Current version of Orientation API is 1.0

Copyright © 2012 Nokia Corporation. All rights reserved.

Nokia is registered trademark of Nokia Corporation. Java and all Java-based marks are trademarks or registered trademarks of Oracle Corporation. Other product and company names mentioned herein may be trademarks or trade names of their respective owners. This document is confidential information of Nokia Corporation.

The information in this document is provided "as is," with no warranties whatsoever, including any warranty of merchantability, fitness for any particular purpose, or any warranty otherwise arising out of any proposal, specification, or sample. Furthermore, information provided in this document is preliminary, and may be changed substantially prior to final release.

Nokia Corporation disclaims all liability, including liability for infringement of any proprietary rights, relating to this document and implementation of any information presented in this document.

Nokia Corporation retains the right to make changes to this document at any time, without notice.

Subject to above disclaimer, a license is hereby granted to use this documentation solely under existing Limited License Agreement and non-disclosure agreement between the companies for the agreed application development for Series 40 Nokia phones. No other licenses e.g. to any intellectual property rights are granted herein. Any use of the screen shots of this documentation, including any icons thereof, is subject to Nokia's prior written approval.