org.gnome.gtk
Class ComboBox

Object
  org.freedesktop.bindings.Pointer
      org.freedesktop.bindings.Proxy
          org.gnome.glib.Object
              org.gnome.gtk.Object
                  org.gnome.gtk.Widget
                      org.gnome.gtk.Container
                          org.gnome.gtk.Bin
                              org.gnome.gtk.ComboBox

All Implemented Interfaces:

CellEditable, CellLayout

Direct Known Subclasses:

ComboBoxEntry, TextComboBox

public class ComboBox
extends Bin
implements CellEditable, CellLayout

A Widget used to choose from a list of items.

Internally, ComboBox uses a TreeModel to store the items, giving you the same MVC power of GTK's TreeView/TreeModel system. There is also an alternative API which can be used to create and manipulate ComboBoxes which are comprised only of text. If that is your requirement, see TextComboBox.

ComboBox is a CellLayout, that is, it possesses many of the same aspects as a TreeViewColumn, and, along with being backed by a TreeModel, is used in much the same way as a TreeView: create a ListStore or TreeStore then build the GUI side by creating CellRenderers against the ComboBox.

An abbreviated example of using this follows; assuming a ListStore model with at least DataColumnString column in it,

 combo = new ComboBox(model);
 renderer = new CellRendererText(combo);
 renderer.setText(column);
 

The underlying GtkComboBox is actually presents two different APIs that are essentially mutually exclusive, which is why we have split this into two public classes.

Since:

4.0.3

Author:

Sebastian Mancke, Andrew Cowie

ComboBox

public ComboBox(TreeModel model)

Construct a new full-power TreeModel-backed ComboBox.

If subclassing ComboBox, use the protected () no-arg constructor and then set the Model later with setModel().

Since:

4.0.3

connect

public void connect(ComboBox.Changed handler)

Hook up a ComboBox.Changed handler to the Widget. since 4.0.3

getActive

public int getActive()

Returns the index of the active item in the ComboBox. This counts from a zero origin, so a return value of 2 means the third item in the list is currently the active item.

This will return -1 if there is no active item.

Since:

4.0.6

getActiveIter

public TreeIter getActiveIter()

Get a TreeIter pointing at the currently selected row. If no row is currently active then null will be returned.

Since:

4.0.6

popdown

public void popdown()

Programmatically tell the ComboBox popup to go away.

Since:

4.0.14

popup

public void popup()

Cause the popup part of the ComboBox to raise and present itself. You don't tend to need this (after all it's the user who clicks on the ComboBox to cause the popup to present). The ComboBox must already have been realized to the screen before you will be able to use this.

Since:

4.0.6

setActive

public void setActive(int active)

Change the active item within this ComboBox to be the one at the supplied index. Items are numbered from 0.

Since:

4.0.6

setActiveIter

public void setActiveIter(TreeIter row)

Set the ComboBox to be pointing at the row nominated by the TreeIter argument.

Since:

4.0.6

setModel

public void setModel(TreeModel model)

Set or change the TreeModel from which this ComboBox draws its data.

Since:

4.0.6

Overview  Package   Class		java-gnome
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD