public class Gutter
extends javax.swing.JComponent
implements javax.swing.SwingConstants
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_FOLD_PAINTER_SERVICE |
static int |
DEFAULT_LAYER
Default extension layer.
|
static java.lang.String |
FOLD_PAINTER_PROPERTY
Fold painter service.
|
static java.lang.String |
FOLD_PAINTER_SERVICE |
static int |
HIGHEST_LAYER
Highest possible layer.
|
static int |
LOWEST_LAYER
The lowest possible layer.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Modifier and Type | Method and Description |
---|---|
void |
addExtension(int layer,
TextAreaExtension extension)
Adds a text area extension, which can perform custom painting and
tool tip handling.
|
void |
addExtension(TextAreaExtension extension)
Adds a text area extension, which can perform custom painting and
tool tip handling.
|
java.awt.Color |
getCurrentLineForeground() |
TextAreaExtension[] |
getExtensions()
Returns an array of registered text area extensions.
|
java.awt.Color |
getFoldColor() |
java.awt.Color |
getHighlightedForeground()
Get the foreground color for highlighted line numbers
|
int |
getHighlightInterval()
Sets the number of lines between highlighted line numbers.
|
int |
getLineNumberAlignment()
Identifies whether the horizontal alignment of the line numbers.
|
java.awt.Dimension |
getMinimumSize() |
java.awt.Dimension |
getPreferredSize() |
GutterPopupHandler |
getSelectionPopupHandler() |
java.awt.Color |
getStructureHighlightColor()
Returns the structure highlight color.
|
java.lang.String |
getToolTipText(java.awt.event.MouseEvent evt)
Returns the tool tip to display at the specified location.
|
boolean |
isCurrentLineHighlightEnabled() |
boolean |
isExpanded()
Identifies whether the gutter is collapsed or expanded.
|
boolean |
isSelectionAreaEnabled() |
boolean |
isStructureHighlightEnabled()
Returns true if structure highlighting is enabled, false otherwise.
|
void |
paintComponent(java.awt.Graphics _gfx) |
void |
removeExtension(TextAreaExtension extension)
Removes a text area extension.
|
void |
setBorder(javax.swing.border.Border border) |
void |
setBorder(int width,
java.awt.Color color1,
java.awt.Color color2,
java.awt.Color color3)
Convenience method for setting a default matte border on the right
with the specified border width and color
|
void |
setCurrentLineForeground(java.awt.Color highlight) |
void |
setCurrentLineHighlightEnabled(boolean enabled) |
void |
setExpanded(boolean expanded)
Sets whether the gutter is collapsed or expanded and force the text
area to update its layout if there is a change.
|
void |
setFoldColor(java.awt.Color foldColor) |
void |
setFoldPainter(FoldPainter painter) |
void |
setFont(java.awt.Font font) |
void |
setGutterEnabled(boolean enabled) |
void |
setHighlightedForeground(java.awt.Color highlight) |
void |
setHighlightInterval(int interval)
Sets the number of lines between highlighted line numbers.
|
void |
setLineNumberAlignment(int alignment)
Sets the horizontal alignment of the line numbers.
|
void |
setMinLineNumberDigitCount(int min) |
void |
setMouseActionsProvider(MouseActionsProvider mouseActionsProvider) |
void |
setSelectionAreaBackground(java.awt.Color bgColor) |
void |
setSelectionAreaEnabled(boolean enabled) |
void |
setSelectionAreaWidth(int width) |
void |
setSelectionPopupHandler(GutterPopupHandler handler) |
void |
setStructureHighlightColor(java.awt.Color structureHighlightColor)
Sets the structure highlight color.
|
void |
setStructureHighlightEnabled(boolean structureHighlight)
Enables or disables structure highlighting.
|
void |
toggleExpanded()
Toggles whether the gutter is collapsed or expanded.
|
void |
updateBorder()
Sets the border differently if the text area has focus or not.
|
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, 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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
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, invalidate, 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, validate, validateTree
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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, imageUpdate, 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, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public static final int LOWEST_LAYER
addExtension(int,TextAreaExtension)
,
Constant Field Valuespublic static final int DEFAULT_LAYER
public static final int HIGHEST_LAYER
public static final java.lang.String FOLD_PAINTER_PROPERTY
public static final java.lang.String FOLD_PAINTER_SERVICE
public static final java.lang.String DEFAULT_FOLD_PAINTER_SERVICE
public Gutter(TextArea textArea)
public void setFoldPainter(FoldPainter painter)
public void paintComponent(java.awt.Graphics _gfx)
paintComponent
in class javax.swing.JComponent
public void addExtension(TextAreaExtension extension)
extension
- The extensionpublic void addExtension(int layer, TextAreaExtension extension)
layer
- The layer to add the extension to. Note that more than
extension can share the same layer.extension
- The extensionpublic void removeExtension(TextAreaExtension extension)
extension
- The extensionpublic TextAreaExtension[] getExtensions()
public java.lang.String getToolTipText(java.awt.event.MouseEvent evt)
getToolTipText
in class javax.swing.JComponent
evt
- The mouse eventpublic void setBorder(int width, java.awt.Color color1, java.awt.Color color2, java.awt.Color color3)
width
- The border width (in pixels)color1
- The focused border colorcolor2
- The unfocused border colorcolor3
- The gutter/text area gap colorpublic void updateBorder()
public void setBorder(javax.swing.border.Border border)
setBorder
in class javax.swing.JComponent
public void setMinLineNumberDigitCount(int min)
public void setFont(java.awt.Font font)
setFont
in class javax.swing.JComponent
public void setGutterEnabled(boolean enabled)
public boolean isSelectionAreaEnabled()
public void setSelectionAreaEnabled(boolean enabled)
public void setSelectionAreaBackground(java.awt.Color bgColor)
public void setSelectionAreaWidth(int width)
public java.awt.Color getHighlightedForeground()
public void setHighlightedForeground(java.awt.Color highlight)
public java.awt.Color getCurrentLineForeground()
public void setCurrentLineForeground(java.awt.Color highlight)
public java.awt.Color getFoldColor()
public void setFoldColor(java.awt.Color foldColor)
public java.awt.Dimension getPreferredSize()
getPreferredSize
in class javax.swing.JComponent
public java.awt.Dimension getMinimumSize()
getMinimumSize
in class javax.swing.JComponent
public int getLineNumberAlignment()
public void setLineNumberAlignment(int alignment)
alignment
- Gutter.RIGHT, Gutter.CENTER, Gutter.LEFTpublic boolean isExpanded()
public void setExpanded(boolean expanded)
expanded
- true if the gutter is expanded,
false if it is collapsedpublic void toggleExpanded()
public int getHighlightInterval()
public void setHighlightInterval(int interval)
interval
- The number of lines between highlighted line numberspublic boolean isCurrentLineHighlightEnabled()
public void setCurrentLineHighlightEnabled(boolean enabled)
public final java.awt.Color getStructureHighlightColor()
public final void setStructureHighlightColor(java.awt.Color structureHighlightColor)
structureHighlightColor
- The structure highlight colorpublic final boolean isStructureHighlightEnabled()
public final void setStructureHighlightEnabled(boolean structureHighlight)
structureHighlight
- True if structure highlighting should be
enabled, false otherwisepublic void setSelectionPopupHandler(GutterPopupHandler handler)
public GutterPopupHandler getSelectionPopupHandler()
public void setMouseActionsProvider(MouseActionsProvider mouseActionsProvider)