Class CodeAreaControl
java.lang.Object
qupath.lib.gui.scripting.richtextfx.CodeAreaControl
- All Implemented Interfaces:
qupath.lib.gui.logging.TextAppendable,qupath.lib.gui.scripting.EditableText,qupath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
public class CodeAreaControl
extends Object
implements qupath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
Code area control using RichTextFX.
-
Property Summary
PropertiesTypePropertyDescription -
Method Summary
Modifier and TypeMethodDescriptionvoidappendText(String text) voidclear()voidcopy()static CodeAreaControlCreate an editable control for writing code.static CodeAreaControlCreate a non-editable control for showing log messages.voidcut()voiddeleteText(int startIdx, int endIdx) voiddeselect()intGets the value of thecaretPositionproperty.qupath.lib.scripting.languages.ScriptLanguageorg.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea> Gets the value of theselectedTextproperty.booleanCheck whether smart editing is requested.getText()Gets the value of thetextproperty.voidinsertText(int pos, String text) booleanbooleanvoidpaste()voidpositionCaret(int index) voidredo()voidreplaceSelection(String text) voidvoidvoidselectRange(int startIdx, int endIdx) voidsetContextMenu(ContextMenu menu) voidsetLanguage(qupath.lib.scripting.languages.ScriptLanguage language) voidsetSmartEditing(boolean smartEditing) Request smart editing, e.g.voidSets the value of thetextproperty.voidundo()Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface qupath.lib.gui.scripting.EditableText
getSelectionLengthMethods inherited from interface qupath.lib.gui.scripting.ScriptEditorControl
getSelectionEnd, getSelectionStart
-
Property Details
-
text
- Specified by:
textPropertyin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>- See Also:
-
selectedText
- Specified by:
selectedTextPropertyin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>- See Also:
-
wrapText
- Specified by:
wrapTextPropertyin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>- See Also:
-
caretPosition
- Specified by:
caretPositionPropertyin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>- See Also:
-
-
Method Details
-
createCodeEditor
Create an editable control for writing code.- Returns:
-
createLog
Create a non-editable control for showing log messages.- Returns:
-
textProperty
- Specified by:
textPropertyin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>- Returns:
- the
textproperty - See Also:
-
setText
Sets the value of thetextproperty.- Specified by:
setTextin interfacequpath.lib.gui.scripting.EditableText- Property description:
- Parameters:
text- the value for thetextproperty- See Also:
-
getText
Gets the value of thetextproperty.- Specified by:
getTextin interfacequpath.lib.gui.scripting.EditableText- Property description:
- Returns:
- the value of the
textproperty - See Also:
-
selectedTextProperty
- Specified by:
selectedTextPropertyin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>- Returns:
- the
selectedTextproperty - See Also:
-
getSelectedText
Gets the value of theselectedTextproperty.- Specified by:
getSelectedTextin interfacequpath.lib.gui.scripting.EditableText- Property description:
- Returns:
- the value of the
selectedTextproperty - See Also:
-
getRegion
public org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea> getRegion()- Specified by:
getRegionin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
isUndoable
public boolean isUndoable()- Specified by:
isUndoablein interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
isRedoable
public boolean isRedoable()- Specified by:
isRedoablein interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
undo
public void undo()- Specified by:
undoin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
redo
public void redo()- Specified by:
redoin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
copy
public void copy()- Specified by:
copyin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
cut
public void cut()- Specified by:
cutin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
paste
public void paste()- Specified by:
pastein interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
appendText
- Specified by:
appendTextin interfacequpath.lib.gui.scripting.EditableText- Specified by:
appendTextin interfacequpath.lib.gui.logging.TextAppendable
-
clear
public void clear()- Specified by:
clearin interfacequpath.lib.gui.scripting.EditableText
-
getCaretPosition
public int getCaretPosition()Gets the value of thecaretPositionproperty.- Specified by:
getCaretPositionin interfacequpath.lib.gui.scripting.EditableText- Property description:
- Returns:
- the value of the
caretPositionproperty - See Also:
-
insertText
- Specified by:
insertTextin interfacequpath.lib.gui.scripting.EditableText
-
deleteText
public void deleteText(int startIdx, int endIdx) - Specified by:
deleteTextin interfacequpath.lib.gui.scripting.EditableText
-
deselect
public void deselect()- Specified by:
deselectin interfacequpath.lib.gui.scripting.EditableText
-
getSelection
- Specified by:
getSelectionin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
selectRange
public void selectRange(int startIdx, int endIdx) - Specified by:
selectRangein interfacequpath.lib.gui.scripting.EditableText
-
wrapTextProperty
- Specified by:
wrapTextPropertyin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>- Returns:
- the
wrapTextproperty
-
positionCaret
public void positionCaret(int index) - Specified by:
positionCaretin interfacequpath.lib.gui.scripting.EditableText
-
requestFollowCaret
public void requestFollowCaret()- Specified by:
requestFollowCaretin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
replaceSelection
- Specified by:
replaceSelectionin interfacequpath.lib.gui.scripting.EditableText
-
setContextMenu
- Specified by:
setContextMenuin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
getContextMenu
- Specified by:
getContextMenuin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
requestFocus
public void requestFocus()- Specified by:
requestFocusin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
caretPositionProperty
- Specified by:
caretPositionPropertyin interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>- Returns:
- the
caretPositionproperty - See Also:
-
setLanguage
public void setLanguage(qupath.lib.scripting.languages.ScriptLanguage language) - Specified by:
setLanguagein interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
getLanguage
public qupath.lib.scripting.languages.ScriptLanguage getLanguage()- Specified by:
getLanguagein interfacequpath.lib.gui.scripting.ScriptEditorControl<org.fxmisc.flowless.VirtualizedScrollPane<org.fxmisc.richtext.CodeArea>>
-
setSmartEditing
public void setSmartEditing(boolean smartEditing) Request smart editing, e.g. to insert closing parentheses.- Parameters:
smartEditing-
-
getSmartEditing
public boolean getSmartEditing()Check whether smart editing is requested.- Returns:
-