Spec-Zone.ru › OpenJavaFX 24

Класс BasicTextModel

java.lang.Object
jfx.incubator.scene.control.richtext.model.StyledTextModel
jfx.incubator.scene.control.richtext.model.BasicTextModel
Прямые известные подклассы:
CodeTextModel
public class BasicTextModel extends StyledTextModel
Модель StyledTextModel, основанная на абзацах простого текста.

Этот класс не предоставляет форматирования. Подклассы могут переопределять getParagraph(int), чтобы обеспечить выделение синтаксиса, основанное на содержании модели.

Эта модель поддерживает механизм хранения пользовательского контента через BasicTextModel.Content. По умолчанию модель предоставляет хранение в памяти через её реализацию BasicTextModel.InMemoryContent.

С:
24

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

Модификатор и тип Класс Описание
static interface  BasicTextModel.Content
Этот интерфейс описывает механизм хранения данных для BasicTextModel.
static class  BasicTextModel.InMemoryContent
Это хранилище предоставляет хранение в памяти в ArrayList String.

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

StyledTextModel.Listener

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

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

redoable, undoable

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

Конструктор Описание
BasicTextModel()
Создаёт пустую модель с хранилищем в памяти Content.
BasicTextModel(BasicTextModel.Content c)
Создаёт пустую модель с указанным Content.

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

Модификатор и тип Метод Описание
protected final void applyStyle(int index, int start, int end, StyleAttributeMap a, 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.
void insertText(TextPos p, String text)
Вставляет текст в указанную позицию.
protected int insertTextSegment(int index, int offset, String text, StyleAttributeMap attrs)
Этот метод вызывается для вставки отдельного стилизованного текстового фрагмента в заданной позиции.
final boolean isWritable()
Определяет, является ли модель изменяемой.
protected void removeRange(TextPos start, TextPos end)
Удаляет указанный диапазон текста.
protected final void setParagraphStyle(int index, StyleAttributeMap a)
Заменяет стили абзаца в указанном абзаце.
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

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

BasicTextModel

public BasicTextModel(BasicTextModel.Content c)
Создает пустую модель с указанным Content.
Параметры:
c - содержимое для использования

BasicTextModel

public BasicTextModel()
Создает пустую модель с внутренней Content.

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

insertText

public void insertText(TextPos p, String text)
Вставляет текст в указанную позицию. Это удобный ярлык для StyledTextModel.replace(StyleResolver, TextPos, TextPos, String, boolean).
Параметры:
p - позиция вставки
text - текст для вставки
Исключения:
NullPointerException - если модель null
UnsupportedOperationException - если модель не writable

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

isWritable

public final boolean isWritable()
Определяет, является ли модель доступной для записи.

Этот метод вызывает BasicTextModel.Content.isWritable().

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

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 - код, который будет использоваться для создания экземпляра узла

getStyleAttributeMap

public StyleAttributeMap getStyleAttributeMap(StyleResolver resolver, TextPos pos)
Описание, скопированное из класса: StyledTextModel
Возвращает StyleAttributeMap символа в указанной позиции. При достижении конца документа возвращает атрибуты последнего символа.
Определено в:
getStyleAttributeMap в классе StyledTextModel
Параметры:
resolver - решатель стиля
pos - позиция текста
Возвращает:
атрибуты стиля, не null

setParagraphStyle

protected final void setParagraphStyle(int index, StyleAttributeMap a)
Описание, скопированное из класса: StyledTextModel
Заменяет стили абзаца в указанном абзаце.
Определено в:
setParagraphStyle в классе StyledTextModel
Параметры:
index - индекс абзаца
a - атрибуты абзаца

applyStyle

protected final void applyStyle(int index, int start, int end, StyleAttributeMap a, boolean merge)
Описание, скопированное из класса: StyledTextModel
Применяет стиль к указанному диапазону текста в рамках одного абзаца. Новые атрибуты перекрывают любые существующие. Аргумент end может превышать длину абзаца, в этом случае результат должен быть таким же, как при указании значения длины абзаца.
Определено в:
applyStyle в классе StyledTextModel
Параметры:
index - индекс абзаца
start - начальное смещение
end - конечное смещение
a - атрибуты символа
merge - определяет, объединять или перезаписывать существующие атрибуты

Сообщить об ошибке или предложить улучшение
Авторские права © 2008, 2025, Oracle и/или его аффилированные лица. Все права защищены.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API