Package org.eclipse.emf.ecp.view.internal.core.swt

Class MatchItemComboViewer

  • All Implemented Interfaces:
    org.eclipse.jface.viewers.IInputProvider, org.eclipse.jface.viewers.IInputSelectionProvider, org.eclipse.jface.viewers.IPostSelectionProvider, org.eclipse.jface.viewers.ISelectionProvider
    public class MatchItemComboViewer
extends org.eclipse.jface.viewers.ComboViewer
    A ComboViewer that allows typed text to be matched against the combo viewer's items and also allows setting the selection via arrow keys. If the escape key pressed, the content of the editor is set back to its initial state.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.eclipse.jface.viewers.StructuredViewer

        org.eclipse.jface.viewers.StructuredViewer.ColorAndFontCollector, org.eclipse.jface.viewers.StructuredViewer.ColorAndFontCollectorWithProviders

    • Field Summary

      • Fields inherited from class org.eclipse.jface.viewers.Viewer

        WIDGET_DATA_KEY

    • Constructor Summary

      Constructors 
      Constructor Description
      MatchItemComboViewer​(org.eclipse.swt.custom.CCombo combo)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      TimeBoundStringBuffer getBuffer()
      Returns the search buffer used during matching.
      void onEnter()
      Callback that is called when the enter key is released.
      protected void onEscape()
      Callback that is called when the escape key is released.
      protected void reset()
      Reset to initial state, i.e.
      void setClosestMatch​(java.lang.String text)
      Match given text against items of combo and set selection, if applicable.
      protected void setupListeners()
      Initializes this viewer.

      • Methods inherited from class org.eclipse.jface.viewers.ComboViewer

        getCCombo, getCombo, getControl, listAdd, listDeselectAll, listGetItemCount, listGetSelectionIndices, listRemove, listRemoveAll, listSetItem, listSetItems, listSetSelection, listShowSelection, reveal

      • Methods inherited from class org.eclipse.jface.viewers.AbstractListViewer

        add, add, doFindInputItem, doFindItem, doUpdateItem, getElementAt, getLabelProvider, getSelectionFromWidget, indexForElement, inputChanged, insert, internalRefresh, listGetTopIndex, listSetTopIndex, remove, remove, setLabelProvider, setSelectionToWidget

      • Methods inherited from class org.eclipse.jface.viewers.StructuredViewer

        addDoubleClickListener, addDragSupport, addDropSupport, addFilter, addOpenListener, addPostSelectionChangedListener, assertContentProviderType, assertElementsNotNull, associate, buildLabel, disassociate, equals, filter, findItem, findItems, fireDoubleClick, fireOpen, firePostSelectionChanged, getColorAndFontCollector, getComparator, getComparer, getFilteredChildren, getFilters, getItem, getRawChildren, getRoot, getSelection, getSortedChildren, getSorter, getStructuredSelection, handleDispose, handleDoubleSelect, handleInvalidSelection, handleLabelProviderChanged, handleOpen, handlePostSelect, handleSelect, hasFilters, hookControl, internalRefresh, internalUpdate, mapElement, needsRefilter, preservingSelection, refresh, refresh, refresh, refresh, refreshItem, removeDoubleClickListener, removeFilter, removeOpenListener, removePostSelectionChangedListener, resetFilters, setComparator, setComparer, setContentProvider, setFilters, setInput, setSelection, setSelectionToWidget, setSorter, setUseHashlookup, testFindItem, testFindItems, unmapAllElements, unmapElement, unmapElement, update, update, updateItem, updateSelection, usingElementMap

      • Methods inherited from class org.eclipse.jface.viewers.ContentViewer

        getContentProvider, getInput, labelProviderChanged

      • Methods inherited from class org.eclipse.jface.viewers.Viewer

        addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelection

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider

        addSelectionChangedListener, removeSelectionChangedListener, setSelection

    • Constructor Detail

      • MatchItemComboViewer

        public MatchItemComboViewer​(org.eclipse.swt.custom.CCombo combo)
        Constructor.
        Parameters:
        combo - the CCombo to be wrapped

    • Method Detail

      • onEnter

        public void onEnter()
        Callback that is called when the enter key is released. By default, this method sets the selection to be the one that matches the text within the combo, ignoring the given parameter.

      • setClosestMatch

        public void setClosestMatch​(java.lang.String text)
        Match given text against items of combo and set selection, if applicable. If no match has been found, reset to initial state.
        Parameters:
        text - the string to be matched

      • onEscape

        protected void onEscape()
        Callback that is called when the escape key is released. By default, this method does nothing, but note that at this point in time the text already has been reset to the initial text.

      • setupListeners

        protected void setupListeners()
        Initializes this viewer.

      • reset

        protected void reset()
        Reset to initial state, i.e. the initial text is restored and the search buffer is emptied.