Класс RichTextFormatHandler

java.lang.Object

jfx.incubator.scene.control.richtext.model.DataFormatHandler

jfx.incubator.scene.control.richtext.model.RichTextFormatHandler

public class RichTextFormatHandler extends DataFormatHandler

Обработчик формата данных для использования с моделями форматированного текста на основе атрибутов.

Обработчик использует простой текстовый формат:

(*) обозначает необязательный элемент.

 PARAGRAPH[]

 PARAGRAPH: {
     PARAGRAPH_ATTRIBUTE[]*,
     TEXT_SEGMENT[],
     "\n"
 }

 PARAGRAPH_ATTRIBUTE: {
     "{!"
     (name)
     ATTRIBUTE_VALUE[]*
     "}"
 }

 ATTRIBUTE: {
     "{"
     (name)
     ATTRIBUTE_VALUE[]*
     "}"
 }

 ATTRIBUTE_VALUE: {
     |
     (value)
 }

 TEXT_SEGMENT: {
     ATTRIBUTE[]*
     (text string with escaped special characters)
 }

Последовательности атрибутов дополнительно дедуплицируются, используя единственный токен {номер}, который указывает индекс в списке уникальных наборов атрибутов. Наборы атрибутов абзацев обрабатываются отдельно от наборов атрибутов фрагментов.

В текстовых фрагментах экранируются следующие символы: {,%,} Формат экранирования — %XX, где XX — шестнадцатеричное значение.

Пример:

 {c|ff00ff}text{b}bold{!rtl}\n
 {1}line 2{!0}\n

С момента:: 24

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

Модификатор и тип	Поле	Описание
`static final DataFormat`	`DATA_FORMAT`	Идентификатор формата данных

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

Модификатор и тип	Метод	Описание
`Object`	`copy(StyledTextModel m, StyleResolver r, TextPos start, TextPos end)`	Создает объект, который помещается в буфер обмена для заданного диапазона текста.
`StyledInput`	`createStyledInput(String input, StyleAttributeMap attr)`	Создает StyledInput для заданной входной строки.
`static final RichTextFormatHandler`	`getInstance()`	Возвращает единственный экземпляр `RtfFormatHandler`.
`void`	`save(StyledTextModel m, StyleResolver r, TextPos start, TextPos end, OutputStream out)`	Сохраняет диапазон текста в формате обработчика в выходной поток (например, сохранение в файл).

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

getDataFormat

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

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

Подробное описание полей

DATA_FORMAT

public static final DataFormat DATA_FORMAT

Идентификатор формата данных

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

getInstance

public static final RichTextFormatHandler getInstance()

Возвращает единственный экземпляр RtfFormatHandler.

Возвращает:: единственный экземпляр RtfFormatHandler

createStyledInput

public StyledInput createStyledInput(String input, StyleAttributeMap attr)

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

Создает StyledInput для заданной входной строки. При вставке вызывающая сторона может передать атрибуты стиля attr в точке вставки. Этот аргумент может использоваться реализацией, если формат сам по себе не содержит стилей (например, в случае простого текстового формата).

Указано в:: createStyledInput в классе DataFormatHandler
Параметры:: input - входная строка; attr - атрибуты стиля (может быть null)
Возвращает:: StyledInput

copy

public Object copy(StyledTextModel m, StyleResolver r, TextPos start, TextPos end) throws IOException

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

Создает объект, который помещается в буфер обмена для заданного диапазона текста. Вызывающая сторона должна гарантировать, что позиция start предшествует позиции end.

Обычно реализация создает экземпляр StyledOutput и вызывает метод StyledTextModel.export(TextPos, TextPos, StyledOutput).

Указано в:: copy в классе DataFormatHandler
Параметры:: m - модель-источник; r - решатель стилей, специфичный для представления; start - начальная позиция текста; end - конечная позиция текста
Возвращает:: объект для размещения в буфере обмена
Исключения:: IOException - при возникновении ошибки ввода-вывода

save

public void save(StyledTextModel m, StyleResolver r, TextPos start, TextPos end, OutputStream out) throws IOException

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

Сохраняет диапазон текста в формате обработчика в выходной поток (например, сохранение в файл). Вызывающая сторона должна гарантировать, что позиция start предшествует позиции end. Ответственность вызывающей стороны — закрытие OutputStream.

Обычно реализация создает экземпляр StyledOutput и вызывает метод StyledTextModel.export(TextPos, TextPos, StyledOutput).

Указано в:: save в классе DataFormatHandler
Параметры:: m - модель-источник; r - решатель стилей, специфичный для представления; start - начальная позиция текста; end - конечная позиция текста; out - целевой OutputStream
Исключения:: IOException - при возникновении ошибки ввода-вывода

© 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.