org.gnu.gtk
Class ComboBox

java.lang.Object
  extended by org.gnu.glib.Struct
      extended by org.gnu.glib.GObject
          extended by org.gnu.gtk.GtkObject
              extended by org.gnu.gtk.Widget
                  extended by org.gnu.gtk.Container
                      extended by org.gnu.gtk.Bin
                          extended by org.gnu.gtk.ComboBox
All Implemented Interfaces:
CellLayout
Direct Known Subclasses:
ComboBoxEntry

public class ComboBox
extends Bin
implements CellLayout

A widget used to choose from a list of items.


Constructor Summary
ComboBox()
          Constructs a new ComboBox that will contain only Strings.
ComboBox(org.gnu.glib.Handle hndl)
           
ComboBox(TreeModel model)
          Creates a new ComboBox.
 
Method Summary
 void addAttributeMapping(CellRenderer renderer, CellRendererAttribute attribute, DataColumn column)
          Adds an attribute mapping to the list in the CellLayout.
 void addListener(ComboBoxListener listener)
          Register an object to handle ComboBox events.
 void appendText(java.lang.String text)
          Appends a string to the list of strings in the ComboBox.
 void clear()
          Unsets all the mappings on all renderers on the CellLayout and removes all renderers from the CellLayout.
 void clearAttributeMappings(CellRenderer renderer)
          Clears all existing attributes previously set with addAttributeMapping(org.gnu.gtk.CellRenderer, org.gnu.gtk.CellRendererAttribute, org.gnu.gtk.DataColumn).
 int getActive()
          Returns the index of the currently active item or -1 if there's no active item.
 TreeIter getActiveIter()
          Returns a TreeIter that is pointing to the currently active item in the ComboBox.
 java.lang.String getActiveText()
           
 boolean getAddTearoffs()
           
 int getColumnSpanColumn()
           
static ComboBox getComboBox(org.gnu.glib.Handle handle)
          Internal static factory method to be used by Java-Gnome only.
 java.lang.Class getEventListenerClass(java.lang.String signal)
           
 EventType getEventType(java.lang.String signal)
           
 boolean getFocusOnClick()
           
 TreeModel getModel()
          Returns the TreeModel for the ComboBox.
 AtkObject getPopupAccessible()
           
 TreeViewRowSeparatorMethod getRowSeparatorMethod()
          Get the object which is used to determine whether a row should be drawn as a separator.
 int getRowSpanColumn()
           
 int getWrapWidth()
           
 void insertText(int position, java.lang.String text)
          Inserts a string into the list of strings in the ComboBox at the provided position.
 void packEnd(CellRenderer renderer, boolean expand)
          Adds the cell to the end of the CellLayout.
 void packStart(CellRenderer renderer, boolean expand)
          Packs the cell into the beginning of the CellLayout.
 void popdown()
          Hides the menu or dropdown list of the ComboBox.
 void popup()
          Pops up the menu or dropdown list of the ComboBox.
 void prependText(java.lang.String text)
          Prepends a string to the list of strings in the ComboBox.
 void removeListener(ComboBoxListener listener)
          Removes a listener
 void removeText(int position)
          Removes the string at the provided position from the list of strings in the ComboBox.
 void reorder(CellRenderer renderer, int position)
          Re-inserts the renderer at position.
 void setActive(int index)
          Sets the active item of the ComboBox to be index.
 void setActiveIter(TreeIter iter)
          Sets the current active item to the one referenced by iter.
 void setAddTearoffs(boolean addTearoffs)
           
 void setColumnSpanColumn(int columnSpan)
          Sets the column span for the ComboBox.
 void setFocusOnClick(boolean focusOnClick)
           
 void setModel(TreeModel model)
          Sets the model for the ComboBox.
 void setRowSeparatorMethod(TreeViewRowSeparatorMethod method)
          Set the object which is used to determine whether a row should be drawn as a separator.
 void setRowSpanColumn(int rowSpan)
          Sets the row span for the ComboBox.
 void setWrapWidth(int width)
          Sets the wrap width of the ComboBox.
 
Methods inherited from class org.gnu.gtk.Bin
getChild, getType
 
Methods inherited from class org.gnu.gtk.Container
add, addListener, getBooleanChildProperty, getBorderWidth, getChildProperty, getChildren, getIntChildProperty, getResizeMode, remove, removeListener, resizeChildren, setBooleanChildProperty, setBorderWidth, setChildProperty, setIntChildProperty, setResizeMode
 
Methods inherited from class org.gnu.gtk.Widget
activate, addAccelerator, addEvents, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, canActivateAccel, createContext, createLayout, draw, drawArea, drawArea, finish, getAccessible, getAllocation, getCanFocus, getColormap, getContext, getData, getDisplay, getDragData, getExtensionEvents, getModifierStyle, getName, getParent, getParentWindow, getPointer, getRootWindow, getScreen, getSensitive, getStyle, getToplevel, getWidget, getWindow, grabDefault, grabFocus, hasFocus, hasScreen, hide, hideAll, highlight, highlight, intersect, isAncestor, makeWidget, modifyStyle, popColormap, pushColormap, realize, removeAccelerator, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, reparent, setBackgroundColor, setBaseColor, setCanFocus, setColormap, setDoubleBuffered, setDragDestination, setDragIcon, setDragIconPixbuf, setDragIconStock, setDragSource, setEvents, setExtensionEvents, setFont, setForegroundColor, setMinimumSize, setName, setNoDragDestination, setNoDragSource, setSensitive, setTextColor, shapeCombineMask, show, showAll, unHighlight, unHighlight
 
Methods inherited from class org.gnu.gtk.GtkObject
destroy, sink
 
Methods inherited from class org.gnu.glib.GObject
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addListener, collect, freezeNotify, getBooleanProperty, getData, getDoubleProperty, getFloatProperty, getGObjectFromHandle, getIntProperty, getJavaObjectProperty, getLongProperty, getPixbufProperty, getProperty, getStringProperty, hasProperty, notify, removeEventHandler, removeListener, setBooleanProperty, setData, setDoubleProperty, setFloatProperty, setIntProperty, setJavaObjectProperty, setLongProperty, setPixbufProperty, setProperty, setStringProperty, thawNotify
 
Methods inherited from class org.gnu.glib.Struct
equals, getHandle, getNullHandle, hashCode
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.gnu.gtk.CellLayout
getHandle
 

Constructor Detail

ComboBox

public ComboBox(org.gnu.glib.Handle hndl)

ComboBox

public ComboBox()
Constructs a new ComboBox that will contain only Strings. If you need to include objects other than strings you must use the constructor that takes a TreeModel. When you use this constructor you should use the appendText, insertText, prependText, and removeText methods to add or remove text from the comboBox.


ComboBox

public ComboBox(TreeModel model)
Creates a new ComboBox. If model is not null, the model of the ComboBox is initialized to the supplied one. Otherwise an empty ComboBox is created.

If you use this constructor you should not use the appendText, insertText, prependText, or removeText methods. You should update the model when you need to change the values in the ComboBox.

Parameters:
model - A TreeModel or null.
Method Detail

getComboBox

public static ComboBox getComboBox(org.gnu.glib.Handle handle)
Internal static factory method to be used by Java-Gnome only.


setWrapWidth

public void setWrapWidth(int width)
Sets the wrap width of the ComboBox. The wrap width is the preferred number of columns when you want the popup to be layed out in a table.

Parameters:
width -

getWrapWidth

public int getWrapWidth()

setRowSpanColumn

public void setRowSpanColumn(int rowSpan)
Sets the row span for the ComboBox. The row span is the number of rows an item should span.

Parameters:
rowSpan -

getRowSpanColumn

public int getRowSpanColumn()

setColumnSpanColumn

public void setColumnSpanColumn(int columnSpan)
Sets the column span for the ComboBox. The column span is the number of columns an item should span.

Parameters:
columnSpan -

getColumnSpanColumn

public int getColumnSpanColumn()

getAddTearoffs

public boolean getAddTearoffs()

setAddTearoffs

public void setAddTearoffs(boolean addTearoffs)

getFocusOnClick

public boolean getFocusOnClick()

setFocusOnClick

public void setFocusOnClick(boolean focusOnClick)

getActive

public int getActive()
Returns the index of the currently active item or -1 if there's no active item.


setActive

public void setActive(int index)
Sets the active item of the ComboBox to be index.

Parameters:
index -

getActiveIter

public TreeIter getActiveIter()
Returns a TreeIter that is pointing to the currently active item in the ComboBox.


setActiveIter

public void setActiveIter(TreeIter iter)
Sets the current active item to the one referenced by iter.

Parameters:
iter -

getModel

public TreeModel getModel()
Returns the TreeModel for the ComboBox.


setModel

public void setModel(TreeModel model)
Sets the model for the ComboBox.

Parameters:
model -

appendText

public void appendText(java.lang.String text)
Appends a string to the list of strings in the ComboBox. This method can only be called if you created the ComboBox with the no-op constructor.

Parameters:
text -

insertText

public void insertText(int position,
                       java.lang.String text)
Inserts a string into the list of strings in the ComboBox at the provided position. This method can only be called if you created the ComboBox with the no-op constructor.

Parameters:
position -
text -

prependText

public void prependText(java.lang.String text)
Prepends a string to the list of strings in the ComboBox. This method can only be called if you created the ComboBox with the no-op constructor.

Parameters:
text -

removeText

public void removeText(int position)
Removes the string at the provided position from the list of strings in the ComboBox. This method can only be called if you created the ComboBox with the no-op constructor.

Parameters:
position -

getActiveText

public java.lang.String getActiveText()

popup

public void popup()
Pops up the menu or dropdown list of the ComboBox.


popdown

public void popdown()
Hides the menu or dropdown list of the ComboBox.


getPopupAccessible

public AtkObject getPopupAccessible()

packStart

public void packStart(CellRenderer renderer,
                      boolean expand)
Packs the cell into the beginning of the CellLayout. If expand is FALSE, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is TRUE.

Specified by:
packStart in interface CellLayout

packEnd

public void packEnd(CellRenderer renderer,
                    boolean expand)
Adds the cell to the end of the CellLayout. If expand is FALSE, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is TRUE.

Specified by:
packEnd in interface CellLayout

clear

public void clear()
Unsets all the mappings on all renderers on the CellLayout and removes all renderers from the CellLayout.

Specified by:
clear in interface CellLayout

addAttributeMapping

public void addAttributeMapping(CellRenderer renderer,
                                CellRendererAttribute attribute,
                                DataColumn column)
Adds an attribute mapping to the list in the CellLayout. The column is the column of the model to get a value from, and the attribute is the parameter on cell to be set from the value.

Specified by:
addAttributeMapping in interface CellLayout

clearAttributeMappings

public void clearAttributeMappings(CellRenderer renderer)
Clears all existing attributes previously set with addAttributeMapping(org.gnu.gtk.CellRenderer, org.gnu.gtk.CellRendererAttribute, org.gnu.gtk.DataColumn).

Specified by:
clearAttributeMappings in interface CellLayout

reorder

public void reorder(CellRenderer renderer,
                    int position)
Re-inserts the renderer at position. Note that the renderer has already to be packed into the CellLayout for this to function properly.

Specified by:
reorder in interface CellLayout

setRowSeparatorMethod

public void setRowSeparatorMethod(TreeViewRowSeparatorMethod method)
Set the object which is used to determine whether a row should be drawn as a separator.

Parameters:
method - The TreeViewRowSeparatorMethod or null if no separators are to be drawn (the default).

getRowSeparatorMethod

public TreeViewRowSeparatorMethod getRowSeparatorMethod()
Get the object which is used to determine whether a row should be drawn as a separator.

Returns:
The TreeViewRowSeparatorMethod or null if no method has been set.

addListener

public void addListener(ComboBoxListener listener)
Register an object to handle ComboBox events.

See Also:
ComboBoxListener

removeListener

public void removeListener(ComboBoxListener listener)
Removes a listener

See Also:
addListener(ComboBoxListener)

getEventListenerClass

public java.lang.Class getEventListenerClass(java.lang.String signal)
Overrides:
getEventListenerClass in class Container

getEventType

public EventType getEventType(java.lang.String signal)
Overrides:
getEventType in class Container