Класс RichTextModel

java.lang.Object

jfx.incubator.scene.control.richtext.model.StyledTextModel

jfx.incubator.scene.control.richtext.model.RichTextModel

public class RichTextModel extends StyledTextModel

Редактируемая, находящаяся в памяти StyledTextModel на основе коллекции стилизованных сегментов.

Данная модель подходит для относительно небольших документов, так как не имеет поддержки дискового хранилища и не сохраняет промежуточные изменения.

Since:: 24

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в классе jfx.incubator.scene.control.richtext.model.StyledTextModel

StyledTextModel.Listener

Краткое описание свойств

Свойства, объявленные в классе jfx.incubator.scene.control.richtext.model.StyledTextModel

redoable, undoable

Краткое описание конструкторов

Конструктор	Описание
`RichTextModel()`	Создаёт пустую модель.

Краткое описание методов

Модификатор и тип	Метод	Описание
`protected void`	`applyStyle(int index, int start, int end, StyleAttributeMap attrs, boolean merge)`	Применяет стиль к указанному диапазону текста в рамках одного абзаца.
`RichParagraph`	`getParagraph(int index)`	Возвращает `RichParagraph` по заданному индексу модели.
`String`	`getPlainText(int index)`	Возвращает обычный текстовый строковый абзац.
`StyleAttributeMap`	`getStyleAttributeMap(StyleResolver resolver, TextPos pos)`	Возвращает `StyleAttributeMap` символа в указанной позиции `charIndex`.
`protected void`	`insertLineBreak(int index, int offset)`	Вставляет символ переноса строки в указанную позицию.
`protected void`	`insertParagraph(int index, Supplier<Region> generator)`	Вставляет абзац, содержащий один `Region`.
`protected int`	`insertTextSegment(int index, int offset, String text, StyleAttributeMap attrs)`	Этот метод вызывается для вставки одного стилизованного текстового сегмента в указанную позицию.
`final boolean`	`isWritable()`	Указывает, поддерживает ли модель модификации контента, выполненные методами `applyStyle()`, `replace()`, `undo()`, `redo()`.
`protected void`	`removeRange(TextPos start, TextPos end)`	Удаляет указанный диапазон текста.
`protected void`	`setParagraphStyle(int index, StyleAttributeMap attrs)`	Заменяет стили абзаца в указанном абзаце.
`int`	`size()`	Возвращает количество абзацев в модели.

Методы, объявленные в классе jfx.incubator.scene.control.richtext.model.StyledTextModel

addListener, applyStyle, clamp, clearUndoRedo, export, exportParagraph, fireChangeEvent, fireStyleChangeEvent, getDataFormatHandler, getDocumentEnd, getEndOfParagraphTextPos, getMarker, getParagraphLength, getSupportedAttributes, getSupportedDataFormats, isRedoable, isUndoable, read, redo, redoableProperty, registerDataFormatHandler, removeDataFormatHandler, removeListener, replace, replace, undo, undoableProperty, write

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

RichTextModel

public RichTextModel()

Создаёт пустую модель.

Подробное описание методов

isWritable

public final boolean isWritable()

Описание скопировано из класса: StyledTextModel

Указывает, поддерживает ли модель изменения содержимого, выполняемые методами applyStyle(), replace(), undo(), redo().

Обратите внимание, что даже когда этот метод возвращает false, сама модель может всё ещё обновлять своё содержимое и генерировать события изменения в ответ, например, на изменения в хранилище данных.

Определено в:: isWritable в классе StyledTextModel
Возвращает:: true, если модель поддерживает изменения содержимого

size

public int size()

Описание скопировано из класса: StyledTextModel

Возвращает количество абзацев в модели.

Определено в:: size в классе StyledTextModel
Возвращает:: количество абзацев

getPlainText

public String getPlainText(int index)

Описание скопировано из класса: StyledTextModel

Возвращает строку простого текста для указанного абзаца. Возвращаемая строка текста не может быть null и не должна содержать никаких управляющих символов, кроме TAB. Вызывающие стороны должны убедиться, что значение index находится в пределах допустимого диапазона документа, так как в противном случае может произойти исключение или неопределённое поведение.

Определено в:: getPlainText в классе StyledTextModel
Параметры:: index - индекс абзаца в диапазоне (0...StyledTextModel.size())
Возвращает:: строку текста абзаца, не равную null

getParagraph

public RichParagraph getParagraph(int index)

Описание скопировано из класса: StyledTextModel

Возвращает RichParagraph по заданному индексу модели. Вызывающие стороны должны убедиться, что значение index находится в пределах допустимого диапазона документа, так как в противном случае может произойти исключение или неопределённое поведение.

Этот метод не гарантирует, что для одного и того же индекса модели будет возвращён тот же экземпляр абзаца.

Определено в:: getParagraph в классе StyledTextModel
Параметры:: index - индекс абзаца в диапазоне (0...StyledTextModel.size())
Возвращает:: экземпляр RichParagraph

insertTextSegment

protected int insertTextSegment(int index, int offset, String text, StyleAttributeMap attrs)

Описание скопировано из класса: StyledTextModel

Этот метод вызывается для вставки одного стилизованного сегмента текста в заданную позицию.

Определено в:: insertTextSegment в классе StyledTextModel
Параметры:: index - индекс абзаца; offset - смещение вставки в пределах абзаца; text - текст для вставки; attrs - атрибуты стиля
Возвращает:: количество вставленных символов

insertLineBreak

protected void insertLineBreak(int index, int offset)

Описание скопировано из класса: StyledTextModel

Вставляет символ перевода строки в указанную позицию.

Определено в:: insertLineBreak в классе StyledTextModel
Параметры:: index - индекс модели; offset - смещение текста

removeRange

protected void removeRange(TextPos start, TextPos end)

Описание скопировано из класса: StyledTextModel

Удаляет указанный диапазон текста. Этот метод вызывается только если модель редактируема. Вызывающая сторона гарантирует, что start предшествует end.

Определено в:: removeRange в классе StyledTextModel
Параметры:: start - начало диапазона для удаления; end - конец диапазона для удаления, ожидается, что он будет больше начальной позиции

insertParagraph

protected void insertParagraph(int index, Supplier<Region> generator)

Описание скопировано из класса: StyledTextModel

Вставляет абзац, содержащий один Region.

Модель не должна кэшировать или каким-либо образом сохранять ссылки на созданные Region, так как они могут запрашиваться несколько раз за время существования модели или разными представлениями.

Этот метод позволяет встраивать Control, обрабатывающие пользовательский ввод. В этом случае модель должна объявлять необходимые свойства и предоставлять двусторонние привязки между свойствами в модели и соответствующими свойствами в элементе управления, а также обрабатывать копирование, вставку, запись в и чтение из потоков ввода-вывода.

Определено в:: insertParagraph в классе StyledTextModel
Параметры:: index - индекс модели; generator - код, который будет использован для создания экземпляра Node

setParagraphStyle

protected void setParagraphStyle(int index, StyleAttributeMap attrs)

Описание скопировано из класса: StyledTextModel

Заменяет стили абзаца в указанном абзаце.

Определено в:: setParagraphStyle в классе StyledTextModel
Параметры:: index - индекс абзаца; attrs - атрибуты абзаца

applyStyle

protected void applyStyle(int index, int start, int end, StyleAttributeMap attrs, boolean merge)

Описание скопировано из класса: StyledTextModel

Применяет стиль к указанному диапазону текста в пределах одного абзаца. Новые атрибуты переопределяют все существующие атрибуты. Аргумент end может превышать длину абзаца, в этом случае результат должен быть таким же, как при использовании значения длины абзаца.

Определено в:: applyStyle в классе StyledTextModel
Параметры:: index - индекс абзаца; start - начальное смещение; end - конечное смещение; attrs - атрибуты символов; merge - определяет, нужно ли сливать или перезаписывать существующие атрибуты

getStyleAttributeMap

public StyleAttributeMap getStyleAttributeMap(StyleResolver resolver, TextPos pos)

Описание скопировано из класса: StyledTextModel

Возвращает StyleAttributeMap символа в указанной позиции charIndex. При достижении конца документа возвращает атрибуты последнего символа.

Определено в:: getStyleAttributeMap в классе StyledTextModel
Параметры:: resolver - обработчик стилей; pos - позиция текста
Возвращает:: атрибуты стиля, не null

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.