Class IzCCombo

Method Details

• getTextControl

  public Text getTextControl()

  Gets the text field for input.

• add

  public TableItem add(String col1, String col2)

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

  Parameters:

  col1 - String for column 1.

  col2 - String for column 2.

  Returns:

  The added table 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.

• add

  public TableItem add(String[] strings)

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

  Parameters:

  strings - The new item strings.

  Returns:

  The added table 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.

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

  See Also:

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

• arrowEvent

  protected void arrowEvent(Event event)

  Processes the arrow event.

  Parameters:

  event - The raw SWT event.

• 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()

• comboEvent

  protected void comboEvent(Event event)

  Processes a combo event.

  Parameters:

  event - The raw SWT event.

• computeSize

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

  Computes the size of the widget.

  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

• createPopup

  protected void createPopup(String[][] items, int selectionIndex)

  Creates the pop-up for the items in question with specified selection.

  Parameters:

  items - The items.

  selectionIndex - The selected index, -1 for none.

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

• 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()

• _findMnemonic

  protected char _findMnemonic(String string)

  Return the lower case of the first non-'&' character following an '&' character in the given string. If there are no '&' characters in the given string, return '\0'.

  Parameters:

  string - The string for the mnemonic.

  Returns:

  The character, or '\0' if not found.

• getAssociatedLabel

  protected String getAssociatedLabel()

  Return the Label immediately preceding the receiver in the z-order, or null if none.

  Returns:

  The string, or null if not found.

• getChildren

  public Control[] getChildren()

  Gets the children of this component.

  Overrides:

  getChildren in class Composite

  Returns:

  An empty array, always.

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

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

• 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()

  Gets the shell of the combobox.

  Overrides:

  getShell in class Control

• getStyle

  public int getStyle()

  Gets the combobox style.

  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.

• handleFocus

  protected void handleFocus(int type)

  Processes focus.

  Parameters:

  type - FocusIn or FocusOut.

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

• initAccessible

  protected void initAccessible()

  Initializes the accessible support.

• isDropped

  public boolean isDropped()

  Checks drop-down is down.

  Returns:

  true if dropped down.

• isFocusControl

  public boolean isFocusControl()

  Checks if the combobox has focus.

  Overrides:

  isFocusControl in class Control

• isParentScrolling

  protected boolean isParentScrolling(Control scrollableParent)

  Checks if the parent is scrolling.

  Parameters:

  scrollableParent - A scrollable parent.

  Returns:

  Flag for parent is scrolling.

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

• redraw

  public void redraw()

  Redraws the combobox.

  Overrides:

  redraw in class Control

• redraw

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

  Redraws a part of the control, overridden to always include children.

  Overrides:

  redraw in class Composite

• removeAll

  public void removeAll()

  Removes all of the items from the receiver's list, but leaves 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.

• setBackground

  public void setBackground(Color color)

  Sets the background.

  Overrides:

  setBackground in class Control

  Parameters:

  color - The color.

  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.

• setForeground

  public void setForeground(Color color)

  Sets the foreground.

  Overrides:

  setForeground in class Control

  Parameters:

  color - The color.

  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.

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

• setEnabled

  public void setEnabled(boolean enabled)

  Sets the enabled state.

  Overrides:

  setEnabled in class Control

  Parameters:

  enabled - The new enabled 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.

• setFocus

  public boolean setFocus()

  Sets the focus.

  Overrides:

  setFocus in class Composite

  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.

• setFont

  public void setFont(Font font)

  Sets the font.

  Overrides:

  setFont in class Control

  Parameters:

  font - The font.

  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.

• 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 -- IGNORED!

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

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

  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)

  Sets the tooltip text.

  Overrides:

  setToolTipText in class Control

  Parameters:

  string - The text, or null for none.

  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.

• setVisible

  public void setVisible(boolean visible)

  Sets the component visibility state.

  Overrides:

  setVisible in class Control

  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.

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

• stripMnemonic

  protected String stripMnemonic(String string)

  Strips the mnemonic from a string.

  Parameters:

  string - The string.

  Returns:

  String without mnemonic.

• textEvent

  protected void textEvent(Event event)

  Processes the text events.

  Parameters:

  event - The raw SWT event.

• traverse

  public boolean traverse(int event)

  Processes the traverse event.

  Overrides:

  traverse in class Control

  Parameters:

  event - The SWT event ID.