com.nokia.mid.ui
Class LCDUIUtil

java.lang.Object
  com.nokia.mid.ui.LCDUIUtil

public class LCDUIUtil
extends java.lang.Object

A utility class which provides static methods.

Get & Set Trait Methods.

Allow the caller to read and set the value of "traits" associated with a given target object. Each "trait" corresponds to an attribute or property, which is parsed and understood by the target object. Unlike attributes, each target object has a well-defined set of traits and attempting to access an undefined trait for that target will result in a unsuccessful completion of the request.

Traits supported in this specification, Nokia UI API 1.6

Below is shown the list of traits that Nokia UI API 1.6 implementations must support.

Trait: "nokia.ui.s40.item.substate"

Description: In Series 40 Java touch UI when user taps on editable Form Item the default behavior is that inline editor is activated for the item. Series 40 native UI style uses sub-state editor screens in these cases. This trait allows application to control whether inline or sub-state screen editing style is used in editable form items (e.g. DateField, TextField and Gauge) in Series 40 touch UI devices.

Target(s): javax.microedition.lcdui.Item

Trait Setter [allowed value(s)]: Boolean.TRUE|Boolean.FALSE

Trait Getter [allowed value(s)]: Boolean.TRUE|Boolean.FALSE

Default value object: Boolean.FALSE

Platform scope: Series 40 platform

Trait: "nokia.ui.s40.item.direct_touch"

Description: In Series 40 Java touch UI the default behavior of a CustomItem that system will propagate touch events (pointer and/or gesture) only to a CustomItem that is already set/selected as the current item of the Form {e.g. by user taping on the item or MIDlet setting item as current via Display#setCurrentItem() }. However, there are valid use cases where a visible CustomItem my need to receive touch events without the user or the application having to select the item first. This trait allows applications to control whether a given CustomItem instance will receive touch events without having to be set as current (selected) first.

Target(s): javax.microedition.lcdui.CustomItem

Trait Setter [allowed value(s)]: Boolean.TRUE|Boolean.FALSE

Trait Getter [allowed value(s)]: Boolean.TRUE|Boolean.FALSE

Default value object: Boolean.FALSE

Platform scope: Series 40 platform

Trait: "nokia.ui.canvas.status_zone"

Description: Allows the caller to display and hide the Interactive Status Zone on the MIDP Canvas (javax.microedition.lcdui.Canvas)in full screen mode and on the Nokia Full Canvas (com.nokia.mid.ui.FullCanvas).

Target(s): javax.microedition.lcdui.Canvas

Trait Setter [allowed value(s)]: Boolean.TRUE|Boolean.FALSE

Trait Getter [allowed value(s)]: Boolean.TRUE|Boolean.FALSE

Default value object: Boolean.FALSE

Platform scope: Series 40 platform

Set Interactive Status Zone Method.

Allows the caller to display and hide the Interactive Status Zone on the MIDP Canvas (javax.microedition.lcdui.Canvas)in full screen mode and on the Nokia Full Canvas (com.nokia.mid.ui.FullCanvas).

Method Summary

static java.lang.Object	getObjectTrait(java.lang.Object target, java.lang.String traitName) This method gets the trait of the specified target object as an object value.
static boolean	setObjectTrait(java.lang.Object target, java.lang.String traitName, java.lang.Object value) Sets the trait value of the target object as Object.
static void	setStatusZoneVisibility(java.lang.Object container, java.lang.Object mode) Deprecated. Please note that this method has now been replaced with: setTrait(Object,"nokia.ui.canvas.status_zone",Object )

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setObjectTrait

public static boolean setObjectTrait(java.lang.Object target,
                                     java.lang.String traitName,
                                     java.lang.Object value)

Sets the trait value of the target object as Object. Values in the given "value" Object are copied into the target's trait so subsequent changes to the "value" Object have no effect on the value of the target's trait.

Parameters:

target - the target object to set the trait to

traitName - the name of the trait to be set.

value - the value of the trait to be set as String.

Returns:

true if the request has succeeded or false otherwise (e.g. trait on this target is read only)

Throws:

java.lang.IllegalArgumentException - with String value "INVALID_ARGUMENT" if the target or traitName object is null.

java.lang.IllegalArgumentException - with String value "ILLEGAL_ARGUMENT" if the target object or value object are illegal for this trait.

java.lang.IllegalArgumentException - with String value "NOT_SUPPORTED" if the specified trait is not supported by this platform.

java.lang.SecurityException - if the application does not have the necessary privilege rights to access this content.

Since:

Nokia UI API 1.6

getObjectTrait

public static java.lang.Object getObjectTrait(java.lang.Object target,
                                              java.lang.String traitName)

This method gets the trait of the specified target object as an object value. The returned object is a copy of the target's trait value and will not change if the corresponding trait changes.

Parameters:

target - the target object to read the trait from

traitName - the name of the trait to retrieve.

Returns:

valid Object if the request has succeeded or null otherwise

Throws:

java.lang.IllegalArgumentException - with String value "INVALID_ARGUMENT" if the target or traitName object is null.

java.lang.IllegalArgumentException - with String value "ILLEGAL_ARGUMENT" if the target object is illegal for this trait.

java.lang.IllegalArgumentException - with String value "NOT_SUPPORTED" if the specified trait is not supported by this platform.

java.lang.SecurityException - if the application does not have the necessary privilege rights to access this content.

Since:

Nokia UI API 1.6

setStatusZoneVisibility

public static void setStatusZoneVisibility(java.lang.Object container,
                                           java.lang.Object mode)

Deprecated. Please note that this method has now been replaced with: setTrait(Object,"nokia.ui.canvas.status_zone",Object )

Sets the visibility of the Status Zone for MIDP Canvas (in full canvas mode) and Nokia Full Canvas.

Parameters:

container - - Can be one of: MIDP Canvas javax.microedition.lcdui.Canvas or Nokia FullCanvas com.nokia.mid.ui.FullCanvas

mode - - if true display status zone forever, if false hide status zone.

Throws:

java.lang.IllegalArgumentException - if container is null.

java.lang.IllegalArgumentException - if setting status zone visibility is unsupported on container.

java.lang.IllegalStateException - if the MIDP Canvas is not in full screen mode.