Spec-Zone.ru › OpenJDK 27

Класс PlainView

java.lang.Object
javax.swing.text.View
javax.swing.text.PlainView
Все реализуемые интерфейсы:
SwingConstants, TabExpander
Известные непосредственные подклассы:
FieldView
public class PlainView extends View implements TabExpander
Реализует интерфейс View для простого многострочного текстового представления, в котором текст отображается одним шрифтом и одним цветом. Представление отображает каждый дочерний элемент как строку текста.
См. также:
  • View

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

Модификатор и тип Поле Описание
protected FontMetrics metrics
Метрики шрифта для текущего шрифта.

Поля, объявленные в классе View

BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
Модификатор и тип Поле Описание
static final int BadBreakWeight
Вес, указывающий, что представление является неудачным местом для разрыва при форматировании.
static final int ExcellentBreakWeight
Вес, указывающий, что представление поддерживает разбиение и что это очень подходящее место для разрыва.
static final int ForcedBreakWeight
Вес, указывающий, что представление поддерживает разбиение и должно быть разбито для корректного отображения при размещении в представлении, форматирующем дочерние элементы путем их разбиения.
static final int GoodBreakWeight
Вес, указывающий, что представление поддерживает разбиение, но, вероятно, существуют более подходящие места.
static final int X_AXIS
Ось для операций форматирования и разбиения.
static final int Y_AXIS
Ось для операций форматирования и разбиения.

Поля, объявленные в интерфейсе SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
Модификатор и тип Поле Описание
static final int BOTTOM
Константа ориентации прямоугольной области, задающая ее нижнюю сторону.
static final int CENTER
Центральная позиция в области.
static final int EAST
Направление по компасу: восток (вправо).
static final int HORIZONTAL
Горизонтальная ориентация.
static final int LEADING
Обозначает начальный край текста для языков с письмом слева направо и справа налево.
static final int LEFT
Константа ориентации прямоугольной области, задающая ее левую сторону.
static final int NEXT
Обозначает следующее направление в последовательности.
static final int NORTH
Направление по компасу: север (вверх).
static final int NORTH_EAST
Направление по компасу: северо-восток (вверх и вправо).
static final int NORTH_WEST
Направление по компасу: северо-запад (вверх и влево).
static final int PREVIOUS
Обозначает предыдущее направление в последовательности.
static final int RIGHT
Константа ориентации прямоугольной области, задающая ее правую сторону.
static final int SOUTH
Направление по компасу: юг (вниз).
static final int SOUTH_EAST
Направление по компасу: юго-восток (вниз и вправо).
static final int SOUTH_WEST
Направление по компасу: юго-запад (вниз и влево).
static final int TOP
Константа ориентации прямоугольной области, задающая ее верхнюю сторону.
static final int TRAILING
Обозначает конечный край текста для языков с письмом слева направо и справа налево.
static final int VERTICAL
Вертикальная ориентация.
static final int WEST
Направление по компасу: запад (влево).

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

Конструктор Описание
PlainView(Element elem)
Создает новый PlainView, связанный с элементом.

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

Модификатор и тип Метод Описание
void changedUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Уведомляет представление об изменении атрибутов документа в области, за которую отвечает это представление.
protected void damageLineRange(int line0, int line1, Shape a, Component host)
Перерисовывает указанный диапазон строк.
protected void drawLine(int lineIndex, Graphics2D g, float x, float y)
Отображает строку текста, удаляя пробельные символы в конце и раскрывая все символы табуляции.
protected void drawLine(int lineIndex, Graphics g, int x, int y)
Устарело.
заменено на drawLine(int, Graphics2D, float, float)
protected float drawSelectedText(Graphics2D g, float x, float y, int p0, int p1)
Отображает указанный диапазон модели как выделенный текст.
protected int drawSelectedText(Graphics g, int x, int y, int p0, int p1)
Устарело.
заменено на drawSelectedText(Graphics2D, float, float, int, int)
protected float drawUnselectedText(Graphics2D g, float x, float y, int p0, int p1)
Отображает указанный диапазон модели как обычный невыделенный текст.
protected int drawUnselectedText(Graphics g, int x, int y, int p0, int p1)
Устарело.
заменено на drawUnselectedText(Graphics2D, float, float, int, int)
protected final Segment getLineBuffer()
Предоставляет доступ к буферу, который можно использовать для получения текста из связанного документа.
float getPreferredSpan(int axis)
Определяет предпочтительный размер этого представления вдоль заданной оси.
protected int getTabSize()
Возвращает заданный для документа размер табуляции; по умолчанию равен 8.
void insertUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Уведомляет о вставке данных в документ в области, за которую отвечает это представление.
protected Rectangle lineToRect(Shape a, int line)
Определяет прямоугольник, представляющий указанную строку.
Shape modelToView(int pos, Shape a, Position.Bias b)
Обеспечивает преобразование координат из пространства координат модели документа в пространство координат соответствующего ей представления.
float nextTabStop(float x, int tabOffset)
Возвращает позицию следующей позиции табуляции после заданной исходной позиции.
void paint(Graphics g, Shape a)
Выполняет отрисовку на заданной поверхности в заданной области этой поверхности.
void removeUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Уведомляет об удалении данных из документа в области, за которую отвечает это представление.
void setSize(float width, float height)
Задает размер представления.
protected void updateDamage(DocumentEvent changes, Shape a, ViewFactory f)
Перерисовывает область изменения, охватываемую заданным событием документа.
protected void updateMetrics()
Проверяет, актуальны ли метрики шрифта и самая длинная строка.
int viewToModel(float x, float y, Shape a, Position.Bias[] bias)
Обеспечивает преобразование координат из пространства координат представления в логическое пространство координат модели.

Методы, объявленные в классе View

append, breakView, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, isVisible, modelToView, modelToView, preferenceChanged, remove, removeAll, replace, setParent, updateChildren, updateLayout, viewToModel
Модификатор и тип Метод Описание
void append(View v)
Добавляет одно дочернее представление.
View breakView(int axis, int offset, float pos, float len)
Пытается разбить это представление по заданной оси.
View createFragment(int p0, int p1)
Создает представление, соответствующее части элемента.
protected void forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f)
Передает заданный DocumentEvent дочерним представлениям, которые необходимо уведомить об изменении модели.
protected void forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f)
Передает DocumentEvent указанному дочернему представлению.
float getAlignment(int axis)
Определяет желаемое выравнивание этого представления вдоль заданной оси.
AttributeSet getAttributes()
Получает атрибуты, используемые при отрисовке.
int getBreakWeight(int axis, float pos, float len)
Определяет, насколько удобно выполнять разрыв в этом представлении.
Shape getChildAllocation(int index, Shape a)
Получает область размещения для заданного дочернего представления.
Container getContainer()
Получает контейнер, в котором размещено представление.
Document getDocument()
Получает модель, связанную с представлением.
Element getElement()
Получает структурную часть объекта, которой соответствует это представление.
int getEndOffset()
Получает часть модели, за которую отвечает это представление.
Graphics getGraphics()
Получает Graphics для отрисовки.
float getMaximumSpan(int axis)
Определяет максимальный размер этого представления вдоль заданной оси.
float getMinimumSpan(int axis)
Определяет минимальный размер этого представления вдоль заданной оси.
int getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet)
Позволяет определить следующее визуально представленное положение модели, в котором можно разместить каретку.
View getParent()
Возвращает родительское представление.
int getResizeWeight(int axis)
Определяет возможность изменения размера представления вдоль заданной оси.
int getStartOffset()
Получает часть модели, за которую отвечает это представление.
String getToolTipText(float x, float y, Shape allocation)
Возвращает текст всплывающей подсказки в указанном месте.
View getView(int n)
Получает n-е дочернее представление.
int getViewCount()
Возвращает количество представлений в этом представлении.
ViewFactory getViewFactory()
Получает реализацию ViewFactory, формирующую иерархию представлений.
int getViewIndex(float x, float y, Shape allocation)
Возвращает индекс дочернего представления, соответствующего заданной позиции в представлении.
int getViewIndex(int pos, Position.Bias b)
Возвращает индекс дочернего представления, соответствующего заданной позиции в модели.
void insert(int offs, View v)
Вставляет одно дочернее представление.
boolean isVisible()
Возвращает логическое значение, указывающее, видно ли представление.
Shape modelToView(int pos, Shape a)
Устарело.
Shape modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a)
Для заданной области обеспечивает преобразование координат из пространства координат модели документа в пространство координат представления.
void preferenceChanged(View child, boolean width, boolean height)
Дочерние представления могут вызвать этот метод у родителя, чтобы сообщить об изменении предпочтительных параметров и необходимости повторно учесть их при компоновке.
void remove(int i)
Удаляет дочерний элемент в заданной позиции.
void removeAll()
Удаляет все дочерние элементы.
void replace(int offset, int length, View[] views)
Заменяет дочерние представления.
void setParent(View parent)
Устанавливает родительское представление для этого представления.
protected boolean updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f)
Обновляет дочерние представления при получении уведомления об изменении модели, если запись об изменении относится к элементу, за который отвечает это представление.
protected void updateLayout(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a)
Обновляет компоновку при получении уведомления об изменении модели.
int viewToModel(float x, float y, Shape a)
Устарело.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Модификатор и тип Метод Описание
protected Object clone()
Создает и возвращает копию этого объекта.
boolean equals(Object obj)
Указывает, равен ли этот объект какому-либо другому объекту.
protected void finalize()
Устарело, будет удалено: этот элемент API может быть удален в будущей версии.
Финализация устарела и будет удалена в одном из будущих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает хеш-код этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
String toString()
Возвращает строковое представление объекта.
final void wait()
Приостанавливает текущий поток до его пробуждения, обычно в результате вызова notify или interrupt.
final void wait(long timeoutMillis)
Приостанавливает текущий поток до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка времени.
final void wait(long timeoutMillis, int nanos)
Приостанавливает текущий поток до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка времени.

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

metrics

protected FontMetrics metrics
Метрики шрифта для текущего шрифта.

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

PlainView

public PlainView(Element elem)
Создает новое представление PlainView, связанное с элементом.
Параметры:
elem — элемент

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

getTabSize

protected int getTabSize()
Возвращает размер табуляции, заданный для документа; по умолчанию — 8.
Возвращает:
размер табуляции

drawLine

@Deprecated(since="9") protected void drawLine(int lineIndex, Graphics g, int x, int y)
Устарел.
заменен на drawLine(int, Graphics2D, float, float)
Отображает строку текста, убирая пробелы в конце и раскрывая символы табуляции. Реализация вызывает методы drawUnselectedText и drawSelectedText, чтобы можно было настраивать отображение выделенного и невыделенного текста.
Параметры:
lineIndex — строка для отображения >= 0
g — контекст Graphics
x — начальная координата X >= 0
y — начальная координата Y >= 0
См. также:
  • drawUnselectedText(Graphics, int, int, int, int)
  • drawSelectedText(Graphics, int, int, int, int)

drawLine

protected void drawLine(int lineIndex, Graphics2D g, float x, float y)
Отображает строку текста, убирая пробелы в конце и раскрывая символы табуляции. Реализация вызывает методы drawUnselectedText и drawSelectedText, чтобы можно было настраивать отображение выделенного и невыделенного текста.
Параметры:
lineIndex — строка для отображения >= 0
g — контекст Graphics
x — начальная координата X >= 0
y — начальная координата Y >= 0
С версии:
9
См. также:
  • drawUnselectedText(Graphics, int, int, int, int)
  • drawSelectedText(Graphics, int, int, int, int)

drawUnselectedText

@Deprecated(since="9") protected int drawUnselectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException
Устарел.
заменен на drawUnselectedText(Graphics2D, float, float, int, int)
Отображает указанный диапазон модели как обычный невыделенный текст. Для отображения текста используется цвет переднего плана или цвет для отключенного состояния.
Параметры:
g — графический контекст
x — начальная координата X >= 0
y — начальная координата Y >= 0
p0 — начальная позиция в модели >= 0
p1 — конечная позиция в модели >= 0
Возвращает:
координату X конца диапазона >= 0
Вызывает исключение:
BadLocationException — если диапазон недопустим

drawUnselectedText

protected float drawUnselectedText(Graphics2D g, float x, float y, int p0, int p1) throws BadLocationException
Отображает указанный диапазон модели как обычный невыделенный текст. Для отображения текста используется цвет переднего плана или цвет для отключенного состояния.
Параметры:
g — графический контекст
x — начальная координата X >= 0
y — начальная координата Y >= 0
p0 — начальная позиция в модели >= 0
p1 — конечная позиция в модели >= 0
Возвращает:
координату X конца диапазона >= 0
Вызывает исключение:
BadLocationException — если диапазон недопустим
С версии:
9

drawSelectedText

@Deprecated(since="9") protected int drawSelectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException
Устарел.
заменен на drawSelectedText(Graphics2D, float, float, int, int)
Отображает указанный диапазон модели как выделенный текст. Реализация отображает текст цветом, заданным в содержащем компоненте. Предполагается, что подсветчик отобразит фон выделения.
Параметры:
g — графический контекст
x — начальная координата X >= 0
y — начальная координата Y >= 0
p0 — начальная позиция в модели >= 0
p1 — конечная позиция в модели >= 0
Возвращает:
координату конца диапазона
Вызывает исключение:
BadLocationException — если диапазон недопустим

drawSelectedText

protected float drawSelectedText(Graphics2D g, float x, float y, int p0, int p1) throws BadLocationException
Отображает указанный диапазон модели как выделенный текст. Реализация отображает текст цветом, заданным в содержащем компоненте. Предполагается, что подсветчик отобразит фон выделения.
Параметры:
g — графический контекст
x — начальная координата X >= 0
y — начальная координата Y >= 0
p0 — начальная позиция в модели >= 0
p1 — конечная позиция в модели >= 0
Возвращает:
координату конца диапазона
Вызывает исключение:
BadLocationException — если диапазон недопустим
С версии:
9

getLineBuffer

protected final Segment getLineBuffer()
Предоставляет доступ к буферу, который можно использовать для получения текста из связанного документа.
Возвращает:
буфер

updateMetrics

protected void updateMetrics()
Проверяет, актуальны ли метрики шрифта и самая длинная строка.
С версии:
1.4

getPreferredSpan

public float getPreferredSpan(int axis)
Определяет предпочтительный размер этого представления вдоль указанной оси.
Определено в:
getPreferredSpan в классе View
Параметры:
axis — может принимать значение View.X_AXIS или View.Y_AXIS
Возвращает:
размер, в который должно быть помещено представление >= 0. Обычно представлению предлагают отобразиться в возвращенном размере, однако это не гарантируется. Родительский элемент может изменить размер представления или разбить его.
Вызывает исключение:
IllegalArgumentException — если ось недопустима

paint

public void paint(Graphics g, Shape a)
Отображает представление на указанной поверхности в заданной области этой поверхности. Для отображения в выделенной области представлению может потребоваться выполнить компоновку и создать дочерние представления.
Определено в:
paint в классе View
Параметры:
g — используемая поверхность отображения
a — выделенная область для отображения
См. также:
  • View.paint(Graphics, Shape)

modelToView

public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException
Преобразует координаты модели документа в координаты соответствующего ей представления.
Определено в:
modelToView в классе View
Параметры:
pos — преобразуемая позиция >= 0
a — выделенная область для отображения
b — смещение к предыдущему или следующему символу, представленному смещением, если позиция является границей двух представлений; b принимает одно из следующих значений:
  • Position.Bias.Forward
  • Position.Bias.Backward
Возвращает:
ограничивающий прямоугольник указанной позиции
Вызывает исключение:
BadLocationException — если указанная позиция не соответствует допустимому месту в связанном документе
См. также:
  • View.modelToView(int, Shape, Position.Bias)

viewToModel

public int viewToModel(float x, float y, Shape a, Position.Bias[] bias)
Преобразует координаты представления в логические координаты модели.
Определено в:
viewToModel в классе View
Параметры:
x — координата X >= 0
y — координата Y >= 0
a — выделенная область для отображения
bias — возвращаемое смещение
Возвращает:
позицию в модели, которая наилучшим образом соответствует указанной точке представления >= 0
См. также:
  • View.viewToModel(float, float, Shape, Position.Bias[])

insertUpdate

public void insertUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Уведомляет о вставке содержимого в документ в области, за которую отвечает это представление.
Переопределяет:
insertUpdate в классе View
Параметры:
changes — сведения об изменении связанного документа
a — текущая выделенная область представления
f — фабрика, используемая для повторного построения, если у представления есть дочерние элементы
См. также:
  • View.insertUpdate(DocumentEvent, Shape, ViewFactory)

removeUpdate

public void removeUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Уведомляет об удалении содержимого из документа в области, за которую отвечает это представление.
Переопределяет:
removeUpdate в классе View
Параметры:
changes — сведения об изменении связанного документа
a — текущая выделенная область представления
f — фабрика, используемая для повторного построения, если у представления есть дочерние элементы
См. также:
  • View.removeUpdate(DocumentEvent, Shape, ViewFactory)

changedUpdate

public void changedUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Уведомляет об изменении атрибутов документа в области, за которую отвечает это представление.
Переопределяет:
changedUpdate в классе View
Параметры:
changes — сведения об изменении связанного документа
a — текущая выделенная область представления
f — фабрика, используемая для повторного построения, если у представления есть дочерние элементы
См. также:
  • View.changedUpdate(DocumentEvent, Shape, ViewFactory)

setSize

public void setSize(float width, float height)
Задает размер представления. Если представление отвечает за компоновку, это должно привести к компоновке вдоль указанной оси.
Переопределяет:
setSize в классе View
Параметры:
width — ширина >= 0
height — высота >= 0

nextTabStop

public float nextTabStop(float x, int tabOffset)
Возвращает позицию следующей позиции табуляции после заданной опорной позиции. Эта реализация не поддерживает такие возможности, как выравнивание по центру, поэтому игнорирует аргумент tabOffset.
Определено в:
nextTabStop в интерфейсе TabExpander
Параметры:
x — текущая позиция >= 0
tabOffset — позиция в текстовом потоке, в которой встретился символ табуляции >= 0.
Возвращает:
позицию табуляции в пунктах >= 0

updateDamage

protected void updateDamage(DocumentEvent changes, Shape a, ViewFactory f)
Повторно отображает измененную область, охватываемую указанным событием документа. Помечает как требующую перерисовки строку, с которой начинается диапазон, чтобы учесть случай, когда вставка или удаление затрагивает только одну строку. Если строки добавлены или удалены, помечает для перерисовки все представление. Проверяет, изменилась ли самая длинная строка.
Параметры:
changes — сведения об изменении связанного документа
a — текущая выделенная область представления
f — фабрика, используемая для повторного построения, если у представления есть дочерние элементы
С версии:
1.4

damageLineRange

protected void damageLineRange(int line0, int line1, Shape a, Component host)
Повторно отображает указанный диапазон строк.
Параметры:
line0 — номер начальной строки для перерисовки. Это должен быть допустимый номер строки в модели.
line1 — номер конечной строки для перерисовки. Это должен быть допустимый номер строки в модели.
a — область, выделенная для отображения представления
host — компонент, содержащий представление (используется для вызова repaint)
С версии:
1.4

lineToRect

protected Rectangle lineToRect(Shape a, int line)
Определяет прямоугольник, представляющий указанную строку.
Параметры:
a — область, выделенная для отображения представления
line — номер строки, область которой нужно найти. Это должен быть допустимый номер строки в модели.
Возвращает:
прямоугольник, представляющий указанную строку
С версии:
1.4

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, которая содержит более подробные описания для разработчиков, обзоры концепций, определения терминов, способы обхода проблем и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее дочерних компаний в США и других странах.
Авторские права © 1993, 2026, 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.

Spec-Zone.ru

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