Класс LabelView

javax.swing.text.LabelView

Все реализуемые интерфейсы:: Cloneable, SwingConstants, TabableView

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

public class LabelView extends GlyphView implements TabableView

LabelView — это стилизованный фрагмент текста, представляющий собой представление, сопоставленное с элементом текстовой модели. Он кэширует атрибуты символов, используемые при отрисовке.

Краткое описание вложенных классов

Вложенные классы и интерфейсы, объявленные в классе GlyphView

GlyphView.GlyphPainter

Модификатор и тип	Класс	Описание
`static class`	`GlyphView.GlyphPainter`	Класс для отрисовки глифов.

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

Поля, объявленные в классе 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`	Направление по компасу: запад (влево).

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

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

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

Модификатор и тип	Метод	Описание
`void`	`changedUpdate(DocumentEvent e, Shape a, ViewFactory f)`	Уведомляет представление об изменении атрибутов документа в области, за которую отвечает это представление.
`Color`	`getBackground()`	Возвращает цвет фона, используемый для отрисовки глифов.
`Font`	`getFont()`	Возвращает шрифт, на основе которого должны отображаться глифы.
`protected FontMetrics`	`getFontMetrics()`	Устарело. При запуске в JDK FontMetrics не используются для отрисовки глифов.
`Color`	`getForeground()`	Возвращает цвет переднего плана, используемый для отрисовки глифов.
`boolean`	`isStrikeThrough()`	Определяет, следует ли отображать глифы с зачеркиванием.
`boolean`	`isSubscript()`	Определяет, следует ли отображать глифы в виде верхнего индекса.
`boolean`	`isSuperscript()`	Определяет, следует ли отображать глифы в виде нижнего индекса.
`boolean`	`isUnderline()`	Определяет, следует ли подчеркивать глифы.
`protected void`	`setBackground(Color bg)`	Задает цвет фона представления.
`protected void`	`setPropertiesFromAttributes()`	Задает кэшированные свойства на основе атрибутов.
`protected void`	`setStrikeThrough(boolean s)`	Задает, должно ли представление отображаться с линией зачеркивания.
`protected void`	`setSubscript(boolean s)`	Задает, представляет ли представление нижний индекс.
`protected void`	`setSuperscript(boolean s)`	Задает, представляет ли представление верхний индекс.
`protected void`	`setUnderline(boolean u)`	Задает, должно ли представление отображаться подчеркнутым.

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

breakView, checkPainter, clone, createFragment, getAlignment, getBreakWeight, getEndOffset, getGlyphPainter, getMinimumSpan, getNextVisualPositionFrom, getPartialSpan, getPreferredSpan, getStartOffset, getTabbedSpan, getTabExpander, getText, insertUpdate, modelToView, paint, removeUpdate, setGlyphPainter, viewToModel

Модификатор и тип	Метод	Описание
`View`	`breakView(int axis, int p0, float pos, float len)`	Разбивает это представление по указанной оси на заданной длине.
`protected void`	`checkPainter()`	Проверяет, существует ли средство отрисовки глифов.
`protected final Object`	`clone()`	Создает поверхностную копию.
`View`	`createFragment(int p0, int p1)`	Создает представление, соответствующее части элемента.
`float`	`getAlignment(int axis)`	Определяет требуемое выравнивание этого представления вдоль оси.
`int`	`getBreakWeight(int axis, float pos, float len)`	Определяет, насколько подходящим является место переноса в этом представлении.
`int`	`getEndOffset()`	Возвращает часть модели, за которую отвечает это представление.
`GlyphView.GlyphPainter`	`getGlyphPainter()`	Возвращает установленное в данный момент средство отрисовки глифов.
`float`	`getMinimumSpan(int axis)`	Определяет минимальный размер этого представления вдоль оси.
`int`	`getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet)`	Позволяет определить следующую визуально представленную позицию модели, в которой можно разместить каретку.
`float`	`getPartialSpan(int p0, int p1)`	Определяет размер части представления вдоль той же оси, что и расширение табуляции.
`float`	`getPreferredSpan(int axis)`	Определяет предпочтительный размер этого представления вдоль оси.
`int`	`getStartOffset()`	Возвращает часть модели, за которую отвечает это представление.
`float`	`getTabbedSpan(float x, TabExpander e)`	Определяет требуемый размер при использовании указанной реализации расширения табуляции.
`TabExpander`	`getTabExpander()`	Возвращает TabExpander, используемый, если это представление содержит символы табуляции.
`Segment`	`getText(int p0, int p1)`	Возвращает ссылку на текст, занимающий указанный диапазон.
`void`	`insertUpdate(DocumentEvent e, Shape a, ViewFactory f)`	Уведомляет о вставке данных в документ в области, за которую отвечает это представление.
`Shape`	`modelToView(int pos, Shape a, Position.Bias b)`	Обеспечивает преобразование координат пространства модели документа в координаты пространства сопоставленного с ней представления.
`void`	`paint(Graphics g, Shape a)`	Отрисовывает часть текстового фрагмента с единым стилем.
`void`	`removeUpdate(DocumentEvent e, Shape a, ViewFactory f)`	Уведомляет об удалении данных из документа в области, за которую отвечает это представление.
`void`	`setGlyphPainter(GlyphView.GlyphPainter p)`	Задает средство отрисовки для отображения глифов.
`int`	`viewToModel(float x, float y, Shape a, Position.Bias[] biasReturn)`	Обеспечивает преобразование координат пространства представления в логические координаты модели.

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

append, forwardUpdate, forwardUpdateToView, getAttributes, getChildAllocation, getContainer, getDocument, getElement, getGraphics, getMaximumSpan, getParent, getResizeWeight, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, isVisible, modelToView, modelToView, preferenceChanged, remove, removeAll, replace, setParent, setSize, updateChildren, updateLayout, viewToModel

Модификатор и тип	Метод	Описание
`void`	`append(View v)`	Добавляет одно дочернее представление.
`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` указанному дочернему представлению.
`AttributeSet`	`getAttributes()`	Возвращает атрибуты, используемые при отрисовке.
`Shape`	`getChildAllocation(int index, Shape a)`	Возвращает область размещения указанного дочернего представления.
`Container`	`getContainer()`	Возвращает контейнер, содержащий представление.
`Document`	`getDocument()`	Возвращает модель, связанную с представлением.
`Element`	`getElement()`	Возвращает структурную часть объекта, с которым сопоставлено это представление.
`Graphics`	`getGraphics()`	Возвращает `Graphics` для отрисовки.
`float`	`getMaximumSpan(int axis)`	Определяет максимальный размер этого представления вдоль оси.
`View`	`getParent()`	Возвращает родительское представление.
`int`	`getResizeWeight(int axis)`	Определяет возможность изменения размера представления вдоль указанной оси.
`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)`	Задает родительское представление для этого представления.
`void`	`setSize(float width, float height)`	Задает размер представления.
`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

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

Модификатор и тип	Метод	Описание
`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, либо до истечения заданного промежутка реального времени.

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

LabelView

public LabelView(Element elem)

Создает новое представление, обернутое вокруг элемента.

Параметры:: elem — элемент

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

setUnderline

protected void setUnderline(boolean u)

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

Параметры:

u — true, если представление подчеркнуто; в противном случае false

См. также:

setStrikeThrough

protected void setStrikeThrough(boolean s)

Задает, должна ли через представление проходить линия. Обратите внимание, что этот метод-сеттер защищен и предназначен в первую очередь для случаев, когда при установке значения необходимо обновить некоторое дополнительное состояние.

Параметры:

s — true, если через представление проходит линия; в противном случае false

См. также:

setSuperscript

protected void setSuperscript(boolean s)

Задает, представляет ли представление верхний индекс. Обратите внимание, что этот метод-сеттер защищен и предназначен в первую очередь для случаев, когда при установке значения необходимо обновить некоторое дополнительное состояние.

Параметры:

s — true, если представление представляет верхний индекс; в противном случае false

См. также:

setSubscript

protected void setSubscript(boolean s)

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

Параметры:

s — true, если представление представляет нижний индекс; в противном случае false

См. также:

setBackground

protected void setBackground(Color bg)

Задает цвет фона представления. Этот метод обычно вызывается при настройке View. Если требуется настроить цвет фона, следует переопределить setPropertiesFromAttributes и вызвать этот метод. Значение null указывает, что фон не нужно отрисовывать, поэтому будет виден фон родительского View.

Параметры:

bg — цвет фона или null

Начиная с:

1.5

См. также:

setPropertiesFromAttributes

protected void setPropertiesFromAttributes()

Задает кэшированные свойства на основе атрибутов.

getFontMetrics

@Deprecated protected FontMetrics getFontMetrics()

Устарел.

При выполнении в JDK метрики шрифта не используются для отрисовки глифов.

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

Возвращает:: FontMetrics, используемые для этого представления

getBackground

public Color getBackground()

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

Переопределяет:: getBackground в классе GlyphView
Возвращает:: кэшированный цвет фона
Начиная с:: 1.3

getForeground

public Color getForeground()

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

Переопределяет:: getForeground в классе GlyphView
Возвращает:: кэшированный цвет переднего плана
Начиная с:: 1.3

getFont

public Font getFont()

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

Переопределяет:: getFont в классе GlyphView
Возвращает:: кэшированный шрифт

isUnderline

public boolean isUnderline()

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

При запросе этого свойства LabelView повторно синхронизирует свое состояние со свойствами AttributeSet объекта Element. Если свойство не задано в AttributeSet объекта Element, значение сбрасывается на false.

Переопределяет:: isUnderline в классе GlyphView
Возвращает:: значение кэшированного свойства underline
Начиная с:: 1.3

isStrikeThrough

public boolean isStrikeThrough()

Определяет, должна ли через глифы проходить зачеркивающая линия. Если возвращается true, линию следует провести через центр глифов. Реализация возвращает кэшированное свойство strikeThrough.

Переопределяет:: isStrikeThrough в классе GlyphView
Возвращает:: значение кэшированного свойства strikeThrough
Начиная с:: 1.3

isSubscript

public boolean isSubscript()

Определяет, должны ли глифы отображаться в виде верхнего индекса.

Переопределяет:: isSubscript в классе GlyphView
Возвращает:: значение кэшированного свойства subscript
Начиная с:: 1.3

isSuperscript

public boolean isSuperscript()

Определяет, должны ли глифы отображаться в виде нижнего индекса.

Переопределяет:: isSuperscript в классе GlyphView
Возвращает:: значение кэшированного свойства superscript
Начиная с:: 1.3

changedUpdate

public void changedUpdate(DocumentEvent e, Shape a, ViewFactory f)

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

Переопределяет:

changedUpdate в классе GlyphView

Параметры:

e — информация об изменении из связанного документа

a — текущее распределение области представления

f — фабрика для перестроения представления, если у него есть дочерние элементы

См. также:

© 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.