Spec-Zone.ru › OpenJDK 25

Класс 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()
Возвращает ElementIterator.
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)
Задает String, используемую для представления символов новой строки.
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)
Выводит набор атрибутов в виде пар «<name>=<value>».
protected void writeLineSeparator()
Записывает разделитель строк.

Методы, объявленные в классе 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.
Возвращает:
значение boolean, указывающее, находится ли элемент в диапазоне.

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, разделители строк lineSeparator выводиться не будут.
Возвращает:
сведения о том, можно ли переносить строки
Начиная с версии:
1.3

setIndentSpace

protected void setIndentSpace(int space)
Позволяет подклассам задавать количество пробелов, соответствующее одному уровню отступа. При выполнении отступа его уровень умножается на это значение. Значение по умолчанию — 2.
Параметры:
space — значение int, задающее количество пробелов для одного уровня отступа.

getIndentSpace

protected int getIndentSpace()
Возвращает количество пробелов в отступе.
Возвращает:
количество пробелов в отступе
Начиная с версии:
1.3

setLineSeparator

public void setLineSeparator(String value)
Задает String, используемую для представления символов новой строки. Она инициализируется в конструкторе на основе объекта Document или системного свойства 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 — символ char.
Вызывает исключения:
IOException — при любой ошибке ввода-вывода

write

protected void write(String content) throws IOException
Выводит строку. Реализация вызывает метод write, принимающий массив char[].
Параметры:
content — строка String.
Вызывает исключения:
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
Все методы записи вызывают этот метод. Если getCanWrapLines() возвращает false, этот метод вызывает output для каждой последовательности chars, не содержащей NEWLINE, а затем вызывает writeLineSeparator. Если же getCanWrapLines() возвращает true, строка при необходимости разбивается на части, чтобы соблюдалось getLineLength. Исключение составляет случай, когда текущая строка не содержит пробельных символов и не помещается: тогда длина строки превысит getLineLength.
Параметры:
chars — символы для вывода
startIndex — начальный индекс
length — длина выводимых данных
Вызывает исключения:
IOException — при любой ошибке ввода-вывода
Начиная с версии:
1.3

writeAttributes

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

output

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

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

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

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, где приведены более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее дочерних компаний в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее дочерние компании, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/swing/text/AbstractWriter.html

Spec-Zone.ru

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