net.rim.device.api.ui
Class Ui

java.lang.Object
  |
  +--net.rim.device.api.ui.Ui

public final class Ui

extends Object

Provides functionality and data global to the entire UI system.

Field Summary

static int	INCREASE_DOWN Alt-rolling downwards should produce higher values in rolling controls.
static int	INCREASE_UP Alt-rolling upwards should produce higher values in rolling controls.
static int	MODE_ADVANCED Advanced UI user mode.
static int	MODE_BEGINNER Beginner UI user mode.
static int	MODE_NORMAL Normal UI user mode.
static int	UNITS_µm Size is specified in µm (micrometers).
static int	UNITS_cpt Size is specified in cpt (centipoints).
static int	UNITS_m Size is specified in m (meters).
static int	UNITS_pt Size is specified in pt (points).
static int	UNITS_px Size is specified in pixels.

Method Summary

static int	getIncreaseDirection() Retrieves the direction for rolling controls.
static int	getMode() Retrieves the UI user mode.
static UiEngine	getUiEngine() Gets this process's UI engine.

Methods inherited from class java.lang.Object

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

Field Detail

MODE_BEGINNER

public static final int MODE_BEGINNER

Beginner UI user mode.

MODE_NORMAL

public static final int MODE_NORMAL

Normal UI user mode.

MODE_ADVANCED

public static final int MODE_ADVANCED

Advanced UI user mode.

INCREASE_UP

public static final int INCREASE_UP

Alt-rolling upwards should produce higher values in rolling controls. This constant is defined as -1. Examples of controls that use this are ChoiceField and DateField.

INCREASE_DOWN

public static final int INCREASE_DOWN

Alt-rolling downwards should produce higher values in rolling controls. This constant is defined as +1. Examples of controls that use this are ChoiceField and DateField.

UNITS_m

public static final int UNITS_m

Size is specified in m (meters). Useful mostly when combined with a prefix.

Since:

JDE 3.7.0

UNITS_pt

public static final int UNITS_pt

Size is specified in pt (points).

1 pt = 1/72 in.

Since:

JDE 3.7.0

UNITS_px

public static final int UNITS_px

Size is specified in pixels. It is assumed to have already gone through the appropriate scaling for the device.

Since:

JDE 3.7.0

UNITS_cpt

public static final int UNITS_cpt

Size is specified in cpt (centipoints).

1 cpt = 1/7200 in.

Since:

JDE 3.7.0

UNITS_µm

public static final int UNITS_µm

Size is specified in µm (micrometers).

Since:

JDE 3.7.0

Method Detail

getIncreaseDirection

public static int getIncreaseDirection()

Retrieves the direction for rolling controls.

A returned value of plus one indicates that, in rolling controls, alt-rolling the trackwheel towards the bottom of the device selects "higher" values in the control's list.

A returned value of minus one indicates that, in rolling controls, alt-rolling the trackwheel towards the top of the device selects "higher" values in the control's list.

Returns:

Plus one if alt-rolling towards the bottom of the device produces higher values in rolling controls; minus one if alt-rolling upwards produces higher values.

getMode

public static int getMode()

Retrieves the UI user mode.

Invoke this method to retrieve the currently set UI user mode: one of MODE_BEGINNER, MODE_NORMAL, and MODE_ADVANCED.

In advanced mode, controls should be less intrusive. In normal and beginner mode, controls should assume the user is unfamiliar with the device, and needs more assistance.

Different operating modes are not exposed at the user level. It is intended initially as a back door.

Returns:

Value corresponding to one of this class's static UI user mode members.

getUiEngine

public static UiEngine getUiEngine()

Gets this process's UI engine.

Returns:

Engine used by this process.