MID Profile: Class ChoiceGroup

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

MID Profile

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.microedition.lcdui
Class ChoiceGroup

java.lang.Object
  |
  +--javax.microedition.lcdui.Item
        |
        +--javax.microedition.lcdui.ChoiceGroup

All Implemented Interfaces:: Choice

public class ChoiceGroup
extends Item
implements Choice

A ChoiceGroup is a group of selectable elements intended to be placed within a Form. The group may be created with a mode that requires a single choice to be made or that allows multiple choices. The implementation is responsible for providing the graphical representation of these modes and must provide visually different graphics for different modes. For example, it might use "radio buttons" for the single choice mode and "check boxes" for the multiple choice mode.

Note: most of the essential methods have been specified in the Choice interface.

Fields inherited from interface javax.microedition.lcdui.Choice

EXCLUSIVE, IMPLICIT, MULTIPLE

Constructor Summary

ChoiceGroup(String label, int choiceType)
          Creates a new, empty ChoiceGroup, specifying its title and its type.

ChoiceGroup(String label, int choiceType, String[] stringElements, Image[] imageElements)
          Creates a new ChoiceGroup, specifying its title, the type of the ChoiceGroup, and an array of Strings and Images to be used as its initial contents.

Method Summary

int append(String stringPart, Image imagePart)
          Appends an element to the Choice.

void delete(int elementNum)
          Deletes the element referenced by elementNum.

Image getImage(int elementNum)
          Gets the Image part of the element referenced by elementNum.

int getSelectedFlags(boolean[] selectedArray_return)
          Queries the state of a ChoiceGroup and returns the state of all elements in the boolean array selectedArray_return.

int getSelectedIndex()
          Returns the index number of an element in the ChoiceGroup that is selected.

String getString(int elementNum)
          Gets the String part of the element referenced by elementNum.

void insert(int elementNum, String stringElement, Image imageElement)
          Inserts an element into the Choice just prior to the element specified.

boolean isSelected(int elementNum)
          Gets a boolean value indicating whether this element is selected.

void set(int elementNum, String stringPart, Image imagePart)
          Sets the element referenced by elementNum to the specified element, replacing the previous contents of the element.

void setLabel(String label)
          Sets the label of the Item.

void setSelectedFlags(boolean[] selectedArray)
          Attempts to set the selected state of every element in the ChoiceGroup.

void setSelectedIndex(int elementNum, boolean selected)
          For ChoiceGroup objects of type MULTIPLE, this simply sets an individual element's selected state.

int size()
          Gets the number of elements present.

Methods inherited from class javax.microedition.lcdui.Item

getLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

ChoiceGroup

public ChoiceGroup(String label,
                   int choiceType)

Creates a new, empty ChoiceGroup, specifying its title and its type. The type must be one of EXCLUSIVE or MULTIPLE. The IMPLICIT choice type is not allowed within a ChoiceGroup.

Parameters:: label - the item's label (see Item); choiceType - either EXCLUSIVE or MULTIPLE
Throws:: IllegalArgumentException - if choice type is neither EXCLUSIVE nor MULTIPLE
See Also:: Choice.EXCLUSIVE, Choice.MULTIPLE, Choice.IMPLICIT

ChoiceGroup

public ChoiceGroup(String label,
                   int choiceType,
                   String[] stringElements,
                   Image[] imageElements)

Creates a new ChoiceGroup, specifying its title, the type of the ChoiceGroup, and an array of Strings and Images to be used as its initial contents.

The type must be one of EXCLUSIVE or MULTIPLE. The IMPLICIT type is not allowed for ChoiceGroup.

The stringElements array must be non-null and every array element must also be non-null. The length of the stringElements array determines the number of elements in the ChoiceGroup. The imageElements array may be null to indicate that the ChoiceGroup elements have no images. If the imageElements array is non-null, it must be the same length as the stringElements array. Individual elements of the imageElements array may be null in order to indicate the absence of an image for the corresponding ChoiceGroup element. Any elements present in the imageElements array must refer to immutable images.

Parameters:: label - the item's label (see Item); choiceType - EXCLUSIVE or MULTIPLE; stringElements - set of strings specifying the string parts of the ChoiceGroup elements; imageElements - set of images specifying the image parts of the ChoiceGroup elements
Throws:: NullPointerException - if stringElements is null; NullPointerException - if the stringElements array contains any null elements; IllegalArgumentException - if the imageElements array is non-null and has a different length from the stringElements array; IllegalArgumentException - if choiceType is neither EXCLUSIVE nor MULTIPLE; IllegalArgumentException - if any image in the imageElements array is mutable
See Also:: Choice.EXCLUSIVE, Choice.MULTIPLE, Choice.IMPLICIT

Method Detail