org.gjt.sp.jedit.textarea
Class Gutter

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byorg.gjt.sp.jedit.textarea.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

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
Gutter(JEditTextArea textArea, TextAreaDefaults defaults)
           
 
Method Summary
 void addCustomHighlight(TextAreaHighlight highlight)
          Adds a custom highlight painter.
 javax.swing.JPopupMenu getContextMenu()
           
 int getGutterWidth()
          Get the width of the expanded gutter
 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()
           
 java.lang.String getToolTipText(java.awt.event.MouseEvent evt)
           
 boolean isCollapsed()
          Identifies whether the gutter is 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 paintCustomHighlights(java.awt.Graphics gfx)
           
protected  void paintLineNumbers(java.awt.Graphics gfx)
           
 void setAnchorMark(java.awt.Color mark)
           
 void setAntiAliasingEnabled(boolean on)
           
 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 setContextMenu(javax.swing.JPopupMenu context)
           
 void setFont(java.awt.Font font)
           
 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 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 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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Gutter

public Gutter(JEditTextArea textArea,
              TextAreaDefaults defaults)
Method Detail

setAntiAliasingEnabled

public void setAntiAliasingEnabled(boolean on)

paintComponent

public void paintComponent(java.awt.Graphics gfx)

paintLineNumbers

protected void paintLineNumbers(java.awt.Graphics gfx)

paintCustomHighlights

protected void paintCustomHighlights(java.awt.Graphics gfx)

addCustomHighlight

public void addCustomHighlight(TextAreaHighlight highlight)
Adds a custom highlight painter.

Parameters:
highlight - The highlight

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)

setFont

public void setFont(java.awt.Font font)

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

getMinimumSize

public java.awt.Dimension getMinimumSize()

getToolTipText

public java.lang.String getToolTipText(java.awt.event.MouseEvent evt)

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

toggleCollapsed

public void toggleCollapsed()
Toggles whether the gutter is collapsed or expanded.


getHighlightInterval

public int getHighlightInterval()
Sets the number of lines between highlighted line numbers.

Returns:
The number of lines between highlighted line numbers or zero if highlighting is disabled

setHighlightInterval

public void setHighlightInterval(int interval)
Sets the number of lines between highlighted line numbers. Any value less than or equal to one will result in highlighting being disabled.

Parameters:
interval - The number of lines between highlighted line numbers

getContextMenu

public javax.swing.JPopupMenu getContextMenu()

setContextMenu

public void setContextMenu(javax.swing.JPopupMenu context)


Copyright © 2002 Romain Guy.