public class FoldIndicator
extends javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
protected int |
currentLineCount
The number of lines in the text area.
|
static java.awt.Color |
DEFAULT_FOLD_BACKGROUND
The default color used to paint the "inside" of fold icons.
|
static java.awt.Color |
DEFAULT_FOREGROUND
The color used to paint fold outlines.
|
protected RTextArea |
textArea
The text area whose lines we are marking with icons.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
FoldIndicator(RTextArea textArea) |
Modifier and Type | Method and Description |
---|---|
javax.swing.JToolTip |
createToolTip()
Overridden to use the editor's background if it's detected that the
user isn't using white as the editor bg, but the system's tool tip
background is yellow-ish.
|
protected static java.awt.Rectangle |
getChildViewBounds(javax.swing.text.View parent,
int line,
java.awt.Rectangle editorRect)
Returns the bounds of a child view as a rectangle, since
View s tend to use Shape . |
java.awt.Color |
getFoldIconArmedBackground()
Returns the color to use for the "background" of armed fold icons.
|
java.awt.Color |
getFoldIconBackground()
Returns the color to use for the "background" of fold icons.
|
protected Gutter |
getGutter()
Returns the parent
Gutter component. |
java.awt.Dimension |
getPreferredSize() |
boolean |
getShowCollapsedRegionToolTips()
Returns whether tool tips are displayed showing the contents of
collapsed fold regions when the mouse hovers over a +/- icon.
|
java.awt.Point |
getToolTipLocation(java.awt.event.MouseEvent e)
Positions tool tips to be aligned in the text component, so that the
displayed content is shown (almost) exactly where it would be in the
editor.
|
java.lang.String |
getToolTipText(java.awt.event.MouseEvent e)
Overridden to show the content of a collapsed fold on mouse-overs.
|
protected void |
init()
Called by the constructor before the text area is set.
|
protected void |
paintComponent(java.awt.Graphics g) |
void |
setFoldIconArmedBackground(java.awt.Color bg)
Sets the color to use for the "background" of armed fold icons.
|
void |
setFoldIconBackground(java.awt.Color bg)
Sets the color to use for the "background" of fold icons.
|
void |
setFoldIcons(javax.swing.Icon collapsedIcon,
javax.swing.Icon expandedIcon)
Sets the icons to use to represent collapsed and expanded folds.
|
void |
setShowCollapsedRegionToolTips(boolean show)
Toggles whether tool tips should be displayed showing the contents of
collapsed fold regions when the mouse hovers over a +/- icon.
|
void |
setTextArea(RTextArea textArea)
Overridden so we can track when code folding is enabled/disabled.
|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, 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
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
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, 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
public static final java.awt.Color DEFAULT_FOREGROUND
public static final java.awt.Color DEFAULT_FOLD_BACKGROUND
protected RTextArea textArea
protected int currentLineCount
public FoldIndicator(RTextArea textArea)
public javax.swing.JToolTip createToolTip()
createToolTip
in class javax.swing.JComponent
public java.awt.Color getFoldIconArmedBackground()
null
, there is no
special color for armed fold icons.setFoldIconArmedBackground(Color)
,
getFoldIconBackground()
public java.awt.Color getFoldIconBackground()
setFoldIconBackground(Color)
,
getFoldIconArmedBackground()
public java.awt.Dimension getPreferredSize()
getPreferredSize
in class javax.swing.JComponent
public boolean getShowCollapsedRegionToolTips()
setShowCollapsedRegionToolTips(boolean)
public java.awt.Point getToolTipLocation(java.awt.event.MouseEvent e)
getToolTipLocation
in class javax.swing.JComponent
e
- The mouse location.public java.lang.String getToolTipText(java.awt.event.MouseEvent e)
getToolTipText
in class javax.swing.JComponent
e
- The mouse location.protected void init()
protected void paintComponent(java.awt.Graphics g)
paintComponent
in class javax.swing.JComponent
public void setFoldIconArmedBackground(java.awt.Color bg)
bg
- The new background color. If null
is passed in,
there will be no special color for armed fold icons.getFoldIconArmedBackground()
,
setFoldIconBackground(Color)
public void setFoldIconBackground(java.awt.Color bg)
bg
- The new background color. This should not be null
.getFoldIconBackground()
,
setFoldIconArmedBackground(Color)
public void setFoldIcons(javax.swing.Icon collapsedIcon, javax.swing.Icon expandedIcon)
collapsedIcon
- The collapsed fold icon. This cannot be
null
.expandedIcon
- The expanded fold icon. This cannot be
null
.public void setShowCollapsedRegionToolTips(boolean show)
show
- Whether to show these tool tips.getShowCollapsedRegionToolTips()
public void setTextArea(RTextArea textArea)
textArea
- The text area.protected static final java.awt.Rectangle getChildViewBounds(javax.swing.text.View parent, int line, java.awt.Rectangle editorRect)
View
s tend to use Shape
.parent
- The parent view of the child whose bounds we're getting.line
- The index of the child view.editorRect
- Returned from the text area's
getVisibleEditorRect
method.protected Gutter getGutter()
Gutter
component.Gutter
.