com.jidesoft.editor.margin
Class AbstractLineMargin

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.jidesoft.margin.AbstractMargin
                  com.jidesoft.margin.AbstractRowMargin
                      com.jidesoft.editor.margin.AbstractLineMargin

All Implemented Interfaces:

Margin, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener

Direct Known Subclasses:

LineNumberMargin, LineOffsetMargin

public abstract class AbstractLineMargin
extends AbstractRowMargin
implements MouseListener, MouseMotionListener

An abstract class which is the base of any line margins such as LineNumberMargin. It implements AbstractRowMargin.paintMargin(java.awt.Graphics) in AbstractMargin and added a new abstract method paintLineMargin(java.awt.Graphics, java.awt.Rectangle, int) to paint the margin for a particular line. In addition, it allows you to provide a tooltip for each line by implementing getToolTipText(int).

See Also:

Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected CodeEditor

_editor

Fields inherited from class com.jidesoft.margin.AbstractRowMargin

_rowMarginPainters

Fields inherited from class com.jidesoft.margin.AbstractMargin

_marginPainters, _marginSupport, _modelChangedCallback, _preferredSize, _repaintCallback, PROPERTY_CLICK_TO_SELECT

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 java.awt.image.ImageObserver

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

Constructor Summary

AbstractLineMargin(CodeEditor editor)

Method Summary

void	addLineMarginPainter(LineMarginPainter painter)
CodeEditor	getCodeEditor()
protected List<RowMarginPainter>	getLineMarginPainters()
abstract String	getToolTipText(int line) Gets the tool tip text from the view line index.
void	mouseClicked(MouseEvent e) Any mouse click will select the line in the code editor.
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
abstract void	paintLineMargin(Graphics g, Rectangle rect, int line) Paint line margin.
void	paintRowMargin(Graphics g, Rectangle rect, int row) Paint line margin.
void	removeLineMarginPainter(LineMarginPainter painter)

Methods inherited from class com.jidesoft.margin.AbstractRowMargin

addRowMarginPainter, getRowMarginPainters, getToolTipLocation, getToolTipText, paintMargin, removeRowMarginPainter

Methods inherited from class com.jidesoft.margin.AbstractMargin

addMarginPainter, createModelChangedCallback, createRepaintCallback, getMarginComponent, getMarginPainters, getMarginSupport, getPreferredSize, invalidate, isClickToSelect, paintBackground, paintComponent, removeMarginPainter, setClickToSelect, setMarginSupport

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jidesoft.margin.Margin

getPreferredWidth

Field Detail

_editor

protected CodeEditor _editor

Constructor Detail

AbstractLineMargin

public AbstractLineMargin(CodeEditor editor)

Method Detail

getCodeEditor

public CodeEditor getCodeEditor()

addLineMarginPainter

public void addLineMarginPainter(LineMarginPainter painter)

removeLineMarginPainter

public void removeLineMarginPainter(LineMarginPainter painter)

getLineMarginPainters

protected List<RowMarginPainter> getLineMarginPainters()

paintRowMargin

public void paintRowMargin(Graphics g,
                           Rectangle rect,
                           int row)

Description copied from class: AbstractRowMargin

Paint line margin.

Specified by:

paintRowMargin in class AbstractRowMargin

Parameters:

g - the Graphics instance

rect - the rectangle to paint the line margin

row - the view line index to be painted

paintLineMargin

public abstract void paintLineMargin(Graphics g,
                                     Rectangle rect,
                                     int line)

Paint line margin.

Parameters:

g - the Graphics instance

rect - the rectangle to paint the line margin

line - the view line index to be painted

getToolTipText

public abstract String getToolTipText(int line)

Gets the tool tip text from the view line index.

Specified by:

getToolTipText in class AbstractRowMargin

Parameters:

line - the view line index

Returns:

the tool tip text.

mouseClicked

public void mouseClicked(MouseEvent e)

Any mouse click will select the line in the code editor.

Specified by:

mouseClicked in interface MouseListener

Overrides:

mouseClicked in class AbstractRowMargin

Parameters:

e - the mouse event

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class AbstractRowMargin

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class AbstractRowMargin

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

Overrides:

mouseEntered in class AbstractRowMargin

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

Overrides:

mouseExited in class AbstractRowMargin

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class AbstractRowMargin

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

Overrides:

mouseMoved in class AbstractRowMargin