Class CompletionWindow

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

    public class CompletionWindow
    extends javax.swing.JDialog
    Window containing list of all suitable completion items.
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JDialog

        javax.swing.JDialog.AccessibleJDialog
      • Nested classes/interfaces inherited from class java.awt.Dialog

        java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
      • Nested classes/interfaces inherited from class java.awt.Window

        java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer
      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Vector allCompletionItems
      List of all possible completion items.
      private javax.swing.JList jlCompletion  
      private javax.swing.JScrollPane spCompletion  
      private javax.swing.JDialog taskDialog
      Reference to task dialog for passing focus after completion is done.
      private javax.swing.text.JTextComponent textComponent
      Text component that invoked this completion window.
      • Fields inherited from class javax.swing.JDialog

        accessibleContext, rootPane, rootPaneCheckingEnabled
      • Fields inherited from class java.awt.Dialog

        DEFAULT_MODALITY_TYPE
      • Fields inherited from class java.awt.Component

        BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
      • Fields inherited from interface java.awt.image.ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
      • Fields inherited from interface javax.swing.WindowConstants

        DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
    • Constructor Summary

      Constructors 
      Constructor Description
      CompletionWindow​(javax.swing.text.JTextComponent textComponent, java.util.Vector allCompletionItems, javax.swing.JDialog taskDialog)
      Creates new form CompletionWindow
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private void completeItem​(java.lang.String value)
      Completes text in text component with selected completion item.
      private java.util.Vector getCompletionItems​(java.lang.String prefix)
      Returns list of completion items that start with given prefix.
      private java.lang.String getIncompleteWord()
      Returns part of word that user typed to narrow list of all completion items.
      private java.lang.String getPrefix()
      Returns text that is before currently incomplete word.
      private java.lang.String getSuffix()
      Returns text that is after currently incomplete word.
      private java.util.Vector getUsedItems()
      Returns list of items that were already used in the text component.
      private void initComponents()
      This method is called from within the constructor to initialize the form.
      private void jlCompletionFocusLost​(java.awt.event.FocusEvent evt)  
      private void jlCompletionKeyPressed​(java.awt.event.KeyEvent evt)  
      private void jlCompletionMouseClicked​(java.awt.event.MouseEvent evt)  
      private void jlCompletionMouseExited​(java.awt.event.MouseEvent evt)  
      private void reduceCompletionBy​(char key)
      Reduces list of completion items by given character.
      void setCompletionItems​(java.util.Vector completionItems)
      Sets list of completion items to given vector.
      • Methods inherited from class javax.swing.JDialog

        addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
      • Methods inherited from class java.awt.Dialog

        addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack
      • Methods inherited from class java.awt.Window

        addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
      • Methods inherited from class java.lang.Object

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

      • textComponent

        private javax.swing.text.JTextComponent textComponent
        Text component that invoked this completion window.
      • allCompletionItems

        private java.util.Vector allCompletionItems
        List of all possible completion items.
      • taskDialog

        private final javax.swing.JDialog taskDialog
        Reference to task dialog for passing focus after completion is done.
      • jlCompletion

        private javax.swing.JList jlCompletion
      • spCompletion

        private javax.swing.JScrollPane spCompletion
    • Constructor Detail

      • CompletionWindow

        public CompletionWindow​(javax.swing.text.JTextComponent textComponent,
                                java.util.Vector allCompletionItems,
                                javax.swing.JDialog taskDialog)
        Creates new form CompletionWindow
        Parameters:
        textComponent - Text component that invoked this completion window.
        allCompletionItems - List of all possible completion items.
    • Method Detail

      • initComponents

        private void initComponents()
        This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.
      • jlCompletionMouseClicked

        private void jlCompletionMouseClicked​(java.awt.event.MouseEvent evt)
      • jlCompletionMouseExited

        private void jlCompletionMouseExited​(java.awt.event.MouseEvent evt)
      • jlCompletionFocusLost

        private void jlCompletionFocusLost​(java.awt.event.FocusEvent evt)
      • jlCompletionKeyPressed

        private void jlCompletionKeyPressed​(java.awt.event.KeyEvent evt)
      • setCompletionItems

        public void setCompletionItems​(java.util.Vector completionItems)
        Sets list of completion items to given vector.
        Parameters:
        completionItems - New list of completion items.
      • getCompletionItems

        private java.util.Vector getCompletionItems​(java.lang.String prefix)
        Returns list of completion items that start with given prefix.
        Parameters:
        prefix - Prefix to be used for finding suitable completion items.
        Returns:
        List of all completion items that begin with given prefix.
      • reduceCompletionBy

        private void reduceCompletionBy​(char key)
        Reduces list of completion items by given character.
        Parameters:
        key - New character that user typed to extend prefix.
      • completeItem

        private void completeItem​(java.lang.String value)
        Completes text in text component with selected completion item.
        Parameters:
        value - Selected completion item to be added to text component.
      • getIncompleteWord

        private java.lang.String getIncompleteWord()
        Returns part of word that user typed to narrow list of all completion items. i.e. "meeting int|" returns "int".
        Returns:
        Incomplete word that user typed to narrow list of all completion items.
      • getPrefix

        private java.lang.String getPrefix()
        Returns text that is before currently incomplete word. i.e. "meeting int|" returns "meeting ".
        Returns:
        Text that is before currently incomplete word.
      • getSuffix

        private java.lang.String getSuffix()
        Returns text that is after currently incomplete word. i.e. "meeting int| hello" returns " hello".
        Returns:
        Text that is after currently incomplete word.
      • getUsedItems

        private java.util.Vector getUsedItems()
        Returns list of items that were already used in the text component. i.e. "meeting int| hello" returns "meeting" and "hello".
        Returns:
        Items that were already used in the text component.