Package org.fife.ui.rsyntaxtextarea
Class RSyntaxTextAreaEditorKit
- java.lang.Object
-
- javax.swing.text.EditorKit
-
- javax.swing.text.DefaultEditorKit
-
- org.fife.ui.rtextarea.RTextAreaEditorKit
-
- org.fife.ui.rsyntaxtextarea.RSyntaxTextAreaEditorKit
-
- All Implemented Interfaces:
Serializable,Cloneable
public class RSyntaxTextAreaEditorKit extends RTextAreaEditorKit
An extension ofRTextAreaEditorKitthat adds functionality for programming-specific stuff. There are currently subclasses to handle:- Toggling code folds.
- Aligning "closing" curly braces with their matches, if the current programming language uses curly braces to identify code blocks.
- Copying the current selection as RTF.
- Block indentation (increasing the indent of one or multiple lines)
- Block un-indentation (decreasing the indent of one or multiple lines)
- Inserting a "code template" when a configurable key (e.g. a space) is pressed
- Decreasing the point size of all fonts in the text area
- Increasing the point size of all fonts in the text area
- Moving the caret to the "matching bracket" of the one at the current caret position
- Toggling whether the currently selected lines are commented out.
- Better selection of "words" on mouse double-clicks for programming languages.
- Better keyboard navigation via Ctrl+arrow keys for programming languages.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static classRSyntaxTextAreaEditorKit.BeginWordActionPositions the caret at the beginning of the word.static classRSyntaxTextAreaEditorKit.ChangeFoldStateActionExpands or collapses the nearest fold.static classRSyntaxTextAreaEditorKit.CloseCurlyBraceActionAction that (optionally) aligns a closing curly brace with the line containing its matching opening curly brace.static classRSyntaxTextAreaEditorKit.CloseMarkupTagAction(Optionally) completes a closing markup tag.static classRSyntaxTextAreaEditorKit.CollapseAllCommentFoldsActionCollapses all comment folds.static classRSyntaxTextAreaEditorKit.CollapseAllFoldsActionCollapses all folds.static classRSyntaxTextAreaEditorKit.CopyAsRtfActionAction for copying text as RTF.static classRSyntaxTextAreaEditorKit.DecreaseFontSizeActionAction for decreasing the font size of all fonts in the text area.static classRSyntaxTextAreaEditorKit.DecreaseIndentActionAction for when un-indenting lines (either the current line if there is selection, or all selected lines if there is one).static classRSyntaxTextAreaEditorKit.DeletePrevWordActionDeletes the previous word, but differentiates symbols from "words" to match the behavior of code editors.static classRSyntaxTextAreaEditorKit.DumbCompleteWordActionOverridden to use the programming language RSTA is displaying when computing words to complete.protected static classRSyntaxTextAreaEditorKit.EndWordActionPositions the caret at the end of the word.static classRSyntaxTextAreaEditorKit.ExpandAllFoldsActionExpands all folds.static classRSyntaxTextAreaEditorKit.GoToMatchingBracketActionAction for moving the caret to the "matching bracket" of the bracket at the caret position (either before or after).static classRSyntaxTextAreaEditorKit.IncreaseFontSizeActionAction for increasing the font size of all fonts in the text area.static classRSyntaxTextAreaEditorKit.InsertBreakActionAction for when the user presses the Enter key.static classRSyntaxTextAreaEditorKit.InsertTabActionAction for inserting tabs.static classRSyntaxTextAreaEditorKit.NextWordActionAction to move the selection and/or caret.static classRSyntaxTextAreaEditorKit.PossiblyInsertTemplateActionAction for when the user tries to insert a template (that is, they've typed a template ID and pressed the trigger character (a space) in an attempt to do the substitution).static classRSyntaxTextAreaEditorKit.PreviousWordActionAction to move the selection and/or caret.static classRSyntaxTextAreaEditorKit.SelectWordActionSelects the word around the caret.static classRSyntaxTextAreaEditorKit.ToggleCommentActionAction that toggles whether the currently selected lines are commented.static classRSyntaxTextAreaEditorKit.ToggleCurrentFoldActionToggles the fold at the current caret position or line.-
Nested classes/interfaces inherited from class org.fife.ui.rtextarea.RTextAreaEditorKit
RTextAreaEditorKit.BeepAction, RTextAreaEditorKit.BeginAction, RTextAreaEditorKit.BeginLineAction, RTextAreaEditorKit.BeginRecordingMacroAction, RTextAreaEditorKit.ClipboardHistoryAction, RTextAreaEditorKit.CopyAction, RTextAreaEditorKit.CutAction, RTextAreaEditorKit.DefaultKeyTypedAction, RTextAreaEditorKit.DeleteLineAction, RTextAreaEditorKit.DeleteNextCharAction, RTextAreaEditorKit.DeletePrevCharAction, RTextAreaEditorKit.DeleteRestOfLineAction, RTextAreaEditorKit.EndAction, RTextAreaEditorKit.EndLineAction, RTextAreaEditorKit.EndRecordingMacroAction, RTextAreaEditorKit.InsertContentAction, RTextAreaEditorKit.InvertSelectionCaseAction, RTextAreaEditorKit.JoinLinesAction, RTextAreaEditorKit.LineMoveAction, RTextAreaEditorKit.LowerSelectionCaseAction, RTextAreaEditorKit.NextBookmarkAction, RTextAreaEditorKit.NextOccurrenceAction, RTextAreaEditorKit.NextVisualPositionAction, RTextAreaEditorKit.PasteAction, RTextAreaEditorKit.PlaybackLastMacroAction, RTextAreaEditorKit.PreviousOccurrenceAction, RTextAreaEditorKit.RedoAction, RTextAreaEditorKit.ScrollAction, RTextAreaEditorKit.SelectAllAction, RTextAreaEditorKit.SelectLineAction, RTextAreaEditorKit.SetReadOnlyAction, RTextAreaEditorKit.SetWritableAction, RTextAreaEditorKit.TimeDateAction, RTextAreaEditorKit.ToggleBookmarkAction, RTextAreaEditorKit.ToggleTextModeAction, RTextAreaEditorKit.UndoAction, RTextAreaEditorKit.UnselectAction, RTextAreaEditorKit.UpperSelectionCaseAction, RTextAreaEditorKit.VerticalPageAction
-
-
Field Summary
Fields Modifier and Type Field Description static StringrstaCloseCurlyBraceActionstatic StringrstaCloseMarkupTagActionstatic StringrstaCollapseAllCommentFoldsActionstatic StringrstaCollapseAllFoldsActionstatic StringrstaCollapseFoldActionstatic StringrstaCopyAsRtfActionstatic StringrstaDecreaseIndentActionstatic StringrstaExpandAllFoldsActionstatic StringrstaExpandFoldActionstatic StringrstaGoToMatchingBracketActionstatic StringrstaPossiblyInsertTemplateActionstatic StringrstaToggleCommentActionstatic StringrstaToggleCurrentFoldAction-
Fields inherited from class org.fife.ui.rtextarea.RTextAreaEditorKit
clipboardHistoryAction, rtaBeginRecordingMacroAction, rtaDecreaseFontSizeAction, rtaDeleteLineAction, rtaDeletePrevWordAction, rtaDeleteRestOfLineAction, rtaDumbCompleteWordAction, rtaEndRecordingMacroAction, rtaIncreaseFontSizeAction, rtaInvertSelectionCaseAction, rtaJoinLinesAction, rtaLineDownAction, rtaLineUpAction, rtaLowerSelectionCaseAction, rtaNextBookmarkAction, rtaNextOccurrenceAction, rtaPlaybackLastMacroAction, rtaPrevBookmarkAction, rtaPrevOccurrenceAction, rtaRedoAction, rtaScrollDownAction, rtaScrollUpAction, rtaSelectionPageDownAction, rtaSelectionPageLeftAction, rtaSelectionPageRightAction, rtaSelectionPageUpAction, rtaTimeDateAction, rtaToggleBookmarkAction, rtaToggleTextModeAction, rtaUndoAction, rtaUnselectAction, rtaUpperSelectionCaseAction
-
Fields inherited from class javax.swing.text.DefaultEditorKit
backwardAction, beepAction, beginAction, beginLineAction, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deleteNextWordAction, deletePrevCharAction, deletePrevWordAction, downAction, endAction, endLineAction, EndOfLineStringProperty, endParagraphAction, endWordAction, forwardAction, insertBreakAction, insertContentAction, insertTabAction, nextWordAction, pageDownAction, pageUpAction, pasteAction, previousWordAction, readOnlyAction, selectAllAction, selectionBackwardAction, selectionBeginAction, selectionBeginLineAction, selectionBeginParagraphAction, selectionBeginWordAction, selectionDownAction, selectionEndAction, selectionEndLineAction, selectionEndParagraphAction, selectionEndWordAction, selectionForwardAction, selectionNextWordAction, selectionPreviousWordAction, selectionUpAction, selectLineAction, selectParagraphAction, selectWordAction, upAction, writableAction
-
-
Constructor Summary
Constructors Constructor Description RSyntaxTextAreaEditorKit()Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentcreateDefaultDocument()Returns the default document used byRSyntaxTextAreas.IconRowHeadercreateIconRowHeader(RTextArea textArea)Overridden to return a row header that is aware of folding.Action[]getActions()Fetches the set of commands that can be used on a text component that is using a model and view produced by this kit.static StringgetString(String key)Returns localized text for an action.-
Methods inherited from class org.fife.ui.rtextarea.RTextAreaEditorKit
createLineNumberList, read
-
Methods inherited from class javax.swing.text.DefaultEditorKit
createCaret, getContentType, getViewFactory, read, write, write
-
-
-
-
Field Detail
-
rstaCloseCurlyBraceAction
public static final String rstaCloseCurlyBraceAction
- See Also:
- Constant Field Values
-
rstaCloseMarkupTagAction
public static final String rstaCloseMarkupTagAction
- See Also:
- Constant Field Values
-
rstaCollapseAllFoldsAction
public static final String rstaCollapseAllFoldsAction
- See Also:
- Constant Field Values
-
rstaCollapseAllCommentFoldsAction
public static final String rstaCollapseAllCommentFoldsAction
- See Also:
- Constant Field Values
-
rstaCollapseFoldAction
public static final String rstaCollapseFoldAction
- See Also:
- Constant Field Values
-
rstaCopyAsRtfAction
public static final String rstaCopyAsRtfAction
- See Also:
- Constant Field Values
-
rstaDecreaseIndentAction
public static final String rstaDecreaseIndentAction
- See Also:
- Constant Field Values
-
rstaExpandAllFoldsAction
public static final String rstaExpandAllFoldsAction
- See Also:
- Constant Field Values
-
rstaExpandFoldAction
public static final String rstaExpandFoldAction
- See Also:
- Constant Field Values
-
rstaGoToMatchingBracketAction
public static final String rstaGoToMatchingBracketAction
- See Also:
- Constant Field Values
-
rstaPossiblyInsertTemplateAction
public static final String rstaPossiblyInsertTemplateAction
- See Also:
- Constant Field Values
-
rstaToggleCommentAction
public static final String rstaToggleCommentAction
- See Also:
- Constant Field Values
-
rstaToggleCurrentFoldAction
public static final String rstaToggleCurrentFoldAction
- See Also:
- Constant Field Values
-
-
Method Detail
-
createDefaultDocument
public Document createDefaultDocument()
Returns the default document used byRSyntaxTextAreas.- Overrides:
createDefaultDocumentin classDefaultEditorKit- Returns:
- The document.
-
createIconRowHeader
public IconRowHeader createIconRowHeader(RTextArea textArea)
Overridden to return a row header that is aware of folding.- Overrides:
createIconRowHeaderin classRTextAreaEditorKit- Parameters:
textArea- The text area.- Returns:
- The icon row header.
-
getActions
public Action[] getActions()
Fetches the set of commands that can be used on a text component that is using a model and view produced by this kit.- Overrides:
getActionsin classRTextAreaEditorKit- Returns:
- the command list
-
-