UiAccess

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.enough.polish.ui
Class UiAccess

java.lang.Object
  de.enough.polish.ui.UiAccess

public final class UiAccess
extends Object
extends Object

Allows to access J2ME Polish specific features in a standard compliant way.

When a ScreenStateListener is registered with a screen, it will get notified when the screen changes its focus or another internal state (like changing a tab in the TabbedForm).

 history
        31-Jan-2006 - rob creation

Author:: Robert Virkus, j2mepolish@enough.de

Field Summary
`static int`	`CONSTRAINT_FIXED_POINT_DECIMAL` A constant for using the FIXED_POINT_DECIMAL constraint on TextFields.
`static int`	`DOWN_PRESSED` The bit representing the DOWN key.
`static int`	`FIRE_PRESSED` The bit representing the FIRE key.
`static int`	`GAME_A_PRESSED` The bit representing the GAME_A key (may not be supported on all devices).
`static int`	`GAME_B_PRESSED` The bit representing the GAME_B key (may not be supported on all devices).
`static int`	`GAME_C_PRESSED` The bit representing the GAME_C key (may not be supported on all devices).
`static int`	`GAME_D_PRESSED` The bit representing the GAME_D key (may not be supported on all devices).
`static int`	`LEFT_PRESSED` The bit representing the LEFT key.
`static int`	`MODE_FIRST_UPPERCASE` A constant for setting the input mode of an TextField to uppercase for the first character, followed by lowercase characters.
`static int`	`MODE_LOWERCASE` A constant for setting the input mode of an TextField to lowercase.
`static int`	`MODE_NATIVE` A constant for setting the input mode of an TextField to it't native input - that's useful for using T9 and similar input helpers.
`static int`	`MODE_NUMBERS` A constant for setting the input mode of an TextField to numbers.
`static int`	`MODE_UPPERCASE` A constant for setting the input mode of an TextField to uppercase.
`static int`	`RIGHT_PRESSED` The bit representing the RIGHT key.
`static int`	`UP_PRESSED` The bit representing the UP key.

Method Summary
`static void`	`addItemCommand(List list, int index, Command command)` Adds a command to a list item.
`static void`	`addItemCommand(List list, int index, Command command)` Adds a command to a list item.
`static void`	`addSubCommand(Command child, Command parent, Screen screen)` Adds the given command as a subcommand to the defined screen.
`static void`	`addSubCommand(Command child, Command parent, Screen screen)` Adds the given command as a subcommand to the defined screen.
`static void`	`addSubCommand(Command child, Command parent, Screen screen)` Adds the given command as a subcommand to the defined screen.
`static void`	`addSubCommand(Command child, Command parent, Screen screen, Style style)` Adds the given command as a subcommand to the defined screen.
`static int`	`append(Item item, Form form)` Adds the specified (J2ME Polish) item to the given form.
`static int`	`append(Item item, Form form)` Adds the specified (J2ME Polish) item to the given form.
`static int`	`append(Ticker ticker, Form form)` Adds a ticker as a normal item to the specified form.
`static void`	`appendChoiceGroupItem(ChoiceGroup ChoiceGroup, ChoiceItem item)` Appends a ChoiceItem or a subclass to the given ChoiceGroup.
`static void`	`appendChoiceGroupItem(ChoiceGroup ChoiceGroup, ChoiceItem item)` Sets a ChoiceItem or a subclass for the given ChoiceGroup.
`static void`	`appendListItem(List list, ChoiceItem item)` Sets a ChoiceItem or a subclass for the given list.
`static void`	`appendListItem(List list, ChoiceItem item)` Sets a ChoiceItem or a subclass for the given list.
`static Command`	`cast(Command cmd)` Casts the given MIDP command into a J2ME Polish command
`static Command`	`cast(Command cmd)` Casts the given J2ME Polish command into a MIDP command
`static CommandListener`	`cast(CommandListener cmd)` Casts the given MIDP CommandListener into a J2ME Polish CommandListener
`static CommandListener`	`cast(CommandListener cmd)` Casts the given J2ME Polish CommandListener into a MIDP CommandListener
`static Displayable`	`cast(Displayable disp)` Casts the given MIDP Displayable into a J2ME Polish Displayable
`static Displayable`	`cast(Displayable disp)` Casts the given J2ME Polish Displayable into a MIDP Displayable
`static Item`	`cast(Item item)` Casts the given LCDUI item into a J2ME Polish item
`static Item`	`cast(Item item)` Casts the given J2ME Polish item into a LCDUI item
`static Item[]`	`cast(Item[] items)` Casts the given LCDUI items into J2ME Polish items
`static Item[]`	`cast(Item[] items)` Casts the given J2ME Polish items into a LCDUI items
`static void`	`defocus(Item item, Style style)` Defocuses the given item and sets the style to the specified one.
`static boolean`	`delete(Form form, Item item)` Deletes the specified item from the form
`static boolean`	`delete(Form form, Item item)` Deletes the specified item from the form
`static void`	`emitGameActionPress(int gameAction)` Simulates a keyPressed event.
`static void`	`emitGameActionRelease(int gameAction)` Simulates a keyReleased event.
`static void`	`emitKeyPress(int keyCode)` Simulates a keyPressed event.
`static void`	`emitKeyRelease(int keyCode)` Simulates a keyReleased event.
`static void`	`emitKeyRepeated(int keyCode)` Simulates a keyRepeated event.
`static void`	`enableScreenChangeAnimation(Screen screen, boolean enable)` Enables or disables screen change animations for the specified screen
`static void`	`enableScreenChangeAnimation(Screen screen, boolean enable)` Enables or disables screen change animations for the specified screen
`static void`	`enableScreenChangeAnimations(boolean enable)` Enables or disables screen change animations
`static void`	`fireEvent(String name, Item item, Object data)` Fires an event for the specified item and all its subitems.
`static void`	`fireEvent(String name, Item item, Object data)` Fires an event for the specified item and all its subitems.
`static void`	`fireEvent(String name, Screen screen, Object data)` Fires an event for the specified screen and all its components.
`static void`	`fireEvent(String name, Screen screen, Object data)` Fires an event for the specified screen and all its components.
`static void`	`fireEventForTitleAndMenubar(String name, Screen screen, Object data)` Fires an event for the title and menubar of the specified screen.
`static void`	`fireEventForTitleAndMenubar(String name, Screen screen, Object data)` Fires an event for the title and menubar of the specified screen.
`static void`	`focus(ChoiceGroup choiceGroup, int index)` Focuses the specified item on the given choice group.
`static void`	`focus(ChoiceGroup choiceGroup, int index)` Focuses the specified item on the given choice group.
`static Style`	`focus(Item item, int direction, Style style)` Focusses the given item with the specified style.
`static void`	`focus(Screen screen, int index)` Focuses the specified item on the given screen.
`static void`	`focus(Screen screen, int index)` Focuses the specified item on the given screen.
`static void`	`focus(Screen screen, Item item)` Focuses the specified item on the given screen.
`static void`	`focus(Screen screen, Item item)` Focuses the specified item on the given screen.
`static void`	`focus(Screen screen, Item item)` Focuses the specified item on the given screen.
`static void`	`focus(Screen screen, Item item)` Focuses the specified item on the given screen.
`static Object`	`getAttribute(Item item, Object key)` Gets an previously added attribute of the specified item.
`static Object`	`getAttribute(Item item, Object key)` Gets an previously added attribute of the specified item.
`static Object`	`getAttribute(List list, int index, Object key)` Gets an previously added attribute of the specified item.
`static Object`	`getAttribute(List list, int index, Object key)` Gets an previously added attribute of the specified item.
`static HashMap`	`getAttributes(Item item)` Returns a HashMap object with all registered attributes.
`static HashMap`	`getAttributes(Item item)` Returns a HashMap object with all registered attributes.
`static HashMap`	`getAttributes(List list, int index)` Returns a HashMap object with all registered attributes.
`static HashMap`	`getAttributes(List list, int index)` Returns a HashMap object with all registered attributes.
`static Background`	`getBackground(Item item)` Retrieves the background of the given item.
`static Background`	`getBackground(Item item)` Retrieves the background of the given item.
`static Background`	`getBackground(Screen screen)` Retrieves the background of the given screen.
`static Background`	`getBackground(Screen screen)` Retrieves the background of the given screen.
`static ChoiceItem`	`getChoiceGroupItem(ChoiceGroup ChoiceGroup, int index)` Retrieves a ChoiceItem or a subclass for the given ChoiceGroup.
`static ChoiceItem`	`getChoiceGroupItem(ChoiceGroup ChoiceGroup, int index)` Retrieves a ChoiceItem or a subclass for the given ChoiceGroup.
`static CommandListener`	`getCommandListener(Screen screen)` Retrieves the command listener belonging to this screen.
`static CommandListener`	`getCommandListener(Screen screen)` Retrieves the command listener belonging to this screen.
`static int`	`getContentHeight(Screen screen)` Retrieves the vertical content width for the given screen.
`static int`	`getContentHeight(Screen screen)` Retrieves the vertical content width for the given screen.
`static int`	`getContentWidth(Screen screen)` Retrieves the horizontal content width for the given screen.
`static int`	`getContentWidth(Screen screen)` Retrieves the horizontal content width for the given screen.
`static int`	`getContentX(Screen screen)` Retrieves the horizontal content start for the given screen.
`static int`	`getContentX(Screen screen)` Retrieves the horizontal content start for the given screen.
`static int`	`getContentY(Screen screen)` Retrieves the vertical content start for the given screen.
`static int`	`getContentY(Screen screen)` Retrieves the vertical content start for the given screen.
`static Object`	`getData(Screen screen)` Retrieves screen specific data.
`static Object`	`getData(Screen screen)` Retrieves screen specific data.
`static String`	`getDotSeparatedDecimalString(TextField field)` Retrieves the decimal value entered with a dot as the decimal mark.
`static String`	`getDotSeparatedDecimalString(TextField field)` Retrieves the decimal value entered with a dot as the decimal mark.
`static int`	`getFocusedIndex(ChoiceGroup group)` Retrieves the currently focused item of the specified ChoiceGroup
`static int`	`getFocusedIndex(ChoiceGroup group)` Retrieves the currently focused item of the specified ChoiceGroup
`static int`	`getFocusedIndex(Screen screen)` Retrieves the focused index of the specified screen
`static int`	`getFocusedIndex(Screen screen)` Retrieves the focused index of the specified screen
`static Item`	`getFocusedItem(Screen screen)` Retrieves the focused index of the specified screen
`static Item`	`getFocusedItem(Screen screen)` Retrieves the focused index of the specified screen
`static int`	`getInputMode(TextBox box)` Retrieves the input mode for the given textbox.
`static int`	`getInputMode(TextBox box)` Retrieves the input mode for the given textbox.
`static int`	`getInputMode(TextField field)` Retrieves the input mode for the given textfield.
`static int`	`getInputMode(TextField field)` Retrieves the input mode for the given textfield.
`static int`	`getInternalHeight(Item item)` Retrieves the internal height of the given item.
`static int`	`getInternalHeight(Item item)` Retrieves the internal height of the given item.
`static int`	`getInternalWidth(Item item)` Retrieves the internal width of the given item.
`static int`	`getInternalWidth(Item item)` Retrieves the internal width of the given item.
`static int`	`getInternalX(Item item)` Retrieves the internal x position of the given item.
`static int`	`getInternalX(Item item)` Retrieves the internal x position of the given item.
`static int`	`getInternalY(Item item)` Retrieves the internal y position of the given item.
`static int`	`getInternalY(Item item)` Retrieves the internal y position of the given item.
`static int`	`getKeyStates()` Gets the states of the physical game keys.
`static ChoiceItem`	`getListItem(List list, int index)` Retrieves a ChoiceItem or a subclass for the given list.
`static ChoiceItem`	`getListItem(List list, int index)` Retrieves a ChoiceItem or a subclass for the given list.
`static int`	`getNumberOfDecimalFractions(TextField field)` Retrieves the number of decimal fractions that are allowed for FIXED_POINT_DECIMAL constrained TextFields
`static int`	`getNumberOfDecimalFractions(TextField field)` Retrieves the number of decimal fractions that are allowed for FIXED_POINT_DECIMAL constrained TextFields
`static Object`	`getPaintLock(Screen screen)` Retrieves the lock object for the paint thread.
`static Object`	`getPaintLock(Screen screen)` Retrieves the lock object for the paint thread.
`static ArrayList`	`getPredictiveMatchingWords(TextField field)` Retrieves matching words for the specified textfield.
`static ArrayList`	`getPredictiveMatchingWords(TextField field)` Retrieves matching words for the specified textfield.
`static int[]`	`getRgbData(Item item)` Retrieves the RGB data of the specified item.
`static int[]`	`getRgbData(Item item)` Retrieves the RGB data of the specified item.
`static int[]`	`getRgbData(Item item, int opacity)` Retrieves the RGB data of the specified item.
`static int[]`	`getRgbData(Item item, int opacity)` Retrieves the RGB data of the specified item.
`static int[]`	`getRgbDataOfContent(Item item)` Retrieves the RGB data of the specified item's content without using a view-type/ItemView.
`static int[]`	`getRgbDataOfContent(Item item)` Retrieves the RGB data of the specified item's content without using a view-type/ItemView.
`static void`	`getRgbDataOfContent(Item item, int[] rgbData, int x, int y, int width)` Retrieves the RGB data of the specified item's content without using a view-type/ItemView.
`static void`	`getRgbDataOfContent(Item item, int[] rgbData, int x, int y, int width)` Retrieves the RGB data of the specified item's content without using a view-type/ItemView.
`static Container`	`getScreenContainer(Screen screen)` Retrieves the container of the screen.
`static Container`	`getScreenContainer(Screen screen)` Retrieves the container of the screen.
`static Style`	`getStyle(Item item)` Gets the current style of the given item.
`static Style`	`getStyle(Item item)` Gets the current style of the given item.
`static Style`	`getStyle(Screen screen)` Gets the current style of the given screen.
`static Style`	`getStyle(Screen screen)` Gets the current style of the given screen.
`static String`	`getText(Item item)` Retrieves text from a J2ME Polish item.
`static String`	`getText(Item item)` Retrieves text from a J2ME Polish item.
`static List`	`getTextFieldSymbols()` Initializes the symbols list and returns it
`static int`	`getTitleHeight(Screen screen)` Determines the height of the title of the specified screen.
`static int`	`getTitleHeight(Screen screen)` Determines the height of the title of the specified screen.
`static Item`	`getTitleItem(Screen screen)` Retrieves the title of the specified screen as an Item
`static Item`	`getTitleItem(Screen screen)` Retrieves the title of the specified screen as an Item
`static UiEventListener`	`getUiEventListener(Item item)` Retrieves an UiEventListener for the specified item
`static UiEventListener`	`getUiEventListener(Item item)` Retrieves an UiEventListener for the specified item
`static UiEventListener`	`getUiEventListener(Screen screen)` Retrieves an UiEventListener for the specified screen and its items.
`static UiEventListener`	`getUiEventListener(Screen screen)` Retrieves an UiEventListener for the specified screen and its items.
`static boolean`	`handleCommand(Item item, Command cmd)` Asks the specified item to handle the command.
`static boolean`	`handleCommand(Item item, Command cmd)` Asks the specified item to handle the command.
`static boolean`	`handleCommand(Screen screen, Command cmd)` Asks the specified screen to handle the command.
`static boolean`	`handleCommand(Screen screen, Command cmd)` Asks the specified screen to handle the command.
`static boolean`	`handleKeyPressed(Item item, int keyCode, int gameAction)` Forwards a key event to the specified item.
`static boolean`	`handleKeyPressed(Item item, int keyCode, int gameAction)` Forwards a key event to the specified item.
`static boolean`	`handleKeyPressed(Screen screen, int keyCode, int gameAction)` Forwards a key event to the specified screen.
`static boolean`	`handleKeyPressed(Screen screen, int keyCode, int gameAction)` Forwards a key event to the specified screen.
`static boolean`	`handleKeyReleased(Item item, int keyCode, int gameAction)` Forwards a key event to the specified item.
`static boolean`	`handleKeyReleased(Item item, int keyCode, int gameAction)` Forwards a key event to the specified item.
`static boolean`	`handleKeyReleased(Screen screen, int keyCode, int gameAction)` Forwards a key event to the specified screen.
`static boolean`	`handleKeyReleased(Screen screen, int keyCode, int gameAction)` Forwards a key event to the specified screen.
`static boolean`	`handleKeyRepeated(Item item, int keyCode, int gameAction)` Forwards a key event to the specified item.
`static boolean`	`handleKeyRepeated(Item item, int keyCode, int gameAction)` Forwards a key event to the specified item.
`static boolean`	`handleKeyRepeated(Screen screen, int keyCode, int gameAction)` Forwards a key event to the specified screen.
`static boolean`	`handleKeyRepeated(Screen screen, int keyCode, int gameAction)` Forwards a key event to the specified screen.
`static boolean`	`handlePointerDragged(Item item, int x, int y)` Forwards a pointer event to the specified item.
`static boolean`	`handlePointerDragged(Item item, int x, int y)` Forwards a pointer event to the specified item.
`static boolean`	`handlePointerPressed(Item item, int x, int y)` Forwards a pointer event to the specified item.
`static boolean`	`handlePointerPressed(Item item, int x, int y)` Forwards a pointer event to the specified item.
`static boolean`	`handlePointerPressed(Screen screen, int x, int y)` Forwards a key event to the specified screen.
`static boolean`	`handlePointerPressed(Screen screen, int x, int y)` Forwards a key event to the specified screen.
`static boolean`	`handlePointerReleased(Item item, int x, int y)` Forwards a pointer event to the specified item.
`static boolean`	`handlePointerReleased(Item item, int x, int y)` Forwards a pointer event to the specified item.
`static boolean`	`handlePointerReleased(Screen screen, int x, int y)` Forwards a pointer event to the specified screen.
`static boolean`	`handlePointerReleased(Screen screen, int x, int y)` Forwards a pointer event to the specified screen.
`static void`	`hideNotify(Item item)` Calls hide notify on the specified item.
`static void`	`hideNotify(Item item)` Calls hide notify on the specified item.
`static int`	`indexOf(Item item, Screen screen)` Retrieves the index of the specified item in the screen.
`static int`	`indexOf(Item item, Screen screen)` Retrieves the index of the specified item in the screen.
`static int`	`indexOf(Item item, Screen screen)` Retrieves the index of the specified item in the screen.
`static int`	`indexOf(Item item, Screen screen)` Retrieves the index of the specified item in the screen.
`static void`	`init(Item item, int firstLineWidth, int availWidth, int availHeight)` Intializes the specified item with the specified dimensions
`static void`	`init(Item item, int firstLineWidth, int availWidth, int availHeight)` Intializes the specified item with the specified dimensions
`static void`	`init(Screen screen)` Intializes the specified screen
`static boolean`	`isGameActionFire(int keyCode, int gameAction, Screen screen)` Determines whether the given key is really a Canvas.FIRE game action
`static boolean`	`isGameActionFire(int keyCode, int gameAction, Screen screen)` Determines whether the given key is really a Canvas.FIRE game action
`static boolean`	`isMenuOpened(Screen screen)` Checks whether the commands menu of the screen is currently opened.
`static boolean`	`isMenuOpened(Screen screen)` Checks whether the commands menu of the screen is currently opened.
`static boolean`	`isSoftKey(int keyCode, int gameAction, Screen screen)` Determines whether the given key code is a soft key for the given screen.
`static boolean`	`isSoftKey(int keyCode, int gameAction, Screen screen)` Determines whether the given key code is a soft key for the given screen.
`static boolean`	`isSoftKey(int keyCode, Screen screen)` Determines whether the given key code is a soft key for the given screen.
`static boolean`	`isSoftKey(int keyCode, Screen screen)` Determines whether the given key code is the middle soft key for the given screen.
`static boolean`	`isSoftKeyLeft(int keyCode, int gameAction, Screen screen)` Determines whether the given key code is the left soft key for the given screen.
`static boolean`	`isSoftKeyLeft(int keyCode, int gameAction, Screen screen)` Determines whether the given key code is the left soft key for the given screen.
`static boolean`	`isSoftKeyLeft(int keyCode, Screen screen)` Determines whether the given key code is the left soft key for the given screen.
`static boolean`	`isSoftKeyLeft(int keyCode, Screen screen)` Determines whether the given key code is the left soft key for the given screen.
`static boolean`	`isSoftKeyMiddle(int keyCode, int gameAction, Screen screen)` Determines whether the given key code is the middle soft key for the given screen.
`static boolean`	`isSoftKeyMiddle(int keyCode, int gameAction, Screen screen)` Determines whether the given key code is the middle soft key for the given screen.
`static boolean`	`isSoftKeyMiddle(int keyCode, Screen screen)` Determines whether the given key code is the middle soft key for the given screen.
`static boolean`	`isSoftKeyMiddle(int keyCode, Screen screen)` Determines whether the given key code is the middle soft key for the given screen.
`static boolean`	`isSoftKeyRight(int keyCode, int gameAction, Screen screen)` Determines whether the given key code is the right soft key for the given screen.
`static boolean`	`isSoftKeyRight(int keyCode, int gameAction, Screen screen)` Determines whether the given key code is the right soft key for the given screen.
`static boolean`	`isSoftKeyRight(int keyCode, Screen screen)` Determines whether the given key code is the right soft key for the given screen.
`static boolean`	`isSoftKeyRight(int keyCode, Screen screen)` Determines whether the given key code is the right soft key for the given screen.
`static boolean`	`isVisible(Item item)` Gets the visible status of the specified item.
`static boolean`	`isVisible(Item item)` Gets the visible status of the specified item.
`static boolean`	`isVisible(List list, int index)` Gets the visible status of the specified list-item.
`static boolean`	`isVisible(List list, int index)` Gets the visible status of the specified list-item.
`static void`	`notifyItemPressedEnd(Item item)` Makes the notifyItemPressedEnd method publicly available.
`static void`	`notifyItemPressedEnd(Item item)` Makes the notifyItemPressedEnd method publicly available.
`static void`	`notifyItemPressedStart(Item item)` Makes the notifyItemPressedStart method publicly available.
`static void`	`notifyItemPressedStart(Item item)` Makes the notifyItemPressedStart method publicly available.
`static void`	`releaseResources()` Releases all (memory) instensive resources that are currently hold by the J2ME Polish GUI.
`static void`	`releaseResources(Screen screen)` Releases all (memory) instensive resources that are currently hold by the J2ME Polish GUI for the specified screen.
`static void`	`releaseResources(Screen screen)` Releases all (memory) instensive resources that are currently hold by the J2ME Polish GUI for the specified screen.
`static void`	`releaseResourcesOnScreenChange()` Releases all (memory) instensive resources that are currently hold by the J2ME Polish GUI when a non-J2ME Polish screen is shown.
`static void`	`removeAllCommands(Screen screen)` Removes all commands from the given screen This option is only available when the "menu" fullscreen mode is activated.
`static void`	`removeAllCommands(Screen screen)` Removes all commands from the given screen This option is only available when the "menu" fullscreen mode is activated.
`static void`	`removeSubCommand(Command childCommand, Command parentCommand, Screen screen)` Removes the given command as subcommand from the defined screen
`static void`	`removeSubCommand(Command childCommand, Command parentCommand, Screen screen)` Removes the given command as a subcommand from the defined screen
`static void`	`repaint(Item item)` Repaints the specified item
`static void`	`repaint(Item item)` Repaints the specified item
`static void`	`scroll(Screen screen, int yOffset)` Scrolls the screen to the given position.
`static void`	`scroll(Screen screen, int yOffset)` Scrolls the screen to the given position.
`static void`	`scrollTo(Item item)` Scrolls the screen so that the specified item becomes visible.
`static void`	`scrollTo(Item item)` Scrolls the screen so that the specified item becomes visible.
`static void`	`scrollTo(Item item, int position)` Scrolls the screen so that the specified item will be position according to the specified position.
`static void`	`scrollTo(Item item, int position)` Scrolls the screen so that the specified item will be position according to the specified position.
`static void`	`setAccessible(Choice choice, int itemIndex, boolean isAccessible)` Makes the specified List or ChoiceGroup item selectable or inaccessible - can be used in combination with a #style preprocessing directive.
`static void`	`setAccessible(Choice choice, int itemIndex, boolean isAccessible)` Makes the specified List item selectable or inaccessible - can be used in combination with a #style preprocessing directive.
`static void`	`setAccessible(Choice choice, int itemIndex, boolean isAccessible, Style style)` Makes the specified List or ChoiceGroup item selectable or inaccessible.
`static void`	`setAccessible(Item item, boolean isAccessible)` Makes the item interactive (accessible) or non-interactive.
`static void`	`setAccessible(Item item, boolean isAccessible)` Makes the item interactive (accessible) or non-interactive.
`static void`	`setAccessible(Item item, boolean isAccessible, Style style)` Makes the item interactive (accessible) or non-interactive.
`static void`	`setAccessible(Screen screen, Command command, boolean isAccessible)` Makes the command interactive (accessible) or non-interactive.
`static void`	`setAccessible(Screen screen, Command command, boolean isAccessible)` Makes the command interactive (accessible) or non-interactive.
`static void`	`setAccessible(Screen screen, Command command, boolean isAccessible)` Makes the item interactive (accessible) or non-interactive.
`static void`	`setAccessible(Screen screen, Command command, boolean isAccessible, Style style)` Makes the item interactive (accessible) or non-interactive.
`static void`	`setAttribute(Item item, Object key, Object value)` Sets an arbitrary attribute for the given item.
`static void`	`setAttribute(Item item, Object key, Object value)` Sets an arbitrary attribute for the given item.
`static void`	`setAttribute(List list, int index, Object key, Object value)` Sets an arbitrary attribute for the specified list item.
`static void`	`setAttribute(List list, int index, Object key, Object value)` Sets an arbitrary attribute for the specified list item.
`static void`	`setBackground(Item item, Background background)` Sets the background for the given item.
`static void`	`setBackground(Item item, Background background)` Sets the background for the given item.
`static void`	`setBackground(Screen screen, Background background)` Sets the background for the given screen.
`static void`	`setBackground(Screen screen, Background background)` Sets the background for the given screen.
`static void`	`setCaretPosition(TextBox box, int position)` Sets the caret position in the given text box.
`static void`	`setCaretPosition(TextBox box, int position)` Sets the caret position in the given text box.
`static void`	`setCaretPosition(TextField field, int position)` Sets the caret position in the given text field.
`static void`	`setCaretPosition(TextField field, int position)` Sets the caret position in the given text field.
`static void`	`setChoiceGroupItem(ChoiceGroup ChoiceGroup, int index, ChoiceItem item)` Sets a ChoiceItem or a subclass for the given ChoiceGroup.
`static void`	`setChoiceGroupItem(ChoiceGroup ChoiceGroup, int index, ChoiceItem item)` Sets a ChoiceItem or a subclass for the given ChoiceGroup.
`static void`	`setCommandLabel(Command command, String label)` Changes the shown label of the specified command.
`static void`	`setCommandLabel(Screen screen, Command command, String label)` Changes the shown label of the specified command.
`static void`	`setCommandLabel(Screen screen, Command command, String label)` Changes the shown label of the specified command.
`static void`	`setCommandLabel(Screen screen, Command command, String label)` Changes the shown label of the specified command.
`static void`	`setCurrentListIndex(Display display, List list, int index)` Sets the focus to the given index of the specified list.
`static void`	`setCurrentListIndex(Display display, List list, int index)` Sets the focus to the given index of the specified list.
`static void`	`setCycling(Container container, boolean cycling)` Specifies if the given contain is allowed to cycle through its items.
`static void`	`setCycling(FramedForm form, boolean cycling)` Specifies if the given FramedForm is allowed to cycle through its items.
`static void`	`setData(Screen screen, Object data)` Attaches data to the specified screen.
`static void`	`setData(Screen screen, Object data)` Attaches data to the specified screen.
`void`	`setEventHandled(CustomItem item)` Notifies the specified CustomItem that a key or pointer event has been processed and that it should not be processed by other components.
`void`	`setEventHandled(CustomItem item)` Notifies the specified CustomItem that a key or pointer event has been processed and that it should not be processed by other components.
`static void`	`setFocusedIndex(Screen screen, int index)` Sets the focused index of the specified screen
`static void`	`setFocusedIndex(Screen screen, int index)` Sets the focused index of the specified screen
`static void`	`setFocusedItem(Screen screen, Item item)` Sets the focused item of the specified screen
`static void`	`setFocusedItem(Screen screen, Item item)` Sets the focused item of the specified screen
`static void`	`setFullScreenMode(Screen screen, boolean fullScreen)` Sets the fullscreen mode of the screen.
`static void`	`setFullScreenMode(Screen screen, boolean fullScreen)` Sets the fullscreen mode of the screen.
`static void`	`setInputMode(TextBox box, int inputMode)` Sets the input mode for the given textbox.
`static void`	`setInputMode(TextBox box, int inputMode)` Sets the input mode for the given textbox.
`static void`	`setInputMode(TextField field, int inputMode)` Sets the input mode for the given textfield.
`static void`	`setInputMode(TextField field, int inputMode)` Sets the input mode for the given textfield.
`static void`	`setItemScreen(Item item, Screen screen)` Sets the 'screen' property of the specified item to the given item
`static void`	`setItemScreen(Item item, Screen screen)` Sets the 'screen' property of the specified item to the given item
`static void`	`setItemStateListener(Item item, ItemStateListener listener)` Sets an ItemStateListener specifically for this item.
`static void`	`setItemStateListener(Item item, ItemStateListener listener)` Sets an ItemStateListener specifically for this item.
`static void`	`setListItem(List list, int index, ChoiceItem item)` Sets a ChoiceItem or a subclass for the given list.
`static void`	`setListItem(List list, int index, ChoiceItem item)` Sets a ChoiceItem or a subclass for the given list.
`static void`	`setMenuBarStyle(Screen screen)` Set the style of the specified screen's menubar.
`static void`	`setMenuBarStyle(Screen screen)` Set the style of the specified screen's menubar.
`static void`	`setMenuBarStyle(Screen screen, Style style)` Set the style of the specified screen's menubar.
`static void`	`setMenuBarStyle(Screen screen, Style style)` Set the style of the specified screen's menubar.
`static void`	`setNoNewLine(TextField textField, boolean noNewLine)` Set if the textfield should accept the enter key as an input which results in a new line.
`static void`	`setNoNewLine(TextField textField, boolean noNewLine)` Set if the textfield should accept the enter key as an input which results in a new line.
`static void`	`setNumberOfDecimalFractions(TextField field, int number)` Sets the number of decimal fractions that are allowed for FIXED_POINT_DECIMAL constrained TextFields
`static void`	`setNumberOfDecimalFractions(TextField field, int number)` Sets the number of decimal fractions that are allowed for FIXED_POINT_DECIMAL constrained TextFields
`static void`	`setParent(Item child, Item parent)` Sets the parent for the given child item.
`static void`	`setParent(Item child, Item parent)` Sets the parent for the given child item.
`static void`	`setParent(Item child, Item parent)` Sets the parent for the given child item.
`static void`	`setPredictiveDictionary(TextField field, String[] words)` Allows the given words for the specified textfield.
`static void`	`setPredictiveDictionary(TextField field, String[] words)` Allows the given words for the specified textfield.
`static void`	`setScreenOrientation(int degrees)` Sets the screen orientation in 90 degrees steps.
`static void`	`setScreenOrientation(Screen screen, int degrees)` Deprecated. use setScreenOrientation(int degress) instead
`static void`	`setScreenOrientation(Screen screen, int degrees)` Deprecated. use setScreenOrientation(int degress) instead
`static void`	`setScreenStateListener(Screen screen, ScreenStateListener listener)` Registers a ScreenStateListener to any J2ME Polish screen.
`static void`	`setScreenStateListener(Screen screen, ScreenStateListener listener)` Registers a ScreenStateListener to any J2ME Polish screen.
`static void`	`setStyle(Alert screen)` Applies a style to the given alert if used in conjunction with the //#style preprocessing directive.
`static void`	`setStyle(Alert screen, Style style)` Applies a style to the given alert if used in conjunction with the //#style preprocessing directive.
`static void`	`setStyle(Command command)` Applies a style to the specified command.
`static void`	`setStyle(Item item)` Applies a style to the given item if used in conjunction with the //#style preprocessing directive.
`static void`	`setStyle(Item item)` Applies a style to the given item if used in conjunction with the //#style preprocessing directive.
`static void`	`setStyle(Item item, Style style)` Applies a style to the given item if used in conjunction with the //#style preprocessing directive.
`static void`	`setStyle(Item item, Style style)` Applies a style to the given item.
`static void`	`setStyle(List list, int itemIndex)` Applies a style to the specified list item.
`static void`	`setStyle(List list, int itemIndex)` Applies a style to the specified list item.
`static void`	`setStyle(List list, int itemIndex, Style style)` Applies a style to the specified list item.
`static void`	`setStyle(Screen screen)` Applies a style to the given screen if used in conjunction with the //#style preprocessing directive.
`static void`	`setStyle(Screen screen)` Applies a style to the given screen if used in conjunction with the //#style preprocessing directive.
`static void`	`setStyle(Screen screen, Style style)` Applies a style to the given screen.
`static void`	`setSubtitle(Screen screen, Item subtitle)` Sets the subtitle for the specified screen
`static void`	`setSubtitle(Screen screen, Item subtitle)` Sets the subtitle for the specified screen
`static void`	`setSubtitle(Screen screen, String subtitle)` Sets the subtitle for the specified screen
`static void`	`setSubtitle(Screen screen, String subtitle)` Sets the subtitle for the specified screen
`static void`	`setSubtitle(Screen screen, String subtitle, Style style)` Sets the subtitle for the specified screen
`static void`	`setSubtitle(Screen screen, String subtitle, Style style)` Sets the subtitle for the specified screen
`static void`	`setSuppressCommands(TextField field, boolean suppress)` Can be used to deactivate or activate commands for a specific TextField.
`static void`	`setSuppressCommands(TextField field, boolean suppress)` Can be used to deactivate or activate commands for a specific TextField.
`static void`	`setTextEffect(StringItem item, TextEffect effect)` Specifies a new text effect for the specified string item.
`static void`	`setTextEffect(StringItem item, TextEffect effect)` Specifies a new text effect for the specified string item.
`static void`	`setTextfieldHelp(TextField field, String text)` Sets the help text for the specified TextField.
`static void`	`setTextfieldHelp(TextField field, String text)` Sets the help text for the specified TextField.
`static void`	`setTextfieldInfo(TextField field, String info)`
`static void`	`setTextfieldInfo(TextField field, String info)`
`static void`	`setTextfieldInfoItem(TextField field, StringItem infoItem)` Sets the item responsible for displaying the current input mode like Abc, ABC, 123, and so on.
`static void`	`setTextfieldInfoItem(TextField field, StringItem infoItem)` Sets the item responsible for displaying the current input mode like Abc, ABC, 123, and so on.
`static void`	`setTickerImage(Ticker ticker, Image image)` Sets an image for the specified ticker.
`static void`	`setTickerImage(Ticker ticker, Image image)` Sets an image for the specified ticker.
`static void`	`setTitle(Screen screen, Item title)` Sets the title of the screen using an Item.
`static void`	`setTitle(Screen screen, Item title)` Sets the title of the screen using an Item.
`static void`	`setTitle(Screen screen, Item title)` Sets the title of the screen using an Item.
`static void`	`setTitle(Screen screen, Item title)`
`static void`	`setTitle(Screen screen, Item title, Style style)` Sets the title of the screen using an Item.
`static void`	`setTitle(Screen screen, Item title, Style style)` Sets the title of the screen using an Item.
`static void`	`setUiEventListener(Item item, UiEventListener listener)` Sets an UiEventListener for the specified item and its children.
`static void`	`setUiEventListener(Item item, UiEventListener listener)` Sets an UiEventListener for the specified item and its children.
`static void`	`setUiEventListener(Screen screen, UiEventListener listener)` Sets an UiEventListener for the specified screen and its items.
`static void`	`setUiEventListener(Screen screen, UiEventListener listener)` Sets an UiEventListener for the specified screen and its items.
`static void`	`setUserInputValidator(Display.UserInputValidator validator)` Sets the key validator for the current display.
`static void`	`setVisible(Item item, boolean visible)` Sets the invisible status of the specified item.
`static void`	`setVisible(Item item, boolean visible)` Sets the visible status of the specified item.
`static void`	`setVisible(List list, int index, boolean visible)` Sets the invisible status of the specified list-item.
`static void`	`setVisible(List list, int index, boolean visible)` Sets the invisible status of the specified list-item.
`static void`	`setWordNotFound(TextField field, Alert alert)` Set the word-not-found box in the textfield
`static void`	`setWordNotFound(TextField field, Alert alert)` Set the word-not-found box in the textfield
`static void`	`showNotify(Item item)` Calls show notify on the specified item.
`static void`	`showNotify(Item item)` Calls show notify on the specified item.
`static void`	`showNotify(Screen screen, Item item)` Calls show notify on the specified item.
`static void`	`showNotify(Screen screen, Item item)` Calls show notify on the specified item.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

UP_PRESSED

public static final int UP_PRESSED

The bit representing the UP key. This constant has a value of 0x0002 (1 << Canvas.UP).

See Also:: getKeyStates(), Constant Field Values

DOWN_PRESSED

public static final int DOWN_PRESSED

The bit representing the DOWN key. This constant has a value of 0x0040 (1 << Canvas.DOWN).

See Also:: getKeyStates(), Constant Field Values

LEFT_PRESSED

public static final int LEFT_PRESSED

The bit representing the LEFT key. This constant has a value of 0x0004 (1 << Canvas.LEFT).

See Also:: getKeyStates(), Constant Field Values

RIGHT_PRESSED

public static final int RIGHT_PRESSED

The bit representing the RIGHT key. This constant has a value of 0x0020 (1 << Canvas.RIGHT).

See Also:: getKeyStates(), Constant Field Values

FIRE_PRESSED

public static final int FIRE_PRESSED

The bit representing the FIRE key. This constant has a value of 0x0100 (1 << Canvas.FIRE).

See Also:: getKeyStates(), Constant Field Values

GAME_A_PRESSED

public static final int GAME_A_PRESSED

The bit representing the GAME_A key (may not be supported on all devices). This constant has a value of 0x0200 (1 << Canvas.GAME_A).

See Also:: getKeyStates(), Constant Field Values

GAME_B_PRESSED

public static final int GAME_B_PRESSED

The bit representing the GAME_B key (may not be supported on all devices). This constant has a value of 0x0400 (1 << Canvas.GAME_B).

See Also:: getKeyStates(), Constant Field Values

GAME_C_PRESSED

public static final int GAME_C_PRESSED

The bit representing the GAME_C key (may not be supported on all devices). This constant has a value of 0x0800 (1 << Canvas.GAME_C).

See Also:: getKeyStates(), Constant Field Values

GAME_D_PRESSED

public static final int GAME_D_PRESSED

The bit representing the GAME_D key (may not be supported on all devices). This constant has a value of 0x1000 (1 << Canvas.GAME_D).

See Also:: getKeyStates(), Constant Field Values

MODE_LOWERCASE

public static final int MODE_LOWERCASE

A constant for setting the input mode of an TextField to lowercase.

See Also:: setInputMode(javax.microedition.lcdui.TextField, int), Constant Field Values

MODE_FIRST_UPPERCASE

public static final int MODE_FIRST_UPPERCASE

A constant for setting the input mode of an TextField to uppercase for the first character, followed by lowercase characters.

See Also:: setInputMode(javax.microedition.lcdui.TextField, int), Constant Field Values

MODE_UPPERCASE

public static final int MODE_UPPERCASE

A constant for setting the input mode of an TextField to uppercase.

See Also:: setInputMode(javax.microedition.lcdui.TextField, int), Constant Field Values

MODE_NUMBERS

public static final int MODE_NUMBERS

A constant for setting the input mode of an TextField to numbers.

See Also:: setInputMode(javax.microedition.lcdui.TextField, int), Constant Field Values

MODE_NATIVE

public static final int MODE_NATIVE

A constant for setting the input mode of an TextField to it't native input - that's useful for using T9 and similar input helpers.

See Also:: setInputMode(javax.microedition.lcdui.TextField, int), Constant Field Values

CONSTRAINT_FIXED_POINT_DECIMAL

public static final int CONSTRAINT_FIXED_POINT_DECIMAL

A constant for using the FIXED_POINT_DECIMAL constraint on TextFields. Sample usage:

 TextField cashRegister = new TextField("Price: ",  null, 5, UiAccess.CONSTRAINT_FIXED_POINT_DECIMAL );

See Also:: TextField.FIXED_POINT_DECIMAL, setNumberOfDecimalFractions(TextField, int), getNumberOfDecimalFractions(TextField), Constant Field Values

Method Detail

getKeyStates

public static int getKeyStates()

Gets the states of the physical game keys. Each bit in the returned integer represents a specific key on the device. A key's bit will be 1 if the key is currently down or has been pressed at least once since the last time this method was called. The bit will be 0 if the key is currently up and has not been pressed at all since the last time this method was called. This latching behavior ensures that a rapid key press and release will always be caught by an application loop, regardless of how slowly the loop runs.

For example:

 
 // Get the key state and store it
 int keyState = getKeyStates();
 if ((keyState & UiAccess.LEFT_KEY) != 0) {
                positionX--;
 }
 else if ((keyState & UiAccess.RIGHT_KEY) != 0) {
                positionX++;
 }

Calling this method has the side effect of clearing any latched state. Another call to getKeyStates immediately after a prior call will therefore report the system's best idea of the current state of the keys, the latched bits having been cleared by the first call.

On J2ME Polish this method is implemented by monitoring key press and release events. Thus the state reported by getKeyStates might lag the actual state of the physical keys since the timeliness of the key information is be subject to the capabilities of each device. Also, some devices may be incapable of detecting simultaneous presses of multiple keys.

This method returns 0 unless the GameCanvas is currently visible as reported by Displayable.isShown(). Upon becoming visible, a GameCanvas will initially indicate that all keys are unpressed (0); if a key is held down while the GameCanvas is being shown, the key must be first released and then pressed in order for the key press to be reported by the GameCanvas.

Returns:: An integer containing the key state information (one bit per key), or 0 if the J2ME Polish is not used or there is no current screen
See Also:: UP_PRESSED, DOWN_PRESSED, LEFT_PRESSED, RIGHT_PRESSED, FIRE_PRESSED, GAME_A_PRESSED, GAME_B_PRESSED, GAME_C_PRESSED, GAME_D_PRESSED

setScreenStateListener

public static void setScreenStateListener(Screen screen,
                                          ScreenStateListener listener)

Registers a ScreenStateListener to any J2ME Polish screen.

Parameters:: screen - the screen; listener - the listener

setScreenStateListener

public static void setScreenStateListener(Screen screen,
                                          ScreenStateListener listener)

Registers a ScreenStateListener to any J2ME Polish screen.

Parameters:: screen - the screen; listener - the listener

getFocusedIndex

public static int getFocusedIndex(Screen screen)

Retrieves the focused index of the specified screen

Parameters:: screen - the screen
Returns:: the focused index, -1 when it is not known

getFocusedIndex

public static int getFocusedIndex(Screen screen)

Retrieves the focused index of the specified screen

Parameters:: screen - the screen
Returns:: the focused index, -1 when it is not known

getFocusedIndex

public static int getFocusedIndex(ChoiceGroup group)

Retrieves the currently focused item of the specified ChoiceGroup

Parameters:: group - the group
Returns:: the index of the currently focused item, -1 if none is focused

getFocusedIndex

public static int getFocusedIndex(ChoiceGroup group)

Retrieves the currently focused item of the specified ChoiceGroup

Parameters:: group - the group
Returns:: the index of the currently focused item, -1 if none is focused

getFocusedItem

public static Item getFocusedItem(Screen screen)

Retrieves the focused index of the specified screen

Parameters:: screen - the screen
Returns:: the focused item, null when it is not known

getFocusedItem

public static Item getFocusedItem(Screen screen)

Retrieves the focused index of the specified screen

Parameters:: screen - the screen
Returns:: the focused item, null when it is not known

setFocusedIndex

public static void setFocusedIndex(Screen screen,
                                   int index)

Sets the focused index of the specified screen

Parameters:: screen - the screen; index - the focused index, -1 when none should be focused

setFocusedIndex

public static void setFocusedIndex(Screen screen,
                                   int index)

Sets the focused index of the specified screen

Parameters:: screen - the screen; index - the focused index, -1 when none should be focused

setFocusedItem

public static void setFocusedItem(Screen screen,
                                  Item item)

Sets the focused item of the specified screen

Parameters:: screen - the screen; item - the focused item, null when none should be focused

setFocusedItem

public static void setFocusedItem(Screen screen,
                                  Item item)

Sets the focused item of the specified screen

Parameters:: screen - the screen; item - the focused item, null when none should be focused

setTitle

public static void setTitle(Screen screen,
                            Item title)

Sets the title of the screen using an Item. important: you cannot call screen.setTitle(String) afterwards anymore!

Parameters:: screen - the screen for which the title should be replaced; title - the element responsible for painting the title.
See Also:: getTitleItem(javax.microedition.lcdui.Screen)

setTitle

public static void setTitle(Screen screen,
                            Item title)

Sets the title of the screen using an Item. important: you cannot call screen.setTitle(String) afterwards anymore!

Parameters:: screen - the screen for which the title should be replaced; title - the element responsible for painting the title.
See Also:: getTitleItem(Screen)

setTitle

public static void setTitle(Screen screen,
                            Item title,
                            Style style)

Sets the title of the screen using an Item. important: you cannot call screen.setTitle(String) afterwards anymore! This method is meant to be used in conjunction with the //#style preprocessing directive.

Parameters:: screen - the screen for which the title should be replaced; title - the element responsible for painting the title.; style - the style for the title
See Also:: getTitleItem(Screen)

setTitle

public static void setTitle(Screen screen,
                            Item title)

Sets the title of the screen using an Item. important: you cannot call screen.setTitle(String) afterwards anymore!

Parameters:: screen - the screen for which the title should be replaced; title - the element responsible for painting the title.
See Also:: getTitleItem(javax.microedition.lcdui.Screen)

setTitle

public static void setTitle(Screen screen,
                            Item title)

setTitle

public static void setTitle(Screen screen,
                            Item title,
                            Style style)

Parameters:: screen - the screen for which the title should be replaced; title - the element responsible for painting the title.; style - the style for the title
See Also:: getTitleItem(javax.microedition.lcdui.Screen)

setFullScreenMode

public static void setFullScreenMode(Screen screen,
                                     boolean fullScreen)

Sets the fullscreen mode of the screen. The title and the menubar will be hidden by this call.

Parameters:: screen - the screen; fullScreen - true when the fullscreen mode should be entered

setFullScreenMode

public static void setFullScreenMode(Screen screen,
                                     boolean fullScreen)

Sets the fullscreen mode of the screen. The title and the menubar will be hidden by this call.

Parameters:: screen - the screen; fullScreen - true when the fullscreen mode should be entered

addItemCommand

public static void addItemCommand(List list,
                                  int index,
                                  Command command)

Adds a command to a list item. Warning: this method won't add any commands when the J2ME Polish GUI is not activated.

Parameters:: list - the list; index - the index of the item; command - the item command

addItemCommand

public static void addItemCommand(List list,
                                  int index,
                                  Command command)

Adds a command to a list item. Warning: this method won't add any commands when the J2ME Polish GUI is not activated.

Parameters:: list - the list; index - the index of the item; command - the item command

setParent

public static void setParent(Item child,
                             Item parent)

Sets the parent for the given child item.

Parameters:: child - the child; parent - the parent

setParent

public static void setParent(Item child,
                             Item parent)

Sets the parent for the given child item.

Parameters:: child - the child; parent - the parent

setParent

public static void setParent(Item child,
                             Item parent)

Sets the parent for the given child item.

Parameters:: child - the child; parent - the parent

getInternalX

public static int getInternalX(Item item)

Retrieves the internal x position of the given item. When it is equal -9999 this item's internal position is not known. The internal position is useful for items that have a large content which needs to be scrolled, e.g. containers.

Parameters:: item - the item
Returns:: the internal x position of this item's currently selected content, -9999 when it is unknown.

getInternalY

public static int getInternalY(Item item)

Retrieves the internal y position of the given item. The internal position is useful for items that have a large content which needs to be scrolled, e.g. containers.

Parameters:: item - the item
Returns:: the internal y position of this item's currently selected content.
See Also:: getInternalX(javax.microedition.lcdui.Item)

getInternalWidth

public static int getInternalWidth(Item item)

Retrieves the internal width of the given item. The internal position is useful for items that have a large content which needs to be scrolled, e.g. containers.

Parameters:: item - the item
Returns:: the internal width of this item's currently selected content.
See Also:: getInternalX(javax.microedition.lcdui.Item)

getInternalHeight

public static int getInternalHeight(Item item)

Retrieves the internal height of the given item. The internal position is useful for items that have a large content which needs to be scrolled, e.g. containers.

Parameters:: item - the item
Returns:: the internal height of this item's currently selected content.
See Also:: getInternalX(javax.microedition.lcdui.Item)

getInternalX

public static int getInternalX(Item item)

Retrieves the internal x position of the given item. When it is equal Item.NO_POSITION_SET / -9999 this item's internal position is not known. The internal position is useful for items that have a large content which needs to be scrolled, e.g. containers.

Parameters:: item - the item
Returns:: the internal x position of this item's currently selected content, -9999 / Item.NO_POSITION_SET when it is unknown.

getInternalY

public static int getInternalY(Item item)

Retrieves the internal y position of the given item. The internal position is useful for items that have a large content which needs to be scrolled, e.g. containers.

Parameters:: item - the item
Returns:: the internal y position of this item's currently selected content.
See Also:: getInternalX(Item)

getInternalWidth

public static int getInternalWidth(Item item)

Retrieves the internal width of the given item. The internal position is useful for items that have a large content which needs to be scrolled, e.g. containers.

Parameters:: item - the item
Returns:: the internal width of this item's currently selected content.
See Also:: getInternalX(Item)

getInternalHeight

public static int getInternalHeight(Item item)

Retrieves the internal height of the given item. The internal position is useful for items that have a large content which needs to be scrolled, e.g. containers.

Parameters:: item - the item
Returns:: the internal height of this item's currently selected content.
See Also:: getInternalX(Item)

focus

public static Style focus(Item item,
                          int direction,
                          Style style)

Focusses the given item with the specified style.

Parameters:: item - the item that should be focussed; direction - the direction from which the focus comes, e.g. Canvas.DOWN, Canvas.UP or 0.; style - the style - use null when the item's focussed style should be used
Returns:: the previously assigned style of that item

defocus

public static void defocus(Item item,
                           Style style)

Defocuses the given item and sets the style to the specified one.

Parameters:: item - the item; style - the style

setCurrentListIndex

public static void setCurrentListIndex(Display display,
                                       List list,
                                       int index)

Sets the focus to the given index of the specified list. When the list is not shown, it will be shown in this call. When the J2ME Polish GUI is not used, only the list will be shown.

Parameters:: display - the display; list - the list; index - the index

setCurrentListIndex

public static void setCurrentListIndex(Display display,
                                       List list,
                                       int index)

Sets the focus to the given index of the specified list. When the list is not shown, it will be shown in this call. When the J2ME Polish GUI is not used, only the list will be shown.

Parameters:: display - the display; list - the list; index - the index

setListItem

public static void setListItem(List list,
                               int index,
                               ChoiceItem item)

Sets a ChoiceItem or a subclass for the given list.

Parameters:: list - the list; index - the index of the item that should be exchanged; item - the new item

getListItem

public static ChoiceItem getListItem(List list,
                                     int index)

Retrieves a ChoiceItem or a subclass for the given list.

Parameters:: list - the list; index - the index of the item that should be returned
Returns:: the item at the given position

appendListItem

public static void appendListItem(List list,
                                  ChoiceItem item)

Sets a ChoiceItem or a subclass for the given list.

Parameters:: list - the list; item - the new item

setListItem

public static void setListItem(List list,
                               int index,
                               ChoiceItem item)

Sets a ChoiceItem or a subclass for the given list.

Parameters:: list - the list; index - the index of the item that should be exchanged; item - the new item

getListItem

public static ChoiceItem getListItem(List list,
                                     int index)

Retrieves a ChoiceItem or a subclass for the given list.

Parameters:: list - the list; index - the index of the item that should be returned
Returns:: the item at the given position

appendListItem

public static void appendListItem(List list,
                                  ChoiceItem item)

Sets a ChoiceItem or a subclass for the given list.

Parameters:: list - the list; item - the new item

setChoiceGroupItem

public static void setChoiceGroupItem(ChoiceGroup ChoiceGroup,
                                      int index,
                                      ChoiceItem item)

Sets a ChoiceItem or a subclass for the given ChoiceGroup.

Parameters:: ChoiceGroup - the ChoiceGroup; index - the index of the item that should be exchanged; item - the new item

getChoiceGroupItem

public static ChoiceItem getChoiceGroupItem(ChoiceGroup ChoiceGroup,
                                            int index)

Retrieves a ChoiceItem or a subclass for the given ChoiceGroup.

Parameters:: ChoiceGroup - the ChoiceGroup; index - the index of the item that should be returned
Returns:: the item at the given position

appendChoiceGroupItem

public static void appendChoiceGroupItem(ChoiceGroup ChoiceGroup,
                                         ChoiceItem item)

Appends a ChoiceItem or a subclass to the given ChoiceGroup.

Parameters:: ChoiceGroup - the ChoiceGroup; item - the new item

setChoiceGroupItem

public static void setChoiceGroupItem(ChoiceGroup ChoiceGroup,
                                      int index,
                                      ChoiceItem item)

Sets a ChoiceItem or a subclass for the given ChoiceGroup.

Parameters:: ChoiceGroup - the ChoiceGroup; index - the index of the item that should be exchanged; item - the new item

getChoiceGroupItem

public static ChoiceItem getChoiceGroupItem(ChoiceGroup ChoiceGroup,
                                            int index)

Retrieves a ChoiceItem or a subclass for the given ChoiceGroup.

Parameters:: ChoiceGroup - the ChoiceGroup; index - the index of the item that should be returned
Returns:: the item at the given position

appendChoiceGroupItem

public static void appendChoiceGroupItem(ChoiceGroup ChoiceGroup,
                                         ChoiceItem item)

Sets a ChoiceItem or a subclass for the given ChoiceGroup.

Parameters:: ChoiceGroup - the ChoiceGroup; item - the new item

setStyle

public static void setStyle(Item item)

Applies a style to the given item if used in conjunction with the //#style preprocessing directive. Example:

 //#style myStyle
 UiAccess.setStyle( myItem );

Parameters:: item - the item which should get the new style

setStyle

public static void setStyle(Item item,
                            Style style)

Applies a style to the given item if used in conjunction with the //#style preprocessing directive. Example:

 //#style myStyle
 UiAccess.setStyle( myItem );

Parameters:: item - the item which should get the new style; style - the style for the item

setStyle

public static void setStyle(Screen screen)

Applies a style to the given screen if used in conjunction with the //#style preprocessing directive. Example:

 //#style myStyle
 UiAccess.setStyle( myScreen );

Parameters:: screen - the screen which should get the new style

setStyle

public static void setStyle(Alert screen)

Applies a style to the given alert if used in conjunction with the //#style preprocessing directive. Example:

 //#style myStyle
 UiAccess.setStyle( myAlert );

Parameters:: screen - the alert which should get the new style

setStyle

public static void setStyle(Alert screen,
                            Style style)

Applies a style to the given alert if used in conjunction with the //#style preprocessing directive. Example:

 //#style myStyle
 UiAccess.setStyle( myAlert );

Parameters:: screen - the alert which should get the new style; style - the style for the alert

setStyle

public static void setStyle(Item item)

Applies a style to the given item if used in conjunction with the //#style preprocessing directive. Example:

 //#style myStyle
 UiAccess.setStyle( myItem );

Parameters:: item - the item which should get the new style

setStyle

public static void setStyle(Screen screen)

Applies a style to the given screen if used in conjunction with the //#style preprocessing directive. Example:

 //#style myStyle
 UiAccess.setStyle( myScreen );

Parameters:: screen - the screen which should get the new style

setStyle

public static void setStyle(Item item,
                            Style style)

Applies a style to the given item.

Parameters:: item - the item which should get the new style; style - the style

setStyle

public static void setStyle(Screen screen,
                            Style style)

Applies a style to the given screen.

Parameters:: screen - the screen which should get the new style; style - the style

setStyle

public static void setStyle(List list,
                            int itemIndex)

Applies a style to the specified list item.

Parameters:: list - the list; itemIndex - the index of the list

setStyle

public static void setStyle(List list,
                            int itemIndex)

Applies a style to the specified list item.

Parameters:: list - the list; itemIndex - the index of the list

setStyle

public static void setStyle(List list,
                            int itemIndex,
                            Style style)

Applies a style to the specified list item.

Parameters:: list - the list; itemIndex - the index of the list; style - the new style of the item

setStyle

public static void setStyle(Command command)

Applies a style to the specified command.

Parameters:: command - the command

getStyle

public static Style getStyle(Item item)

Gets the current style of the given item. Example:

 //#if polish.usePolishGui
        Style style = UiAccess.getStyle( myItem );
        if (style != null) }
                style.background = new SimpleBackground( 0x00FF00 );
  }
 //#endif

Note: this method is only available when the J2ME Polish GUI is used, so you better check for the polish.usePolishGui prepocessing symbol.

Parameters:: item - the item of which the style should be retrieved
Returns:: the style of the item

getStyle

public static Style getStyle(Screen screen)

Gets the current style of the given screen. Example:

 //#if polish.usePolishGui
        Style style = UiAccess.getStyle( myScreen );
        if (style != null) }
                style.background = new SimpleBackground( 0x00FF00 );
  }
 //#endif

Note: this method is only available when the J2ME Polish GUI is used, so you better check for the polish.usePolishGui prepocessing symbol.

Parameters:: screen - the screen of which the style should be retrieved
Returns:: the style of the screen

getStyle

public static Style getStyle(Item item)

Gets the current style of the given item. Example:

 //#if polish.usePolishGui
        Style style = UiAccess.getStyle( myItem );
        if (style != null) }
                style.background = new SimpleBackground( 0x00FF00 );
  }
 //#endif

Note: this method is only available when the J2ME Polish GUI is used, so you better check for the polish.usePolishGui prepocessing symbol.

Parameters:: item - the item of which the style should be retrieved
Returns:: the style of the item

getStyle

public static Style getStyle(Screen screen)

Gets the current style of the given screen. Example:

 //#if polish.usePolishGui
        Style style = UiAccess.getStyle( myScreen );
        if (style != null) }
                style.background = new SimpleBackground( 0x00FF00 );
  }
 //#endif

Note: this method is only available when the J2ME Polish GUI is used, so you better check for the polish.usePolishGui prepocessing symbol.

Parameters:: screen - the screen of which the style should be retrieved
Returns:: the style of the screen

handleKeyPressed

public static boolean handleKeyPressed(Item item,
                                       int keyCode,
                                       int gameAction)

Forwards a key event to the specified item. The handleKeyPressed call is protected, this is an public accessor for any item.

Parameters:: item - the item; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the item

handleKeyPressed

public static boolean handleKeyPressed(Item item,
                                       int keyCode,
                                       int gameAction)

Forwards a key event to the specified item. The handleKeyPressed call is protected, this is an public accessor for any item.

Parameters:: item - the item; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the item

handleKeyReleased

public static boolean handleKeyReleased(Item item,
                                        int keyCode,
                                        int gameAction)

Forwards a key event to the specified item. The handleKeyReleased call is protected, this is an public accessor for any item.

Parameters:: item - the item; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the item

handleKeyReleased

public static boolean handleKeyReleased(Item item,
                                        int keyCode,
                                        int gameAction)

Forwards a key event to the specified item. The handleKeyPressed call is protected, this is an public accessor for any item.

Parameters:: item - the item; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the item

handleKeyRepeated

public static boolean handleKeyRepeated(Item item,
                                        int keyCode,
                                        int gameAction)

Forwards a key event to the specified item. The handleKeyRepeated call is protected, this is an public accessor for any item.

Parameters:: item - the item; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the item

handleKeyRepeated

public static boolean handleKeyRepeated(Item item,
                                        int keyCode,
                                        int gameAction)

Forwards a key event to the specified item. The handleKeyPressed call is protected, this is an public accessor for any item.

Parameters:: item - the item; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the item

handlePointerPressed

public static boolean handlePointerPressed(Item item,
                                           int x,
                                           int y)

Forwards a pointer event to the specified item. The handlePointerPressed call is protected, this is an public accessor for any item.

Parameters:: item - the item; x - the x position of the pointer position relative to this item's left position; y - the y position of the pointer position relative to this item's top position
Returns:: true when the event has been consumed by the item

handlePointerPressed

public static boolean handlePointerPressed(Item item,
                                           int x,
                                           int y)

Forwards a pointer event to the specified item. The handlePointerPressed call is protected, this is an public accessor for any item.

Parameters:: item - the item; x - the x position of the pointer position relative to this item's left position; y - the y position of the pointer position relative to this item's top position
Returns:: true when the event has been consumed by the item

handlePointerDragged

public static boolean handlePointerDragged(Item item,
                                           int x,
                                           int y)

Forwards a pointer event to the specified item. The handlePointerDragged call is protected, this is an public accessor for any item.

Parameters:: item - the item; x - the x position of the pointer position relative to this item's left position; y - the y position of the pointer position relative to this item's top position
Returns:: true when the event has been consumed by the item

handlePointerDragged

public static boolean handlePointerDragged(Item item,
                                           int x,
                                           int y)

Forwards a pointer event to the specified item. The handlePointerDragged call is protected, this is an public accessor for any item.

Parameters:: item - the item; x - the x position of the pointer position relative to this item's left position; y - the y position of the pointer position relative to this item's top position
Returns:: true when the event has been consumed by the item

handlePointerReleased

public static boolean handlePointerReleased(Item item,
                                            int x,
                                            int y)

Forwards a pointer event to the specified item. The handlePointerReleased call is protected, this is an public accessor for any item.

Parameters:: item - the item; x - the x position of the pointer position relative to this item's left position; y - the y position of the pointer position relative to this item's top position
Returns:: true when the event has been consumed by the item

handlePointerReleased

public static boolean handlePointerReleased(Item item,
                                            int x,
                                            int y)

Forwards a pointer event to the specified item. The handlePointerReleased call is protected, this is an public accessor for any item.

Parameters:: item - the item; x - the x position of the pointer position relative to this item's left position; y - the y position of the pointer position relative to this item's top position
Returns:: true when the event has been consumed by the item

handleCommand

public static boolean handleCommand(Item item,
                                    Command cmd)

Asks the specified item to handle the command.

Parameters:: item - the item; cmd - the command that the item should handle
Returns:: true when the item has handled that command

handleCommand

public static boolean handleCommand(Item item,
                                    Command cmd)

Asks the specified item to handle the command.

Parameters:: item - the item; cmd - the command that the item should handle
Returns:: true when the item has handled that command

handleKeyPressed

public static boolean handleKeyPressed(Screen screen,
                                       int keyCode,
                                       int gameAction)

Forwards a key event to the specified screen. The handleKeyPressed call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the screen

handleKeyPressed

public static boolean handleKeyPressed(Screen screen,
                                       int keyCode,
                                       int gameAction)

Forwards a key event to the specified screen. The handleKeyPressed call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the screen

handleKeyReleased

public static boolean handleKeyReleased(Screen screen,
                                        int keyCode,
                                        int gameAction)

Forwards a key event to the specified screen. The handleKeyReleased call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the screen

handleKeyReleased

public static boolean handleKeyReleased(Screen screen,
                                        int keyCode,
                                        int gameAction)

Forwards a key event to the specified screen. The handleKeyPressed call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the screen

handleKeyRepeated

public static boolean handleKeyRepeated(Screen screen,
                                        int keyCode,
                                        int gameAction)

Forwards a key event to the specified screen. The handleKeyRepeated call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the screen

handleKeyRepeated

public static boolean handleKeyRepeated(Screen screen,
                                        int keyCode,
                                        int gameAction)

Forwards a key event to the specified screen. The handleKeyPressed call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; keyCode - the code of the key; gameAction - the associated game action
Returns:: true when the event has been consumed by the screen

handlePointerPressed

public static boolean handlePointerPressed(Screen screen,
                                           int x,
                                           int y)

Forwards a key event to the specified screen. The handlePointerPressed call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; x - the x position of the pointer pressing relative to this screen's left position; y - the y position of the pointer pressing relative to this screen's top position
Returns:: true when the event has been consumed by the screen

handlePointerPressed

public static boolean handlePointerPressed(Screen screen,
                                           int x,
                                           int y)

Forwards a key event to the specified screen. The handlePointerPressed call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; x - the x position of the pointer pressing relative to this screen's left position; y - the y position of the pointer pressing relative to this screen's top position
Returns:: true when the event has been consumed by the screen

handlePointerReleased

public static boolean handlePointerReleased(Screen screen,
                                            int x,
                                            int y)

Forwards a pointer event to the specified screen. The handlePointerReleased call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; x - the x position of the pointer pressing relative to this screen's left position; y - the y position of the pointer pressing relative to this screen's top position
Returns:: true when the event has been consumed by the screen

handlePointerReleased

public static boolean handlePointerReleased(Screen screen,
                                            int x,
                                            int y)

Forwards a pointer event to the specified screen. The handlePointerReleased call is protected, this is an public accessor for any screen.

Parameters:: screen - the screen; x - the x position of the pointer pressing relative to this screen's left position; y - the y position of the pointer pressing relative to this screen's top position
Returns:: true when the event has been consumed by the screen

handleCommand

public static boolean handleCommand(Screen screen,
                                    Command cmd)

Asks the specified screen to handle the command.

Parameters:: screen - the screen; cmd - the command that the screen should handle
Returns:: true when the screen has handled that command

handleCommand

public static boolean handleCommand(Screen screen,
                                    Command cmd)

Asks the specified screen to handle the command.

Parameters:: screen - the screen; cmd - the command that the screen should handle
Returns:: true when the screen has handled that command

setCaretPosition

public static void setCaretPosition(TextField field,
                                    int position)

Sets the caret position in the given text field. Please note that this operation requires the direct input mode to work.

Parameters:: field - the text field; position - the new caret position, 0 puts the caret at the start of the line, getString().length moves the caret to the end of the input.

setCaretPosition

public static void setCaretPosition(TextField field,
                                    int position)

Sets the caret position in the given text field. Please note that this operation requires the direct input mode to work.

Parameters:: field - the text field; position - the new caret position, 0 puts the caret at the start of the line, getString().length moves the caret to the end of the input.

setNumberOfDecimalFractions

public static void setNumberOfDecimalFractions(TextField field,
                                               int number)

Sets the number of decimal fractions that are allowed for FIXED_POINT_DECIMAL constrained TextFields

Parameters:: field - the textfield the textfield for which the fractions are set; number - the number (defaults to 2)
See Also:: CONSTRAINT_FIXED_POINT_DECIMAL, TextField.FIXED_POINT_DECIMAL

setNumberOfDecimalFractions

public static void setNumberOfDecimalFractions(TextField field,
                                               int number)

Sets the number of decimal fractions that are allowed for FIXED_POINT_DECIMAL constrained TextFields

Parameters:: field - the textfield the textfield for which the fractions are set; number - the number (defaults to 2)
See Also:: CONSTRAINT_FIXED_POINT_DECIMAL, TextField.FIXED_POINT_DECIMAL

getNumberOfDecimalFractions

public static int getNumberOfDecimalFractions(TextField field)

Retrieves the number of decimal fractions that are allowed for FIXED_POINT_DECIMAL constrained TextFields

Parameters:: field - the textfield the textfield for which the fractions are set
Returns:: the number (defaults to 2)
See Also:: CONSTRAINT_FIXED_POINT_DECIMAL, TextField.FIXED_POINT_DECIMAL

getNumberOfDecimalFractions

public static int getNumberOfDecimalFractions(TextField field)

Retrieves the number of decimal fractions that are allowed for FIXED_POINT_DECIMAL constrained TextFields

Parameters:: field - the textfield the textfield for which the fractions are set
Returns:: number the number (defaults to 2)
See Also:: CONSTRAINT_FIXED_POINT_DECIMAL, TextField.FIXED_POINT_DECIMAL

setCaretPosition

public static void setCaretPosition(TextBox box,
                                    int position)

Sets the caret position in the given text box. Please note that this operation requires the direct input mode to work.

Parameters:: box - the text box; position - the new caret position, 0 puts the caret at the start of the line, getString().length moves the caret to the end of the input.

setCaretPosition

public static void setCaretPosition(TextBox box,
                                    int position)

Sets the caret position in the given text box. Please note that this operation requires the direct input mode to work.

Parameters:: box - the text box; position - the new caret position, 0 puts the caret at the start of the line, getString().length moves the caret to the end of the input.

setInputMode

public static void setInputMode(TextField field,
                                int inputMode)

Sets the input mode for the given textfield. Warning: you have to ensure that the input mode matches the contraints of the given TextField.

Parameters:: field - the text field; inputMode - the input mode, either UiAccess.MODE_NUMBERS, UiAcccss.MODE_LOWERCASE, UiAccess.MODE_UPPERCASE, UiAccess.MODE_FIRST_UPPERCASE or UiAccess.MODE_NATIVE
See Also:: MODE_NUMBERS, MODE_LOWERCASE, MODE_UPPERCASE, MODE_FIRST_UPPERCASE, MODE_NATIVE

setInputMode

public static void setInputMode(TextField field,
                                int inputMode)

Sets the input mode for the given textfield. Warning: you have to ensure that the input mode matches the contraints of the given TextField.

Parameters:: field - the text field; inputMode - the input mode, either UiAccess.MODE_NUMBERS, UiAcccss.MODE_LOWERCASE, UiAccess.MODE_UPPERCASE, UiAccess.MODE_FIRST_UPPERCASE or UiAccess.MODE_NATIVE
See Also:: MODE_NUMBERS, MODE_LOWERCASE, MODE_UPPERCASE, MODE_FIRST_UPPERCASE, MODE_NATIVE

setInputMode

public static void setInputMode(TextBox box,
                                int inputMode)

Sets the input mode for the given textbox. Warning: you have to ensure that the input mode matches the contraints of the given TextBox.

Parameters:: box - the text box; inputMode - the input mode, either UiAccess.MODE_NUMBERS, UiAcccss.MODE_LOWERCASE, UiAccess.MODE_UPPERCASE, UiAccess.MODE_FIRST_UPPERCASE or UiAccess.MODE_NATIVE
See Also:: MODE_NUMBERS, MODE_LOWERCASE, MODE_UPPERCASE, MODE_FIRST_UPPERCASE, MODE_NATIVE

setInputMode

public static void setInputMode(TextBox box,
                                int inputMode)

Sets the input mode for the given textbox. Warning: you have to ensure that the input mode matches the contraints of the given TextBox.

Parameters:: box - the text box; inputMode - the input mode, either UiAccess.MODE_NUMBERS, UiAcccss.MODE_LOWERCASE, UiAccess.MODE_UPPERCASE, UiAccess.MODE_FIRST_UPPERCASEor UiAccess.MODE_NATIVE
See Also:: MODE_NUMBERS, MODE_LOWERCASE, MODE_UPPERCASE, MODE_FIRST_UPPERCASE, MODE_NATIVE

getInputMode

public static int getInputMode(TextField field)

Retrieves the input mode for the given textfield.

Parameters:: field - the text field
Returns:: the input mode, either UiAccess.MODE_NUMBERS, UiAcccss.MODE_LOWERCASE, UiAccess.MODE_UPPERCASE, UiAccess.MODE_FIRST_UPPERCASEor UiAccess.MODE_NATIVE
See Also:: MODE_NUMBERS, MODE_LOWERCASE, MODE_UPPERCASE, MODE_FIRST_UPPERCASE, MODE_NATIVE

getInputMode

public static int getInputMode(TextField field)

Retrieves the input mode for the given textfield.

Parameters:: field - the text field
Returns:: the input mode, either UiAccess.MODE_NUMBERS, UiAcccss.MODE_LOWERCASE, UiAccess.MODE_UPPERCASE, UiAccess.MODE_FIRST_UPPERCASE or UiAccess.MODE_NATIVE
See Also:: MODE_NUMBERS, MODE_LOWERCASE, MODE_UPPERCASE, MODE_FIRST_UPPERCASE, MODE_NATIVE

getInputMode

public static int getInputMode(TextBox box)

Retrieves the input mode for the given textbox.

Parameters:: box - the text box
Returns:: the input mode, either UiAccess.MODE_NUMBERS, UiAcccss.MODE_LOWERCASE, UiAccess.MODE_UPPERCASE, UiAccess.MODE_FIRST_UPPERCASE or UiAccess.MODE_NATIVE
See Also:: MODE_NUMBERS, MODE_LOWERCASE, MODE_UPPERCASE, MODE_FIRST_UPPERCASE, MODE_NATIVE

getInputMode

public static int getInputMode(TextBox box)

Retrieves the input mode for the given textbox.

Parameters:: box - the text box
Returns:: the input mode, either UiAccess.MODE_NUMBERS, UiAcccss.MODE_LOWERCASE, UiAccess.MODE_UPPERCASE, UiAccess.MODE_FIRST_UPPERCASE or UiAccess.MODE_NATIVE
See Also:: MODE_NUMBERS, MODE_LOWERCASE, MODE_UPPERCASE, MODE_FIRST_UPPERCASE, MODE_NATIVE

getDotSeparatedDecimalString

public static String getDotSeparatedDecimalString(TextField field)

Retrieves the decimal value entered with a dot as the decimal mark.

When the value has no decimal places it will be returned as it is: 12
When the value is null, null will be returned: null
When the value has decimal places, a dot will be used: 12.3

When the J2ME Polish GUI is not used, this method will only detect commas as possible alternative decimal marks.

Parameters:: field - the text field with a DECIMAL constraint
Returns:: either the formatted value or null, when there was no input.
Throws:: IllegalStateException - when the TextField is not DECIMAL constrained

getDotSeparatedDecimalString

public static String getDotSeparatedDecimalString(TextField field)

Retrieves the decimal value entered with a dot as the decimal mark.

When the value has no decimal places it will be returned as it is: 12
When the value is null, null will be returned: null
When the value has decimal places, a dot will be used: 12.3

Parameters:: field - the text field with a DECIMAL constraint
Returns:: either the formatted value or null, when there was no input.
Throws:: IllegalStateException - when the TextField is not DECIMAL constrained

addSubCommand

public static void addSubCommand(Command child,
                                 Command parent,
                                 Screen screen)

Adds the given command as a subcommand to the defined screen. When the J2ME Polish GUI is not used, this will just add the command to the screen like a normal command.

Parameters:: child - the sub command; parent - the parent command; screen - the screen.

addSubCommand

public static void addSubCommand(Command child,
                                 Command parent,
                                 Screen screen)

Adds the given command as a subcommand to the defined screen. When the J2ME Polish GUI is not used, this will just add the command to the screen like a normal command.

Parameters:: child - the sub command; parent - the parent command; screen - the screen.

addSubCommand

public static void addSubCommand(Command child,
                                 Command parent,
                                 Screen screen)

Adds the given command as a subcommand to the defined screen. When the J2ME Polish GUI is not used, this will just add the command to the screen like a normal command.

Parameters:: child - the sub command; parent - the parent command; screen - the screen.

addSubCommand

public static void addSubCommand(Command child,
                                 Command parent,
                                 Screen screen,
                                 Style style)

Adds the given command as a subcommand to the defined screen. When the J2ME Polish GUI is not used, this will just add the command to the screen like a normal command.

Parameters:: child - the sub command; parent - the parent command; screen - the screen.; style - the style of the command

removeSubCommand

public static void removeSubCommand(Command childCommand,
                                    Command parentCommand,
                                    Screen screen)

Removes the given command as subcommand from the defined screen

Parameters:: childCommand - the command to remove.; parentCommand - the parent command of the command to remove.; screen - the screen.

removeSubCommand

public static void removeSubCommand(Command childCommand,
                                    Command parentCommand,
                                    Screen screen)

Removes the given command as a subcommand from the defined screen

Parameters:: childCommand - the command to remove.; parentCommand - the parent command of the command to remove.; screen - the screen.

removeAllCommands

public static void removeAllCommands(Screen screen)

Removes all commands from the given screen This option is only available when the "menu" fullscreen mode is activated.

Parameters:: screen - the screen.

removeAllCommands

public static void removeAllCommands(Screen screen)

Removes all commands from the given screen This option is only available when the "menu" fullscreen mode is activated.

Parameters:: screen - the screen.

isMenuOpened

public static boolean isMenuOpened(Screen screen)

Checks whether the commands menu of the screen is currently opened. Useful when overriding the keyPressed() method.

Parameters:: screen - the screen
Returns:: true when the commands menu is opened.

isMenuOpened

public static boolean isMenuOpened(Screen screen)

Checks whether the commands menu of the screen is currently opened. Useful when overriding the keyPressed() method.

Parameters:: screen - the screen
Returns:: true when the commands menu is opened.

focus

public static void focus(Screen screen,
                         Item item)

Focuses the specified item on the given screen.

Parameters:: screen - the screen; item - the item that should be focused

focus

public static void focus(Screen screen,
                         Item item)

Focuses the specified item on the given screen.

Parameters:: screen - the screen; item - the item that should be focused

focus

public static void focus(Screen screen,
                         Item item)

Focuses the specified item on the given screen.

Parameters:: screen - the screen; item - the item that should be focused

focus

public static void focus(Screen screen,
                         Item item)

Focuses the specified item on the given screen.

Parameters:: screen - the screen; item - the item that should be focused

focus

public static void focus(Screen screen,
                         int index)

Focuses the specified item on the given screen.

Parameters:: screen - the screen; index - the index of the item that should be focused, first item has the index 0

focus

public static void focus(Screen screen,
                         int index)

Focuses the specified item on the given screen.

Parameters:: screen - the screen; index - the index of the item that should be focused, first item has the index 0

focus

public static void focus(ChoiceGroup choiceGroup,
                         int index)

Focuses the specified item on the given choice group.

Parameters:: choiceGroup - the choice group; index - the index of the item that should be focused, first item has the index 0

focus

public static void focus(ChoiceGroup choiceGroup,
                         int index)

Focuses the specified item on the given choice group.

Parameters:: choiceGroup - the choice group; index - the index of the item that should be focused, first item has the index 0

releaseResources

public static void releaseResources()

Releases all (memory) instensive resources that are currently hold by the J2ME Polish GUI.

releaseResourcesOnScreenChange

public static void releaseResourcesOnScreenChange()

Releases all (memory) instensive resources that are currently hold by the J2ME Polish GUI when a non-J2ME Polish screen is shown.

releaseResources

public static void releaseResources(Screen screen)

Releases all (memory) instensive resources that are currently hold by the J2ME Polish GUI for the specified screen. The release is synchronized with the paint cycle of the screen and must not be called from within a paint method, as this will result in deadlocks.

Parameters:: screen - the screen for which the resources should be released.

releaseResources

public static void releaseResources(Screen screen)

Parameters:: screen - the screen for which the resources should be released.

setSubtitle

public static void setSubtitle(Screen screen,
                               String subtitle)

Sets the subtitle for the specified screen

Parameters:: screen - the screen; subtitle - the subtitle text

setSubtitle

public static void setSubtitle(Screen screen,
                               String subtitle,
                               Style style)

Sets the subtitle for the specified screen

Parameters:: screen - the screen; subtitle - the subtitle text; style - the style of the subtitle text

setSubtitle

public static void setSubtitle(Screen screen,
                               String subtitle)

Sets the subtitle for the specified screen

Parameters:: screen - the screen; subtitle - the subtitle text

setSubtitle

public static void setSubtitle(Screen screen,
                               String subtitle,
                               Style style)

Sets the subtitle for the specified screen

Parameters:: screen - the screen; subtitle - the subtitle text; style - the style of the subtitle text

setSubtitle

public static void setSubtitle(Screen screen,
                               Item subtitle)

Sets the subtitle for the specified screen

Parameters:: screen - the screen; subtitle - the subtitle item

setSubtitle

public static void setSubtitle(Screen screen,
                               Item subtitle)

Sets the subtitle for the specified screen

Parameters:: screen - the screen; subtitle - the subtitle item

scroll

public static void scroll(Screen screen,
                          int yOffset)

Scrolls the screen to the given position.

Parameters:: screen - the screen; yOffset - the vertical offset: 0 is the very top, negative values scroll the screen towards the end.

scroll

public static void scroll(Screen screen,
                          int yOffset)

Scrolls the screen to the given position.

Parameters:: screen - the screen; yOffset - the vertical offset: 0 is the very top, negative values scroll the screen towards the end.

scrollTo

public static void scrollTo(Item item)

Scrolls the screen so that the specified item becomes visible. If the item is above the currently visible screen area, it will be placed at the top. If the item is below the currently visible screen area, it will be placed at the bottom. If the item is within the currently visible screen area, the call will be ignored.

Parameters:: item - the item that should become visible.
See Also:: scrollTo(javax.microedition.lcdui.Item, int)

scrollTo

public static void scrollTo(Item item,
                            int position)

Scrolls the screen so that the specified item will be position according to the specified position.

Parameters:: item - the item that should become visible.; position - the position, either Graphics.TOP, Graphics.BOTTOM or Graphics.VCENTER
See Also:: scrollTo(javax.microedition.lcdui.Item)

scrollTo

public static void scrollTo(Item item)

Parameters:: item - the item that should become visible.
See Also:: scrollTo(Item, int)

scrollTo

public static void scrollTo(Item item,
                            int position)

Scrolls the screen so that the specified item will be position according to the specified position.

Parameters:: item - the item that should become visible.; position - the position, either Graphics.TOP, Graphics.BOTTOM or Graphics.VCENTER
See Also:: scrollTo(javax.microedition.lcdui.Item)

getBackground

public static Background getBackground(Screen screen)

Retrieves the background of the given screen. This can be used to dynamically alter the background, e.g. by setting a different image:

 //#if polish.usePolishGui
   ImageBackground ib = (ImageBackground) UiAccess.getBackground( form );
   ib.setImage( newImage );
 //#endif