Package com.intellij.openapi.editor.ex

Class EditorGutterComponentEx

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.intellij.openapi.editor.ex.EditorGutterComponentEx

All Implemented Interfaces:

EditorGutter, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public abstract class EditorGutterComponentEx
extends javax.swing.JComponent
implements EditorGutter

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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 and Description
static DataKey<java.awt.Point>	ICON_CENTER_POSITION The key to retrieve a editor gutter icon center position of a latest actionable click inside the gutter.
static DataKey<java.lang.Integer>	LOGICAL_LINE_AT_CURSOR The key to retrieve a logical editor line position of a latest actionable click inside the gutter.

Fields inherited from class javax.swing.JComponent

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

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.intellij.openapi.editor.EditorGutter

KEY

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
EditorGutterComponentEx()

Method Summary

Modifier and Type	Method and Description
abstract FoldRegion	findFoldingAnchorAt(int x, int y)
abstract int	getAnnotationsAreaOffset()
abstract int	getAnnotationsAreaWidth()
abstract java.awt.Point	getCenterPoint(GutterIconRenderer renderer)
GutterMark	getGutterRenderer(java.awt.Point p)
abstract java.util.List<GutterMark>	getGutterRenderers(int line)
abstract int	getIconAreaOffset()
abstract int	getIconsAreaWidth()
abstract int	getLineMarkerAreaOffset()
abstract int	getLineMarkerFreePaintersAreaOffset()
abstract int	getWhitespaceSeparatorOffset()
abstract void	revalidateMarkup()
abstract void	setCanCloseAnnotations(boolean canCloseAnnotations) When set to false, makes EditorGutter.closeAllAnnotations() a no-op and hides the corresponding context menu action.
abstract void	setForceShowLeftFreePaintersArea(boolean value)
abstract void	setForceShowRightFreePaintersArea(boolean value)
abstract void	setGutterPopupGroup(ActionGroup group)
abstract void	setInitialIconAreaWidth(int width)
void	setLineNumberConvertor(TIntFunction lineNumberConvertor) Deprecated. Use EditorGutter.setLineNumberConverter(LineNumberConverter) instead.
void	setLineNumberConvertor(TIntFunction convertor1, TIntFunction convertor2) Deprecated. Use EditorGutter.setLineNumberConverter(LineNumberConverter, LineNumberConverter) instead.
abstract void	setPaintBackground(boolean value)
abstract void	setShowDefaultGutterPopup(boolean show)

Methods inherited from class javax.swing.JComponent

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, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, 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, updateUI

Methods inherited from class 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, 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

Methods inherited from class 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.editor.EditorGutter

closeAllAnnotations, closeTextAnnotations, getTextAnnotations, isAnnotationsShown, registerTextAnnotation, registerTextAnnotation, setLineNumberConverter, setLineNumberConverter

Field Detail

LOGICAL_LINE_AT_CURSOR

public static final DataKey<java.lang.Integer> LOGICAL_LINE_AT_CURSOR

The key to retrieve a logical editor line position of a latest actionable click inside the gutter. Available to gutter popup actions (see setGutterPopupGroup(ActionGroup), GutterIconRenderer.getPopupMenuActions(), TextAnnotationGutterProvider.getPopupActions(int, Editor))

ICON_CENTER_POSITION

public static final DataKey<java.awt.Point> ICON_CENTER_POSITION

The key to retrieve a editor gutter icon center position of a latest actionable click inside the gutter. Available to gutter popup actions (see setGutterPopupGroup(ActionGroup), GutterIconRenderer.getPopupMenuActions(), TextAnnotationGutterProvider.getPopupActions(int, Editor))

Constructor Detail

EditorGutterComponentEx

public EditorGutterComponentEx()

Method Detail

findFoldingAnchorAt

public abstract FoldRegion findFoldingAnchorAt(int x,
                                               int y)

getGutterRenderers

public abstract java.util.List<GutterMark> getGutterRenderers(int line)

getWhitespaceSeparatorOffset

public abstract int getWhitespaceSeparatorOffset()

revalidateMarkup

public abstract void revalidateMarkup()

getLineMarkerAreaOffset

public abstract int getLineMarkerAreaOffset()

getIconAreaOffset

public abstract int getIconAreaOffset()

getLineMarkerFreePaintersAreaOffset

public abstract int getLineMarkerFreePaintersAreaOffset()

getIconsAreaWidth

public abstract int getIconsAreaWidth()

getAnnotationsAreaOffset

public abstract int getAnnotationsAreaOffset()

getAnnotationsAreaWidth

public abstract int getAnnotationsAreaWidth()

getCenterPoint

public abstract java.awt.Point getCenterPoint(GutterIconRenderer renderer)

setLineNumberConvertor

@Deprecated
public void setLineNumberConvertor(TIntFunction lineNumberConvertor)

Deprecated. Use EditorGutter.setLineNumberConverter(LineNumberConverter) instead.

See Also:

LineNumberConverterAdapter

setLineNumberConvertor

@Deprecated
public void setLineNumberConvertor(TIntFunction convertor1,
                                   TIntFunction convertor2)

Deprecated. Use EditorGutter.setLineNumberConverter(LineNumberConverter, LineNumberConverter) instead.

See Also:

LineNumberConverterAdapter

setShowDefaultGutterPopup

public abstract void setShowDefaultGutterPopup(boolean show)

setCanCloseAnnotations

public abstract void setCanCloseAnnotations(boolean canCloseAnnotations)

When set to false, makes EditorGutter.closeAllAnnotations() a no-op and hides the corresponding context menu action.

setGutterPopupGroup

public abstract void setGutterPopupGroup(ActionGroup group)

setPaintBackground

public abstract void setPaintBackground(boolean value)

setForceShowLeftFreePaintersArea

public abstract void setForceShowLeftFreePaintersArea(boolean value)

setForceShowRightFreePaintersArea

public abstract void setForceShowRightFreePaintersArea(boolean value)

setInitialIconAreaWidth

public abstract void setInitialIconAreaWidth(int width)

getGutterRenderer

public GutterMark getGutterRenderer(java.awt.Point p)