Spec-Zone.ru › OpenJDK 24

Класс 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
Как пакет текстовых моделей представляет новые строки.
См. также:
  • getLineSeparator()
  • Значения константных полей

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

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 - элемент Element
pos - Позиция в документе для извлечения содержимого.
len - Количество для записи.

AbstractWriter

protected AbstractWriter(Writer w, Element root)
Создаёт новый AbstractWriter. Инициализирует ElementIterator с переданным элементом.
Параметры:
w - объект Writer
root - элемент Element

AbstractWriter

protected AbstractWriter(Writer w, Element root, int pos, int len)
Создаёт новый AbstractWriter. Инициализирует ElementIterator с переданным элементом.
Параметры:
w - объект Writer
root - элемент Element
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 - элемент Element.
Возвращает:
логическое значение, указывающее, находится ли элемент в диапазоне.

write

protected abstract void write() throws IOException, BadLocationException
Этот абстрактный метод должен быть реализован подклассами. Он отвечает за итерацию по элементам и использование методов write() для генерации вывода в желаемом формате.
Использует:
IOException - если произошла проблема с вводом/выводом
BadLocationException - для неверной позиции в документе

getText

protected String getText(Element elem) throws BadLocationException
Возвращает текст, связанный с элементом. Предполагается, что элемент является листовым элементом. Бросает исключение BadLocationException при обнаружении.
Параметры:
elem - элемент Element
Возвращает:
текст как String
Использует:
BadLocationException - если pos представляет недопустимую позицию в документе

text

protected void text(Element elem) throws BadLocationException, IOException
Записывает текст. Если диапазон задан при вызове конструктора, записывается только соответствующий диапазон текста.
Параметры:
elem - элемент Element.
Использует:
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, не будут выводиться разделители строк.
Возвращает:
могут ли строки переноситься на новую строку
С тех пор, как:
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[].
Параметры:
content - строка.
Выбрасывает:
IOException - при любой ошибке ввода-вывода

writeLineSeparator

protected void writeLineSeparator() throws IOException
Выводит разделитель строк. Вызывает output напрямую, а также устанавливает lineLength в 0.
Выбрасывает:
IOException - при любой ошибке ввода-вывода
С момента:
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.
Параметры:
chars - символы для вывода
startIndex - начальный индекс
length - длина вывода
Выбрасывает:
IOException - при любой ошибке ввода-вывода
С момента:
1.3

writeAttributes

protected void writeAttributes(AttributeSet attr) throws IOException
Выводит набор атрибутов как пары «<имя>=<значение>». Выбрасывает IOException при возникновении.
Параметры:
attr - атрибут AttributeSet.
Выбрасывает:
IOException - при любой ошибке ввода-вывода

output

protected void output(char[] content, int start, int length) throws IOException
Последний этап вывода содержимого. Все методы write в конечном итоге попадают в этот метод, который вызывает write в Writer.

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

Параметры:
content - символы для вывода
start - начальный индекс
length - длина вывода
Выбрасывает:
IOException - при любой ошибке ввода-вывода
С момента:
1.3

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/javax/swing/text/AbstractWriter.html

Spec-Zone.ru

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