org.gnu.gtk

Class ComboBox

public class ComboBox extends Bin implements CellLayout

A widget used to choose from a list of items.
Constructor Summary
ComboBox(Handle hndl)
ComboBox()
Constructs a new ComboBox that will contain only Strings.
ComboBox(TreeModel model)
Creates a new ComboBox.
Method Summary
voidaddAttributeMapping(CellRenderer renderer, CellRendererAttribute attribute, DataColumn column)
Adds an attribute mapping to the list in the CellLayout.
voidaddListener(ComboBoxListener listener)
Register an object to handle ComboBox events.
voidappendText(String text)
Appends a string to the list of strings in the ComboBox.
voidclear()
Unsets all the mappings on all renderers on the CellLayout and removes all renderers from the CellLayout.
voidclearAttributeMappings(CellRenderer renderer)
Clears all existing attributes previously set with ComboBox.
intgetActive()
Returns the index of the currently active item or -1 if there's no active item.
TreeItergetActiveIter()
Returns a TreeIter that is pointing to the currently active item in the ComboBox.
StringgetActiveText()
booleangetAddTearoffs()
intgetColumnSpanColumn()
static ComboBoxgetComboBox(Handle handle)
Internal static factory method to be used by Java-Gnome only.
ClassgetEventListenerClass(String signal)
EventTypegetEventType(String signal)
booleangetFocusOnClick()
TreeModelgetModel()
Returns the TreeModel for the ComboBox.
AtkObjectgetPopupAccessible()
TreeViewRowSeparatorMethodgetRowSeparatorMethod()
Get the object which is used to determine whether a row should be drawn as a separator.
intgetRowSpanColumn()
intgetWrapWidth()
voidinsertText(int position, String text)
Inserts a string into the list of strings in the ComboBox at the provided position.
voidpackEnd(CellRenderer renderer, boolean expand)
Adds the cell to the end of the CellLayout.
voidpackStart(CellRenderer renderer, boolean expand)
Packs the cell into the beginning of the CellLayout.
voidpopdown()
Hides the menu or dropdown list of the ComboBox.
voidpopup()
Pops up the menu or dropdown list of the ComboBox.
voidprependText(String text)
Prepends a string to the list of strings in the ComboBox.
voidremoveListener(ComboBoxListener listener)
Removes a listener
voidremoveText(int position)
Removes the string at the provided position from the list of strings in the ComboBox.
voidreorder(CellRenderer renderer, int position)
Re-inserts the renderer at position.
voidsetActive(int index)
Sets the active item of the ComboBox to be index.
voidsetActiveIter(TreeIter iter)
Sets the current active item to the one referenced by iter.
voidsetAddTearoffs(boolean addTearoffs)
voidsetColumnSpanColumn(int columnSpan)
Sets the column span for the ComboBox.
voidsetFocusOnClick(boolean focusOnClick)
voidsetModel(TreeModel model)
Sets the model for the ComboBox.
voidsetRowSeparatorMethod(TreeViewRowSeparatorMethod method)
Set the object which is used to determine whether a row should be drawn as a separator.
voidsetRowSpanColumn(int rowSpan)
Sets the row span for the ComboBox.
voidsetWrapWidth(int width)
Sets the wrap width of the ComboBox.

Constructor Detail

ComboBox

public ComboBox(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

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.

addListener

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

See Also: ComboBoxListener

appendText

public void appendText(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

clear

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

clearAttributeMappings

public void clearAttributeMappings(CellRenderer renderer)
Clears all existing attributes previously set with ComboBox.

getActive

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

getActiveIter

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

getActiveText

public String getActiveText()

getAddTearoffs

public boolean getAddTearoffs()

getColumnSpanColumn

public int getColumnSpanColumn()

getComboBox

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

getEventListenerClass

public Class getEventListenerClass(String signal)

getEventType

public EventType getEventType(String signal)

getFocusOnClick

public boolean getFocusOnClick()

getModel

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

getPopupAccessible

public AtkObject getPopupAccessible()

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.

getRowSpanColumn

public int getRowSpanColumn()

getWrapWidth

public int getWrapWidth()

insertText

public void insertText(int position, 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

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.

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.

popdown

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

popup

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

prependText

public void prependText(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

removeListener

public void removeListener(ComboBoxListener listener)
Removes a listener

See Also: addListener

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

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.

setActive

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

Parameters: index

setActiveIter

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

Parameters: iter

setAddTearoffs

public void setAddTearoffs(boolean addTearoffs)

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

setFocusOnClick

public void setFocusOnClick(boolean focusOnClick)

setModel

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

Parameters: model

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).

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

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