Class IZ_CCombo

Method Details

• setForeground

  public void setForeground(Color color)

  Overrides:

  setForeground in class Control

• setBackground

  public void setBackground(Color color)

  Overrides:

  setBackground in class Control

• add

  public void add(String string)

  Adds the argument to the end of the receiver's list.

  Note: If control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.

  Parameters:

  string - the new item

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the string is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  See Also:

  • add(String,int)

• add

  public void add(String string, int index)

  Adds the argument to the receiver's list at the given zero-relative index.

  Note: To add an item at the end of the list, use the result of calling getItemCount() as the index or use add(String).

  Also note, if control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.

  Parameters:

  string - the new item

  index - the index for the item

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the string is null
  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list (inclusive)

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  See Also:

  • add(String)

• addModifyListener

  public void addModifyListener(ModifyListener listener)

  Adds the listener to the collection of listeners who will be notified when the receiver's text is modified, by sending it one of the messages defined in the ModifyListener interface.

  Parameters:

  listener - the listener which should be notified

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the listener is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  See Also:

  • ModifyListener
  • removeModifyListener(org.eclipse.swt.events.ModifyListener)

• addSelectionListener

  public void addSelectionListener(SelectionListener listener)

  Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the SelectionListener interface.

  widgetSelected is called when the combo's list selection changes. widgetDefaultSelected is typically called when ENTER is pressed the combo's text area.

  Parameters:

  listener - the listener which should be notified when the user changes the receiver's selection

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the listener is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  See Also:

  • SelectionListener
  • removeSelectionListener(org.eclipse.swt.events.SelectionListener)
  • SelectionEvent

• addVerifyListener

  public void addVerifyListener(VerifyListener listener)

  Adds the listener to the collection of listeners who will be notified when the receiver's text is verified, by sending it one of the messages defined in the VerifyListener interface.

  Parameters:

  listener - the listener which should be notified

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the listener is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.3

  See Also:

  • VerifyListener
  • removeVerifyListener(org.eclipse.swt.events.VerifyListener)

• clearSelection

  public void clearSelection()

  Sets the selection in the receiver's text field to an empty selection starting just before the first character. If the text field is editable, this has the effect of placing the i-beam at the start of the text.

  Note: To clear the selected items in the receiver's list, use deselectAll().

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  See Also:

  • deselectAll()

• computeSize

  public Point computeSize(int wHint, int hHint, boolean changed)

  Overrides:

  computeSize in class Composite

• copy

  public void copy()

  Copies the selected text.

  The current selection is copied to the clipboard.

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.3

• cut

  public void cut()

  Cuts the selected text.

  The current selection is first copied to the clipboard and then deleted from the widget.

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.3

• deselect

  public void deselect(int index)

  Deselects the item at the given zero-relative index in the receiver's list. If the item at the index was already deselected, it remains deselected. Indices that are out of range are ignored.

  Parameters:

  index - the index of the item to deselect

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• deselectAll

  public void deselectAll()

  Deselects all selected items in the receiver's list.

  Note: To clear the selection in the receiver's text field, use clearSelection().

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  See Also:

  • clearSelection()

• getAlignment

  public int getAlignment()

  Returns the horizontal alignment. The alignment style (LEFT, CENTER or RIGHT) is returned.

  Returns:

  SWT.LEFT, SWT.RIGHT or SWT.CENTER

  Since:

  3.113

• getChildren

  public Control[] getChildren()

  Overrides:

  getChildren in class Composite

• getEditable

  public boolean getEditable()

  Gets the editable state.

  Returns:

  whether or not the receiver is editable

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.0

• getItem

  public String getItem(int index)

  Returns the item at the given, zero-relative index in the receiver's list. Throws an exception if the index is out of range.

  Parameters:

  index - the index of the item to return

  Returns:

  the item at the given index

  Throws:

  IllegalArgumentException -

  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• getItemCount

  public int getItemCount()

  Returns the number of items contained in the receiver's list.

  Returns:

  the number of items

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• getItemHeight

  public int getItemHeight()

  Returns the height of the area which would be used to display one of the items in the receiver's list.

  Returns:

  the height of one item

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• getItems

  public String[] getItems()

  Returns an array of Strings which are the items in the receiver's list.

  Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.

  Returns:

  the items in the receiver's list

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• getListVisible

  public boolean getListVisible()

  Returns true if the receiver's list is visible, and false otherwise.

  If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

  Returns:

  the receiver's list's visibility state

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.4

• getMenu

  public Menu getMenu()

  Overrides:

  getMenu in class Control

• getSelection

  public Point getSelection()

  Returns a Point whose x coordinate is the start of the selection in the receiver's text field, and whose y coordinate is the end of the selection. The returned values are zero-relative. An "empty" selection as indicated by the the x and y coordinates having the same value.

  Returns:

  a point representing the selection start and end

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• getSelectionIndex

  public int getSelectionIndex()

  Returns the zero-relative index of the item which is currently selected in the receiver's list, or -1 if no item is selected.

  Returns:

  the index of the selected item

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• getShell

  public Shell getShell()

  Overrides:

  getShell in class Control

• getStyle

  public int getStyle()

  Overrides:

  getStyle in class Widget

• getText

  public String getText()

  Returns a string containing a copy of the contents of the receiver's text field.

  Returns:

  the receiver's text

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• getTextHeight

  public int getTextHeight()

  Returns the height of the receivers's text field.

  Returns:

  the text height

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• getTextLimit

  public int getTextLimit()

  Returns the maximum number of characters that the receiver's text field is capable of holding. If this has not been changed by setTextLimit(), it will be the constant Combo.LIMIT.

  Returns:

  the text limit

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• getVisibleItemCount

  public int getVisibleItemCount()

  Gets the number of items that are visible in the drop down portion of the receiver's list.

  Returns:

  the number of items that are visible

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.0

• indexOf

  public int indexOf(String string)

  Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item. If no item is found, returns -1.

  Parameters:

  string - the search item

  Returns:

  the index of the item

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the string is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• indexOf

  public int indexOf(String string, int start)

  Searches the receiver's list starting at the given, zero-relative index until an item is found that is equal to the argument, and returns the index of that item. If no item is found or the starting index is out of range, returns -1.

  Parameters:

  string - the search item

  start - the zero-relative index at which to begin the search

  Returns:

  the index of the item

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the string is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• isFocusControl

  public boolean isFocusControl()

  Overrides:

  isFocusControl in class Control

• paste

  public void paste()

  Pastes text from clipboard.

  The selected text is deleted from the widget and new text inserted from the clipboard.

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.3

• redraw

  public void redraw()

  Overrides:

  redraw in class Control

• redraw

  public void redraw(int x, int y, int width, int height, boolean all)

  Overrides:

  redraw in class Composite

• remove

  public void remove(int index)

  Removes the item from the receiver's list at the given zero-relative index.

  Parameters:

  index - the index for the item

  Throws:

  IllegalArgumentException -

  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• remove

  public void remove(int start, int end)

  Removes the items from the receiver's list which are between the given zero-relative start and end indices (inclusive).

  Parameters:

  start - the start of the range

  end - the end of the range

  Throws:

  IllegalArgumentException -

  • ERROR_INVALID_RANGE - if either the start or end are not between 0 and the number of elements in the list minus 1 (inclusive)

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• remove

  public void remove(String string)

  Searches the receiver's list starting at the first item until an item is found that is equal to the argument, and removes that item from the list.

  Parameters:

  string - the item to remove

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the string is null
  • ERROR_INVALID_ARGUMENT - if the string is not found in the list

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• removeAll

  public void removeAll()

  Removes all of the items from the receiver's list and clear the contents of receiver's text field.

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• removeModifyListener

  public void removeModifyListener(ModifyListener listener)

  Removes the listener from the collection of listeners who will be notified when the receiver's text is modified.

  Parameters:

  listener - the listener which should no longer be notified

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the listener is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  See Also:

  • ModifyListener
  • addModifyListener(org.eclipse.swt.events.ModifyListener)

• removeSelectionListener

  public void removeSelectionListener(SelectionListener listener)

  Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.

  Parameters:

  listener - the listener which should no longer be notified

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the listener is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  See Also:

  • SelectionListener
  • addSelectionListener(org.eclipse.swt.events.SelectionListener)

• removeVerifyListener

  public void removeVerifyListener(VerifyListener listener)

  Removes the listener from the collection of listeners who will be notified when the control is verified.

  Parameters:

  listener - the listener which should no longer be notified

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the listener is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.3

  See Also:

  • VerifyListener
  • addVerifyListener(org.eclipse.swt.events.VerifyListener)

• select

  public void select(int index)

  Selects the item at the given zero-relative index in the receiver's list. If the item at the index was already selected, it remains selected. Indices that are out of range are ignored.

  Parameters:

  index - the index of the item to select

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• setAlignment

  public void setAlignment(int align)

  Set the horizontal alignment of the CCombo. Use the values LEFT, CENTER and RIGHT to align image and text within the available space.

  Parameters:

  align - the alignment style of LEFT, RIGHT or CENTER

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
  • ERROR_INVALID_ARGUMENT - if the value of align is not one of SWT.LEFT, SWT.RIGHT or SWT.CENTER

  Since:

  3.113

• setEditable

  public void setEditable(boolean editable)

  Sets the editable state.

  Parameters:

  editable - the new editable state

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.0

• setEnabled

  public void setEnabled(boolean enabled)

  Overrides:

  setEnabled in class Control

• setFocus

  public boolean setFocus()

  Overrides:

  setFocus in class Composite

• setFont

  public void setFont(Font font)

  Overrides:

  setFont in class Control

• setItem

  public void setItem(int index, String string)

  Sets the text of the item in the receiver's list at the given zero-relative index to the string argument. This is equivalent to remove'ing the old item at the index, and then add'ing the new item at that index.

  Parameters:

  index - the index for the item

  string - the new text for the item

  Throws:

  IllegalArgumentException -

  • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
  • ERROR_NULL_ARGUMENT - if the string is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• setItems

  public void setItems(String[] items)

  Sets the receiver's list to be the given array of items.

  Parameters:

  items - the array of items

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the items array is null
  • ERROR_INVALID_ARGUMENT - if an item in the items array is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• setLayout

  public void setLayout(Layout layout)

  Sets the layout which is associated with the receiver to be the argument which may be null.

  Note: No Layout can be set on this Control because it already manages the size and position of its children.

  Overrides:

  setLayout in class Composite

  Parameters:

  layout - the receiver's new layout or null

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• setListVisible

  public void setListVisible(boolean visible)

  Marks the receiver's list as visible if the argument is true, and marks it invisible otherwise.

  If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

  Parameters:

  visible - the new visibility state

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.4

• setMenu

  public void setMenu(Menu menu)

  Overrides:

  setMenu in class Control

• setSelection

  public void setSelection(Point selection)

  Sets the selection in the receiver's text field to the range specified by the argument whose x coordinate is the start of the selection and whose y coordinate is the end of the selection.

  Parameters:

  selection - a point representing the new selection start and end

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the point is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• setText

  public void setText(String string)

  Sets the contents of the receiver's text field to the given string.

  Note: The text field in a Combo is typically only capable of displaying a single line of text. Thus, setting the text to a string containing line breaks or other special characters will probably cause it to display incorrectly.

  Also note, if control characters like '\n', '\t' etc. are used in the string, then the behavior is platform dependent.

  Parameters:

  string - the new text

  Throws:

  IllegalArgumentException -

  • ERROR_NULL_ARGUMENT - if the string is null

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• setTextLimit

  public void setTextLimit(int limit)

  Sets the maximum number of characters that the receiver's text field is capable of holding to be the argument.

  Parameters:

  limit - new text limit

  Throws:

  IllegalArgumentException -

  • ERROR_CANNOT_BE_ZERO - if the limit is zero

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

• setToolTipText

  public void setToolTipText(String string)

  Overrides:

  setToolTipText in class Control

• setVisible

  public void setVisible(boolean visible)

  Overrides:

  setVisible in class Control

• setVisibleItemCount

  public void setVisibleItemCount(int count)

  Sets the number of items that are visible in the drop down portion of the receiver's list.

  Parameters:

  count - the new number of items to be visible

  Throws:

  SWTException -

  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

  Since:

  3.0

• traverse

  public boolean traverse(int event)

  Overrides:

  traverse in class Control