javax.swing.text

Класс AbstractDocument

java.lang. Объект

javax.swing.text. AbstractDocument

Все Реализованные Интерфейсы:

Сериализуемый, Документ

Прямые Известные Подклассы:

DefaultStyledDocument, PlainDocument

public abstract class AbstractDocument
extends Object
implements Document, Serializable

Реализация документа взаимодействует через интерфейс, чтобы служить основанием для того, чтобы реализовать различные виды документов. На этом уровне есть очень немного политики, таким образом есть соответствующее увеличение трудности использования.

Этот класс реализует механизм блокировки для документа. Это позволяет многократным читателям или одному писателю, и писатели должны ожидать, пока все наблюдатели документа не были уведомлены относительно предыдущего изменения прежде, чем начать другую мутацию к документу. Блокировка чтения получается и выпускала использование render метод. Блокировка записи является aquired методами, которые видоизменяют документ, и сохранены для продолжительности вызова метода. Уведомление делается на потоке, который произвел мутацию, и у потока есть полный доступ для чтения к документу для продолжительности уведомления, но другие читатели не впускаются, пока уведомление не закончилось. Уведомление является бобовым уведомлением о событии, которое не позволяет дальнейшие мутации, пока все слушатели не были уведомлены.

Любые модели, разделенные на подклассы от этого класса и используемый в соединении с текстовым компонентом, который взглянул и реализация чувства, которая получается из BasicTextUI, могут быть безопасно обновлены асинхронно, потому что весь доступ к иерархии Представления сериализируется BasicTextUI, если документ имеет тип AbstractDocument. Блокировка предполагает, что независимый поток получит доступ к иерархии Представления только от методов DocumentListener, и что будет только один поток события, активный за один раз.

Если поддержка параллелизма требуется, есть следующие дополнительные импликации. Путь выполнения кода для любой реализации DocumentListener и любой реализации UndoListener должен быть ориентирован на многопотоковое исполнение, и не получить доступ к компонентной блокировке, пытаясь быть безопасным от мертвых блокировок. repaint и revalidate методы на JComponent безопасны.

AbstractDocument моделирует подразумеваемое повреждение в конце документа. Между прочим это позволяет Вам располагать каре после последнего знака. В результате этого, getLength возвраты меньше чем длина Контента. Если Вы создаете свой собственный Контент, убеждаетесь и инициализируете его, чтобы иметь дополнительный символ. Обратитесь к StringContent и GapContent для примеров этого. Другая импликация этого - то, что у Элементов, которые моделируют подразумеваемый конечный символ, будет endOffset == (getLength () + 1). Например, в DefaultStyledDocument getParagraphElement(getLength()).getEndOffset() == getLength() + 1 .

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

Вложенная Сводка Класса

Вложенные Классы

Модификатор и Тип	Класс и Описание
class	AbstractDocument. AbstractElement Реализует абстрактную часть элемента.
static interface	AbstractDocument. AttributeContext Интерфейс, который может использоваться, чтобы позволить реализациям MutableAttributeSet использовать сменные методы сжатия атрибута.
class	AbstractDocument. BranchElement Реализует составной элемент, который содержит другие элементы.
static interface	AbstractDocument. Контент Интерфейс, чтобы описать последовательность символьного контента, который может быть отредактирован.
class	AbstractDocument. DefaultDocumentEvent Изменения документа хранилищ как документ изменяются.
static class	AbstractDocument. ElementEdit Реализация ElementChange, который может быть добавлен к событию документа.
class	AbstractDocument. LeafElement Реализует элемент, который непосредственно представляет контент некоторого вида.

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
protected static String	BAD_LOCATION Сообщение об ошибке, чтобы указать на плохое расположение.
static String	BidiElementName Имя элементов, используемых, чтобы содержать однонаправленное выполнение
static String	ContentElementName Имя элементов, используемых, чтобы представить контент
static String	ElementNameAttribute Имя атрибута, используемого, чтобы определить имена элементов.
protected EventListenerList	listenerList Слушатель события перечисляет для документа.
static String	ParagraphElementName Имя элементов, используемых, чтобы представить абзацы
static String	SectionElementName Имя элементов, используемых, чтобы содержать разделы (строки/абзацы).

Поля, наследованные от интерфейса javax.swing.text. Документ

StreamDescriptionProperty, TitleProperty

Сводка конструктора

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

Модификатор	Конструктор и Описание
protected	AbstractDocument(AbstractDocument.Content data) Создает новое AbstractDocument, перенесенный некоторый указанный механизм хранения контента.
protected	AbstractDocument(AbstractDocument.Content data, AbstractDocument.AttributeContext context) Создает новое AbstractDocument, перенесенный некоторый указанный механизм хранения контента.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
void	addDocumentListener(DocumentListener listener) Добавляет слушатель документа для уведомления о любых изменениях.
void	addUndoableEditListener(UndoableEditListener listener) Добавляет слушатель отмены для уведомления о любых изменениях.
protected Element	createBranchElement(Element parent, AttributeSet a) Создает элемент ответвления документа, который может содержать другие элементы.
protected Element	createLeafElement(Element parent, AttributeSet a, int p0, int p1) Создает листовой элемент документа.
Позиция	createPosition(int offs) Возвращает позицию, которая отследит изменение, поскольку документ изменяется.
void	dump(PrintStream out) Дает диагностический дамп.
protected void	fireChangedUpdate(DocumentEvent e) Уведомляет всех слушателей, которые зарегистрировали интерес для уведомления на этом типе события.
protected void	fireInsertUpdate(DocumentEvent e) Уведомляет всех слушателей, которые зарегистрировали интерес для уведомления на этом типе события.
protected void	fireRemoveUpdate(DocumentEvent e) Уведомляет всех слушателей, которые зарегистрировали интерес для уведомления на этом типе события.
protected void	fireUndoableEditUpdate(UndoableEditEvent e) Уведомляет всех слушателей, которые зарегистрировали интерес для уведомления на этом типе события.
int	getAsynchronousLoadPriority() Получает асинхронный приоритет загрузки.
protected AbstractDocument.AttributeContext	getAttributeContext() Выбирает контекст для того, чтобы управлять атрибутами.
Элемент	getBidiRootElement() Возвращает корневой элемент двунаправленной структуры для этого документа.
protected AbstractDocument.Content	getContent() Получает контент для документа.
protected Thread	getCurrentWriter() Выбирает текущий поток записи, если есть тот.
abstract Element	getDefaultRootElement() Возвращает корневой элемент, который представления должны быть основаны на том, если некоторый другой механизм для того, чтобы присвоить представления структурам элемента не обеспечивается.
DocumentFilter	getDocumentFilter() Возвраты DocumentFilter это ответственно за фильтрацию вставки/удаления.
DocumentListener[]	getDocumentListeners() Возвращает массив всех слушателей документа, зарегистрированных на этом документе.
Dictionary<Object,Object>	getDocumentProperties() Поддерживает управляющий ряд свойств.
Позиция	getEndPosition() Возвращает позицию, которая представляет конец документа.
int	getLength() Возвращает длину данных.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Возвращает массив всех объектов, в настоящий момент зарегистрированных как FooListeners согласно этому документу.
abstract Element	getParagraphElement(int pos) Получите элемент абзаца, содержащий данную позицию.
Объект	getProperty(Object key) Метод удобства для того, чтобы искать значение свойства.
Элемент[]	getRootElements() Получает все корневые определенные элементы.
Позиция	getStartPosition() Возвращает позицию, которая представляет запуск документа.
Строка	getText(int offset, int length) Получает последовательность текста из документа.
void	getText(int offset, int length, Segment txt) Выбирает текст, содержавший в пределах данной части документа.
UndoableEditListener[]	getUndoableEditListeners() Возвращает массив всех невыполнимых слушателей редактирования, зарегистрированных на этом документе.
void	insertString(int offs, String str, AttributeSet a) Вставляет некоторый контент в документ.
protected void	insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr) Структура документа обновлений в результате вставки текста.
protected void	postRemoveUpdate(AbstractDocument.DefaultDocumentEvent chng) Обновления любая структура документа в результате текстового удаления.
void	putProperty(Object key, Object value) Метод удобства для того, чтобы запасти значение свойства.
void	readLock() Получает блокировку, чтобы начать читать некоторое состояние из документа.
void	readUnlock() Делает чтение, разблокировали.
void	remove(int offs, int len) Удаляет некоторый контент из документа.
void	removeDocumentListener(DocumentListener listener) Удаляет слушателя документа.
void	removeUndoableEditListener(UndoableEditListener listener) Удаляет слушателя отмены.
protected void	removeUpdate(AbstractDocument.DefaultDocumentEvent chng) Обновления любая структура документа в результате текстового удаления.
void	render(Runnable r) Это позволяет модели быть безопасно представленной в присутствии валюты, если модель поддерживает быть обновленным асинхронно.
void	replace(int offset, int length, String text, AttributeSet attrs) Удаляет область текста от offset к offset + length, и замены это с text.
void	setAsynchronousLoadPriority(int p) Устанавливает асинхронный приоритет загрузки.
void	setDocumentFilter(DocumentFilter filter) Наборы DocumentFilter.
void	setDocumentProperties(Dictionary<Object,Object> x) Заменяет словарь свойств документа для этого документа.
protected void	writeLock() Получает блокировку, чтобы начать видоизменять документ, который защищает эта блокировка.
protected void	writeUnlock() Выпускает блокировку записи, ранее полученную через writeLock.

Методы java.lang унаследованный от класса. Объект

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

Полевая Деталь

listenerList

protected EventListenerList listenerList

Слушатель события перечисляет для документа.

BAD_LOCATION

protected static final String BAD_LOCATION

Сообщение об ошибке, чтобы указать на плохое расположение.

См. Также:

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

ParagraphElementName

public static final String ParagraphElementName

Имя элементов, используемых, чтобы представить абзацы

См. Также:

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

ContentElementName

public static final String ContentElementName

Имя элементов, используемых, чтобы представить контент

См. Также:

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

SectionElementName

public static final String SectionElementName

Имя элементов, используемых, чтобы содержать разделы (строки/абзацы).

См. Также:

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

BidiElementName

public static final String BidiElementName

Имя элементов, используемых, чтобы содержать однонаправленное выполнение

См. Также:

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

ElementNameAttribute

public static final String ElementNameAttribute

Имя атрибута, используемого, чтобы определить имена элементов.

См. Также:

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

Деталь конструктора

AbstractDocument

protected AbstractDocument(AbstractDocument.Content data)

Создает новое AbstractDocument, перенесенный некоторый указанный механизм хранения контента.

Параметры:

data - контент

AbstractDocument

protected AbstractDocument(AbstractDocument.Content data,
                AbstractDocument.AttributeContext context)

Создает новое AbstractDocument, перенесенный некоторый указанный механизм хранения контента.

Параметры:

data - контент

context - контекст атрибута

Деталь метода

getDocumentProperties

public Dictionary<Object,Object> getDocumentProperties()

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

Возвраты:

не -null Dictionary

См. Также:

setDocumentProperties(java.util.Dictionary<java.lang.Object, java.lang.Object>)

setDocumentProperties

public void setDocumentProperties(Dictionary<Object,Object> x)

Заменяет словарь свойств документа для этого документа.

Параметры:

x - новый словарь

См. Также:

getDocumentProperties()

fireInsertUpdate

protected void fireInsertUpdate(DocumentEvent e)

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

Параметры:

e - событие

См. Также:

EventListenerList

fireChangedUpdate

protected void fireChangedUpdate(DocumentEvent e)

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

Параметры:

e - событие

См. Также:

EventListenerList

fireRemoveUpdate

protected void fireRemoveUpdate(DocumentEvent e)

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

Параметры:

e - событие

См. Также:

EventListenerList

fireUndoableEditUpdate

protected void fireUndoableEditUpdate(UndoableEditEvent e)

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

Параметры:

e - событие

См. Также:

EventListenerList

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

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

Можно определить listenerType параметр с литералом класса, такой как FooListener.class. Например, можно запросить документ d для его слушателей документа со следующим кодом:

DocumentListener[] mls = (DocumentListener[])(d.getListeners(DocumentListener.class));

Если никакие такие слушатели не существуют, этот метод возвращает пустой массив.

Параметры:

listenerType - тип слушателей требуют; этот параметр должен определить интерфейс, который убывает от java.util.EventListener

Возвраты:

массив всех объектов, зарегистрированных как FooListeners на этом компоненте, или пустом массиве, если никакие такие слушатели не были добавлены

Броски:

ClassCastException - если listenerType не определяет класс или интерфейс, который реализует java.util.EventListener

С тех пор:

1.3

См. Также:

getDocumentListeners(), getUndoableEditListeners()

getAsynchronousLoadPriority

public int getAsynchronousLoadPriority()

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

Возвраты:

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

setAsynchronousLoadPriority

public void setAsynchronousLoadPriority(int p)

Устанавливает асинхронный приоритет загрузки.

Параметры:

p - новый асинхронный приоритет загрузки; меньше значения чем нуль указывают, что документ не должен быть загружен асинхронно

setDocumentFilter

public void setDocumentFilter(DocumentFilter filter)

Наборы DocumentFilter. DocumentFilter передается insert и remove условно позволить вставлять/удалять текста. A null значение указывает, что никакая фильтрация не произойдет.

Параметры:

filter - DocumentFilter используемый, чтобы ограничить текст

С тех пор:

1.4

См. Также:

getDocumentFilter()

getDocumentFilter

public DocumentFilter getDocumentFilter()

Возвраты DocumentFilter это ответственно за фильтрацию вставки/удаления. A null возвращаемое значение подразумевает, что никакая фильтрация не должна произойти.

Возвраты:

DocumentFilter

С тех пор:

1.4

См. Также:

setDocumentFilter(javax.swing.text.DocumentFilter)

рендеринг

public void render(Runnable r)

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

Это реализуется к aquire блокировка чтения для продолжительности runnables выполнения. Может быть многократный runnables, выполняющийся одновременно, и все писатели будут блокированы, в то время как есть активный рендеринг runnables. Если выполнимые броски исключение, его блокировка будет безопасно выпущена. Нет никакой защиты от выполнимого, которое никогда не выходит, который эффективно оставит документ заблокированным, поскольку это - время жизни.

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

Этот метод ориентирован на многопотоковое исполнение, хотя большинство методов Swing не. Пожалуйста, см., Как Использовать Потоки для получения дополнительной информации.

Определенный:

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

Параметры:

r - средство рендеринга, чтобы выполниться

getLength

public int getLength()

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

Определенный:

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

Возвраты:

длина> = 0

См. Также:

Document.getLength()

addDocumentListener

public void addDocumentListener(DocumentListener listener)

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

Определенный:

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

Параметры:

listener - DocumentListener добавить

См. Также:

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

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

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

Определенный:

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

Параметры:

listener - DocumentListener удалить

См. Также:

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

getDocumentListeners

public DocumentListener[] getDocumentListeners()

Возвращает массив всех слушателей документа, зарегистрированных на этом документе.

Возвраты:

весь этот документ DocumentListeners или пустой массив, если никакие слушатели документа в настоящий момент не регистрируются

С тех пор:

1.4

См. Также:

addDocumentListener(javax.swing.event.DocumentListener), removeDocumentListener(javax.swing.event.DocumentListener)

addUndoableEditListener

public void addUndoableEditListener(UndoableEditListener listener)

Добавляет слушатель отмены для уведомления о любых изменениях. Операции отмены/Восстановления, выполняемые на UndoableEdit заставит соответствующий DocumentEvent быть уволенным, чтобы сохранить представление (я) в синхронизации с моделью.

Определенный:

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

Параметры:

listener - UndoableEditListener добавить

См. Также:

Document.addUndoableEditListener(javax.swing.event.UndoableEditListener)

removeUndoableEditListener

public void removeUndoableEditListener(UndoableEditListener listener)

Удаляет слушателя отмены.

Определенный:

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

Параметры:

listener - UndoableEditListener удалить

См. Также:

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

getUndoableEditListeners

public UndoableEditListener[] getUndoableEditListeners()

Возвращает массив всех невыполнимых слушателей редактирования, зарегистрированных на этом документе.

Возвраты:

весь этот документ UndoableEditListeners или пустой массив, если никакие невыполнимые слушатели редактирования в настоящий момент не регистрируются

С тех пор:

1.4

См. Также:

addUndoableEditListener(javax.swing.event.UndoableEditListener), removeUndoableEditListener(javax.swing.event.UndoableEditListener)

getProperty

public final Object getProperty(Object key)

Метод удобства для того, чтобы искать значение свойства. Это эквивалентно:

 getDocumentProperties().get(key);
 

Определенный:

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

Параметры:

key - не -null ключ свойства

Возвраты:

значение этого свойства или null

См. Также:

getDocumentProperties()

putProperty

public final void putProperty(Object key,
               Object value)

Метод удобства для того, чтобы запасти значение свойства. Это эквивалентно:

 getDocumentProperties().put(key, value);
 

Если value null этот метод удалит свойство.

Определенный:

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

Параметры:

key - не -null ключ

value - значение свойства

См. Также:

getDocumentProperties()

удалить

public void remove(int offs,
          int len)
            throws BadLocationException

Удаляет некоторый контент из документа. Удаление контента заставляет блокировку записи быть сохраненной, в то время как фактические изменения имеют место. Наблюдатели уведомляются относительно изменения на потоке который названный этим методом.

Этот метод ориентирован на многопотоковое исполнение, хотя большинство методов Swing не. Пожалуйста, см., Как Использовать Потоки для получения дополнительной информации.

Определенный:

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

Параметры:

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

len - число символов, чтобы удалить> = 0

Броски:

BadLocationException - данные удаляют позицию, не допустимая позиция в пределах документа

См. Также:

Document.remove(int, int)

замена

public void replace(int offset,
           int length,
           String text,
           AttributeSet attrs)
             throws BadLocationException

Удаляет область текста от offset к offset + length, и замены это с text. Это до реализации относительно того, как это реализуется, некоторые реализации могут обработать это как две отличных операции: удаление сопровождаемого вставкой, другие могут обработать замену как одну атомарную работу.

Параметры:

offset - индекс дочернего элемента

length - длина текста, чтобы удалить, могут быть 0 указаний, ничего не удаляют

text - текст, чтобы вставить, null не указывает ни на какой текст, чтобы вставить

attrs - AttributeSet, указывающий на атрибуты вставленного текста, null является законным, и обычно обработанный как пустой attributeset, но точную интерпретацию оставляют подклассу

Броски:

BadLocationException - данная позиция не является допустимой позицией в пределах документа

С тех пор:

1.4

insertString

public void insertString(int offs,
                String str,
                AttributeSet a)
                  throws BadLocationException

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

Этот метод ориентирован на многопотоковое исполнение, хотя большинство методов Swing не. Пожалуйста, см., Как Использовать Потоки для получения дополнительной информации.

Определенный:

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

Параметры:

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

str - строка, чтобы вставить; ничего не делает с нулевыми/пустыми строками

a - атрибуты для вставленного контента

Броски:

BadLocationException - данная позиция вставки не является допустимой позицией в пределах документа

См. Также:

Document.insertString(int, java.lang.String, javax.swing.text.AttributeSet)

getText

public String getText(int offset,
             int length)
               throws BadLocationException

Получает последовательность текста из документа.

Определенный:

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

Параметры:

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

length - число символов, чтобы получить> = 0

Возвраты:

текст

Броски:

BadLocationException - данный диапазон включает позицию, которая не является допустимой позицией в пределах документа

См. Также:

Document.getText(int, int)

getText

public void getText(int offset,
           int length,
           Segment txt)
             throws BadLocationException

Выбирает текст, содержавший в пределах данной части документа.

Если partialReturn свойство на txt параметре будет ложью, то данные, возвращенные в Сегменте, будут всей длиной, которую требуют, и можете, или, возможно, не копия в зависимости от того, как данные хранились. Если partialReturn свойство является истиной, только количество текста, который может быть возвращен, не создавая копию, возвращается. Используя частичные возвраты даст лучшую производительность для ситуаций, где значительные части документа сканируются. Следующее является примером использования частичного возврата, чтобы получить доступ ко всему документу:

  int nleft = doc.getDocumentLength();
  Segment text = new Segment();
  int offs = 0;
  text.setPartialReturn(true);
  while (nleft > 0) {
  doc.getText(offs, nleft, text);
  // do something with text
  nleft -= text.count;
  offs += text.count;
  }
 

Определенный:

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

Параметры:

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

length - число символов, чтобы получить> = 0

txt - объект Сегмента получить текст в

Броски:

BadLocationException - данный диапазон включает позицию, которая не является допустимой позицией в пределах документа

createPosition

public Position createPosition(int offs)
                        throws BadLocationException

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

Этот метод ориентирован на многопотоковое исполнение, хотя большинство методов Swing не. Пожалуйста, см., Как Использовать Потоки для получения дополнительной информации.

Определенный:

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

Параметры:

offs - позиция в модели> = 0

Возвраты:

позиция

Броски:

BadLocationException - если данная позиция не представляет допустимое расположение в ассоциированном документе

См. Также:

Document.createPosition(int)

getStartPosition

public final Position getStartPosition()

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

Определенный:

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

Возвраты:

позиция

getEndPosition

public final Position getEndPosition()

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

Определенный:

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

Возвраты:

позиция

getRootElements

public Element[] getRootElements()

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

Определенный:

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

Возвраты:

корневой элемент

getDefaultRootElement

public abstract Element getDefaultRootElement()

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

Определенный:

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

Возвраты:

корневой элемент

См. Также:

Document.getDefaultRootElement()

getBidiRootElement

public Element getBidiRootElement()

Возвращает корневой элемент двунаправленной структуры для этого документа. Его дочерние элементы представляют символьные выполнения с данным Unicode bidi уровень.

getParagraphElement

public abstract Element getParagraphElement(int pos)

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

Параметры:

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

Возвраты:

элемент

getAttributeContext

protected final AbstractDocument.AttributeContext getAttributeContext()

Выбирает контекст для того, чтобы управлять атрибутами. Этот метод эффективно устанавливает стратегию, используемую для того, чтобы сжать информацию о AttributeSet.

Возвраты:

контекст

insertUpdate

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

Структура документа обновлений в результате вставки текста. Это произойдет в пределах блокировки записи. Если подкласс этого класса повторно реализует этот метод, это должно делегировать к суперклассу также.

Параметры:

chng - описание изменения

attr - атрибуты для изменения

removeUpdate

protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)

Обновления любая структура документа в результате текстового удаления. Этот метод вызывают прежде, чем текст фактически удаляется из Контента. Это произойдет в пределах блокировки записи. Если подкласс этого класса повторно реализует этот метод, это должно делегировать к суперклассу также.

Параметры:

chng - описание изменения

postRemoveUpdate

protected void postRemoveUpdate(AbstractDocument.DefaultDocumentEvent chng)

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

Параметры:

chng - описание изменения

дамп

public void dump(PrintStream out)

Дает диагностический дамп.

Параметры:

out - поток вывода

getContent

protected final AbstractDocument.Content getContent()

Получает контент для документа.

Возвраты:

контент

createLeafElement

protected Element createLeafElement(Element parent,
                        AttributeSet a,
                        int p0,
                        int p1)

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

Параметры:

parent - родительский элемент

a - атрибуты для элемента

p0 - начало диапазона> = 0

p1 - конец диапазона> = p0

Возвраты:

новый элемент

createBranchElement

protected Element createBranchElement(Element parent,
                          AttributeSet a)

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

Параметры:

parent - родительский элемент

a - атрибуты

Возвраты:

элемент

getCurrentWriter

protected final Thread getCurrentWriter()

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

Возвраты:

поток, активно изменяющий документ или null если нет никаких происходящих модификаций

writeLock

protected final void writeLock()

Получает блокировку, чтобы начать видоизменять документ, который защищает эта блокировка. Не может быть никакой записи, уведомления об изменениях, или чтения продолжения, чтобы получить блокировку. Дополнительно потоку позволяют получить больше чем один writeLock, пока это не пытается получить дополнительный writeLocks изнутри уведомления о документе. Попытка получить a writeLock изнутри DocumentListener уведомление приведет к IllegalStateException. Возможность получить больше чем один writeLock на поток позволяет подклассам получать writeLock, выполнять много операций, затем выпускать блокировку.

Звонки writeLock должен быть сбалансирован со звонков writeUnlock, еще Document будет оставлен в заблокированном состоянии так, чтобы никакое чтение или запись не могли быть сделаны.

Броски:

IllegalStateException - брошенный в недопустимую попытку блокировки. Если документ реализуется должным образом, это может только произойти, если слушатель документа пытается видоизменить документ. Эта ситуация нарушает бобовую модель событий, где порядок поставки не гарантируется, и все слушатели должны быть уведомлены прежде, чем дальнейшие мутации позволяются.

writeUnlock

protected final void writeUnlock()

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

См. Также:

writeLock()

readLock

public final void readLock()

Получает блокировку, чтобы начать читать некоторое состояние из документа. Одновременно могут быть многократные читатели. Запись блокирует читателей, пока уведомление об изменении слушателям не было завершено. Этот метод должен использоваться очень тщательно, чтобы избежать непреднамеренного компромисса документа. Это должно всегда балансироваться с a readUnlock.

См. Также:

readUnlock()

readUnlock

public final void readUnlock()

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

  readLock();
  try {
  // do something
  } finally {
  readUnlock();
  }
 

См. Также:

readLock()