com.nokia.mid.ui
Class PopupListItem

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

Direct Known Subclasses:

PopupList

public class PopupListItem
extends java.lang.Object

This class represents an item in a popuplist. PopupList item types are: Text:


Text

Text and Icon:

Icon

Text

Text and additional marking (checkbox) functionality:

Text

V

Text and Icon and marking:

Icon

Text

V

Constructor Summary

PopupListItem(java.lang.String itemText)
This constructor instantiates the PopupList item.

PopupListItem(java.lang.String itemText, boolean markingEnabled)
This constructor instantiates the PopupList item.

PopupListItem(java.lang.String itemText, javax.microedition.lcdui.Image itemIcon)
This constructor instantiates the PopupList item.

PopupListItem(java.lang.String itemText, javax.microedition.lcdui.Image itemIcon, boolean itemHasMarking, boolean marked)
This constructor instantiates the PopupList item.

Method Summary

javax.microedition.lcdui.Image	getIcon() This returns the icon currently used in this PopupList item.
java.lang.String	getText() This method gets the text displayed by the PopupList item.
boolean	hasMarking() This retrieves whether the PopupListItem has marking or not
boolean	isMarked() This retrieves whether the PopupListItem is marked (checked).
void	setHasMarking(boolean hasMarking) This method sets whether the PopupListItem has marking or not.
void	setIcon(javax.microedition.lcdui.Image itemIcon) This method sets the current icon of this PopupList item.
void	setMarked(boolean marked) This method sets whether the PopupListItem is marked (checked).
void	setText(java.lang.String itemText) This method sets the text for the PopupList item to the indicated value.

Methods inherited from class java.lang.Object

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

Constructor Detail

PopupListItem

public PopupListItem(java.lang.String itemText)
              throws java.lang.NullPointerException

This constructor instantiates the PopupList item.

Parameters:

itemText - The text to show on the PopupList item.

Throws:

java.lang.NullPointerException - if null itemText is null.

PopupListItem

public PopupListItem(java.lang.String itemText,
                     boolean markingEnabled)
              throws java.lang.NullPointerException

This constructor instantiates the PopupList item.

Parameters:

itemText - The text to show on the PopupList item.

markingEnabled - if marking is supported on this item

Throws:

java.lang.NullPointerException - if null itemText is null.

PopupListItem

public PopupListItem(java.lang.String itemText,
                     javax.microedition.lcdui.Image itemIcon)
              throws java.lang.NullPointerException

This constructor instantiates the PopupList item.

Parameters:

itemText - The text to show on the PopupList item.

itemIcon - The icon to show on the PopupList item.

Throws:

java.lang.NullPointerException - if null itemText is null.

PopupListItem

public PopupListItem(java.lang.String itemText,
                     javax.microedition.lcdui.Image itemIcon,
                     boolean itemHasMarking,
                     boolean marked)
              throws java.lang.NullPointerException

This constructor instantiates the PopupList item.

Parameters:

itemText - The text to show on the PopupList item.

itemIcon - The icon to show on the PopupList item. null if no icon should be used

itemHasMarking - Indicates that a check mark icon should be used in the PopupList item.

marked - true: item is default checked, false: item is default not checked.

Throws:

java.lang.NullPointerException - if null itemText is null.

Method Detail

setText

public void setText(java.lang.String itemText)
             throws java.lang.NullPointerException

This method sets the text for the PopupList item to the indicated value.

Parameters:

itemText - The text to set the PopupList item to.

Throws:

java.lang.NullPointerException - if itemText is null

getText

public java.lang.String getText()

This method gets the text displayed by the PopupList item.

Returns:

The current text shown by the PopupList item.

setIcon

public void setIcon(javax.microedition.lcdui.Image itemIcon)

This method sets the current icon of this PopupList item.

Parameters:

itemIcon - The icon to show on the PopupList item.

getIcon

public javax.microedition.lcdui.Image getIcon()

This returns the icon currently used in this PopupList item.

Returns:

The icon shown in this PopupList item.

setMarked

public void setMarked(boolean marked)

This method sets whether the PopupListItem is marked (checked).

Parameters:

marked - true: item is checked, false: item is not checked.

isMarked

public boolean isMarked()

This retrieves whether the PopupListItem is marked (checked).

Returns:

true: item is marked, false: item is not marked.

setHasMarking

public void setHasMarking(boolean hasMarking)

This method sets whether the PopupListItem has marking or not.

Parameters:

hasMarking - true: item has marking, false: item doesn't have marking.

hasMarking

public boolean hasMarking()

This retrieves whether the PopupListItem has marking or not

Returns:

true: item has marking, false it doesn't