com.fr.design.gui.autocomplete

类 CompletionCellRenderer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

javax.swing.DefaultListCellRenderer

com.fr.design.gui.autocomplete.CompletionCellRenderer

所有已实现的接口:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.ListCellRenderer<java.lang.Object>, javax.swing.SwingConstants

public class CompletionCellRenderer
extends javax.swing.DefaultListCellRenderer

A cell renderer that adds some pizazz when rendering the standard Completion types, like Eclipse and NetBeans do. Specifically, this renderer handles:

• FunctionCompletions
• VariableCompletions
• MarkupTagCompletions
• ShorthandCompletions
• TemplateCompletions

版本:

1.0

作者:

Robert Futrell

另请参阅:

序列化表格

嵌套类概要

从类继承的嵌套类/接口 javax.swing.DefaultListCellRenderer

javax.swing.DefaultListCellRenderer.UIResource

从类继承的嵌套类/接口 javax.swing.JLabel

javax.swing.JLabel.AccessibleJLabel

从类继承的嵌套类/接口 javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

从类继承的嵌套类/接口 java.awt.Container

java.awt.Container.AccessibleAWTContainer

从类继承的嵌套类/接口 java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

字段概要

从类继承的字段 javax.swing.DefaultListCellRenderer

noFocusBorder

从类继承的字段 javax.swing.JLabel

labelFor

从类继承的字段 javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

从类继承的字段 java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

从接口继承的字段 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

从接口继承的字段 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

构造器概要

构造器

构造器和说明
CompletionCellRenderer() Constructor.
CompletionCellRenderer(javax.swing.DefaultListCellRenderer delegate) Constructor.

方法概要

方法

限定符和类型	方法和说明
void	delegateToSubstanceRenderer() Attempts to delegate rendering to a Substance cell renderer.
static java.awt.Color	getAlternateBackground() Returns the background color to use on alternating lines.
javax.swing.DefaultListCellRenderer	getDelegateRenderer() Returns the delegate renderer, or null if there is none.
java.awt.Font	getDisplayFont() Returns the font used when rendering completions.
java.awt.Component	getListCellRendererComponent(javax.swing.JList list, java.lang.Object value, int index, boolean selected, boolean hasFocus) Returns the renderer.
boolean	getShowTypes() Returns whether the types of fields and return types of methods are shown in the completion text.
protected void	paintComponent(java.awt.Graphics g)
protected void	prepareForFunctionCompletion(javax.swing.JList list, FunctionCompletion fc, int index, boolean selected, boolean hasFocus) Prepares this renderer to display a function completion.
protected void	prepareForMarkupTagCompletion(javax.swing.JList list, MarkupTagCompletion mc, int index, boolean selected, boolean hasFocus) Prepares this renderer to display a markup tag completion.
protected void	prepareForOtherCompletion(javax.swing.JList list, Completion c, int index, boolean selected, boolean hasFocus) Prepares this renderer to display a completion not specifically handled elsewhere.
protected void	prepareForTemplateCompletion(javax.swing.JList list, TemplateCompletion tc, int index, boolean selected, boolean hasFocus) Prepares this renderer to display a template completion.
protected void	prepareForVariableCompletion(javax.swing.JList list, VariableCompletion vc, int index, boolean selected, boolean hasFocus) Prepares this renderer to display a variable completion.
static void	setAlternateBackground(java.awt.Color altBG) Sets the background color to use on alternating lines.
void	setDelegateRenderer(javax.swing.DefaultListCellRenderer delegate) Sets the delegate renderer.
void	setDisplayFont(java.awt.Font font) Sets the font to use when rendering completion items.
protected void	setIconWithDefault(Completion completion, javax.swing.Icon defaultIcon) Sets the icon to display based off of a completion, falling back to a default icon if the completion has no icon.
void	setParamColor(java.awt.Color color) Sets the color to use for function arguments.
void	setShowTypes(boolean show) Sets whether the types of fields and return types of methods are shown in the completion text.
void	setTypeColor(java.awt.Color color) Sets the color to use for function/field types.
void	updateUI() Overridden to update our delegate, if necessary.

从类继承的方法 javax.swing.DefaultListCellRenderer

firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, invalidate, isOpaque, repaint, repaint, repaint, revalidate, validate

从类继承的方法 javax.swing.JLabel

checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition

从类继承的方法 javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

从类继承的方法 java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validateTree

从类继承的方法 java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

从类继承的方法 java.lang.Object

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

构造器详细资料

CompletionCellRenderer

public CompletionCellRenderer()

Constructor.

CompletionCellRenderer

public CompletionCellRenderer(javax.swing.DefaultListCellRenderer delegate)

Constructor. This is primarily a hook for Substance, or any other Look and Feel whose renderers look drastically different than standard DefaultListCellRenderers. Everything except for the text rendering will be done by the delegate. In almost all scenarios, you will want to use the no-argument constructor instead of this one.

参数:

delegate - The delegate renderer.

另请参阅:

delegateToSubstanceRenderer()

方法详细资料

delegateToSubstanceRenderer

public void delegateToSubstanceRenderer()
                                 throws java.lang.Exception

Attempts to delegate rendering to a Substance cell renderer. This should only be called if Substance is known to be on the classpath.

抛出:

java.lang.Exception - If Substance is not on the classpath, or some other error occurs creating the Substance cell renderer.

另请参阅:

Util.getUseSubstanceRenderers(), setDelegateRenderer(DefaultListCellRenderer)

getAlternateBackground

public static java.awt.Color getAlternateBackground()

Returns the background color to use on alternating lines.

返回:

The alternate background color. If this is null, alternating colors are not used.

另请参阅:

setAlternateBackground(Color)

getDelegateRenderer

public javax.swing.DefaultListCellRenderer getDelegateRenderer()

Returns the delegate renderer, or null if there is none.

返回:

The delegate renderer.

另请参阅:

setDelegateRenderer(DefaultListCellRenderer)

getDisplayFont

public java.awt.Font getDisplayFont()

Returns the font used when rendering completions.

返回:

The font. If this is null, then the default list font is used.

另请参阅:

setDisplayFont(Font)

getListCellRendererComponent

public java.awt.Component getListCellRendererComponent(javax.swing.JList list,
                                              java.lang.Object value,
                                              int index,
                                              boolean selected,
                                              boolean hasFocus)

Returns the renderer.

指定者:

getListCellRendererComponent 在接口中 javax.swing.ListCellRenderer<java.lang.Object>

覆盖:

getListCellRendererComponent 在类中 javax.swing.DefaultListCellRenderer

参数:

list - The list of choices being rendered.

value - The Completion being rendered.

index - The index into list being rendered.

selected - Whether the item is selected.

hasFocus - Whether the item has focus.

getShowTypes

public boolean getShowTypes()

Returns whether the types of fields and return types of methods are shown in the completion text.

返回:

Whether to show the types.

另请参阅:

setShowTypes(boolean)

paintComponent

protected void paintComponent(java.awt.Graphics g)

覆盖:

paintComponent 在类中 javax.swing.JComponent

prepareForFunctionCompletion

protected void prepareForFunctionCompletion(javax.swing.JList list,
                                FunctionCompletion fc,
                                int index,
                                boolean selected,
                                boolean hasFocus)

Prepares this renderer to display a function completion.

参数:

list - The list of choices being rendered.

fc - The completion to render.

index - The index into list being rendered.

selected - Whether the item is selected.

hasFocus - Whether the item has focus.

prepareForMarkupTagCompletion

protected void prepareForMarkupTagCompletion(javax.swing.JList list,
                                 MarkupTagCompletion mc,
                                 int index,
                                 boolean selected,
                                 boolean hasFocus)

Prepares this renderer to display a markup tag completion.

参数:

list - The list of choices being rendered.

mc - The completion to render.

index - The index into list being rendered.

selected - Whether the item is selected.

hasFocus - Whether the item has focus.

prepareForOtherCompletion

protected void prepareForOtherCompletion(javax.swing.JList list,
                             Completion c,
                             int index,
                             boolean selected,
                             boolean hasFocus)

Prepares this renderer to display a completion not specifically handled elsewhere.

参数:

list - The list of choices being rendered.

c - The completion to render.

index - The index into list being rendered.

selected - Whether the item is selected.

hasFocus - Whether the item has focus.

prepareForTemplateCompletion

protected void prepareForTemplateCompletion(javax.swing.JList list,
                                TemplateCompletion tc,
                                int index,
                                boolean selected,
                                boolean hasFocus)

Prepares this renderer to display a template completion.

参数:

list - The list of choices being rendered.

tc - The completion to render.

index - The index into list being rendered.

selected - Whether the item is selected.

hasFocus - Whether the item has focus.

prepareForVariableCompletion

protected void prepareForVariableCompletion(javax.swing.JList list,
                                VariableCompletion vc,
                                int index,
                                boolean selected,
                                boolean hasFocus)

Prepares this renderer to display a variable completion.

参数:

list - The list of choices being rendered.

vc - The completion to render.

index - The index into list being rendered.

selected - Whether the item is selected.

hasFocus - Whether the item has focus.

setAlternateBackground

public static void setAlternateBackground(java.awt.Color altBG)

Sets the background color to use on alternating lines.

参数:

altBG - The new alternate background color. If this is null, alternating lines will not use different background colors.

另请参阅:

getAlternateBackground()

setDelegateRenderer

public void setDelegateRenderer(javax.swing.DefaultListCellRenderer delegate)

Sets the delegate renderer. Most users will never use this method; it is primarily a hook for Substance and other Look and Feels whose renderers look drastically different from the standard DefaultListCellRenderer.

参数:

delegate - The new delegate renderer. If this is null, the default rendering of this component is used.

另请参阅:

getDelegateRenderer(), delegateToSubstanceRenderer()

setDisplayFont

public void setDisplayFont(java.awt.Font font)

Sets the font to use when rendering completion items.

参数:

font - The font to use. If this is null, then the default list font is used.

另请参阅:

getDisplayFont()

setIconWithDefault

protected void setIconWithDefault(Completion completion,
                      javax.swing.Icon defaultIcon)

Sets the icon to display based off of a completion, falling back to a default icon if the completion has no icon.

参数:

completion - The completion to check.

defaultIcon - The icon to use if completion does not specify an icon.

setParamColor

public void setParamColor(java.awt.Color color)

Sets the color to use for function arguments.

参数:

color - The color to use. This is ignored if null.

另请参阅:

setTypeColor(Color)

setShowTypes

public void setShowTypes(boolean show)

Sets whether the types of fields and return types of methods are shown in the completion text.

参数:

show - Whether to show the types.

另请参阅:

getShowTypes()

setTypeColor

public void setTypeColor(java.awt.Color color)

Sets the color to use for function/field types. Note that if getShowTypes() returns false, this property effectively does nothing.

参数:

color - The color to use for types. This is ignored if null.

另请参阅:

setShowTypes(boolean), setParamColor(Color)

updateUI

public void updateUI()

Overridden to update our delegate, if necessary.

覆盖:

updateUI 在类中 javax.swing.JLabel