org.fxmisc.richtext

Interface ClipboardActions<PS,SEG,S>

All Superinterfaces:

EditActions<PS,SEG,S>, TextEditingArea<PS,SEG,S>

All Known Implementing Classes:

CodeArea, GenericStyledArea, InlineCssTextArea, StyleClassedTextArea, StyledTextArea

public interface ClipboardActions<PS,SEG,S>
extends EditActions<PS,SEG,S>

Clipboard actions for TextEditingArea.

Property Summary

Properties inherited from interface org.fxmisc.richtext.TextEditingArea

anchor, beingUpdated, caretBounds, caretColumn, caretPosition, currentParagraph, length, selectedText, selectionBounds, selection, showCaret, text

Method Summary

Modifier and Type	Method and Description
default void	copy() Transfers the currently selected text to the clipboard, leaving the current selection.
default void	cut() Transfers the currently selected text to the clipboard, removing the current selection.
SegmentOps<SEG,S>	getSegOps() Returns the object used for operating over segments and their styles
java.util.Optional<Tuple2<Codec<PS>,Codec<StyledSegment<SEG,S>>>>	getStyleCodecs() Gets codecs to encode/decode style information to/from binary format.
default void	paste() Inserts the content from the clipboard into this text-editing area, replacing the current selection.
void	setStyleCodecs(Codec<PS> paragraphStyleCodec, Codec<StyledSegment<SEG,S>> textStyleCodec)

Methods inherited from interface org.fxmisc.richtext.EditActions

append, appendText, clear, deleteNextChar, deletePreviousChar, deleteText, deleteText, deleteText, insert, insert, insertText, insertText, moveSelectedText, replace, replaceSelection, replaceSelection, replaceText

Methods inherited from interface org.fxmisc.richtext.TextEditingArea

anchorProperty, beingUpdatedProperty, caretBoundsProperty, caretColumnProperty, caretPositionProperty, createMultiChange, createMultiChange, currentParagraphProperty, displaceCaret, dispose, getAbsolutePosition, getAnchor, getCaretBounds, getCaretColumn, getCaretPosition, getCaretSelectionBind, getContent, getCurrentParagraph, getDocument, getLength, getParagraph, getParagraphLength, getParagraphs, getParagraphSelection, getParagraphSelection, getSelectedText, getSelection, getSelectionBounds, getShowCaret, getText, getText, getText, getText, getText, isBeingUpdated, lengthProperty, multiPlainChanges, multiRichChanges, plainTextChanges, replace, replace, replace, replace, replace, replace, replaceText, replaceText, replaceText, richChanges, selectedTextProperty, selectionBoundsProperty, selectionProperty, selectRange, selectRange, setShowCaret, showCaretProperty, subDocument, subDocument, subDocument, subDocument, textProperty

Method Detail

getStyleCodecs

java.util.Optional<Tuple2<Codec<PS>,Codec<StyledSegment<SEG,S>>>> getStyleCodecs()

Gets codecs to encode/decode style information to/from binary format. Providing codecs enables clipboard actions to retain the style information.

setStyleCodecs

void setStyleCodecs(Codec<PS> paragraphStyleCodec,
                    Codec<StyledSegment<SEG,S>> textStyleCodec)

getSegOps

SegmentOps<SEG,S> getSegOps()

Description copied from interface: TextEditingArea

Returns the object used for operating over segments and their styles

Specified by:

getSegOps in interface TextEditingArea<PS,SEG,S>

cut

default void cut()

Transfers the currently selected text to the clipboard, removing the current selection.

copy

default void copy()

Transfers the currently selected text to the clipboard, leaving the current selection.

paste

default void paste()

Inserts the content from the clipboard into this text-editing area, replacing the current selection. If there is no selection, the content from the clipboard is inserted at the current caret position.