public class RSyntaxTextArea extends RTextArea implements SyntaxConstants
RTextArea
that adds syntax highlighting
of certain programming languages to its list of features. Languages
currently supported include:
|
|
RTextScrollPane
instead of a regular
JScrollPane
as this class allows you to add line numbers and
bookmarks easily to your text area.TextEditorPane
,
Serialized FormRTextArea.RTextAreaMutableCaretEvent
RTextAreaBase.RTAMouseListener
javax.swing.JTextArea.AccessibleJTextArea
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ANIMATE_BRACKET_MATCHING_PROPERTY |
static java.lang.String |
ANTIALIAS_PROPERTY |
static java.lang.String |
AUTO_INDENT_PROPERTY |
static java.lang.String |
BRACKET_MATCHING_PROPERTY |
static java.lang.String |
CLEAR_WHITESPACE_LINES_PROPERTY |
static java.lang.String |
CLOSE_CURLY_BRACES_PROPERTY |
static java.lang.String |
CLOSE_MARKUP_TAGS_PROPERTY |
static java.lang.String |
CODE_FOLDING_PROPERTY |
static java.lang.String |
EOL_VISIBLE_PROPERTY |
static java.lang.String |
FOCUSABLE_TIPS_PROPERTY |
static java.lang.String |
FRACTIONAL_FONTMETRICS_PROPERTY |
static java.lang.String |
HIGHLIGHT_SECONDARY_LANGUAGES_PROPERTY |
static java.lang.String |
HYPERLINKS_ENABLED_PROPERTY |
static java.lang.String |
MARK_OCCURRENCES_PROPERTY |
static java.lang.String |
MARKED_OCCURRENCES_CHANGED_PROPERTY |
static java.lang.String |
PAINT_MATCHED_BRACKET_PAIR_PROPERTY |
static java.lang.String |
PARSER_NOTICES_PROPERTY |
static java.lang.String |
SYNTAX_SCHEME_PROPERTY |
static java.lang.String |
SYNTAX_STYLE_PROPERTY |
static java.lang.String |
TAB_LINE_COLOR_PROPERTY |
static java.lang.String |
TAB_LINES_PROPERTY |
static java.lang.String |
USE_SELECTED_TEXT_COLOR_PROPERTY |
static java.lang.String |
VISIBLE_WHITESPACE_PROPERTY |
COPY_ACTION, CUT_ACTION, DELETE_ACTION, INSERT_MODE, MARK_ALL_COLOR_PROPERTY, MARK_ALL_OCCURRENCES_CHANGED_PROPERTY, MARK_ALL_ON_OCCURRENCE_SEARCHES_PROPERTY, OVERWRITE_MODE, PASTE_ACTION, REDO_ACTION, SELECT_ALL_ACTION, UNDO_ACTION
BACKGROUND_IMAGE_PROPERTY, CURRENT_LINE_HIGHLIGHT_COLOR_PROPERTY, CURRENT_LINE_HIGHLIGHT_FADE_PROPERTY, HIGHLIGHT_CURRENT_LINE_PROPERTY, ROUNDED_SELECTION_PROPERTY
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
SYNTAX_STYLE_ACTIONSCRIPT, SYNTAX_STYLE_ASSEMBLER_X86, SYNTAX_STYLE_BBCODE, SYNTAX_STYLE_C, SYNTAX_STYLE_CLOJURE, SYNTAX_STYLE_CPLUSPLUS, SYNTAX_STYLE_CSHARP, SYNTAX_STYLE_CSS, SYNTAX_STYLE_D, SYNTAX_STYLE_DART, SYNTAX_STYLE_DELPHI, SYNTAX_STYLE_DOCKERFILE, SYNTAX_STYLE_DTD, SYNTAX_STYLE_FORTRAN, SYNTAX_STYLE_GROOVY, SYNTAX_STYLE_HOSTS, SYNTAX_STYLE_HTACCESS, SYNTAX_STYLE_HTML, SYNTAX_STYLE_INI, SYNTAX_STYLE_JAVA, SYNTAX_STYLE_JAVASCRIPT, SYNTAX_STYLE_JSON, SYNTAX_STYLE_JSON_WITH_COMMENTS, SYNTAX_STYLE_JSP, SYNTAX_STYLE_LATEX, SYNTAX_STYLE_LESS, SYNTAX_STYLE_LISP, SYNTAX_STYLE_LUA, SYNTAX_STYLE_MAKEFILE, SYNTAX_STYLE_MXML, SYNTAX_STYLE_NONE, SYNTAX_STYLE_NSIS, SYNTAX_STYLE_PERL, SYNTAX_STYLE_PHP, SYNTAX_STYLE_PROPERTIES_FILE, SYNTAX_STYLE_PYTHON, SYNTAX_STYLE_RUBY, SYNTAX_STYLE_SAS, SYNTAX_STYLE_SCALA, SYNTAX_STYLE_SQL, SYNTAX_STYLE_TCL, SYNTAX_STYLE_TYPESCRIPT, SYNTAX_STYLE_UNIX_SHELL, SYNTAX_STYLE_VISUAL_BASIC, SYNTAX_STYLE_WINDOWS_BATCH, SYNTAX_STYLE_XML, SYNTAX_STYLE_YAML
Constructor and Description |
---|
RSyntaxTextArea()
Constructor.
|
RSyntaxTextArea(int textMode)
Creates a new
RSyntaxTextArea . |
RSyntaxTextArea(int rows,
int cols)
Constructor.
|
RSyntaxTextArea(RSyntaxDocument doc)
Constructor.
|
RSyntaxTextArea(RSyntaxDocument doc,
java.lang.String text,
int rows,
int cols)
Constructor.
|
RSyntaxTextArea(java.lang.String text)
Constructor.
|
RSyntaxTextArea(java.lang.String text,
int rows,
int cols)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addActiveLineRangeListener(ActiveLineRangeListener l)
Adds an "active line range" listener to this text area.
|
void |
addHyperlinkListener(javax.swing.event.HyperlinkListener l)
Adds a hyperlink listener to this text area.
|
void |
addNotify()
Updates the font metrics the first time we're displayed.
|
void |
addParser(Parser parser)
Adds the parser to "validate" the source code in this text area.
|
protected void |
appendFoldingMenu(javax.swing.JPopupMenu popup)
Appends a submenu with code folding options to this text component's
popup menu.
|
void |
clearParsers()
Removes all parsers from this text area.
|
protected void |
configurePopupMenu(javax.swing.JPopupMenu popupMenu)
Overridden to toggle the enabled state of various
RSyntaxTextArea-specific menu items.
|
void |
copyAsRtf()
Copies the currently selected text to the system clipboard, with
any necessary style information (font, foreground color and background
color).
|
protected javax.swing.text.Document |
createDefaultModel()
Returns the document to use for an
RSyntaxTextArea . |
protected RTextAreaBase.RTAMouseListener |
createMouseListener()
Returns the caret event/mouse listener for
RTextArea s. |
protected javax.swing.JPopupMenu |
createPopupMenu()
Overridden to add menu items related to cold folding.
|
protected RTextAreaUI |
createRTextAreaUI()
Returns the a real UI to install on this text area.
|
protected void |
doBracketMatching()
If the caret is on a bracket, this method finds the matching bracket,
and if it exists, highlights it.
|
protected void |
fireCaretUpdate(javax.swing.event.CaretEvent e)
Notifies all listeners that a caret change has occurred.
|
void |
foldToggled(Fold fold)
Called whenever a fold is collapsed or expanded.
|
void |
forceReparsing(int parser)
Forces the given
Parser to re-parse the content of this text
area. |
boolean |
forceReparsing(Parser parser)
Forces re-parsing with a specific parser.
|
boolean |
getAnimateBracketMatching()
Returns whether bracket matching should be animated.
|
boolean |
getAntiAliasingEnabled()
Returns whether anti-aliasing is enabled in this editor.
|
java.awt.Color |
getBackgroundForToken(Token token)
Returns the background color for a token.
|
boolean |
getCloseCurlyBraces()
Returns whether curly braces should be automatically closed when a
newline is entered after an opening curly brace.
|
boolean |
getCloseMarkupTags()
Returns whether closing markup tags should be automatically completed
when "
</ " is typed. |
static CodeTemplateManager |
getCodeTemplateManager()
Returns the code template manager for all instances of
RSyntaxTextArea . |
static java.awt.Color |
getDefaultBracketMatchBGColor()
Returns the default bracket-match background color.
|
static java.awt.Color |
getDefaultBracketMatchBorderColor()
Returns the default bracket-match border color.
|
static java.awt.Color |
getDefaultSelectionColor()
Returns the default selection color for this text area.
|
SyntaxScheme |
getDefaultSyntaxScheme()
Returns the "default" syntax highlighting color scheme.
|
boolean |
getEOLMarkersVisible()
Returns whether an EOL marker should be drawn at the end of each line.
|
FoldManager |
getFoldManager()
Returns the fold manager for this text area.
|
java.awt.Font |
getFontForTokenType(int type)
Returns the font for tokens of the specified type.
|
java.awt.FontMetrics |
getFontMetricsForTokenType(int type)
Returns the font metrics for tokens of the specified type.
|
java.awt.Color |
getForegroundForToken(Token t)
Returns the foreground color to use when painting a token.
|
java.awt.Color |
getForegroundForTokenType(int type)
Returns the foreground color to use when painting a token.
|
boolean |
getFractionalFontMetricsEnabled()
Returns whether fractional font metrics are enabled for this text area.
|
boolean |
getHighlightSecondaryLanguages()
Returns whether "secondary" languages should have their backgrounds
colored differently to visually differentiate them.
|
java.awt.Color |
getHyperlinkForeground()
Returns the color to use when painting hyperlinks.
|
boolean |
getHyperlinksEnabled()
Returns whether hyperlinks are enabled for this text area.
|
int |
getLastVisibleOffset()
Returns the last visible offset in this text area.
|
int |
getLineHeight()
Returns the height to use for a line of text in this text area.
|
LinkGenerator |
getLinkGenerator() |
java.util.List<DocumentRange> |
getMarkAllHighlightRanges()
Returns a list of "mark all" highlights in the text area.
|
java.util.List<DocumentRange> |
getMarkedOccurrences()
Returns a list of "marked occurrences" in the text area.
|
boolean |
getMarkOccurrences()
Returns whether "Mark Occurrences" is enabled.
|
java.awt.Color |
getMarkOccurrencesColor()
Returns the color used for "mark occurrences" highlights.
|
int |
getMarkOccurrencesDelay()
Returns the delay between when the caret is moved and when "marked
occurrences" are highlighted.
|
java.awt.Color |
getMatchedBracketBGColor()
Gets the color used as the background for a matched bracket.
|
java.awt.Color |
getMatchedBracketBorderColor()
Gets the color used as the border for a matched bracket.
|
int |
getMaxAscent()
Overridden to return the max ascent for any font used in the editor.
|
boolean |
getPaintMarkOccurrencesBorder()
Returns whether a border is painted around marked occurrences.
|
boolean |
getPaintMatchedBracketPair()
Returns whether the bracket at the caret position is painted as a
"match" when a matched bracket is found.
|
boolean |
getPaintTabLines()
Returns whether tab lines are painted.
|
Parser |
getParser(int index)
Returns the specified parser.
|
int |
getParserCount()
Returns the number of parsers operating on this text area.
|
int |
getParserDelay()
Returns the currently set parser delay.
|
java.util.List<ParserNotice> |
getParserNotices()
Returns a list of the current parser notices for this text area.
|
int |
getRightHandSideCorrection()
Workaround for JTextComponents allowing the caret to be rendered
entirely off-screen if the entire "previous" character fit entirely.
|
java.awt.Color |
getSecondaryLanguageBackground(int index)
Returns the background color for the specified secondary language.
|
int |
getSecondaryLanguageCount()
Returns the number of secondary language backgrounds.
|
boolean |
getShouldIndentNextLine(int line)
If auto-indent is enabled, this method returns whether a new line after
this one should be indented (based on the standard indentation rules for
the current programming language).
|
boolean |
getShowMatchedBracketPopup()
Returns whether a small popup window should display the text on the
line containing a matched bracket whenever a matched bracket is off-
screen.
|
java.lang.String |
getSyntaxEditingStyle()
Returns what type of syntax highlighting this editor is doing.
|
SyntaxScheme |
getSyntaxScheme()
Returns all of the colors currently being used in syntax highlighting
by this text component.
|
java.awt.Color |
getTabLineColor()
Returns the color used to paint tab lines.
|
static boolean |
getTemplatesEnabled()
Returns whether or not templates are enabled for all instances
of
RSyntaxTextArea . |
Token |
getTokenListForLine(int line)
Returns a list of tokens representing the given line.
|
java.lang.String |
getToolTipText(java.awt.event.MouseEvent e)
Returns the tool tip to display for a mouse event at the given
location.
|
protected java.lang.String |
getToolTipTextImpl(java.awt.event.MouseEvent e)
Does the dirty work of getting the tool tip text.
|
boolean |
getUnderlineForToken(Token t)
Returns whether the specified token should be underlined.
|
boolean |
getUseFocusableTips()
Returns whether "focusable" tool tips are used instead of standard
ones.
|
boolean |
getUseSelectedTextColor()
Returns whether selected text should use the "selected text color"
property set via
JTextComponent.setSelectedTextColor(Color) . |
protected void |
init()
Called by constructors to initialize common properties of the text
editor.
|
boolean |
isAutoIndentEnabled()
Returns whether or not auto-indent is enabled.
|
boolean |
isBracketMatchingEnabled()
Returns whether or not bracket matching is enabled.
|
boolean |
isClearWhitespaceLinesEnabled()
Returns whether or not lines containing nothing but whitespace are made
into blank lines when Enter is pressed in them.
|
boolean |
isCodeFoldingEnabled()
Returns whether code folding is enabled.
|
boolean |
isWhitespaceVisible()
Returns whether whitespace (spaces and tabs) is visible.
|
Token |
modelToToken(int offs)
Returns the token at the specified position in the model.
|
protected void |
paintComponent(java.awt.Graphics g)
The
paintComponent method is overridden so we
apply any necessary rendering hints to the Graphics object. |
void |
redoLastAction()
Attempt to redo the last action.
|
void |
removeActiveLineRangeListener(ActiveLineRangeListener l)
Removes an "active line range" listener from this text area.
|
void |
removeHyperlinkListener(javax.swing.event.HyperlinkListener l)
Removes a hyperlink listener from this text area.
|
void |
removeNotify()
Overridden so we stop this text area's parsers, if any.
|
boolean |
removeParser(Parser parser)
Removes a parser from this text area.
|
void |
restoreDefaultSyntaxScheme()
Sets the colors used for syntax highlighting to their defaults.
|
static boolean |
saveTemplates()
Attempts to save all currently-known templates to the current template
directory, as set by
setTemplateDirectory . |
void |
setActiveLineRange(int min,
int max)
Sets the "active line range." Note that this
RSyntaxTextArea itself does nothing with this information,
but if it is contained inside an RTextScrollPane ,
the active line range may be displayed in the icon area of the
Gutter . |
void |
setAnimateBracketMatching(boolean animate)
Sets whether bracket matching should be animated.
|
void |
setAntiAliasingEnabled(boolean enabled)
Sets whether anti-aliasing is enabled in this editor.
|
void |
setAutoIndentEnabled(boolean enabled)
Sets whether or not auto-indent is enabled.
|
void |
setBracketMatchingEnabled(boolean enabled)
Sets whether bracket matching is enabled.
|
void |
setClearWhitespaceLinesEnabled(boolean enabled)
Sets whether or not lines containing nothing but whitespace are made
into blank lines when Enter is pressed in them.
|
void |
setCloseCurlyBraces(boolean close)
Toggles whether curly braces should be automatically closed when a
newline is entered after an opening curly brace.
|
void |
setCloseMarkupTags(boolean close)
Sets whether closing markup tags should be automatically completed
when "
</ " is typed. |
void |
setCodeFoldingEnabled(boolean enabled)
Sets whether code folding is enabled.
|
void |
setDocument(javax.swing.text.Document document)
Sets the document used by this text area.
|
void |
setEOLMarkersVisible(boolean visible)
Sets whether EOL markers are visible at the end of each line.
|
void |
setFont(java.awt.Font font)
Sets the font used by this text area.
|
void |
setFractionalFontMetricsEnabled(boolean enabled)
Sets whether fractional font metrics are enabled.
|
void |
setHighlighter(javax.swing.text.Highlighter h)
Sets the highlighter used by this text area.
|
void |
setHighlightSecondaryLanguages(boolean highlight)
Sets whether "secondary" languages should have their backgrounds
colored differently to visually differentiate them.
|
void |
setHyperlinkForeground(java.awt.Color fg)
Sets the color to use when painting hyperlinks.
|
void |
setHyperlinksEnabled(boolean enabled)
Sets whether hyperlinks are enabled for this text area.
|
void |
setLinkGenerator(LinkGenerator generator) |
void |
setLinkScanningMask(int mask)
Sets the mask for the key used to toggle whether we are scanning for
hyperlinks with mouse hovering.
|
void |
setMarkOccurrences(boolean markOccurrences)
Toggles whether "mark occurrences" is enabled.
|
void |
setMarkOccurrencesColor(java.awt.Color color)
Sets the "mark occurrences" color.
|
void |
setMarkOccurrencesDelay(int delay)
Sets the delay between when the caret is moved and when "marked
occurrences" are highlighted.
|
void |
setMatchedBracketBGColor(java.awt.Color color)
Sets the color used as the background for a matched bracket.
|
void |
setMatchedBracketBorderColor(java.awt.Color color)
Sets the color used as the border for a matched bracket.
|
void |
setPaintMarkOccurrencesBorder(boolean paintBorder)
Toggles whether a border should be painted around marked occurrences.
|
void |
setPaintMatchedBracketPair(boolean paintPair)
Sets whether the bracket at the caret position is painted as a "match"
when a matched bracket is found.
|
void |
setPaintTabLines(boolean paint)
Toggles whether tab lines are painted.
|
void |
setParserDelay(int millis)
Sets the parser delay.
|
void |
setRightHandSideCorrection(int rhsCorrection)
Applications typically have no need to modify this value.
|
void |
setSecondaryLanguageBackground(int index,
java.awt.Color color)
Sets the background color to use for a secondary language.
|
void |
setShowMatchedBracketPopup(boolean show)
Sets whether a small popup window should display the text on the
line containing a matched bracket whenever a matched bracket is off-
screen.
|
void |
setSyntaxEditingStyle(java.lang.String styleKey)
Sets what type of syntax highlighting this editor is doing.
|
void |
setSyntaxScheme(SyntaxScheme scheme)
Sets all of the colors used in syntax highlighting to the colors
specified.
|
void |
setTabLineColor(java.awt.Color c)
Sets the color use to paint tab lines.
|
static boolean |
setTemplateDirectory(java.lang.String dir)
If templates are enabled, all currently-known templates are forgotten
and all templates are loaded from all files in the specified directory
ending in "*.xml".
|
static void |
setTemplatesEnabled(boolean enabled)
Enables or disables templates.
|
void |
setUseFocusableTips(boolean use)
Sets whether "focusable" tool tips are used instead of standard ones.
|
void |
setUseSelectedTextColor(boolean use)
Sets whether selected text should use the "selected text color" property
(set via
JTextComponent.setSelectedTextColor(Color) ). |
void |
setWhitespaceVisible(boolean visible)
Sets whether whitespace is visible.
|
void |
undoLastAction()
Attempt to undo an "action" done in this text area.
|
Token |
viewToToken(java.awt.Point p)
Returns the token at the specified position in the view.
|
addLineHighlight, beginAtomicEdit, beginRecordingMacro, canRedo, canUndo, createPopupMenuItem, createUndoManager, discardAllEdits, endAtomicEdit, endRecordingMacro, getAction, getCurrentMacro, getDefaultMarkAllHighlightColor, getIconGroup, getMarkAllHighlightColor, getMarkAllOnOccurrenceSearches, getPopupMenu, getSelectedOccurrenceText, getTextMode, getToolTipSupplier, getUndoManager, handleReplaceSelection, isRecordingMacro, loadMacro, paste, playbackLastMacro, print, read, removeAllLineHighlights, removeLineHighlight, replaceRange, replaceSelection, setActionProperties, setActionProperties, setCaret, setCaretStyle, setIconGroup, setMarkAllHighlightColor, setMarkAllOnOccurrenceSearches, setPopupMenu, setRoundedSelectionEdges, setSelectedOccurrenceText, setTextMode, setToolTipSupplier, setUI, setUndoManager
convertSpacesToTabs, convertTabsToSpaces, forceCurrentLineHighlightRepaint, getBackground, getBackgroundImage, getBackgroundObject, getCaretLineNumber, getCaretOffsetFromLineStart, getCurrentCaretY, getCurrentLineHighlightColor, getDefaultCaretColor, getDefaultCurrentLineHighlightColor, getDefaultFont, getDefaultForeground, getDefaultMarginLineColor, getDefaultMarginLinePosition, getDefaultTabSize, getFadeCurrentLineHighlight, getHighlightCurrentLine, getLineEndOffsetOfCurrentLine, getLineStartOffsetOfCurrentLine, getMarginLineColor, getMarginLinePixelLocation, getMarginLinePosition, getRoundedSelectionEdges, getTabsEmulated, isMarginLineEnabled, isOSX, possiblyUpdateCurrentLineHighlightLocation, processComponentEvent, setBackground, setBackgroundImage, setBackgroundObject, setCurrentLineHighlightColor, setFadeCurrentLineHighlight, setHighlightCurrentLine, setLineWrap, setMargin, setMarginLineColor, setMarginLineEnabled, setMarginLinePosition, setRTextAreaUI, setTabsEmulated, setTabSize, updateMarginLineX, yForLine, yForLineContaining
append, getAccessibleContext, getColumns, getColumnWidth, getLineCount, getLineEndOffset, getLineOfOffset, getLineStartOffset, getLineWrap, getPreferredScrollableViewportSize, getPreferredSize, getRowHeight, getRows, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getTabSize, getUIClassID, getWrapStyleWord, insert, paramString, setColumns, setRows, setWrapStyleWord
addCaretListener, addInputMethodListener, addKeymap, copy, cut, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, print, print, print, processInputMethodEvent, removeCaretListener, removeKeymap, restoreComposedText, saveComposedText, select, selectAll, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setKeymap, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, updateUI, viewToModel, write
addAncestorListener, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, 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, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, 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, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, 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, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, 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, transferFocusUpCycle
public static final java.lang.String ANIMATE_BRACKET_MATCHING_PROPERTY
public static final java.lang.String ANTIALIAS_PROPERTY
public static final java.lang.String AUTO_INDENT_PROPERTY
public static final java.lang.String BRACKET_MATCHING_PROPERTY
public static final java.lang.String CLEAR_WHITESPACE_LINES_PROPERTY
public static final java.lang.String CLOSE_CURLY_BRACES_PROPERTY
public static final java.lang.String CLOSE_MARKUP_TAGS_PROPERTY
public static final java.lang.String CODE_FOLDING_PROPERTY
public static final java.lang.String EOL_VISIBLE_PROPERTY
public static final java.lang.String FOCUSABLE_TIPS_PROPERTY
public static final java.lang.String FRACTIONAL_FONTMETRICS_PROPERTY
public static final java.lang.String HIGHLIGHT_SECONDARY_LANGUAGES_PROPERTY
public static final java.lang.String HYPERLINKS_ENABLED_PROPERTY
public static final java.lang.String MARK_OCCURRENCES_PROPERTY
public static final java.lang.String MARKED_OCCURRENCES_CHANGED_PROPERTY
public static final java.lang.String PAINT_MATCHED_BRACKET_PAIR_PROPERTY
public static final java.lang.String PARSER_NOTICES_PROPERTY
public static final java.lang.String SYNTAX_SCHEME_PROPERTY
public static final java.lang.String SYNTAX_STYLE_PROPERTY
public static final java.lang.String TAB_LINE_COLOR_PROPERTY
public static final java.lang.String TAB_LINES_PROPERTY
public static final java.lang.String USE_SELECTED_TEXT_COLOR_PROPERTY
public static final java.lang.String VISIBLE_WHITESPACE_PROPERTY
public RSyntaxTextArea()
public RSyntaxTextArea(RSyntaxDocument doc)
doc
- The document for the editor.public RSyntaxTextArea(java.lang.String text)
text
- The initial text to display.public RSyntaxTextArea(int rows, int cols)
rows
- The number of rows to display.cols
- The number of columns to display.java.lang.IllegalArgumentException
- If either rows
or
cols
is negative.public RSyntaxTextArea(java.lang.String text, int rows, int cols)
text
- The initial text to display.rows
- The number of rows to display.cols
- The number of columns to display.java.lang.IllegalArgumentException
- If either rows
or
cols
is negative.public RSyntaxTextArea(RSyntaxDocument doc, java.lang.String text, int rows, int cols)
doc
- The document for the editor.text
- The initial text to display.rows
- The number of rows to display.cols
- The number of columns to display.java.lang.IllegalArgumentException
- If either rows
or
cols
is negative.public RSyntaxTextArea(int textMode)
RSyntaxTextArea
.textMode
- Either INSERT_MODE
or
OVERWRITE_MODE
.public void addActiveLineRangeListener(ActiveLineRangeListener l)
l
- The listener to add.removeActiveLineRangeListener(ActiveLineRangeListener)
public void addHyperlinkListener(javax.swing.event.HyperlinkListener l)
l
- The listener to add.removeHyperlinkListener(HyperlinkListener)
public void addNotify()
addNotify
in class RTextAreaBase
public void addParser(Parser parser)
parser
- The new parser. A value of null
will
do nothing.getParser(int)
,
getParserCount()
,
removeParser(Parser)
protected void appendFoldingMenu(javax.swing.JPopupMenu popup)
popup
- The popup menu to append to.createPopupMenu()
public void clearParsers()
removeParser(Parser)
protected void configurePopupMenu(javax.swing.JPopupMenu popupMenu)
RTextArea.setPopupMenu(JPopupMenu)
, you
will want to override this method, especially if you removed any of the
menu items in the default popup menu.configurePopupMenu
in class RTextArea
popupMenu
- The popup menu. This will never be null
.createPopupMenu()
,
RTextArea.setPopupMenu(JPopupMenu)
public void copyAsRtf()
null
selections.protected javax.swing.text.Document createDefaultModel()
RSyntaxTextArea
.createDefaultModel
in class RTextArea
protected RTextAreaBase.RTAMouseListener createMouseListener()
RTextArea
s.createMouseListener
in class RTextArea
protected javax.swing.JPopupMenu createPopupMenu()
createPopupMenu
in class RTextArea
appendFoldingMenu(JPopupMenu)
protected RTextAreaUI createRTextAreaUI()
createRTextAreaUI
in class RTextArea
protected final void doBracketMatching()
protected void fireCaretUpdate(javax.swing.event.CaretEvent e)
fireCaretUpdate
in class RTextArea
e
- The caret event.public void foldToggled(Fold fold)
fold
- The fold that was collapsed or expanded.public void forceReparsing(int parser)
Parser
to re-parse the content of this text
area.
This method can be useful when a Parser
can be configured
as to what notices it returns. For example, if a Java language parser
can be configured to set whether no serialVersionUID is a warning,
error, or ignored, this method can be called after changing the expected
notice type to have the document re-parsed.
parser
- The index of the Parser
to re-run.getParser(int)
public boolean forceReparsing(Parser parser)
parser
- The parser that should re-parse this text area's contents.
This should be installed on this text area.forceReparsing(int)
public boolean getAnimateBracketMatching()
setAnimateBracketMatching(boolean)
public boolean getAntiAliasingEnabled()
setAntiAliasingEnabled(boolean)
,
getFractionalFontMetricsEnabled()
public java.awt.Color getBackgroundForToken(Token token)
token
- The token.null
then this token has no special background
color.getForegroundForToken(Token)
public boolean getCloseCurlyBraces()
setCloseCurlyBraces(boolean)
public boolean getCloseMarkupTags()
</
" is typed. Note that this property is only
honored for markup languages, such as HTML, XML and PHP.setCloseMarkupTags(boolean)
public static CodeTemplateManager getCodeTemplateManager()
RSyntaxTextArea
. The manager is lazily created.setTemplatesEnabled(boolean)
public static final java.awt.Color getDefaultBracketMatchBGColor()
getDefaultBracketMatchBorderColor()
public static final java.awt.Color getDefaultBracketMatchBorderColor()
getDefaultBracketMatchBGColor()
public static java.awt.Color getDefaultSelectionColor()
RSyntaxTextArea
does not change text color between selected/unselected text for
contrast like regular JTextArea
s do.public SyntaxScheme getDefaultSyntaxScheme()
restoreDefaultSyntaxScheme()
,
getSyntaxScheme()
,
setSyntaxScheme(SyntaxScheme)
public boolean getEOLMarkersVisible()
setEOLMarkersVisible(boolean)
,
isWhitespaceVisible()
public FoldManager getFoldManager()
public java.awt.Font getFontForTokenType(int type)
type
- The type of token.getFontMetricsForTokenType(int)
public java.awt.FontMetrics getFontMetricsForTokenType(int type)
type
- The type of token.getFontForTokenType(int)
public java.awt.Color getForegroundForToken(Token t)
t
- The token.null
.getBackgroundForToken(Token)
public java.awt.Color getForegroundForTokenType(int type)
type
- The token type.null
.getForegroundForToken(Token)
public boolean getFractionalFontMetricsEnabled()
setFractionalFontMetricsEnabled(boolean)
,
getAntiAliasingEnabled()
public boolean getHighlightSecondaryLanguages()
setHighlightSecondaryLanguages(boolean)
,
getSecondaryLanguageBackground(int)
,
getSecondaryLanguageCount()
,
setSecondaryLanguageBackground(int, Color)
public java.awt.Color getHyperlinkForeground()
setHyperlinkForeground(Color)
,
getHyperlinksEnabled()
public boolean getHyperlinksEnabled()
setHyperlinksEnabled(boolean)
public int getLastVisibleOffset()
public int getLineHeight()
getLineHeight
in class RTextAreaBase
public LinkGenerator getLinkGenerator()
public java.util.List<DocumentRange> getMarkAllHighlightRanges()
public java.util.List<DocumentRange> getMarkedOccurrences()
public boolean getMarkOccurrences()
setMarkOccurrences(boolean)
public java.awt.Color getMarkOccurrencesColor()
setMarkOccurrencesColor(Color)
public int getMarkOccurrencesDelay()
setMarkOccurrencesDelay(int)
public java.awt.Color getMatchedBracketBGColor()
null
, no special
background is painted behind a matched bracket.setMatchedBracketBGColor(java.awt.Color)
,
getMatchedBracketBorderColor()
public java.awt.Color getMatchedBracketBorderColor()
setMatchedBracketBorderColor(java.awt.Color)
,
getMatchedBracketBGColor()
public int getMaxAscent()
getMaxAscent
in class RTextArea
public boolean getPaintMatchedBracketPair()
isBracketMatchingEnabled()
returns
false
.setPaintMatchedBracketPair(boolean)
,
isBracketMatchingEnabled()
,
setBracketMatchingEnabled(boolean)
public boolean getPaintTabLines()
setPaintTabLines(boolean)
,
getTabLineColor()
public Parser getParser(int index)
index
- The Parser
to retrieve.Parser
.getParserCount()
,
addParser(Parser)
public int getParserCount()
addParser(Parser)
public int getParserDelay()
Parser
s to run.setParserDelay(int)
public java.util.List<ParserNotice> getParserNotices()
public int getRightHandSideCorrection()
setRightHandSideCorrection(int)
public boolean getShouldIndentNextLine(int line)
for (int i=0; i<10; i++) {the following line should be indented.
line
- The line to check.false
.isAutoIndentEnabled()
public boolean getShowMatchedBracketPopup()
setShowMatchedBracketPopup(boolean)
public java.lang.String getSyntaxEditingStyle()
SyntaxConstants.SYNTAX_STYLE_JAVA
.setSyntaxEditingStyle(String)
,
SyntaxConstants
public SyntaxScheme getSyntaxScheme()
SyntaxScheme
that represents
the colors currently being used for syntax highlighting.setSyntaxScheme(SyntaxScheme)
public java.awt.Color getTabLineColor()
setTabLineColor(Color)
,
getPaintTabLines()
,
setPaintTabLines(boolean)
public boolean getPaintMarkOccurrencesBorder()
setPaintMarkOccurrencesBorder(boolean)
,
getMarkOccurrencesColor()
,
getMarkOccurrences()
public java.awt.Color getSecondaryLanguageBackground(int index)
index
- The language index. Note that these are 1-based, not
0-based, and should be in the range
1-getSecondaryLanguageCount()
, inclusive.null
if none.getSecondaryLanguageCount()
,
setSecondaryLanguageBackground(int, Color)
,
getHighlightSecondaryLanguages()
public int getSecondaryLanguageCount()
getSecondaryLanguageBackground(int)
,
setSecondaryLanguageBackground(int, Color)
,
getHighlightSecondaryLanguages()
public static boolean getTemplatesEnabled()
RSyntaxTextArea
.For more flexible boilerplate code insertion, consider using the TemplateCompletion class in the AutoComplete add-on library.
saveTemplates()
,
setTemplateDirectory(String)
,
setTemplatesEnabled(boolean)
public Token getTokenListForLine(int line)
line
- The line number to get tokens for.public java.lang.String getToolTipText(java.awt.event.MouseEvent e)
getToolTipText
in class RTextArea
e
- The mouse event.null
if none.RTextArea.getToolTipSupplier()
,
RTextArea.setToolTipSupplier(ToolTipSupplier)
protected java.lang.String getToolTipTextImpl(java.awt.event.MouseEvent e)
e
- The mouse event.public boolean getUnderlineForToken(Token t)
t
- The token.public boolean getUseFocusableTips()
setUseFocusableTips(boolean)
,
FocusableTip
public boolean getUseSelectedTextColor()
JTextComponent.setSelectedTextColor(Color)
. This is the
typical behavior of text components. By default, RSyntaxTextArea does
not do this, so that token styles are visible even in selected regions
of text.setUseSelectedTextColor(boolean)
protected void init()
public boolean isAutoIndentEnabled()
setAutoIndentEnabled(boolean)
public final boolean isBracketMatchingEnabled()
true
iff bracket matching is enabled.setBracketMatchingEnabled(boolean)
public boolean isClearWhitespaceLinesEnabled()
setClearWhitespaceLinesEnabled(boolean)
public boolean isCodeFoldingEnabled()
setCodeFoldingEnabled(boolean)
public boolean isWhitespaceVisible()
setWhitespaceVisible(boolean)
,
getEOLMarkersVisible()
public Token modelToToken(int offs)
offs
- The position in the model.null
if no token is at that
position.viewToToken(Point)
protected void paintComponent(java.awt.Graphics g)
paintComponent
method is overridden so we
apply any necessary rendering hints to the Graphics object.paintComponent
in class RTextAreaBase
g
- The graphics context with which to paint.public void redoLastAction()
redoLastAction
in class RTextArea
RTextArea.undoLastAction()
public void removeActiveLineRangeListener(ActiveLineRangeListener l)
l
- The listener to remove.removeActiveLineRangeListener(ActiveLineRangeListener)
public void removeHyperlinkListener(javax.swing.event.HyperlinkListener l)
l
- The listener to remove.addHyperlinkListener(HyperlinkListener)
public void removeNotify()
removeNotify
in class javax.swing.text.JTextComponent
public boolean removeParser(Parser parser)
parser
- The Parser
to remove.clearParsers()
,
addParser(Parser)
,
getParser(int)
public void restoreDefaultSyntaxScheme()
public static boolean saveTemplates()
setTemplateDirectory
. Templates
will be saved as XML files with names equal to their abbreviations; for
example, a template that expands on the word "forb" will be saved as
forb.xml
.setTemplateDirectory
).getTemplatesEnabled()
,
setTemplateDirectory(java.lang.String)
,
setTemplatesEnabled(boolean)
public void setActiveLineRange(int min, int max)
RSyntaxTextArea
itself does nothing with this information,
but if it is contained inside an RTextScrollPane
,
the active line range may be displayed in the icon area of the
Gutter
.
Note that basic users of RSyntaxTextArea
will not call this
method directly; rather, it is usually called by instances of
LanguageSupport
in the RSTALangaugeSupport
library. See http://fifesoft.com
for more information about this library.
min
- The "minimum" line in the active line range, or
-1
if the range is being cleared.max
- The "maximum" line in the active line range, or
-1
if the range is being cleared.addActiveLineRangeListener(ActiveLineRangeListener)
public void setAnimateBracketMatching(boolean animate)
ANIMATE_BRACKET_MATCHING_PROPERTY
.animate
- Whether to animate bracket matching.getAnimateBracketMatching()
public void setAntiAliasingEnabled(boolean enabled)
ANTIALIAS_PROPERTY
.enabled
- Whether anti-aliasing is enabled.getAntiAliasingEnabled()
public void setAutoIndentEnabled(boolean enabled)
AUTO_INDENT_PROPERTY
.enabled
- Whether or not auto-indent is enabled.isAutoIndentEnabled()
public void setBracketMatchingEnabled(boolean enabled)
BRACKET_MATCHING_PROPERTY
.enabled
- Whether or not bracket matching should be enabled.isBracketMatchingEnabled()
public void setClearWhitespaceLinesEnabled(boolean enabled)
CLEAR_WHITESPACE_LINES_PROPERTY
.enabled
- Whether or not whitespace-only lines are cleared when
the user presses Enter on them.isClearWhitespaceLinesEnabled()
public void setCloseCurlyBraces(boolean close)
This method fires a property change event of type
CLOSE_CURLY_BRACES_PROPERTY
.
close
- Whether curly braces should be automatically closed.getCloseCurlyBraces()
public void setCloseMarkupTags(boolean close)
</
" is typed. Note that this property is only
honored for markup languages, such as HTML, XML and PHP.
This method fires a property change event of type
CLOSE_MARKUP_TAGS_PROPERTY
.
close
- Whether closing markup tags should be automatically
completed.getCloseMarkupTags()
public void setCodeFoldingEnabled(boolean enabled)
This method fires a property change event of type
CODE_FOLDING_PROPERTY
.
enabled
- Whether code folding should be enabled.isCodeFoldingEnabled()
public void setDocument(javax.swing.text.Document document)
RSyntaxDocument
are accepted; for all
others, an exception will be thrown.setDocument
in class RTextArea
document
- The new document for this text area.java.lang.IllegalArgumentException
- If the document is not an
RSyntaxDocument
.public void setEOLMarkersVisible(boolean visible)
EOL_VISIBLE_PROPERTY
.visible
- Whether EOL markers are visible.getEOLMarkersVisible()
,
setWhitespaceVisible(boolean)
public void setFont(java.awt.Font font)
SyntaxScheme
.setFont
in class RTextAreaBase
font
- The font.SyntaxScheme.getStyle(int)
public void setFractionalFontMetricsEnabled(boolean enabled)
FRACTIONAL_FONTMETRICS_PROPERTY
.enabled
- Whether fractional font metrics are enabled.getFractionalFontMetricsEnabled()
public void setHighlighter(javax.swing.text.Highlighter h)
setHighlighter
in class javax.swing.text.JTextComponent
h
- The highlighter.java.lang.IllegalArgumentException
- If h
is not an instance
of RSyntaxTextAreaHighlighter
.public void setHighlightSecondaryLanguages(boolean highlight)
HIGHLIGHT_SECONDARY_LANGUAGES_PROPERTY
.public void setHyperlinkForeground(java.awt.Color fg)
fg
- The color to use when painting hyperlinks.java.lang.NullPointerException
- If fg
is null
.getHyperlinkForeground()
,
setHyperlinksEnabled(boolean)
public void setHyperlinksEnabled(boolean enabled)
HYPERLINKS_ENABLED_PROPERTY
.enabled
- Whether hyperlinks are enabled.getHyperlinksEnabled()
public void setLinkGenerator(LinkGenerator generator)
public void setLinkScanningMask(int mask)
CTRL_DOWN_MASK
.mask
- The mask to use. This should be some bitwise combination of
InputEvent.CTRL_DOWN_MASK
,
InputEvent.ALT_DOWN_MASK
,
InputEvent.SHIFT_DOWN_MASK
or
InputEvent.META_DOWN_MASK
.
For invalid values, behavior is undefined.InputEvent
public void setMarkOccurrences(boolean markOccurrences)
MARK_OCCURRENCES_PROPERTY
.markOccurrences
- Whether "Mark Occurrences" should be enabled.getMarkOccurrences()
,
setMarkOccurrencesColor(Color)
public void setMarkOccurrencesColor(java.awt.Color color)
color
- The new color. This cannot be null
.getMarkOccurrencesColor()
,
setMarkOccurrences(boolean)
public void setMarkOccurrencesDelay(int delay)
delay
- The new delay. This must be greater than 0
.getMarkOccurrencesDelay()
,
getMarkOccurrences()
public void setMatchedBracketBGColor(java.awt.Color color)
color
- The color to use. If this is null
, then no
special background is painted behind a matched bracket.getMatchedBracketBGColor()
,
setMatchedBracketBorderColor(java.awt.Color)
,
setPaintMarkOccurrencesBorder(boolean)
public void setMatchedBracketBorderColor(java.awt.Color color)
color
- The color to use.getMatchedBracketBorderColor()
,
setMatchedBracketBGColor(java.awt.Color)
public void setPaintMarkOccurrencesBorder(boolean paintBorder)
paintBorder
- Whether to paint a border.getPaintMarkOccurrencesBorder()
,
setMarkOccurrencesColor(Color)
,
setMarkOccurrences(boolean)
public void setPaintMatchedBracketPair(boolean paintPair)
isBracketMatchingEnabled()
returns false
.
This method fires a property change event of type
PAINT_MATCHED_BRACKET_PAIR_PROPERTY
.
paintPair
- Whether both brackets in a bracket pair should be
highlighted when bracket matching is enabled.getPaintMatchedBracketPair()
,
isBracketMatchingEnabled()
,
setBracketMatchingEnabled(boolean)
public void setPaintTabLines(boolean paint)
TAB_LINES_PROPERTY
.paint
- Whether tab lines are painted.getPaintTabLines()
,
setTabLineColor(Color)
public void setParserDelay(int millis)
Parser
s to run.millis
- The new parser delay, in milliseconds. This must be
greater than zero.getParserDelay()
public void setRightHandSideCorrection(int rhsCorrection)
Workaround for JTextComponents allowing the caret to be rendered entirely off-screen if the entire "previous" character fit entirely.
rhsCorrection
- The amount of space to add to the x-axis preferred
span. This should be non-negative.getRightHandSideCorrection()
public void setSecondaryLanguageBackground(int index, java.awt.Color color)
index
- The language index. Note that these are 1-based, not
0-based, and should be in the range
1-getSecondaryLanguageCount()
, inclusive.color
- The new color, or null
for none.getSecondaryLanguageBackground(int)
,
getSecondaryLanguageCount()
public void setShowMatchedBracketPopup(boolean show)
show
- Whether to show the popup.getShowMatchedBracketPopup()
public void setSyntaxEditingStyle(java.lang.String styleKey)
SYNTAX_STYLE_PROPERTY
.styleKey
- The syntax editing style to use, for example,
SyntaxConstants.SYNTAX_STYLE_NONE
or
SyntaxConstants.SYNTAX_STYLE_JAVA
.getSyntaxEditingStyle()
,
SyntaxConstants
public void setSyntaxScheme(SyntaxScheme scheme)
This method fires a property change event of type
SYNTAX_SCHEME_PROPERTY
.
scheme
- The instance of SyntaxScheme
to use.getSyntaxScheme()
public static boolean setTemplateDirectory(java.lang.String dir)
dir
- The directory containing files ending in extension
.xml
that contain templates to load.true
if the load was successful;
false
if either templates aren't currently
enabled or the load failed somehow (most likely, the
directory doesn't exist).getTemplatesEnabled()
,
setTemplatesEnabled(boolean)
,
saveTemplates()
public static void setTemplatesEnabled(boolean enabled)
Templates are a set of "shorthand identifiers" that you can configure so that you only have to type a short identifier (such as "forb") to insert a larger amount of code into the document (such as:
for (<caret>) { }Templates are a shared resource among all instances of
RSyntaxTextArea
; that is, templates can only be
enabled/disabled for all text areas globally, not individually, and
all text areas have access of the same templates. This should not
be an issue; rather, it should be beneficial as it promotes
uniformity among all text areas in an application.For more flexible boilerplate code insertion, consider using the TemplateCompletion class in the AutoComplete add-on library.
enabled
- Whether or not templates should be enabled.getTemplatesEnabled()
public void setTabLineColor(java.awt.Color c)
TAB_LINE_COLOR_PROPERTY
.c
- The color. If this value is null
, the default
(gray) is used.getTabLineColor()
,
setPaintTabLines(boolean)
,
getPaintTabLines()
public void setUseFocusableTips(boolean use)
FOCUSABLE_TIPS_PROPERTY
.use
- Whether to use focusable tool tips.getUseFocusableTips()
,
FocusableTip
public void setUseSelectedTextColor(boolean use)
JTextComponent.setSelectedTextColor(Color)
). This is the typical
behavior of text components. By default, RSyntaxTextArea does not do
this, so that token styles are visible even in selected regions of text.
This method fires a property change event of type
USE_SELECTED_TEXT_COLOR_PROPERTY
.use
- Whether to use the "selected text" color when painting text
in selected regions.getUseSelectedTextColor()
public void setWhitespaceVisible(boolean visible)
VISIBLE_WHITESPACE_PROPERTY
.visible
- Whether whitespace should be visible.isWhitespaceVisible()
public void undoLastAction()
undoLastAction
in class RTextArea
RTextArea.redoLastAction()
public Token viewToToken(java.awt.Point p)
p
- The position in the view.null
if no token is at that
position.modelToToken(int)