Class UIChoice

In this topic

Package com.ms.ui Previous This
Package Next

Class UIChoice

public class UIChoice extends UIPanel implements IUISelector
{
  // Fields
  public static final int THICK;

  // Constructors
  public UIChoice();

  // Methods
  public boolean action(Event e, Object obj);
  public IUIComponent add(IUIComponent comp);
  public void addActionListener(IUIActionListener l);
  public synchronized void addItemListener(IUIItemListener l);
  public void addNotify();
  public void addSelectedIndex(int index);
  public void addSelectedIndex(int index, boolean notify);
  public void addSelectedIndices(int indices[]);
  public void addSelectedIndices(int indices[], boolean notify);
  public void addSelectedItem(IUIComponent comp);
  public void addSelectedItem(IUIComponent comp, boolean notify);
  public void addSelectedItems(IUIComponent comps[]);
  public void addSelectedItems(IUIComponent comps[],
        boolean notify);
  public IUIComponent addString(String s);
  public IUIComponent getAnchorItem();
  public IUIComponent getExtensionItem();
  public UIMenuList getMenu();
  public Dimension getPreferredSize();
  public int getRoleCode();
  public int[] getSelectedIndices();
  public IUIComponent getSelectedItem();
  public IUIComponent[] getSelectedItems();
  public int getSelectionMode();
  public int getStyle();
  public String getValueText();
  public boolean handleEvent(Event e);
  public boolean keyDown(Event e, int key);
  public void layout();
  public boolean mouseDown(Event e, int x, int y);
  public boolean postEvent(Event e);
  protected void processEvent(UIEvent e);
  protected void processItemEvent(UIItemEvent e);
  public void remove(IUIComponent comp);
  public void removeActionListener(IUIActionListener l);
  public synchronized void removeItemListener(IUIItemListener l);
  public void removeSelectedIndex(int index);
  public void removeSelectedIndex(int index, boolean notify);
  public void removeSelectedIndices(int indices[]);
  public void removeSelectedIndices(int indices[], boolean notify);
  public void removeSelectedItem(IUIComponent comp);
  public void removeSelectedItem(IUIComponent comp, boolean notify);
  public void removeSelectedItems(IUIComponent comps[]);
  public void removeSelectedItems(IUIComponent comps[],
        boolean notify);
  public void requestFocus();
  public void setAnchorItem(IUIComponent comp);
  public void setExtensionItem(IUIComponent comp);
  public void setSelectedIndex(int index);
  public void setSelectedIndex(int index, boolean notify);
  public void setSelectedIndices(int indices[]);
  public void setSelectedIndices(int indices[], boolean notify);
  public void setSelectedItem(IUIComponent comp);
  public void setSelectedItem(IUIComponent comp, boolean notify);
  public void setSelectedItems(IUIComponent comps[]);
  public void setSelectedItems(IUIComponent comps[],
        boolean notify);
  public void setSelectionMode(int mode);
  public void setStyle(int style);
  public void setValueText(String s);
}

This class implements a choice control (combo box). A UIChoice object manages the components listed in the following table. In general, any IUIComponent can be added to the menu list. If the IUIComponent is not an IUIContainer, for example, it is a UIItem or UIText, an exact copy of this item appears in the choice display when the item is selected. If an IUIContainer component is used, for example, UIPanel, the name of that container is used in display component, instead of a copy of the actual container. Use getSelectedItem to retrieve the container.

This class supports event listeners.

Component Description

UIMenuList component Displays the pop-up list of items that can be selected by the choice control.

UIMenuButton component Launches or cancels the associated pop-up list.

IUIComponent component Displays the choice control's currently selected item.

When a UIChoice object is first created, its associated UIMenuList object is empty. To add items to the list, call the add or addString method, as shown in the following example.

// Construct a UIChoice object.
UIChoice c = new UIChoice();

// Create an array of components. When items are added to
// the choice control, these array values will hold the
// components returned from addString.
IUIComponent comps[] = new IUIComponent[4];

// Create an array of strings and add each
// element to the choice control.
String colors[] = {"Red", "Blue", "Green", "Black"};
for (int i=0; i<4; i++)
   comps[i] = c.addString(colors[i]);

// Add the control to the container. 
uiec.addSelectedItems(comps);

Note Although UIChoice operates only in SINGLESELECT mode, it implements the IUISelector interface, which has "pluralized" methods, such as getSelectedItems and setSelectedIndices. An IllegalArgumentException is thrown more if an attempt is made to select more than one item. The methods getSelectedIndices/Items simply returns arrays of length 1.

To remove items from a UIChoice menu, use one of the following methods. Call UIChoice.remove(IUIComponent comp) where the comp is the component to be moved from the menu. Or, obtain the UIChoice menu using UIChoice.getMenu, and call any remove method on the menu itself. If UIChoice.remove(int index) is used, components will be removed from the UIChoice control itself, like the menu launcher button.