public class RTextScrollPane
extends javax.swing.JScrollPane
JScrollPane that will only take
RTextAreas (or javax.swing.JLayers decorating
RTextAreas) for its view. This class has the ability to show:
Gutter class.
Each RTextScrollPane has a Gutter instance that
it uses as its row header. The gutter is only made visible when one of its
features is being used (line numbering, folding, and/or icons).javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBarjavax.swing.JComponent.AccessibleJComponentcolumnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewportlistenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTCOLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT| Constructor and Description |
|---|
RTextScrollPane()
Constructor.
|
RTextScrollPane(java.awt.Component comp)
Creates a scroll pane.
|
RTextScrollPane(java.awt.Component comp,
boolean lineNumbers)
Creates a scroll pane.
|
RTextScrollPane(java.awt.Component comp,
boolean lineNumbers,
java.awt.Color lineNumberColor)
Creates a scroll pane.
|
RTextScrollPane(RTextArea textArea)
Creates a scroll pane.
|
RTextScrollPane(RTextArea textArea,
boolean lineNumbers)
Creates a scroll pane.
|
| Modifier and Type | Method and Description |
|---|---|
Gutter |
getGutter()
Returns the gutter.
|
boolean |
getLineNumbersEnabled()
Returns
true if the line numbers are enabled and visible. |
RTextArea |
getTextArea()
Returns the text area being displayed.
|
boolean |
isFoldIndicatorEnabled()
Returns whether the fold indicator is enabled.
|
boolean |
isIconRowHeaderEnabled()
Returns whether the icon row header is enabled.
|
void |
setFoldIndicatorEnabled(boolean enabled)
Toggles whether the fold indicator is enabled.
|
void |
setIconRowHeaderEnabled(boolean enabled)
Toggles whether the icon row header (used for breakpoints, bookmarks,
etc.) is enabled.
|
void |
setLineNumbersEnabled(boolean enabled)
Toggles whether or not line numbers are visible.
|
void |
setViewportView(java.awt.Component view)
Sets the view for this scroll pane.
|
createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setWheelScrollingEnabled, updateUIaddAncestorListener, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, 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, updateadd, 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, transferFocusDownCycle, validate, validateTreeaction, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCyclepublic RTextScrollPane()
setViewportView(Component) and pass in an RTextArea
for this scroll pane to render line numbers properly.public RTextScrollPane(RTextArea textArea)
textArea - The text area this scroll pane will contain.public RTextScrollPane(java.awt.Component comp)
comp - The component this scroll pane should display. This should
be an instance of RTextArea,
javax.swing.JLayer (or the older
org.jdesktop.jxlayer.JXLayer), or null.
If this argument is null, you must call
setViewportView(Component), passing in an instance of
one of the types above.public RTextScrollPane(RTextArea textArea, boolean lineNumbers)
textArea - The text area this scroll pane will contain. If this is
null, you must call
setViewportView(Component), passing in an
RTextArea.lineNumbers - Whether line numbers should be enabled.public RTextScrollPane(java.awt.Component comp,
boolean lineNumbers)
comp - The component this scroll pane should display. This should
be an instance of RTextArea,
javax.swing.JLayer (or the older
org.jdesktop.jxlayer.JXLayer), or null.
If this argument is null, you must call
setViewportView(Component), passing in an instance of
one of the types above.lineNumbers - Whether line numbers should be enabled.public RTextScrollPane(java.awt.Component comp,
boolean lineNumbers,
java.awt.Color lineNumberColor)
comp - The component this scroll pane should display. This should
be an instance of RTextArea,
javax.swing.JLayer (or the older
org.jdesktop.jxlayer.JXLayer), or null.
If this argument is null, you must call
setViewportView(Component), passing in an instance of
one of the types above.lineNumbers - Whether line numbers are initially enabled.lineNumberColor - The color to use for line numbers.public Gutter getGutter()
public boolean getLineNumbersEnabled()
true if the line numbers are enabled and visible.setLineNumbersEnabled(boolean)public RTextArea getTextArea()
setViewportView(Component)public boolean isFoldIndicatorEnabled()
setFoldIndicatorEnabled(boolean)public boolean isIconRowHeaderEnabled()
setIconRowHeaderEnabled(boolean)public void setFoldIndicatorEnabled(boolean enabled)
enabled - Whether the fold indicator should be enabled.isFoldIndicatorEnabled()public void setIconRowHeaderEnabled(boolean enabled)
enabled - Whether the icon row header is enabled.isIconRowHeaderEnabled()public void setLineNumbersEnabled(boolean enabled)
enabled - Whether or not line numbers should be visible.getLineNumbersEnabled()public void setViewportView(java.awt.Component view)
RTextArea.setViewportView in class javax.swing.JScrollPaneview - The new view.getTextArea()