Класс AbstractWriter

java.lang.Object

javax.swing.text.AbstractWriter

Прямые известные подклассы:: HTMLWriter, MinimalHTMLWriter

public abstract class AbstractWriter extends Object

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

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

Модификатор и тип	Поле	Описание
`protected static final char`	`NEWLINE`	Как текстовые пакеты моделируют новые строки.

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

AbstractWriter(Writer w,
 Document doc)

AbstractWriter(Writer w,
 Document doc,
 int pos,
 int len)

AbstractWriter(Writer w,
 Element root)

AbstractWriter(Writer w,
 Element root,
 int pos,
 int len)

Модификатор	Конструктор	Описание
`protected`	Создаёт новый AbstractWriter.
`protected`	Создаёт новый AbstractWriter.
`protected`	Создаёт новый AbstractWriter.
`protected`	Создаёт новый AbstractWriter.

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

Модификатор и тип	Метод	Описание
`protected void`	`decrIndent()`	Уменьшает уровень отступа.
`protected boolean`	`getCanWrapLines()`	Возвращает значение, указывающее, могут ли строки переноситься на следующую строку.
`protected int`	`getCurrentLineLength()`	Возвращает текущую длину строки.
`protected Document`	`getDocument()`	Возвращает документ.
`protected ElementIterator`	`getElementIterator()`	Возвращает итератор элементов.
`int`	`getEndOffset()`	Возвращает последний смещение для вывода.
`protected int`	`getIndentLevel()`	Возвращает текущий уровень отступа.
`protected int`	`getIndentSpace()`	Возвращает количество пробелов для отступа.
`protected int`	`getLineLength()`	Возвращает максимальную длину строки.
`String`	`getLineSeparator()`	Возвращает строку, используемую для представления новых строк.
`int`	`getStartOffset()`	Возвращает первое смещение для вывода.
`protected String`	`getText(Element elem)`	Возвращает текст, связанный с элементом.
`protected Writer`	`getWriter()`	Возвращает Writer, используемый для вывода содержимого.
`protected void`	`incrIndent()`	Увеличивает уровень отступа.
`protected void`	`indent()`	Выполняет отступ.
`protected boolean`	`inRange(Element next)`	Этот метод определяет, находится ли текущий элемент в указанном диапазоне.
`protected boolean`	`isLineEmpty()`	Возвращает true, если текущая строка должна считаться пустой.
`protected void`	`output(char[] content, int start, int length)`	Последняя остановка при выводе содержимого.
`protected void`	`setCanWrapLines(boolean newValue)`	Устанавливает возможность переноса строк.
`protected void`	`setCurrentLineLength(int length)`	Устанавливает текущую длину строки.
`protected void`	`setIndentSpace(int space)`	Позволяет подклассам указать, сколько пробелов соответствует одному отступу.
`protected void`	`setLineLength(int l)`	Позволяет подклассам задать количество символов, которые должны быть выведены в одной строке.
`void`	`setLineSeparator(String value)`	Устанавливает строку, используемую для представления новых строк.
`protected void`	`text(Element elem)`	Выводит текст.
`protected abstract void`	`write()`	Этот абстрактный метод должен быть реализован подклассами.
`protected void`	`write(char ch)`	Выводит символ.
`protected void`	`write(char[] chars, int startIndex, int length)`	Все методы записи обращаются к этому методу.
`protected void`	`write(String content)`	Выводит строку.
`protected void`	`writeAttributes(AttributeSet attr)`	Выводит набор атрибутов в виде пар "имя=значение".
`protected void`	`writeLineSeparator()`	Выводит разделитель строк.

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

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

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

NEWLINE

protected static final char NEWLINE

Как текстовые пакеты моделируют новые строки.

См. также:

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

AbstractWriter

protected AbstractWriter(Writer w, Document doc)

Создаёт новый AbstractWriter. Инициализирует ElementIterator с корнем документа по умолчанию.

Параметры:: w - объект Writer.; doc - объект Document

AbstractWriter

protected AbstractWriter(Writer w, Document doc, int pos, int len)

Создаёт новый AbstractWriter. Инициализирует ElementIterator с переданным элементом.

Параметры:: w - объект Writer; doc - элемент; pos - позиция в документе для извлечения содержимого.; len - объём для вывода.

AbstractWriter

protected AbstractWriter(Writer w, Element root)

Создаёт новый AbstractWriter. Инициализирует ElementIterator с переданным элементом.

Параметры:: w - объект Writer; root - элемент

AbstractWriter

protected AbstractWriter(Writer w, Element root, int pos, int len)

Создаёт новый AbstractWriter. Инициализирует ElementIterator с переданным элементом.

Параметры:: w - объект Writer; root - элемент; pos - позиция в документе для извлечения содержимого.; len - объём для вывода.

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

getStartOffset

public int getStartOffset()

Возвращает начальную позицию для вывода.

Возвращает:: начальную позицию для вывода
С момента:: 1.3

getEndOffset

public int getEndOffset()

Возвращает конечную позицию для вывода.

Возвращает:: конечную позицию для вывода
С момента:: 1.3

getElementIterator

protected ElementIterator getElementIterator()

Возвращает ElementIterator.

Возвращает:: ElementIterator.

getWriter

protected Writer getWriter()

Возвращает Writer, используемый для вывода содержимого.

Возвращает:: Writer, используемый для вывода содержимого
С момента:: 1.3

getDocument

protected Document getDocument()

Возвращает документ.

Возвращает:: объект Document.

inRange

protected boolean inRange(Element next)

Этот метод определяет, находится ли текущий элемент в указанном диапазоне. Если диапазон не указан, он инициализируется всем документом. inRange() возвращает true, если указанный диапазон пересекается с диапазоном элемента.

Параметры:: next - элемент.
Возвращает:: логическое значение, указывающее, находится ли элемент в диапазоне.

write

protected abstract void write() throws IOException, BadLocationException

Этот абстрактный метод должен быть реализован подклассами. Его задача — итерироваться по элементам и использовать методы write() для генерации вывода в нужном формате.

Исключения:: IOException - если произошла проблема с вводом/выводом; BadLocationException - для некорректной позиции в документе

getText

protected String getText(Element elem) throws BadLocationException

Возвращает текст, связанный с элементом. Предполагается, что элемент является листовым элементом. Бросает BadLocationException при возникновении ошибки.

Параметры:: elem - элемент
Возвращает:: текст как String
Исключения:: BadLocationException - если pos представляет неверную позицию в документе

text

protected void text(Element elem) throws BadLocationException, IOException

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

Параметры:: elem - элемент.
Исключения:: IOException - при любой ошибке ввода/вывода; BadLocationException - если pos представляет неверную позицию в документе.

setLineLength

protected void setLineLength(int l)

Позволяет подклассам задать количество символов, которые они хотят выводить в строке. По умолчанию — 100.

Параметры:: l - максимальная длина строки.

getLineLength

protected int getLineLength()

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

Возвращает:: максимальная длина строки
С момента:: 1.3

setCurrentLineLength

protected void setCurrentLineLength(int length)

Устанавливает текущую длину строки.

Параметры:: length - новая длина строки
С момента:: 1.3

getCurrentLineLength

protected int getCurrentLineLength()

Возвращает текущую длину строки.

Возвращает:: текущая длина строки
С момента:: 1.3

isLineEmpty

protected boolean isLineEmpty()

Возвращает true, если текущая строка должна считаться пустой. Это верно, когда getCurrentLineLength == 0 || indent был вызван для пустой строки.

Возвращает:: true, если текущая строка должна считаться пустой
С момента:: 1.3

setCanWrapLines

protected void setCanWrapLines(boolean newValue)

Устанавливает, разрешено ли переносить строки. Это можно переключать во время вывода строк. Например, при выводе HTML это может быть установлено в false при выводе цитаты.

Параметры:: newValue - новое значение для переноса строк
С момента:: 1.3

getCanWrapLines

protected boolean getCanWrapLines()

Возвращает, разрешены ли переносы строк. Если это false, не будут выведены lineSeparator'ы.

Возвращает:: разрешены ли переносы строк
С момента:: 1.3

setIndentSpace

protected void setIndentSpace(int space)

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

Параметры:: space - целое число, представляющее отображение пробелов для отступа.

getIndentSpace

protected int getIndentSpace()

Возвращает количество пробелов для отступа.

Возвращает:: количество пробелов для отступа
С момента:: 1.3

setLineSeparator

public void setLineSeparator(String value)

Устанавливает строку, используемую для представления новых строк. Инициализируется в конструкторе из документа или системной переменной line.separator.

Параметры:: value - новый разделитель строк
С момента:: 1.3

getLineSeparator

public String getLineSeparator()

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

Возвращает:: строку, используемую для представления новых строк
С момента:: 1.3

incrIndent

protected void incrIndent()

Увеличивает уровень отступа. Если отступ приведет к getIndentSpace() *getIndentLevel() > getLineLength(), отступ не будет произведён.

decrIndent

protected void decrIndent()

Уменьшает уровень отступа.

getIndentLevel

protected int getIndentLevel()

Возвращает текущий уровень отступа. То есть количество вызовов incrIndent минус количество вызовов decrIndent.

Возвращает:: текущий уровень отступа
С момента:: 1.3

indent

protected void indent() throws IOException

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

Исключения:: IOException - при любой ошибке ввода/вывода

write

protected void write(char ch) throws IOException

Выводит символ. Реализовано для вызова метода write, принимающего char[].

Параметры:: ch - символ.
Исключения:: IOException - при любой ошибке ввода/вывода

write

protected void write(String content) throws IOException

Выводит строку. Эта реализация вызывается методом write, который принимает массив char[].

Parameters:: content - строка.
Throws:: IOException - при любой ошибке ввода-вывода

writeLineSeparator

protected void writeLineSeparator() throws IOException

Выводит разделитель строк. Вызывает output напрямую, а также устанавливает lineLength в 0.

Throws:: IOException - при любой ошибке ввода-вывода
Since:: 1.3

write

protected void write(char[] chars, int startIndex, int length) throws IOException

Все методы write вызывают этот метод. Если getCanWrapLines() возвращает false, это вызовет output для каждой последовательности chars, которая не содержит NEWLINE, за которым следует вызов writeLineSeparator. С другой стороны, если getCanWrapLines() возвращает true, это разделит строку, при необходимости, чтобы гарантировать выполнение getLineLength. Единственным исключением является случай, когда текущая строка не содержит пробелов и не помещается, в результате чего длина строки превысит getLineLength.

Parameters:: chars - символы для вывода; startIndex - начальный индекс; length - длина вывода
Throws:: IOException - при любой ошибке ввода-вывода
Since:: 1.3

writeAttributes

protected void writeAttributes(AttributeSet attr) throws IOException

Выводит набор атрибутов в виде пар «имя=значение». Выбрасывает исключение IOException при возникновении ошибки.

Parameters:: attr - набор атрибутов.
Throws:: IOException - при любой ошибке ввода-вывода

output

protected void output(char[] content, int start, int length) throws IOException

Последний этап вывода содержимого. Все методы write в конечном итоге попадают в этот метод, который вызывает write у объекта Writer.

Этот метод также обновляет длину строки на основе length. Если этот метод вызван для вывода новой строки, текущая длина строки должна быть сброшена, так как она больше не будет действительной. Если это необходимо, это должен сделать вызывающий метод. Используйте writeLineSeparator для вывода новой строки, которая корректно обновит текущую длину строки.

Parameters:: content - символы для вывода; start - начальный индекс; length - длина вывода
Throws:: IOException - при любой ошибке ввода-вывода
Since:: 1.3

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/text/AbstractWriter.html