org.netbeans.editor
Class CodeFoldingSideBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              org.netbeans.editor.CodeFoldingSideBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class CodeFoldingSideBar
extends JComponent
implements Accessible

Code Folding Side Bar. Component responsible for drawing folding signs and responding on user fold/unfold action.

See Also:

Serialized Form

Nested Class Summary

class	CodeFoldingSideBar.Mark Keeps info of visible folding mark
class	CodeFoldingSideBar.PaintInfo This class should be never used by other code; will be made private

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 Color	backColor Deprecated. Without any replacement.
protected JTextComponent	component This field should be treated as final.
protected Font	font Deprecated. Without any replacement.
protected Color	foreColor Deprecated. Without any replacement.
static int	PAINT_END_MARK End angled line, without a sign
static int	PAINT_LINE Vertical line - typically at the end of the screen
static int	PAINT_MARK Normal opening +- marker
static int	PAINT_NOOP Paint operations
static int	SINGLE_PAINT_MARK Single-line marker, both start and end
protected List<CodeFoldingSideBar.Mark>	visibleMarks

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

CodeFoldingSideBar()
Deprecated. Don't use this constructor, it does nothing!

CodeFoldingSideBar(JTextComponent component)

Method Summary

protected void	collectPaintInfos(View rootView, Fold fold, Map<Integer,CodeFoldingSideBar.PaintInfo> map, int level, int startIndex, int endIndex)
AccessibleContext	getAccessibleContext()
protected Color	getBackColor() Deprecated. Without any replacement.
protected Font	getColoringFont() Deprecated. Without any replacement.
protected Document	getDocument()
protected EditorUI	getEditorUI()
protected Color	getForeColor() Deprecated. Without any replacement.
protected int	getMarkSize(Graphics g)
protected List<? extends CodeFoldingSideBar.PaintInfo>	getPaintInfo(Rectangle clip)
protected void	paintComponent(Graphics g)
protected void	performAction(CodeFoldingSideBar.Mark mark)
void	update(Graphics g)

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

Field Detail

backColor

protected Color backColor

Deprecated. Without any replacement.

This field should be treated as final. Subclasses are forbidden to change it.

foreColor

protected Color foreColor

Deprecated. Without any replacement.

This field should be treated as final. Subclasses are forbidden to change it.

font

protected Font font

Deprecated. Without any replacement.

This field should be treated as final. Subclasses are forbidden to change it.

component

protected JTextComponent component

This field should be treated as final. Subclasses are forbidden to change it.

visibleMarks

protected List<CodeFoldingSideBar.Mark> visibleMarks

PAINT_NOOP

public static final int PAINT_NOOP

Paint operations

See Also:

Constant Field Values

PAINT_MARK

public static final int PAINT_MARK

Normal opening +- marker

See Also:

Constant Field Values

PAINT_LINE

public static final int PAINT_LINE

Vertical line - typically at the end of the screen

See Also:

Constant Field Values

PAINT_END_MARK

public static final int PAINT_END_MARK

End angled line, without a sign

See Also:

Constant Field Values

SINGLE_PAINT_MARK

public static final int SINGLE_PAINT_MARK

Single-line marker, both start and end

See Also:

Constant Field Values

Constructor Detail

CodeFoldingSideBar

public CodeFoldingSideBar()

Deprecated. Don't use this constructor, it does nothing!

CodeFoldingSideBar

public CodeFoldingSideBar(JTextComponent component)

Method Detail

getBackColor

protected Color getBackColor()

Deprecated. Without any replacement.

This method should be treated as final. Subclasses are forbidden to override it.

Returns:

The background color used for painting this component.

getForeColor

protected Color getForeColor()

Deprecated. Without any replacement.

This method should be treated as final. Subclasses are forbidden to override it.

Returns:

The foreground color used for painting this component.

getColoringFont

protected Font getColoringFont()

Deprecated. Without any replacement.

This method should be treated as final. Subclasses are forbidden to override it.

Returns:

The font used for painting this component.

update

public void update(Graphics g)

Overrides:

update in class JComponent

collectPaintInfos

protected void collectPaintInfos(View rootView,
                                 Fold fold,
                                 Map<Integer,CodeFoldingSideBar.PaintInfo> map,
                                 int level,
                                 int startIndex,
                                 int endIndex)
                          throws BadLocationException

Throws:

BadLocationException

getPaintInfo

protected List<? extends CodeFoldingSideBar.PaintInfo> getPaintInfo(Rectangle clip)
                                                             throws BadLocationException

Throws:

BadLocationException

getEditorUI

protected EditorUI getEditorUI()

getDocument

protected Document getDocument()

performAction

protected void performAction(CodeFoldingSideBar.Mark mark)

getMarkSize

protected int getMarkSize(Graphics g)

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

getAccessibleContext

public AccessibleContext getAccessibleContext()

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class JComponent