SwingConstants
, TabExpander
ParagraphView
public class ParagraphView extends FlowView implements TabExpander
breakView
method is called to try and carve the view into pieces that fit.FlowView.FlowStrategy
Modifier and Type | Field | Description |
---|---|---|
protected int |
firstLineIndent |
Indentation for the first line, from the left inset. |
layoutPool, layoutSpan, strategy
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
Constructor | Description |
---|---|
ParagraphView |
Constructs a ParagraphView for the given element. |
Modifier and Type | Method | Description |
---|---|---|
View |
breakView |
Breaks this view on the given axis at the given length. |
protected SizeRequirements |
calculateMinorAxisRequirements |
Calculate the needs for the paragraph along the minor axis. |
void |
changedUpdate |
Gives notification from the document that attributes were changed in a location that this view is responsible for. |
protected View |
createRow() |
Create a View that should be used to hold a a row's worth of children in a flow. |
protected int |
findOffsetToCharactersInString |
Finds the next character in the document with a character in string , starting at offset start . |
protected boolean |
flipEastAndWestAtEnds |
Determines in which direction the next view lays. |
float |
getAlignment |
Determines the desired alignment for this view along an axis. |
int |
getBreakWeight |
Gets the break weight for a given location. |
protected int |
getClosestPositionTo |
Returns the closest model position to x . |
int |
getFlowSpan |
Fetches the constraining span to flow against for the given child index. |
int |
getFlowStart |
Fetches the location along the flow axis that the flow span will start at. |
protected View |
getLayoutView |
Returns the view at a given index . |
protected int |
getLayoutViewCount() |
Returns the number of views that this view is responsible for. |
protected int |
getNextNorthSouthVisualPositionFrom |
Returns the next visual position for the cursor, in either the east or west direction. |
protected float |
getPartialSize |
Returns the size used by the views between startOffset and endOffset . |
protected float |
getTabBase() |
Returns where the tabs are calculated from. |
protected TabSet |
getTabSet() |
Gets the Tabset to be used in calculating tabs. |
float |
nextTabStop |
Returns the next tab stop position given a reference position. |
void |
paint |
Renders using the given rendering surface and area on that surface. |
protected void |
setFirstLineIndent |
Sets the indent on the first line. |
protected void |
setJustification |
Sets the type of justification. |
protected void |
setLineSpacing |
Sets the line spacing. |
protected void |
setPropertiesFromAttributes() |
Set the cached properties from the attributes. |
getFlowAxis, getViewIndexAtPosition, insertUpdate, layout, loadChildren, removeUpdate
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
getBottomInset, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewAtPosition, getViewCount, getViewIndex, modelToView, setInsets, setParagraphInsets, setParent
append, breakView, createFragment, forwardUpdateToView, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getGraphics, getParent, getStartOffset, getToolTipText, getViewFactory, getViewIndex, insert, isVisible, modelToView, remove, removeAll, updateChildren, updateLayout, viewToModel
protected int firstLineIndent
public ParagraphView(Element elem)
ParagraphView
for the given element.elem
- the element that this view is responsible forprotected void setJustification(int j)
j
- one of the following values: StyleConstants.ALIGN_LEFT
StyleConstants.ALIGN_CENTER
StyleConstants.ALIGN_RIGHT
protected void setLineSpacing(float ls)
ls
- the value is a factor of the line heightprotected void setFirstLineIndent(float fi)
fi
- the value in pointsprotected void setPropertiesFromAttributes()
protected int getLayoutViewCount()
View
s that represent the child elements. This is the number of views that have been tiled in two dimensions, and should be equivalent to the number of child elements to the element this view is responsible for.ParagraphView
is responsible forprotected View getLayoutView(int index)
index
. The child views of the paragraph are rows which have been used to arrange pieces of the Views
that represent the child elements. This methods returns the view responsible for the child element index (prior to breaking). These are the Views that were produced from a factory (to represent the child elements) and used for layout.index
- the index
of the desired viewindex
protected int getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException
CompositeView
.getNextNorthSouthVisualPositionFrom
in class CompositeView
pos
- position into the modelb
- either Position.Bias.Forward
or Position.Bias.Backward
a
- the allocated region to render intodirection
- either SwingConstants.NORTH
or SwingConstants.SOUTH
biasRet
- an array containing the bias that were checked in this methodBadLocationException
- for a bad location within a document modelprotected int getClosestPositionTo(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet, int rowIndex, int x) throws BadLocationException
x
. rowIndex
gives the index of the view that corresponds that should be looked in.pos
- position into the modelb
- the biasa
- the allocated region to render intodirection
- one of the following values: SwingConstants.NORTH
SwingConstants.SOUTH
biasRet
- an array containing the bias that were checked in this methodrowIndex
- the index of the viewx
- the x coordinate of interestx
BadLocationException
- if a bad location is encounteredprotected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)
View
at index n. Typically the View
s are laid out from left to right, so that the View
to the EAST will be at index n + 1, and the View
to the WEST will be at index n - 1. In certain situations, such as with bidirectional text, it is possible that the View
to EAST is not at index n + 1, but rather at index n - 1, or that the View
to the WEST is not at index n - 1, but index n + 1. In this case this method would return true, indicating the View
s are laid out in descending order. This will return true if the text is laid out right to left at position, otherwise false.
flipEastAndWestAtEnds
in class BoxView
position
- position into the modelbias
- either Position.Bias.Forward
or Position.Bias.Backward
public int getFlowSpan(int index)
getFlowSpan
in class FlowView
index
- the index of the view being queriedindex
public int getFlowStart(int index)
getFlowStart
in class FlowView
index
- the index of the view being queriedindex
protected View createRow()
View
that should be used to hold a a row's worth of children in a flow.public float nextTabStop(float x, int tabOffset)
getTabbedSpan
on the logical children in the process of layout to determine the desired span of the children. The logical children can delegate their tab expansion upward to the paragraph which knows how to expand tabs. LabelView
is an example of a view that delegates its tab expansion needs upward to the paragraph. This is implemented to try and locate a TabSet
in the paragraph element's attribute set. If one can be found, its settings will be used, otherwise a default expansion will be provided. The base location for tab expansion is the left inset from the paragraphs most recent allocation (which is what the layout of the children is based upon).
nextTabStop
in interface TabExpander
x
- the X reference positiontabOffset
- the position within the text stream that the tab occurred at >= 0protected TabSet getTabSet()
Tabset
to be used in calculating tabs.TabSet
protected float getPartialSize(int startOffset, int endOffset)
startOffset
and endOffset
. This uses getPartialView
to calculate the size if the child view implements the TabableView
interface. If a size is needed and a View
does not implement the TabableView
interface, the preferredSpan
will be used.startOffset
- the starting document offset >= 0endOffset
- the ending document offset >= startOffsetprotected int findOffsetToCharactersInString(char[] string, int start)
string
, starting at offset start
. If there are no characters found, -1 will be returned.string
- the string of charactersstart
- where to start in the model >= 0protected float getTabBase()
public void paint(Graphics g, Shape a)
public float getAlignment(int axis)
getAlignment
in class BoxView
axis
- may be either View.X_AXIS
or View.Y_AXIS
public View breakView(int axis, float len, Shape a)
ParagraphView
instances are breakable along the Y_AXIS
only, and only if len
is after the first line.
axis
- may be either View.X_AXIS
or View.Y_AXIS
len
- specifies where a potential break is desired along the given axis >= 0a
- the current allocation of the viewpublic int getBreakWeight(int axis, float len)
ParagraphView
instances are breakable along the Y_AXIS
only, and only if len
is after the first row. If the length is less than one row, a value of BadBreakWeight
is returned.
axis
- may be either View.X_AXIS
or View.Y_AXIS
len
- specifies where a potential break is desired >= 0GoodBreakWeight
or BadBreakWeight
protected SizeRequirements calculateMinorAxisRequirements(int axis, SizeRequirements r)
This uses size requirements of the superclass, modified to take into account the non-breakable areas at the adjacent views edges. The minimal size requirements for such views should be no less than the sum of all adjacent fragments.
If the axis
parameter is neither View.X_AXIS
nor View.Y_AXIS
, IllegalArgumentException
is thrown. If the r
parameter is null,
a new SizeRequirements
object is created, otherwise the supplied SizeRequirements
object is returned.
calculateMinorAxisRequirements
in class FlowView
axis
- the minor axisr
- the input SizeRequirements
objectSizeRequirements
objectIllegalArgumentException
- if the axis
parameter is invalidpublic void changedUpdate(DocumentEvent changes, Shape a, ViewFactory f)
changedUpdate
in class FlowView
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children
© 1993, 2023, 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/21/docs/api/java.desktop/javax/swing/text/ParagraphView.html