Класс ParagraphView

javax.swing.text.ParagraphView

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

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

public class ParagraphView extends FlowView implements TabExpander

Представление простого абзаца с переходом на новую строку, поддерживающего несколько шрифтов, цветов, компонентов, значков и т. д. По сути, это вертикальная коробка с отступом вокруг неё. Содержимое коробки — это набор строк, которые являются специальными горизонтальными коробками. Данный вид создаёт набор представлений, которые отображают дочерние элементы элемента абзаца. Каждый из этих представлений размещается непосредственно в строке, если помещается, в противном случае вызывается метод breakView, чтобы попытаться разбить представление на части, которые поместятся.

См. также:

View

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

Вложенные классы/интерфейсы, объявленные в классе javax.swing.text.FlowView

FlowView.FlowStrategy

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

Модификатор и тип	Поле	Описание
`protected int`	`firstLineIndent`	Отступ первой строки слева от внутреннего отступа.

Поля, объявленные в классе javax.swing.text.FlowView

layoutPool, layoutSpan, strategy

Поля, объявленные в классе javax.swing.text.View

BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS

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

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

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

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

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

Модификатор и тип	Метод	Описание
`View`	`breakView(int axis, float len, Shape a)`	Разбивает этот вид по заданной оси по заданной длине.
`protected SizeRequirements`	`calculateMinorAxisRequirements(int axis, SizeRequirements r)`	Вычисляет потребности абзаца по малой оси.
`void`	`changedUpdate(DocumentEvent changes, Shape a, ViewFactory f)`	Получает уведомление от документа о том, что атрибуты были изменены в позиции, за которую отвечает данный вид.
`protected View`	`createRow()`	Создаёт `View`, который следует использовать для хранения строки дочерних элементов в потоке.
`protected int`	`findOffsetToCharactersInString(char[] string, int start)`	Находит следующую позицию символа в документе с символом в `string`, начиная с смещения `start`.
`protected boolean`	`flipEastAndWestAtEnds(int position, Position.Bias bias)`	Определяет направление размещения следующего вида.
`float`	`getAlignment(int axis)`	Определяет требуемое выравнивание для данного вида по оси.
`int`	`getBreakWeight(int axis, float len)`	Возвращает вес разрыва для заданной позиции.
`protected int`	`getClosestPositionTo(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet, int rowIndex, int x)`	Возвращает ближайшую модельную позицию к `x`.
`int`	`getFlowSpan(int index)`	Извлекает ограничивающий разделитель для потока по индексу дочернего элемента.
`int`	`getFlowStart(int index)`	Извлекает позицию по оси потока, в которой начнётся разделитель потока.
`protected View`	`getLayoutView(int index)`	Возвращает вид по заданной `index`.
`protected int`	`getLayoutViewCount()`	Возвращает количество представлений, за которые отвечает этот вид.
`protected int`	`getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet)`	Возвращает следующую визуальную позицию курсора в восточном или западном направлении.
`protected float`	`getPartialSize(int startOffset, int endOffset)`	Возвращает размер, используемый представлениями между `startOffset` и `endOffset`.
`protected float`	`getTabBase()`	Возвращает, откуда рассчитываются табуляции.
`protected TabSet`	`getTabSet()`	Возвращает `Tabset`, используемый при вычислении табуляций.
`float`	`nextTabStop(float x, int tabOffset)`	Возвращает следующую позицию табуляции относительно опорной позиции.
`void`	`paint(Graphics g, Shape a)`	Отображает на заданной поверхности отрисовки и области на этой поверхности.
`protected void`	`setFirstLineIndent(float fi)`	Устанавливает отступ первой строки.
`protected void`	`setJustification(int j)`	Устанавливает тип выравнивания.
`protected void`	`setLineSpacing(float ls)`	Устанавливает интерлиньяж.
`protected void`	`setPropertiesFromAttributes()`	Устанавливает кешированные свойства из атрибутов.

Методы, объявленные в классе javax.swing.text.FlowView

getFlowAxis, getViewIndexAtPosition, insertUpdate, layout, loadChildren, removeUpdate

Методы, объявленные в классе javax.swing.text.BoxView

baselineLayout, baselineRequirements, calculateMajorAxisRequirements, childAllocation, forwardUpdate, getAxis, getChildAllocation, getHeight, getMaximumSpan, getMinimumSpan, getOffset, getPreferredSpan, getResizeWeight, getSpan, getViewAtPoint, getWidth, isAfter, isAllocationValid, isBefore, isLayoutValid, layoutChanged, layoutMajorAxis, layoutMinorAxis, modelToView, paintChild, preferenceChanged, replace, setAxis, setSize, viewToModel

Методы, объявленные в классе javax.swing.text.CompositeView

getBottomInset, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewAtPosition, getViewCount, getViewIndex, modelToView, setInsets, setParagraphInsets, setParent

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

append, breakView, createFragment, forwardUpdateToView, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getGraphics, getParent, getStartOffset, getToolTipText, getViewFactory, getViewIndex, insert, isVisible, modelToView, remove, removeAll, updateChildren, updateLayout, viewToModel

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

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

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

firstLineIndent

protected int firstLineIndent

Отступ первой строки слева.

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

ParagraphView

public ParagraphView(Element elem)

Создаёт ParagraphView для заданного элемента.

Параметры:: elem - элемент, за который отвечает этот вид

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

setJustification

protected void setJustification(int j)

Устанавливает тип выравнивания.

Параметры:

j - одно из следующих значений:

StyleConstants.ALIGN_LEFT
StyleConstants.ALIGN_CENTER
StyleConstants.ALIGN_RIGHT

setLineSpacing

protected void setLineSpacing(float ls)

Устанавливает интервал между строками.

Параметры:: ls - значение является множителем высоты строки

setFirstLineIndent

protected void setFirstLineIndent(float fi)

Устанавливает отступ первой строки.

Параметры:: fi - значение в пунктах

setPropertiesFromAttributes

protected void setPropertiesFromAttributes()

Устанавливает кешированные свойства из атрибутов.

getLayoutViewCount

protected int getLayoutViewCount()

Возвращает количество представлений, за которые отвечает этот вид. Подчиненные представления абзаца — это строки, которые использовались для упорядочения фрагментов View , представляющих дочерние элементы. Это количество представлений, которое было выложено в двух измерениях, и должно быть равно количеству дочерних элементов элемента, за который отвечает этот вид.

Возвращает:: количество представлений, за которые отвечает данный ParagraphView

getLayoutView

protected View getLayoutView(int index)

Возвращает представление по заданному index. Подчиненные представления абзаца — это строки, которые использовались для упорядочения фрагментов Views , представляющих дочерние элементы. Этот метод возвращает представление, ответственное за дочерний элемент с индексом (до разбиения). Это представления, которые были созданы из фабрики (для представления дочерних элементов) и использовались для выкладки.

Параметры:: index - index желаемого представления
Возвращает:: представление по index

getNextNorthSouthVisualPositionFrom

protected int getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException

Возвращает следующую визуальную позицию курсора в направлении восток или запад. Переопределено из CompositeView.

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

getNextNorthSouthVisualPositionFrom в классе CompositeView

Параметры:

pos - позиция в модели

b - либо Position.Bias.Forward, либо Position.Bias.Backward

a - выделенная область для отрисовки

direction - либо SwingConstants.NORTH, либо SwingConstants.SOUTH

biasRet - массив, содержащий смещения, которые проверялись в этом методе

Возвращает:

позицию в модели, представляющую следующую визуальную позицию

Исключения:

BadLocationException - для неверной позиции в модели документа

См. также:

CompositeView.getNextVisualPositionFrom(int, javax.swing.text.Position.Bias, java.awt.Shape, int, javax.swing.text.Position.Bias[])

getClosestPositionTo

protected int getClosestPositionTo(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet, int rowIndex, int x) throws BadLocationException

Возвращает ближайшую позицию модели к x. rowIndex указывает индекс представления, которое должно быть просмотрено.

Параметры:

pos - позиция в модели

b - смещение

a - выделенная область для отрисовки

direction - одно из следующих значений:

SwingConstants.NORTH
SwingConstants.SOUTH

biasRet - массив, содержащий смещения, которые проверялись в этом методе

rowIndex - индекс представления

x - координата x, представляющая интерес

Возвращает:

ближайшая позиция модели к x

Исключения:

BadLocationException - если обнаружена неверная позиция

flipEastAndWestAtEnds

protected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)

Определяет направление расположения следующего представления. Рассмотрим View с индексом n. Обычно View располагаются слева направо, так что View на ВОСТОК будет иметь индекс n + 1, а View на ЗАПАД — индекс n - 1. В некоторых ситуациях, например, при двунаправленном тексте, возможно, что View на ВОСТОК будет не с индексом n + 1, а с индексом n - 1, или что View на ЗАПАД будет не с индексом n - 1, а с индексом n + 1. В этом случае этот метод вернёт true, указывая, что View располагаются в порядке убывания.

Этот метод вернёт true, если текст выложен справа налево в данной позиции, иначе false.

Переопределяет:: flipEastAndWestAtEnds в классе BoxView
Параметры:: position - позиция в модели; bias - либо Position.Bias.Forward, либо Position.Bias.Backward
Возвращает:: true, если текст выложен справа налево в данной позиции, иначе false.

getFlowSpan

public int getFlowSpan(int index)

Извлекает ограничивающую область для выкладки для заданного индекса дочернего элемента.

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

getFlowSpan в классе FlowView

Параметры:

index - индекс представления, для которого запрашивается информация

Возвращает:

ограничивающая область для данного представления по index

См. также:

FlowView.getFlowStart(int)

getFlowStart

public int getFlowStart(int index)

Извлекает положение по оси выкладки, с которого начнётся область выкладки.

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

getFlowStart в классе FlowView

Параметры:

index - индекс представления, для которого запрашивается информация

Возвращает:

положение для данного представления по index

См. также:

FlowView.getFlowSpan(int)

createRow

protected View createRow()

Создаёт View , который должен использоваться для хранения строки дочерних элементов в выкладке.

Определяет:: createRow в классе FlowView
Возвращает:: новое View

nextTabStop

public float nextTabStop(float x, int tabOffset)

Возвращает позицию следующей табуляции, исходя из ссылки на текущую позицию. Этот вид реализует систему координат табуляции, вызывая getTabbedSpan на логических дочерних элементах в процессе выкладки, чтобы определить желаемый диапазон дочерних элементов. Логические дочерние элементы могут делегировать свои потребности в расширении табуляции абзацу, который знает, как их расширить. LabelView — пример вида, который делегирует свои потребности в расширении табуляции абзацу.

Реализуется для поиска TabSet в наборе атрибутов элемента абзаца. Если один будет найден, его настройки будут использованы, в противном случае будет предоставлено расширение по умолчанию. Базовое положение для расширения табуляции — это отступ слева от последнего выделения абзаца (на котором основана выкладка дочерних элементов).

Определяет:

nextTabStop в интерфейсе TabExpander

Параметры:

x - текущая позиция X

tabOffset - позиция в потоке текста, в которой произошла табуляция >= 0

Возвращает:

конечная точка расширения табуляции >= 0

См. также:

getTabSet

protected TabSet getTabSet()

Возвращает Tabset для расчёта табуляций.

Возвращает:: TabSet

getPartialSize

protected float getPartialSize(int startOffset, int endOffset)

Возвращает размер, используемый представлениями между startOffset и endOffset. Используется getPartialView для расчёта размера, если дочернее представление реализует интерфейс TabableView. Если нужен размер, а дочернее представление не реализует интерфейс TabableView, будет использован preferredSpan.

Параметры:: startOffset - начальный смещение в документе >= 0; endOffset - конечный смещение в документе >= startOffset
Возвращает:: размер >= 0

findOffsetToCharactersInString

protected int findOffsetToCharactersInString(char[] string, int start)

Находит следующий символ в документе с символом в string, начиная с смещения start. Если символы не найдены, возвращается -1.

Параметры:: string - строка символов; start - с чего начать в модели >= 0
Возвращает:: смещение в документе или -1, если символы не найдены

getTabBase

protected float getTabBase()

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

Возвращает:: откуда рассчитываются табуляции

paint

public void paint(Graphics g, Shape a)

Отображает с использованием заданной поверхности рендеринга и области на этой поверхности. Это реализовано для делегирования суперклассу после сохранения базовой координаты для расчета табуляций.

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

paint в классе BoxView

Параметры:

g - поверхность рендеринга для использования

a - выделенная область для рендеринга

См. также:

View.paint(java.awt.Graphics, java.awt.Shape)

getAlignment

public float getAlignment(int axis)

Определяет желаемое выравнивание для этого представления вдоль оси. Это реализовано для задания выравнивания по центру первой строки по оси y и по умолчанию по оси x.

Переопределяет:: getAlignment в классе BoxView
Параметры:: axis - может быть либо View.X_AXIS или View.Y_AXIS
Возвращает:: желаемое выравнивание. Оно должно быть значением от 0,0 до 1,0 включительно, где 0 указывает выравнивание по началу координат, а 1,0 указывает выравнивание по всей ширине от начала координат. Выравнивание 0,5 соответствует центру представления.

breakView

public View breakView(int axis, float len, Shape a)

Разбивает это представление по заданной оси в заданной длине.

ParagraphView экземпляры разбиваются только по оси Y_AXIS, и только если len находится после первой строки.

Параметры:

axis - может быть либо View.X_AXIS или View.Y_AXIS

len - указывает, где желательно разбиение вдоль заданной оси >= 0

a - текущее выделение представления

Возвращает:

фрагмент представления, представляющий заданный диапазон, если представление может быть разбито; если представление не поддерживает поведение разбивки, возвращается само представление

См. также:

View.breakView(int, int, float, float)

getBreakWeight

public int getBreakWeight(int axis, float len)

Получает вес разбиения для заданного расположения.

ParagraphView экземпляры разбиваются только по оси Y_AXIS, и только если len находится после первой строки. Если длина меньше одной строки, возвращается значение BadBreakWeight.

Параметры:

axis - может быть либо View.X_AXIS или View.Y_AXIS

len - указывает, где желательно разбиение >= 0

Возвращает:

значение, указывающее привлекательность разбиения здесь; либо GoodBreakWeight или BadBreakWeight

См. также:

View.getBreakWeight(int, float, float)

calculateMinorAxisRequirements

protected SizeRequirements calculateMinorAxisRequirements(int axis, SizeRequirements r)

Вычисление потребностей абзаца вдоль малой оси.

Использует требования к размеру суперкласса, измененные с учетом неразбиваемых областей на краях смежных представлений. Минимальные требования к размеру таких представлений не должны быть меньше суммы всех смежных фрагментов.

Если параметр axis не равен ни View.X_AXIS, ни View.Y_AXIS, выбрасывается IllegalArgumentException. Если параметр r равен null,, создается новый объект SizeRequirements, в противном случае возвращается предоставленный объект SizeRequirements.

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

calculateMinorAxisRequirements в классе FlowView

Параметры:

axis - малая ось

r - входной объект SizeRequirements

Возвращает:

новый или измененный объект SizeRequirements

Выбрасывает:

IllegalArgumentException - если параметр axis некорректен

См. также:

SizeRequirements

changedUpdate

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

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

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

changedUpdate в классе FlowView

Параметры:

changes - информация о изменении из связанного документа

a - текущее выделение представления

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

См. также:

View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

© 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/ParagraphView.html