Module platform

Package de.grogra.pf.ui.autocomplete.impl

Class AutoCompletePopupWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

javax.swing.JWindow

de.grogra.pf.ui.autocomplete.impl.AutoCompletePopupWindow

All Implemented Interfaces:

MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, CaretListener, ListSelectionListener, RootPaneContainer

public class AutoCompletePopupWindow
extends JWindow
implements CaretListener, ListSelectionListener, MouseListener

The actual popup window of choices. When visible, this window intercepts certain keystrokes in the parent text component and uses them to navigate the completion choices instead. If Enter or Escape is pressed, the window hides itself and notifies the AbstractAutoCompletor to insert the selected text. Copied and adapted for GroIMP

Version:

1.0

Author:

Robert Futrell

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JWindow

JWindow.AccessibleJWindow

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JWindow

accessibleContext, rootPane, rootPaneCheckingEnabled

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

Method Summary

Modifier and Type	Method	Description
void	caretUpdate(CaretEvent e)
protected void	doAutocomplete()
Color	getDescriptionWindowColor()	Returns the background color of the description window.
ListCellRenderer	getListCellRenderer()	Returns the default list cell renderer used when a completion provider does not supply its own.
Completion	getSelection()	Returns the selected value, or null if nothing is selected.
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	setCompletions(List<Completion> completions)	Sets the completions to display in the choices list.
void	setDescriptionWindowColor(Color color)	Sets the color of the description window.
void	setDescriptionWindowSize(Dimension size)	Sets the size of the description window.
void	setListCellRenderer(ListCellRenderer<Object> renderer)	Sets the default list cell renderer to use when a completion provider does not supply its own.
void	setLocationRelativeTo(Rectangle r)	Sets the location of this window to be "good" relative to the specified rectangle.
void	setVisible(boolean visible)	Toggles the visibility of this popup window.
void	updateUI()	Updates the LookAndFeel of this window and the description window.
void	valueChanged(ListSelectionEvent e)	Called when a new item is selected in the popup list.

Methods inherited from class javax.swing.JWindow

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setGlassPane, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update, windowInit

Methods inherited from class java.awt.Window

addNotify, 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, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBackground, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setOpacity, setShape, setSize, setSize, setType, show, toBack, 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

Method Details

caretUpdate

public void caretUpdate(CaretEvent e)

Specified by:

caretUpdate in interface CaretListener

doAutocomplete

protected void doAutocomplete()

getDescriptionWindowColor

public Color getDescriptionWindowColor()

Returns the background color of the description window.

Returns:

The background color, or null if it has not been created yet.

See Also:

• setDescriptionWindowColor(Color)

getListCellRenderer

public ListCellRenderer getListCellRenderer()

Returns the default list cell renderer used when a completion provider does not supply its own.

Returns:

The default list cell renderer.

See Also:

• setListCellRenderer(ListCellRenderer)

getSelection

public Completion getSelection()

Returns the selected value, or null if nothing is selected.

Returns:

The selected value.

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

setCompletions

public void setCompletions(List<Completion> completions)

Sets the completions to display in the choices list. The first completion is selected.

Parameters:

completions - The completions to display.

setDescriptionWindowSize

public void setDescriptionWindowSize(Dimension size)

Sets the size of the description window.

Parameters:

size - The new size. This cannot be null.

setDescriptionWindowColor

public void setDescriptionWindowColor(Color color)

Sets the color of the description window.

Parameters:

color - The new color. This cannot be null.

See Also:

• getDescriptionWindowColor()

setListCellRenderer

public void setListCellRenderer(ListCellRenderer<Object> renderer)

Sets the default list cell renderer to use when a completion provider does not supply its own.

Parameters:

renderer - The renderer to use. If this is null, a default renderer is used.

See Also:

• getListCellRenderer()

setLocationRelativeTo

public void setLocationRelativeTo(Rectangle r)

Sets the location of this window to be "good" relative to the specified rectangle. That rectangle should be the location of the text component's caret, in screen coordinates.

Parameters:

r - The text component's caret position, in screen coordinates.

setVisible

public void setVisible(boolean visible)

Toggles the visibility of this popup window.

Overrides:

setVisible in class Window

Parameters:

visible - Whether this window should be visible.

updateUI

public void updateUI()

Updates the LookAndFeel of this window and the description window.

valueChanged

public void valueChanged(ListSelectionEvent e)

Called when a new item is selected in the popup list.

Specified by:

valueChanged in interface ListSelectionListener

Parameters:

e - The event.