Package org.fife.ui.autocomplete
Class ParameterizedCompletionChoicesWindow
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- java.awt.Window
-
- javax.swing.JWindow
-
- org.fife.ui.autocomplete.ParameterizedCompletionChoicesWindow
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
,javax.swing.RootPaneContainer
public class ParameterizedCompletionChoicesWindow extends javax.swing.JWindow
A small popup window offering a list of likely choices for a parameter when the user has code-completed a parameterized completion. For example, if they have just code-completed the C function "fprintf
", when entering the file name, this popup might display all local variables of type "char *
".- Version:
- 1.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JWindow
javax.swing.JWindow.AccessibleJWindow
-
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
-
-
Field Summary
Fields Modifier and Type Field Description private AutoCompletion
ac
The parent AutoCompletion instance.private java.util.List<java.util.List<Completion>>
choicesListList
A list of lists of choices for each parameter.private javax.swing.JList<Completion>
list
The list of completion choices.private javax.swing.DefaultListModel<Completion>
model
The currently displayed completion choices.private static java.util.Comparator<Completion>
SORT_BY_RELEVANCE_COMPARATOR
Comparator used to sort completions by their relevance before sorting them lexicographically.private javax.swing.JScrollPane
sp
The scroll pane containing the list.-
Fields inherited from class javax.swing.JWindow
accessibleContext, rootPane, rootPaneCheckingEnabled
-
-
Constructor Summary
Constructors Constructor Description ParameterizedCompletionChoicesWindow(java.awt.Window parent, AutoCompletion ac, ParameterizedCompletionContext context)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getSelectedChoice()
Returns the selected value.void
incSelection(int amount)
Changes the selected index.void
initialize(ParameterizedCompletion pc)
Initializes this window to offer suggestions for the parameters of a specific completion.void
setLocationRelativeTo(java.awt.Rectangle r)
Sets the location of this window relative to the given rectangle.void
setParameter(int param, java.lang.String prefix)
Displays the choices for the specified parameter matching the given text.void
setVisible(boolean visible)
Toggles the visibility of this popup window.void
updateUI()
Updates theLookAndFeel
of this window.-
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
-
-
-
-
Field Detail
-
ac
private AutoCompletion ac
The parent AutoCompletion instance.
-
list
private javax.swing.JList<Completion> list
The list of completion choices.
-
model
private javax.swing.DefaultListModel<Completion> model
The currently displayed completion choices.
-
choicesListList
private java.util.List<java.util.List<Completion>> choicesListList
A list of lists of choices for each parameter.
-
sp
private javax.swing.JScrollPane sp
The scroll pane containing the list.
-
SORT_BY_RELEVANCE_COMPARATOR
private static final java.util.Comparator<Completion> SORT_BY_RELEVANCE_COMPARATOR
Comparator used to sort completions by their relevance before sorting them lexicographically.
-
-
Constructor Detail
-
ParameterizedCompletionChoicesWindow
public ParameterizedCompletionChoicesWindow(java.awt.Window parent, AutoCompletion ac, ParameterizedCompletionContext context)
Constructor.- Parameters:
parent
- The parent window (hosting the text component).ac
- The auto-completion instance.context
- The completion context.
-
-
Method Detail
-
getSelectedChoice
public java.lang.String getSelectedChoice()
Returns the selected value.- Returns:
- The selected value, or
null
if nothing is selected.
-
incSelection
public void incSelection(int amount)
Changes the selected index.- Parameters:
amount
- The amount by which to change the selected index.
-
initialize
public void initialize(ParameterizedCompletion pc)
Initializes this window to offer suggestions for the parameters of a specific completion.- Parameters:
pc
- The completion whose parameters we should offer suggestions for.
-
setLocationRelativeTo
public void setLocationRelativeTo(java.awt.Rectangle r)
Sets the location of this window relative to the given rectangle.- Parameters:
r
- The visual position of the caret (in screen coordinates).
-
setParameter
public void setParameter(int param, java.lang.String prefix)
Displays the choices for the specified parameter matching the given text. This will display or hide this popup window as necessary.- Parameters:
param
- The index of the parameter the caret is currently in. This may be-1
if not in a parameter (i.e., on the comma between parameters).prefix
- Text in the parameter before the dot. This may benull
to represent the empty string.
-
setVisible
public void setVisible(boolean visible)
Toggles the visibility of this popup window.- Overrides:
setVisible
in classjava.awt.Window
- Parameters:
visible
- Whether this window should be visible.
-
updateUI
public void updateUI()
Updates theLookAndFeel
of this window.
-
-