Class TableCombo

  • All Implemented Interfaces:
    org.eclipse.swt.graphics.Drawable

    public class TableCombo
    extends org.eclipse.swt.widgets.Composite
    The TableCombo class represents a selectable user interface object that combines a label, textfield, and a table and issues notification when an item is selected from the table. Note: This widget is basically a extension of the CCombo widget. The list control was replaced by a Table control and a Label control was added so that images can be displayed when a value from the drop down items has a image associated to it.

    TableCombo was written to allow the user to be able to display multiple columns of data in the "Drop Down" portion of the combo.

    Special Note: Although this class is a subclass of Composite, it does not make sense to add children to it, or set a layout on it.

    Styles:
    BORDER, READ_ONLY, FLAT
    Events:
    DefaultSelection, Modify, Selection, Verify
    • Constructor Summary

      Constructors 
      Constructor Description
      TableCombo​(org.eclipse.swt.widgets.Composite parent, int style)
      Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private char _findMnemonic​(java.lang.String string)  
      void addModifyListener​(org.eclipse.swt.events.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.
      void addSelectionListener​(org.eclipse.swt.events.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.
      void addTextControlKeyListener​(org.eclipse.swt.events.KeyListener listener)
      Adds the listener to the collection of listeners who will be notified when the user presses keys in the text field.
      void addVerifyListener​(org.eclipse.swt.events.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.
      private void arrowEvent​(org.eclipse.swt.widgets.Event event)
      Handle Arrow Event
      private void autoAdjustColumnWidthsIfNeeded​(org.eclipse.swt.widgets.TableColumn[] tableColumns, int totalAvailWidth, int totalColumnWidthUsage)
      adjusts the last table column width to fit inside of the table if the table column data does not fill out the table area.
      private static int checkStyle​(int style)  
      void clearSelection()
      Sets the selection in the receiver's text field to an empty selection starting just before the first character.
      private void comboEvent​(org.eclipse.swt.widgets.Event event)
      Handle Combo events
      org.eclipse.swt.graphics.Point computeSize​(int wHint, int hHint, boolean changed)
      void copy()
      Copies the selected text.
      private void createListeners()  
      (package private) void createPopup​(int selectionIndex)
      creates the popup shell.
      void cut()
      Cuts the selected text.
      void defineColumns​(int numberOfColumnsToCreate)
      Defines what columns the drop down table will have.
      void defineColumns​(int[] columnBounds)
      Defines what columns the drop down table will have.
      void defineColumns​(java.lang.String[] columnHeaders)
      Defines what columns the drop down table will have.
      void defineColumns​(java.lang.String[] columnHeaders, int[] columnBounds)
      Defines what columns the drop down table will have.
      private void defineColumnsInternal​(java.lang.String[] columnHeaders, int[] columnBounds, int totalColumnsToBeCreated)
      Defines what columns the drop down table will have.
      (package private) void dropDown​(boolean drop)
      handle DropDown request
      org.eclipse.swt.widgets.Button getArrowControl()
      Returns the Arrow control reference.
      private org.eclipse.swt.widgets.Label getAssociatedLabel()  
      private int getDisplayColumnIndex()
      returns the column index of the TableColumn to be displayed when selected.
      boolean getEditable()
      Gets the editable state.
      java.lang.String getItem​(int index)
      Returns the item at the given, zero-relative index in the receiver's list.
      int getItemCount()
      Returns the number of items contained in the receiver's list.
      int getItemHeight()
      Returns the height of the area which would be used to display one of the items in the receiver's list.
      java.lang.String[] getItems()
      Returns an array of Strings which are the items in the receiver's list.
      org.eclipse.swt.graphics.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.
      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.
      int getStyle()
      org.eclipse.swt.widgets.Table getTable()
      returns the Table reference.
      java.lang.String getText()
      Returns a string containing a copy of the contents of the receiver's text field.
      org.eclipse.swt.widgets.Text getTextControl()
      Returns the Text control reference.
      int getTextHeight()
      Returns the height of the receivers's text field.
      int getVisibleItemCount()
      Gets the number of items that are visible in the drop down portion of the receiver's list.
      private void handleFocus​(int type)
      Handle Focus event
      int indexOf​(java.lang.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.
      int indexOf​(java.lang.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.
      (package private) void initAccessible()
      Add Accessbile listeners to label and table.
      private void internalLayout​(boolean changed, boolean closeDropDown)
      This method is invoked when a resize event occurs.
      private boolean isDropped()
      returns if the drop down is currently open
      boolean isFocusControl()
      void paste()
      Pastes text from clipboard.
      private void popupEvent​(org.eclipse.swt.widgets.Event event)
      Handles Popup Events
      void redraw()
      void redraw​(int x, int y, int width, int height, boolean all)
      private void refreshText​(int index)
      Refreshes the label control with the selected object's details.
      void removeModifyListener​(org.eclipse.swt.events.ModifyListener listener)
      Removes the listener from the collection of listeners who will be notified when the receiver's text is modified.
      void removeSelectionListener​(org.eclipse.swt.events.SelectionListener listener)
      Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.
      void removeTextControlKeyListener​(org.eclipse.swt.events.KeyListener listener)
      Removes the listener from the collection of listeners who will be notified when the user presses keys in the text control.
      void removeVerifyListener​(org.eclipse.swt.events.VerifyListener listener)
      Removes the listener from the collection of listeners who will be notified when the control is verified.
      void select​(int index)
      Selects the item at the given zero-relative index in the receiver's list.
      (package private) void selectedImageEvent​(org.eclipse.swt.widgets.Event event)  
      void setBackground​(org.eclipse.swt.graphics.Color color)
      void setBorderColor​(org.eclipse.swt.graphics.Color color)
      Sets the receiver's border color to the color specified by the argument, or to the default system color for the control if the argument is null.
      void setClosePopupAfterSelection​(boolean closePopupAfterSelection)
      Modifies the behavior of the popup after an entry was selected.
      void setDisplayColumnIndex​(int displayColumnIndex)
      Sets the zero-relative column index that will be used to display the currently selected item in the label control.
      void setEditable​(boolean editable)
      Sets the editable state.
      void setEnabled​(boolean enabled)
      void setEvenLinesBackgroundColor​(org.eclipse.swt.graphics.Color color)
      Sets the receiver's background color for even lines to the color specified by the argument, or to the default system color for the control if the argument is null.
      void setEvenLinesForegroundColor​(org.eclipse.swt.graphics.Color color)
      Sets the receiver's color for even lines to the color specified by the argument, or to the default system color for the control if the argument is null.
      boolean setFocus()
      void setFont​(org.eclipse.swt.graphics.Font font)
      void setForeground​(org.eclipse.swt.graphics.Color color)
      void setLayout​(org.eclipse.swt.widgets.Layout layout)
      Sets the layout which is associated with the receiver to be the argument which may be null.
      void setOddLinesBackgroundColor​(org.eclipse.swt.graphics.Color color)
      Sets the receiver's background color for odd lines to the color specified by the argument, or to the default system color for the control if the argument is null.
      void setOddLinesForegroundColor​(org.eclipse.swt.graphics.Color color)
      Sets the receiver's color for odd lines to the color specified by the argument, or to the default system color for the control if the argument is null.
      void setSelection​(org.eclipse.swt.graphics.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.
      void setShowColorWithinSelection​(boolean showColorWithinSelection)  
      void setShowFontWithinSelection​(boolean showFontWithinSelection)  
      void setShowImageWithinSelection​(boolean showImageWithinSelection)  
      void setShowTableHeader​(boolean showTableHeader)
      sets whether or not to show table header.
      void setShowTableLines​(boolean showTableLines)
      sets whether or not to show table lines
      void setTableVisible​(boolean visible)
      Marks the receiver's list as visible if the argument is true, and marks it invisible otherwise.
      void setTableWidthPercentage​(int ddWidthPct)
      Sets the table width percentage in relation to the width of the label control.
      void setText​(java.lang.String string)
      Sets the contents of the receiver's text field to the given string.
      void setTextLimit​(int limit)
      Sets the maximum number of characters that the receiver's text field is capable of holding to be the argument.
      void setToolTipText​(java.lang.String tipText)
      void setUpdateSelectionOnEnter​(boolean selectOnEnter)
      Allows to change the on enter behavior when the drop-down is shown.
      void setUpdateTextWithinSelection​(boolean updateTextWithinSelection)
      Whether a selection change should automatically update the combo's text to the selection's text.
      void setVisible​(boolean visible)
      void setVisibleItemCount​(int count)
      Sets the number of items that are visible in the drop down portion of the receiver's list.
      private java.lang.String stripMnemonic​(java.lang.String string)  
      private void tableEvent​(org.eclipse.swt.widgets.Event event)
      Handles Table Events.
      (package private) void textEvent​(org.eclipse.swt.widgets.Event event)  
      private boolean wasColumnWidthSpecified​(int columnIndex)
      determines if the user explicitly set a column width for a given column index.
      • Methods inherited from class org.eclipse.swt.widgets.Composite

        changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setLayoutDeferred, setTabList
      • Methods inherited from class org.eclipse.swt.widgets.Scrollable

        computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar
      • Methods inherited from class org.eclipse.swt.widgets.Control

        addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isAutoScalable, isEnabled, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setTouchEnabled, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update
      • Methods inherited from class org.eclipse.swt.widgets.Widget

        addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • newStyle

        private static int newStyle
      • hasBorder

        private final boolean hasBorder
      • popup

        private org.eclipse.swt.widgets.Shell popup
      • arrow

        private org.eclipse.swt.widgets.Button arrow
      • selectedImage

        private org.eclipse.swt.widgets.Label selectedImage
      • text

        private org.eclipse.swt.widgets.Text text
      • table

        private org.eclipse.swt.widgets.Table table
      • font

        private org.eclipse.swt.graphics.Font font
      • hasFocus

        private boolean hasFocus
      • visibleItemCount

        private int visibleItemCount
      • listener

        private org.eclipse.swt.widgets.Listener listener
      • focusFilter

        private org.eclipse.swt.widgets.Listener focusFilter
      • displayColumnIndex

        private int displayColumnIndex
      • foreground

        private org.eclipse.swt.graphics.Color foreground
      • background

        private org.eclipse.swt.graphics.Color background
      • borderColor

        private org.eclipse.swt.graphics.Color borderColor
      • oddLinesForegroundColor

        private org.eclipse.swt.graphics.Color oddLinesForegroundColor
      • oddLinesBackgroundColor

        private org.eclipse.swt.graphics.Color oddLinesBackgroundColor
      • evenLinesForegroundColor

        private org.eclipse.swt.graphics.Color evenLinesForegroundColor
      • evenLinesBackgroundColor

        private org.eclipse.swt.graphics.Color evenLinesBackgroundColor
      • columnWidths

        private int[] columnWidths
      • tableWidthPercentage

        private int tableWidthPercentage
      • showImageWithinSelection

        private boolean showImageWithinSelection
      • showColorWithinSelection

        private boolean showColorWithinSelection
      • showFontWithinSelection

        private boolean showFontWithinSelection
      • closePupupAfterSelection

        private boolean closePupupAfterSelection
      • selectOnEnter

        private boolean selectOnEnter
      • updateTextWithinSelection

        private boolean updateTextWithinSelection
    • Constructor Detail

      • TableCombo

        public TableCombo​(org.eclipse.swt.widgets.Composite parent,
                          int style)
        Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

        The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

        Parameters:
        parent - a widget which will be the parent of the new instance (cannot be null)
        style - the style of widget to construct
        Throws:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the parent is null
        org.eclipse.swt.SWTException -
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
        See Also:
        SWT.BORDER, SWT.READ_ONLY, SWT.FLAT, Widget.getStyle()
    • Method Detail

      • createListeners

        private void createListeners()
      • checkStyle

        private static int checkStyle​(int style)
        Parameters:
        style -
        Returns:
      • addModifyListener

        public void addModifyListener​(org.eclipse.swt.events.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the listener is null
        org.eclipse.swt.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​(org.eclipse.swt.events.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the listener is null
        org.eclipse.swt.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
      • addTextControlKeyListener

        public void addTextControlKeyListener​(org.eclipse.swt.events.KeyListener listener)
        Adds the listener to the collection of listeners who will be notified when the user presses keys in the text field. interface.
        Parameters:
        listener - the listener which should be notified when the user presses keys in the text control.
        Throws:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the listener is null
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • removeTextControlKeyListener

        public void removeTextControlKeyListener​(org.eclipse.swt.events.KeyListener listener)
        Removes the listener from the collection of listeners who will be notified when the user presses keys in the text control.
        Parameters:
        listener - the listener which should no longer be notified
        Throws:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the listener is null
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • addVerifyListener

        public void addVerifyListener​(org.eclipse.swt.events.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the listener is null
        org.eclipse.swt.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)
      • arrowEvent

        private void arrowEvent​(org.eclipse.swt.widgets.Event event)
        Handle Arrow Event
        Parameters:
        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:
        org.eclipse.swt.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

        private void comboEvent​(org.eclipse.swt.widgets.Event event)
        Handle Combo events
        Parameters:
        event -
      • computeSize

        public org.eclipse.swt.graphics.Point computeSize​(int wHint,
                                                          int hHint,
                                                          boolean changed)
        Overrides:
        computeSize in class org.eclipse.swt.widgets.Control
      • copy

        public void copy()
        Copies the selected text.

        The current selection is copied to the clipboard.

        Throws:
        org.eclipse.swt.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

        void createPopup​(int selectionIndex)
        creates the popup shell.
        Parameters:
        selectionIndex -
      • cut

        public void cut()
        Cuts the selected text.

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

        Throws:
        org.eclipse.swt.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
      • dropDown

        void dropDown​(boolean drop)
        handle DropDown request
        Parameters:
        drop -
      • getAssociatedLabel

        private org.eclipse.swt.widgets.Label getAssociatedLabel()
      • getEditable

        public boolean getEditable()
        Gets the editable state.
        Returns:
        whether or not the receiver is editable
        Throws:
        org.eclipse.swt.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 java.lang.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:
        java.lang.IllegalArgumentException -
        • ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
        org.eclipse.swt.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:
        org.eclipse.swt.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:
        org.eclipse.swt.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 java.lang.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:
        org.eclipse.swt.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 org.eclipse.swt.graphics.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:
        org.eclipse.swt.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:
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • getStyle

        public int getStyle()
        Overrides:
        getStyle in class org.eclipse.swt.widgets.Widget
      • getText

        public java.lang.String getText()
        Returns a string containing a copy of the contents of the receiver's text field.
        Returns:
        the receiver's text
        Throws:
        org.eclipse.swt.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:
        org.eclipse.swt.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:
        org.eclipse.swt.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
      • handleFocus

        private void handleFocus​(int type)
        Handle Focus event
        Parameters:
        type -
      • indexOf

        public int indexOf​(java.lang.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the string is null
        org.eclipse.swt.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​(java.lang.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the string is null
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • setShowTableLines

        public void setShowTableLines​(boolean showTableLines)
        sets whether or not to show table lines
        Parameters:
        showTableLines -
      • setShowTableHeader

        public void setShowTableHeader​(boolean showTableHeader)
        sets whether or not to show table header.
        Parameters:
        showTableHeader -
      • initAccessible

        void initAccessible()
        Add Accessbile listeners to label and table.
      • isDropped

        private boolean isDropped()
        returns if the drop down is currently open
        Returns:
      • isFocusControl

        public boolean isFocusControl()
        Overrides:
        isFocusControl in class org.eclipse.swt.widgets.Control
      • internalLayout

        private void internalLayout​(boolean changed,
                                    boolean closeDropDown)
        This method is invoked when a resize event occurs.
        Parameters:
        changed -
        closeDropDown -
      • tableEvent

        private void tableEvent​(org.eclipse.swt.widgets.Event event)
        Handles Table Events.
        Parameters:
        event -
        Throws:
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.NoSuchMethodException
      • setUpdateSelectionOnEnter

        public void setUpdateSelectionOnEnter​(boolean selectOnEnter)
        Allows to change the on enter behavior when the drop-down is shown. Default value is true.
        Parameters:
        selectOnEnter - true if pressing enter should set the combo selection to the last selected element in the table, false if combo selection should not change
      • paste

        public void paste()
        Pastes text from clipboard.

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

        Throws:
        org.eclipse.swt.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
      • popupEvent

        private void popupEvent​(org.eclipse.swt.widgets.Event event)
        Handles Popup Events
        Parameters:
        event -
      • redraw

        public void redraw()
        Overrides:
        redraw in class org.eclipse.swt.widgets.Control
      • redraw

        public void redraw​(int x,
                           int y,
                           int width,
                           int height,
                           boolean all)
        Overrides:
        redraw in class org.eclipse.swt.widgets.Control
      • removeModifyListener

        public void removeModifyListener​(org.eclipse.swt.events.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the listener is null
        org.eclipse.swt.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​(org.eclipse.swt.events.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the listener is null
        org.eclipse.swt.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​(org.eclipse.swt.events.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the listener is null
        org.eclipse.swt.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:
        org.eclipse.swt.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​(org.eclipse.swt.graphics.Color color)
        Overrides:
        setBackground in class org.eclipse.swt.widgets.Control
      • setEditable

        public void setEditable​(boolean editable)
        Sets the editable state.
        Parameters:
        editable - the new editable state
        Throws:
        org.eclipse.swt.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 org.eclipse.swt.widgets.Control
      • setFocus

        public boolean setFocus()
        Overrides:
        setFocus in class org.eclipse.swt.widgets.Composite
      • setFont

        public void setFont​(org.eclipse.swt.graphics.Font font)
        Overrides:
        setFont in class org.eclipse.swt.widgets.Control
      • setForeground

        public void setForeground​(org.eclipse.swt.graphics.Color color)
        Overrides:
        setForeground in class org.eclipse.swt.widgets.Control
      • setLayout

        public void setLayout​(org.eclipse.swt.widgets.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 org.eclipse.swt.widgets.Composite
        Parameters:
        layout - the receiver's new layout or null
        Throws:
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • setTableVisible

        public void setTableVisible​(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:
        org.eclipse.swt.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
      • setSelection

        public void setSelection​(org.eclipse.swt.graphics.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the point is null
        org.eclipse.swt.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​(java.lang.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:
        java.lang.IllegalArgumentException -
        • ERROR_NULL_ARGUMENT - if the string is null
        org.eclipse.swt.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:
        java.lang.IllegalArgumentException -
        • ERROR_CANNOT_BE_ZERO - if the limit is zero
        org.eclipse.swt.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​(java.lang.String tipText)
        Overrides:
        setToolTipText in class org.eclipse.swt.widgets.Control
      • setVisible

        public void setVisible​(boolean visible)
        Overrides:
        setVisible in class org.eclipse.swt.widgets.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:
        org.eclipse.swt.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
      • stripMnemonic

        private java.lang.String stripMnemonic​(java.lang.String string)
        Parameters:
        string -
        Returns:
      • defineColumns

        public void defineColumns​(java.lang.String[] columnHeaders)
        Defines what columns the drop down table will have. Use this method when you don't care about the width of the columns but want to set the column header text.
        Parameters:
        columnHeaders -
        columnWidths -
      • defineColumns

        public void defineColumns​(int[] columnBounds)
        Defines what columns the drop down table will have. Use this method when you don't care about the column header text but you want the fields to be a specific width.
        Parameters:
        columnHeaders -
        columnBounds -
      • defineColumns

        public void defineColumns​(int numberOfColumnsToCreate)
        Defines what columns the drop down table will have. Use this method when you don't care about the column headers and you want the columns to be automatically sized based upon their content.
        Parameters:
        columnHeaders -
        columnWidths -
      • defineColumns

        public void defineColumns​(java.lang.String[] columnHeaders,
                                  int[] columnBounds)
        Defines what columns the drop down table will have. Use this method when you want to specify the column header text and the column widths.
        Parameters:
        columnHeaders -
        columnBounds -
      • defineColumnsInternal

        private void defineColumnsInternal​(java.lang.String[] columnHeaders,
                                           int[] columnBounds,
                                           int totalColumnsToBeCreated)
        Defines what columns the drop down table will have.
        Parameters:
        columnHeaders -
        columnBounds -
      • setTableWidthPercentage

        public void setTableWidthPercentage​(int ddWidthPct)
        Sets the table width percentage in relation to the width of the label control. The default value if 100% which means that it will be the same size as the label control. If you want the table to be wider than the label then just display a value higher than 100%.
        Parameters:
        ddWidthPct -
      • setDisplayColumnIndex

        public void setDisplayColumnIndex​(int displayColumnIndex)
        Sets the zero-relative column index that will be used to display the currently selected item in the label control.
        Parameters:
        displayColumnIndex -
      • setClosePopupAfterSelection

        public void setClosePopupAfterSelection​(boolean closePopupAfterSelection)
        Modifies the behavior of the popup after an entry was selected. If true the popup will be closed, if false it will remain open.
        Parameters:
        closePopupAfterSelection -
      • getDisplayColumnIndex

        private int getDisplayColumnIndex()
        returns the column index of the TableColumn to be displayed when selected.
        Returns:
      • _findMnemonic

        private char _findMnemonic​(java.lang.String string)
      • refreshText

        private void refreshText​(int index)
        Refreshes the label control with the selected object's details.
      • setShowImageWithinSelection

        public void setShowImageWithinSelection​(boolean showImageWithinSelection)
        Parameters:
        showImageWithinSelection -
      • setShowColorWithinSelection

        public void setShowColorWithinSelection​(boolean showColorWithinSelection)
        Parameters:
        showColorWithinSelection -
      • setShowFontWithinSelection

        public void setShowFontWithinSelection​(boolean showFontWithinSelection)
        Parameters:
        showFontWithinSelection -
      • setUpdateTextWithinSelection

        public void setUpdateTextWithinSelection​(boolean updateTextWithinSelection)
        Whether a selection change should automatically update the combo's text to the selection's text. The default value is true.
        Parameters:
        updateTextWithinSelection - true if selection changes will update the combo's text accordingly; false if no text changes are desired. Clients have to update the text manually
      • getTable

        public org.eclipse.swt.widgets.Table getTable()
        returns the Table reference. NOTE: the access is public for now but will most likely be changed in a future release.
        Returns:
      • wasColumnWidthSpecified

        private boolean wasColumnWidthSpecified​(int columnIndex)
        determines if the user explicitly set a column width for a given column index.
        Parameters:
        columnIndex -
        Returns:
      • textEvent

        void textEvent​(org.eclipse.swt.widgets.Event event)
      • selectedImageEvent

        void selectedImageEvent​(org.eclipse.swt.widgets.Event event)
      • autoAdjustColumnWidthsIfNeeded

        private void autoAdjustColumnWidthsIfNeeded​(org.eclipse.swt.widgets.TableColumn[] tableColumns,
                                                    int totalAvailWidth,
                                                    int totalColumnWidthUsage)
        adjusts the last table column width to fit inside of the table if the table column data does not fill out the table area.
      • getTextControl

        public org.eclipse.swt.widgets.Text getTextControl()
        Returns the Text control reference.
        Returns:
      • getArrowControl

        public org.eclipse.swt.widgets.Button getArrowControl()
        Returns the Arrow control reference.
        Returns:
      • setBorderColor

        public void setBorderColor​(org.eclipse.swt.graphics.Color color)
        Sets the receiver's border color to the color specified by the argument, or to the default system color for the control if the argument is null.
        Parameters:
        color - the new color (or null)
        Throws:
        java.lang.IllegalArgumentException -
        • ERROR_INVALID_ARGUMENT - if the argument has been disposed
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • setOddLinesBackgroundColor

        public void setOddLinesBackgroundColor​(org.eclipse.swt.graphics.Color color)
        Sets the receiver's background color for odd lines to the color specified by the argument, or to the default system color for the control if the argument is null.
        Parameters:
        color - the new color (or null)
        Throws:
        java.lang.IllegalArgumentException -
        • ERROR_INVALID_ARGUMENT - if the argument has been disposed
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • setOddLinesForegroundColor

        public void setOddLinesForegroundColor​(org.eclipse.swt.graphics.Color color)
        Sets the receiver's color for odd lines to the color specified by the argument, or to the default system color for the control if the argument is null.
        Parameters:
        color - the new color (or null)
        Throws:
        java.lang.IllegalArgumentException -
        • ERROR_INVALID_ARGUMENT - if the argument has been disposed
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • setEvenLinesForegroundColor

        public void setEvenLinesForegroundColor​(org.eclipse.swt.graphics.Color color)
        Sets the receiver's color for even lines to the color specified by the argument, or to the default system color for the control if the argument is null.
        Parameters:
        color - the new color (or null)
        Throws:
        java.lang.IllegalArgumentException -
        • ERROR_INVALID_ARGUMENT - if the argument has been disposed
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
      • setEvenLinesBackgroundColor

        public void setEvenLinesBackgroundColor​(org.eclipse.swt.graphics.Color color)
        Sets the receiver's background color for even lines to the color specified by the argument, or to the default system color for the control if the argument is null.
        Parameters:
        color - the new color (or null)
        Throws:
        java.lang.IllegalArgumentException -
        • ERROR_INVALID_ARGUMENT - if the argument has been disposed
        org.eclipse.swt.SWTException -
        • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
        • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver