Класс DefaultStyledDocument

public class DefaultStyledDocument
extends AbstractDocument
implements StyledDocument

Документ, который может быть помечен стилями символов и абзацев подобно формату Rich Text Format. Структура элементов этого документа представляет собой пересечения стилей для блоков стилей. Эти блоки стилей отображаются в структуру абзацев (которая может находиться в другой структуре). Блоки стилей разрываются на границах абзацев, так как логические стили назначаются границам абзацев.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, добавлена поддержка долгосрочного хранения всех JavaBeans™ в пакете java.beans. См. XMLEncoder.

Поля

BUFFER_SIZE_DEFAULT

public static final int BUFFER_SIZE_DEFAULT

Размер буфера начального содержимого по умолчанию.

См. также:

Значения константных полей

buffer

protected DefaultStyledDocument.ElementBuffer buffer

Конструкторы

DefaultStyledDocument

public DefaultStyledDocument(AbstractDocument.Content c,
                             StyleContext styles)

Создаёт стилизованный документ.

Параметры:

c - контейнер для содержимого

styles - ресурсы и определения стилей, которые могут быть совместно использованы между документами

DefaultStyledDocument

public DefaultStyledDocument(StyleContext styles)

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

Параметры:

styles - стили

DefaultStyledDocument

public DefaultStyledDocument()

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

Методы

getDefaultRootElement

public Element getDefaultRootElement()

Получает элемент корня по умолчанию.

Определено в:

getDefaultRootElement в интерфейсе Document

Определено в:

getDefaultRootElement в классе AbstractDocument

Возвращает:

корень

См. также:

Document.getDefaultRootElement()

create

protected void create(DefaultStyledDocument.ElementSpec[] data)

Инициализирует документ, отражающий заданную структуру элементов (т.е. структуру, полученную методом getDefaultRootElement). Если документ содержал какие-либо данные, они будут сначала удалены.

insert

protected void insert(int offset,
                      DefaultStyledDocument.ElementSpec[] data)
               throws BadLocationException

Параметры:

offset - начальное смещение >= 0

data - данные элементов

Исключение:

BadLocationException - для недопустимого начального смещения

removeElement

public void removeElement(Element elem)

Параметры:

elem - элемент для удаления

Исключение:

NullPointerException - если элемент является null

IllegalArgumentException - если элемент не смог быть удалён

IllegalStateException - если структура элементов недействительна

С:

1.7

addStyle

public Style addStyle(String nm,
                      Style parent)

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

Определено в:

addStyle в интерфейсе StyledDocument

Параметры:

nm - имя стиля (должно быть уникальным в наборе именованных стилей). Имя может быть null, если стиль неименованный, но вызывающий код отвечает за управление ссылкой, так как неименованный стиль не может быть получен по имени. Неименованный стиль может быть полезен для переопределения атрибутов символов, таких как те, что встречаются в стиле пробега.

parent - родительский стиль. Может быть null, если атрибуты, не определённые явно, не должны быть разрешены в другом стиле.

Возвращает:

стиль

removeStyle

public void removeStyle(String nm)

Удаляет именованный стиль, ранее добавленный в документ.

Определено в:

removeStyle в интерфейсе StyledDocument

Параметры:

nm - имя стиля для удаления

getStyle

public Style getStyle(String nm)

Получает именованный стиль, ранее добавленный.

Определено в:

getStyle в интерфейсе StyledDocument

Параметры:

nm - имя стиля

Возвращает:

стиль

getStyleNames

public Enumeration<?> getStyleNames()

Получает список имён стилей.

Возвращает:

все имена стилей

setLogicalStyle

public void setLogicalStyle(int pos,
                            Style s)

Определено в:

setLogicalStyle в интерфейсе StyledDocument

Параметры:

pos - смещение от начала документа >= 0

s - логический стиль для назначения абзацу, null если нет

getLogicalStyle

public Style getLogicalStyle(int p)

Получает логический стиль, назначенный абзацу, представленному заданной позицией.

Определено в:

getLogicalStyle в интерфейсе StyledDocument

Параметры:

p - положение для перевода в абзац и определения назначенного логического стиля >= 0. Это смещение от начала документа.

Возвращает:

стиль, null если нет

setCharacterAttributes

public void setCharacterAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)

Определено в:

setCharacterAttributes в интерфейсе StyledDocument

Параметры:

offset - смещение в документе >= 0

length - длина >= 0

s - атрибуты

replace - true, если предыдущие атрибуты должны быть заменены перед установкой новых атрибутов

setParagraphAttributes

public void setParagraphAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)

Определено в:

setParagraphAttributes в интерфейсе StyledDocument

Параметры:

offset - смещение в абзаце >= 0

length - количество затронутых символов >= 0

s - атрибуты

replace - следует ли заменить существующие атрибуты или объединить их

getParagraphElement

public Element getParagraphElement(int pos)

Получает элемент абзаца по смещению pos. Абзац состоит как минимум из одного дочернего элемента, который обычно является листовым.

Определено в:

getParagraphElement в интерфейсе StyledDocument

Определено в:

getParagraphElement в классе AbstractDocument

Параметры:

pos - начальное смещение >= 0

Возвращает:

элемент

getCharacterElement

public Element getCharacterElement(int pos)

Получает элемент символа на основе положения.

Определено в:

getCharacterElement в интерфейсе StyledDocument

Параметры:

pos - положение в документе >= 0

Возвращает:

элемент

insertUpdate

protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
                            AttributeSet attr)

Обновляет структуру документа в результате вставки текста. Это происходит в рамках блокировки записи. Эта реализация просто анализирует вставленное содержимое на наличие переносов строк и создаёт набор инструкций для буфера элементов.

Переопределяет:

insertUpdate в классе AbstractDocument

Параметры:

chng - описание изменения документа

attr - атрибуты

ИзменениеУдаления

protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)

Обновляет структуру документа в результате удаления текста.

Переопределяет:

removeUpdate в классе AbstractDocument

Параметры:

chng - описание изменения документа

СоздатьКорневойЭлемент

protected AbstractDocument.AbstractElement createDefaultRoot()

Создаёт корневой элемент, используемый для представления стандартной структуры документа.

Возвращает:

базовый элемент

ПолучитьЦветПереднегоПлана

public Color getForeground(AttributeSet attr)

Получает цвет переднего плана из набора атрибутов.

Определено в:

getForeground в интерфейсе StyledDocument

Параметры:

attr - набор атрибутов

Возвращает:

цвет

ПолучитьЦветФоновогоПлана

public Color getBackground(AttributeSet attr)

Получает цвет фона из набора атрибутов.

Определено в:

getBackground в интерфейсе StyledDocument

Параметры:

attr - набор атрибутов

Возвращает:

цвет

ПолучитьШрифт

public Font getFont(AttributeSet attr)

Получает шрифт из набора атрибутов.

Определено в:

getFont в интерфейсе StyledDocument

Параметры:

attr - набор атрибутов

Возвращает:

шрифт

ИзмененСтиль

protected void styleChanged(Style style)

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

Параметры:

style - Стиль, который был изменён.

ДобавитьСлушателяИзмененийДокумента

public void addDocumentListener(DocumentListener listener)

Добавляет слушателя изменений документа для получения уведомлений о любых изменениях.

Определено в:

addDocumentListener в интерфейсе Document

Переопределяет:

addDocumentListener в классе AbstractDocument

Параметры:

listener - слушатель

См. также:

Document.addDocumentListener(javax.swing.event.DocumentListener)

УдалитьСлушателяИзмененийДокумента

public void removeDocumentListener(DocumentListener listener)

Удаляет слушателя изменений документа.

Определено в:

removeDocumentListener в интерфейсе Document

Переопределяет:

removeDocumentListener в классе AbstractDocument

Параметры:

listener - слушатель

См. также:

Document.removeDocumentListener(javax.swing.event.DocumentListener)