Класс WrappedPlainView

Все реализованные интерфейсы:
SwingConstants, TabExpander
public class WrappedPlainView
extends BoxView
implements TabExpander

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

Представления строк выполняют всю свою отрисовку через метод drawLine, который в свою очередь выполняет всю отрисовку через методы drawSelectedText и drawUnselectedText. Это позволяет подклассам легко специализировать отрисовку, не беспокоясь о аспектах макета.

См. также:
View

Поля

Поля, объявленные в классе 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

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

Конструктор Описание
WrappedPlainView​(Element elem)

Создаёт новый WrappedPlainView.

WrappedPlainView​(Element elem, boolean wordWrap)

Создаёт новый WrappedPlainView.

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

Модификатор и тип Метод Описание
protected int calculateBreakPosition​(int p0, int p1)

Вызывается вложенными представлениями обернутых строк для определения места разрыва.

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

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

protected void drawLine​(int p0, int p1, Graphics2D g, float x, float y)

Отображает строку текста, подавляя пробелы в конце и расширяя табуляции.

protected void drawLine​(int p0, int p1, Graphics g, int x, int y)

Устарело.

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)

Устарело.

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)

Устарело.

protected Segment getLineBuffer()

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

float getMaximumSpan​(int axis)

Определяет максимальную ширину этого представления вдоль оси.

float getMinimumSpan​(int axis)

Определяет минимальную ширину этого представления вдоль оси.

float getPreferredSpan​(int axis)

Определяет предпочтительную ширину этого представления вдоль оси.

protected int getTabSize()

Возвращает размер табуляции, заданный для документа, по умолчанию 8.

void insertUpdate​(DocumentEvent e, Shape a, ViewFactory f)

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

protected void loadChildren​(ViewFactory f)

Загружает все дочерние элементы для инициализации представления.

float nextTabStop​(float x, int tabOffset)

Возвращает следующую позицию табуляции после заданной опорной позиции.

void paint​(Graphics g, Shape a)

Отображает используя заданную поверхность отрисовки и область на этой поверхности.

void removeUpdate​(DocumentEvent e, Shape a, ViewFactory f)

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

void setSize​(float width, float height)

Устанавливает размер представления.

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

baselineLayout, baselineRequirements, calculateMajorAxisRequirements, calculateMinorAxisRequirements, childAllocation, flipEastAndWestAtEnds, forwardUpdate, getAlignment, getAxis, getChildAllocation, getHeight, getOffset, getResizeWeight, getSpan, getViewAtPoint, getWidth, isAfter, isAllocationValid, isBefore, isLayoutValid, layout, layoutChanged, layoutMajorAxis, layoutMinorAxis, modelToView, paintChild, preferenceChanged, replace, setAxis, viewToModel

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

getBottomInset, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextNorthSouthVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewAtPosition, getViewCount, getViewIndex, getViewIndexAtPosition, 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

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

WrappedPlainView

public WrappedPlainView(Element elem)

Создаёт новый WrappedPlainView. Строки будут переноситься по границам символов.

Параметры:
elem - элемент, лежащий в основе представления

WrappedPlainView

public WrappedPlainView(Element elem,
                        boolean wordWrap)

Создаёт новый WrappedPlainView. Строки могут переноситься по границам либо символов, либо слов в зависимости от параметра wordWrap.

Параметры:
elem - элемент, лежащий в основе представления
wordWrap - должны ли строки переноситься по границам слов?

Методы

getTabSize

protected int getTabSize()

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

Возвращает:
размер табуляции

drawLine

@Deprecated(since="9")
protected void drawLine(int p0,
                        int p1,
                        Graphics g,
                        int x,
                        int y)
Устаревший.

Отображает строку текста, подавляя пробелы в конце и расширяя табуляции. Это реализовано для вызовов методов drawUnselectedText и drawSelectedText, чтобы можно было настроить отображение выделенного и невыделенного текста.

Параметры:
p0 - начальная позиция в документе >= 0
p1 - конечная позиция в документе >= p1
g - контекст графики
x - начальная позиция X >= 0
y - начальная позиция Y >= 0
См. также:
drawUnselectedText(java.awt.Graphics, int, int, int, int), drawSelectedText(java.awt.Graphics, int, int, int, int)

drawLine

protected void drawLine(int p0,
                        int p1,
                        Graphics2D g,
                        float x,
                        float y)

Отображает строку текста, подавляя пробелы в конце и расширяя табуляции. Это реализовано для вызовов методов drawUnselectedText и drawSelectedText, чтобы можно было настроить отображение выделенного и невыделенного текста.

Параметры:
p0 - начальная позиция в документе >= 0
p1 - конечная позиция в документе >= p1
g - контекст графики
x - начальная позиция X >= 0
y - начальная позиция Y >= 0
С:
9
См. также:
drawUnselectedText(java.awt.Graphics, int, int, int, int), drawSelectedText(java.awt.Graphics, int, int, int, int)

drawUnselectedText

@Deprecated(since="9")
protected int drawUnselectedText(Graphics g,
                                 int x,
                                 int y,
                                 int p0,
                                 int p1)
                          throws BadLocationException
Устаревший.

Отображает заданный диапазон в модели как обычный невыделенный текст.

Параметры:
g - контекст графики
x - начальная координата X >= 0
y - начальная координата Y >= 0
p0 - начальная позиция в модели >= 0
p1 - конечная позиция в модели >= p0
Возвращает:
координата 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 - конечная позиция в модели >= p0
Возвращает:
координата X конца диапазона >= 0
Исключение:
BadLocationException - если диапазон некорректен
С:
9

drawSelectedText

@Deprecated(since="9")
protected int drawSelectedText(Graphics g,
                               int x,
                               int y,
                               int p0,
                               int p1)
                        throws BadLocationException
Устаревший.

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

Параметры:
g - контекст графики
x - начальная координата X >= 0
y - начальная координата Y >= 0
p0 - начальная позиция в модели >= 0
p1 - конечная позиция в модели >= p0
Возвращает:
позицию конца диапазона.
Исключение:
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 - конечная позиция в модели >= p0
Возвращает:
позицию конца диапазона.
Исключение:
BadLocationException - если диапазон некорректен
С:
9

getLineBuffer

protected final Segment getLineBuffer()

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

Возвращает:
буфер

calculateBreakPosition

protected int calculateBreakPosition(int p0,
                                     int p1)

Вызывается вложенными представлениями строк для определения позиции разрыва. Это можно переопределить, чтобы изменить поведение разрыва. Разрыв происходит либо по границам слов, либо по границам символов в зависимости от аргумента break, заданного при создании.

Параметры:
p0 - начальная позиция в документе
p1 - конечная позиция в документе для использования
Возвращает:
позиция разрыва

loadChildren

protected void loadChildren(ViewFactory f)

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

Переопределяет:
loadChildren в классе CompositeView
Параметры:
f - фабрика представлений
См. также:
CompositeView.setParent(javax.swing.text.View)

nextTabStop

public float nextTabStop(float x,
                         int tabOffset)

Возвращает позицию следующей табуляции после заданной позиции. Эта реализация не поддерживает такие вещи, как центрирование, поэтому аргумент tabOffset игнорируется.

Определяется:
nextTabStop в интерфейсе TabExpander
Параметры:
x - текущая позиция >= 0
tabOffset - позиция в потоке текста, где произошла табуляция >= 0.
Возвращает:
позицию табуляции, измеряемую в пунктах >= 0

paint

public void paint(Graphics g,
                  Shape a)

Отображает с помощью заданной поверхности отрисовки и области на этой поверхности. Эта реализация сохраняет позиции выделения, цвета выделения и метрики шрифта для использования вложенными строками.

Переопределяет:
paint в классе BoxView
Параметры:
g - поверхность отрисовки для использования
a - выделенная область для отрисовки
См. также:
View.paint(java.awt.Graphics, java.awt.Shape)

setSize

public void setSize(float width,
                    float height)

Устанавливает размер представления. Это должно вызвать расположение представления вдоль заданной оси, если у него есть обязанности по расположению.

Переопределяет:
setSize в классе BoxView
Параметры:
width - ширина >= 0
height - высота >= 0

getPreferredSpan

public float getPreferredSpan(int axis)

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

Переопределяет:
getPreferredSpan в классе BoxView
Параметры:
axis - может быть либо View.X_AXIS, либо View.Y_AXIS
Возвращает:
размер, который представление хотело бы отобразить. Обычно представлению говорят отобразиться в этом размере, хотя никакой гарантии нет. Родитель может изменить размер или разбить представление.
См. также:
View.getPreferredSpan(int)

getMinimumSpan

public float getMinimumSpan(int axis)

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

Переопределяет:
getMinimumSpan в классе BoxView
Параметры:
axis - может быть либо View.X_AXIS, либо View.Y_AXIS
Возвращает:
размер, который представление хотело бы отобразить. Обычно представлению говорят отобразиться в этом размере, хотя никакой гарантии нет. Родитель может изменить размер или разбить представление.
См. также:
View.getMinimumSpan(int)

getMaximumSpan

public float getMaximumSpan(int axis)

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

Переопределяет:
getMaximumSpan в классе BoxView
Параметры:
axis - может быть либо View.X_AXIS, либо View.Y_AXIS
Возвращает:
размер, который представление хотело бы отобразить. Обычно представлению говорят отобразиться в этом размере, хотя никакой гарантии нет. Родитель может изменить размер или разбить представление.
См. также:
View.getMaximumSpan(int)

insertUpdate

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

Уведомляет о том, что что-то было вставлено в документ в место, за которое отвечает этот вид. Это реализовано для простого обновления дочерних элементов.

Overrides:
insertUpdate в классе View
Параметры:
e - информация о изменении из связанного документа
a - текущее распределение вида
f - фабрика для использования при перестроении, если вид имеет дочерние элементы
См. также:
View.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

removeUpdate

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

Уведомляет о том, что что-то было удалено из документа в место, за которое отвечает этот вид. Это реализовано для простого обновления дочерних элементов.

Overrides:
removeUpdate в классе View
Параметры:
e - информация о изменении из связанного документа
a - текущее распределение вида
f - фабрика для использования при перестроении, если вид имеет дочерние элементы
См. также:
View.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

changedUpdate

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

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

Overrides:
changedUpdate в классе View
Параметры:
e - информация о изменении из связанного документа
a - текущее распределение вида
f - фабрика для использования при перестроении, если вид имеет дочерние элементы
См. также:
View.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)

© 1993, 2020, 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/11/docs/api/java.desktop/javax/swing/text/WrappedPlainView.html

Spec-Zone .ru
спецификации, руководства, описания, API