org.jeditor.gui

Class Gutter

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.jeditor.gui.Gutter

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class Gutter
extends javax.swing.JComponent
implements javax.swing.SwingConstants

The Gutter implementation.

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 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 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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
Gutter(JEditor editor, CodeEditorDefaults defaults)

Method Summary

Modifier and Type	Method and Description
JEditor	getEditor() Return the Editor.
GutterHandler	getGutterHandler() Return the gutter handler which draws specific graphics and handles right clicks on the gutter.
int	getGutterWidth() Get the width of the expanded gutter
java.awt.Color	getHighlightedForeground() Get the foreground color for highlighted line numbers
int	getLineNumber(int y) Return the line number for an y position on the gutter.
int	getLineNumberAlignment() Identifies whether the horizontal alignment of the line numbers.
java.awt.Dimension	getMinimumSize()
java.awt.Dimension	getPreferredSize()
boolean	isCollapsed() Identifies whether the gutter is collapsed or expanded.
boolean	isExpandable() Identifies whether the gutter cab be collapsed or expanded.
boolean	isLineNumberingEnabled() Identifies whether or not the line numbers are drawn in the gutter
void	paintComponent(java.awt.Graphics gfx)
protected void	paintLineNumbers(java.awt.Graphics gfx)
void	setAnchorMark(java.awt.Color mark)
void	setBorder(javax.swing.border.Border border)
void	setBorder(int width, java.awt.Color color) Convenience method for setting a default matte border on the right with the specified border width and color
void	setCaretMark(java.awt.Color mark)
void	setCollapsed(boolean collapsed) Sets whether the gutter is collapsed or expanded and force the text area to update its layout if there is a change.
void	setDefaults(CodeEditorDefaults defaults) Set the Gutter defaults.
void	setExpandable(boolean expandable) Sets whether the gutter can be expanded or colllapses.
void	setFont(java.awt.Font font)
void	setGutterHandler(GutterHandler gutterHandler) Set the gutter handler for drawing specific graphcis and handling right clicks on the gutter.
void	setGutterWidth(int width) Set the width of the expanded gutter
void	setHighlightedForeground(java.awt.Color highlight) Set the foreground color for highlighted line numbers
void	setLineNumberAlignment(int alignment) Sets the horizontal alignment of the line numbers.
void	setLineNumberingEnabled(boolean enabled) Turns the line numbering on or off and causes the gutter to be repainted.
void	setSelectionMark(java.awt.Color mark)
void	toggleCollapsed() Toggles whether the gutter is collapsed or expanded.

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, 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

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, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

Gutter

public Gutter(JEditor editor,
              CodeEditorDefaults defaults)

Method Detail

setDefaults

public void setDefaults(CodeEditorDefaults defaults)

Set the Gutter defaults.

Parameters:

defaults - the defaults

getEditor

public JEditor getEditor()

Return the Editor.

Returns:

the Editor

setGutterHandler

public void setGutterHandler(GutterHandler gutterHandler)

Set the gutter handler for drawing specific graphcis and handling right clicks on the gutter. Note that by default if the gutterHandler is an AbstractGutterHandler, the method will call the AbstractGutterHandler.setGutter(org.jeditor.gui.Gutter) method internally.

Parameters:

gutterHandler - the gutter handler

getGutterHandler

public GutterHandler getGutterHandler()

Return the gutter handler which draws specific graphics and handles right clicks on the gutter.

Returns:

the gutter handler

paintComponent

public void paintComponent(java.awt.Graphics gfx)

Overrides:

paintComponent in class javax.swing.JComponent

getLineNumber

public int getLineNumber(int y)

Return the line number for an y position on the gutter. The returned number will be -1 if it does not correspond to any line.

Parameters:

y - the y position

Returns:

the line number

paintLineNumbers

protected void paintLineNumbers(java.awt.Graphics gfx)

setBorder

public void setBorder(int width,
                      java.awt.Color color)

Convenience method for setting a default matte border on the right with the specified border width and color

Parameters:

width - The border width (in pixels)

color - The border color

setBorder

public void setBorder(javax.swing.border.Border border)

Overrides:

setBorder in class javax.swing.JComponent

setFont

public void setFont(java.awt.Font font)

Overrides:

setFont in class javax.swing.JComponent

setHighlightedForeground

public void setHighlightedForeground(java.awt.Color highlight)

Set the foreground color for highlighted line numbers

Parameters:

highlight - The highlight color

getHighlightedForeground

public java.awt.Color getHighlightedForeground()

Get the foreground color for highlighted line numbers

Returns:

The highlight color

setCaretMark

public void setCaretMark(java.awt.Color mark)

setAnchorMark

public void setAnchorMark(java.awt.Color mark)

setSelectionMark

public void setSelectionMark(java.awt.Color mark)

setGutterWidth

public void setGutterWidth(int width)

Set the width of the expanded gutter

Parameters:

width - The gutter width

getGutterWidth

public int getGutterWidth()

Get the width of the expanded gutter

Returns:

The gutter width

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

isLineNumberingEnabled

public boolean isLineNumberingEnabled()

Identifies whether or not the line numbers are drawn in the gutter

Returns:

true if the line numbers are drawn, false otherwise

setLineNumberingEnabled

public void setLineNumberingEnabled(boolean enabled)

Turns the line numbering on or off and causes the gutter to be repainted.

Parameters:

enabled - true if line numbers are drawn, false otherwise

getLineNumberAlignment

public int getLineNumberAlignment()

Identifies whether the horizontal alignment of the line numbers.

Returns:

Gutter.RIGHT, Gutter.CENTER, Gutter.LEFT

setLineNumberAlignment

public void setLineNumberAlignment(int alignment)

Sets the horizontal alignment of the line numbers.

Parameters:

alignment - Gutter.RIGHT, Gutter.CENTER, Gutter.LEFT

isCollapsed

public boolean isCollapsed()

Identifies whether the gutter is collapsed or expanded.

Returns:

true if the gutter is collapsed, false if it is expanded

setCollapsed

public void setCollapsed(boolean collapsed)

Sets whether the gutter is collapsed or expanded and force the text area to update its layout if there is a change.

Parameters:

collapsed - true if the gutter is collapsed, false if it is expanded

setExpandable

public void setExpandable(boolean expandable)

Sets whether the gutter can be expanded or colllapses.

Parameters:

expandable - true if the gutter can be expanded or collapsed

isExpandable

public boolean isExpandable()

Identifies whether the gutter cab be collapsed or expanded.

Returns:

true if the gutter cab be collapsed or expanded

toggleCollapsed

public void toggleCollapsed()

Toggles whether the gutter is collapsed or expanded.