Class ParagraphView
- All Implemented Interfaces:
SwingConstants, TabExpander
- Direct Known Subclasses:
ParagraphView
public class ParagraphView extends FlowView implements TabExpander
breakView method is called to try and carve the view into pieces that fit.- See Also:
Nested Class Summary
Nested classes/interfaces declared in class FlowView
FlowView.FlowStrategy | Modifier and Type | Class | Description |
|---|---|---|
static class |
FlowView.FlowStrategy |
Strategy for maintaining the physical form of the flow. |
Field Summary
| Modifier and Type | Field | Description |
|---|---|---|
protected int |
firstLineIndent |
Indentation for the first line, from the left inset. |
Fields declared in class FlowView
layoutPool, layoutSpan, strategy | Modifier and Type | Field | Description |
|---|---|---|
protected View |
layoutPool |
These are the views that represent the child elements of the element this view represents (The logical view to translate to a physical view). |
protected int |
layoutSpan |
Default constraint against which the flow is created against. |
protected FlowView.FlowStrategy |
strategy |
The behavior for keeping the flow updated. |
Fields declared in class View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS | Modifier and Type | Field | Description |
|---|---|---|
static final int |
BadBreakWeight |
The weight to indicate a view is a bad break opportunity for the purpose of formatting. |
static final int |
ExcellentBreakWeight |
The weight to indicate a view supports breaking, and this represents a very attractive place to break. |
static final int |
ForcedBreakWeight |
The weight to indicate a view supports breaking, and must be broken to be represented properly when placed in a view that formats its children by breaking them. |
static final int |
GoodBreakWeight |
The weight to indicate a view supports breaking, but better opportunities probably exist. |
static final int |
X_AXIS |
Axis for format/break operations. |
static final int |
Y_AXIS |
Axis for format/break operations. |
Fields declared in interface SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST | Modifier and Type | Field | Description |
|---|---|---|
static final int |
BOTTOM |
Box-orientation constant used to specify the bottom of a box. |
static final int |
CENTER |
The central position in an area. |
static final int |
EAST |
Compass-direction east (right). |
static final int |
HORIZONTAL |
Horizontal orientation. |
static final int |
LEADING |
Identifies the leading edge of text for use with left-to-right and right-to-left languages. |
static final int |
LEFT |
Box-orientation constant used to specify the left side of a box. |
static final int |
NEXT |
Identifies the next direction in a sequence. |
static final int |
NORTH |
Compass-direction North (up). |
static final int |
NORTH_EAST |
Compass-direction north-east (upper right). |
static final int |
NORTH_WEST |
Compass-direction north west (upper left). |
static final int |
PREVIOUS |
Identifies the previous direction in a sequence. |
static final int |
RIGHT |
Box-orientation constant used to specify the right side of a box. |
static final int |
SOUTH |
Compass-direction south (down). |
static final int |
SOUTH_EAST |
Compass-direction south-east (lower right). |
static final int |
SOUTH_WEST |
Compass-direction south-west (lower left). |
static final int |
TOP |
Box-orientation constant used to specify the top of a box. |
static final int |
TRAILING |
Identifies the trailing edge of text for use with left-to-right and right-to-left languages. |
static final int |
VERTICAL |
Vertical orientation. |
static final int |
WEST |
Compass-direction west (left). |
Constructor Summary
| Constructor | Description |
|---|---|
ParagraphView |
Constructs a ParagraphView for the given element. |
Method Summary
| 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. |
Methods declared in class FlowView
getFlowAxis, getViewIndexAtPosition, insertUpdate, layout, loadChildren, removeUpdate | Modifier and Type | Method | Description |
|---|---|---|
int |
getFlowAxis() |
Fetches the axis along which views should be flowed. |
protected int |
getViewIndexAtPosition |
Fetches the child view index representing the given position in the model. |
void |
insertUpdate |
Gives notification that something was inserted into the document in a location that this view is responsible for. |
protected void |
layout |
Lays out the children. |
protected void |
loadChildren |
Loads all of the children to initialize the view. |
void |
removeUpdate |
Gives notification that something was removed from the document in a location that this view is responsible for. |
Methods declared in class 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 | Modifier and Type | Method | Description |
|---|---|---|
protected void |
baselineLayout |
Computes the location and extent of each child view in this BoxView given the targetSpan, which is the width (or height) of the region we have to work with. |
protected SizeRequirements |
baselineRequirements |
Calculates the size requirements for this BoxView by examining the size of each child view. |
protected SizeRequirements |
calculateMajorAxisRequirements |
Calculates the size requirements for the major axis axis. |
protected void |
childAllocation |
Allocates a region for a child view. |
protected void |
forwardUpdate |
Forwards the given DocumentEvent to the child views that need to be notified of the change to the model. |
int |
getAxis() |
Fetches the tile axis property. |
Shape |
getChildAllocation |
Fetches the allocation for the given child view. |
int |
getHeight() |
Returns the current height of the box. |
float |
getMaximumSpan |
Determines the maximum span for this view along an axis. |
float |
getMinimumSpan |
Determines the minimum span for this view along an axis. |
protected int |
getOffset |
Fetches the offset of a particular child's current layout. |
float |
getPreferredSpan |
Determines the preferred span for this view along an axis. |
int |
getResizeWeight |
Gets the resize weight. |
protected int |
getSpan |
Fetches the span of a particular child's current layout. |
protected View |
getViewAtPoint |
Fetches the child view at the given coordinates. |
int |
getWidth() |
Returns the current width of the box. |
protected boolean |
isAfter |
Determines if a point falls after an allocated region. |
protected boolean |
isAllocationValid() |
Are the allocations for the children still valid? |
protected boolean |
isBefore |
Determines if a point falls before an allocated region. |
protected boolean |
isLayoutValid |
Determines if the layout is valid along the given axis. |
void |
layoutChanged |
Invalidates the layout along an axis. |
protected void |
layoutMajorAxis |
Performs layout for the major axis of the box (i.e. the axis that it represents). |
protected void |
layoutMinorAxis |
Performs layout for the minor axis of the box (i.e. the axis orthogonal to the axis that it represents). |
Shape |
modelToView |
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it. |
protected void |
paintChild |
Paints a child. |
void |
preferenceChanged |
This is called by a child to indicate its preferred span has changed. |
void |
replace |
Invalidates the layout and resizes the cache of requests/allocations. |
void |
setAxis |
Sets the tile axis property. |
void |
setSize |
Sets the size of the view. |
int |
viewToModel |
Provides a mapping from the view coordinate space to the logical coordinate space of the model. |
Methods declared in class CompositeView
getBottomInset, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewAtPosition, getViewCount, getViewIndex, modelToView, setInsets, setParagraphInsets, setParent | Modifier and Type | Method | Description |
|---|---|---|
protected short |
getBottomInset() |
Gets the bottom inset. |
protected Rectangle |
getInsideAllocation |
Translates the immutable allocation given to the view to a mutable allocation that represents the interior allocation (i.e. the bounds of the given allocation with the top, left, bottom, and right insets removed. |
protected short |
getLeftInset() |
Gets the left inset. |
protected int |
getNextEastWestVisualPositionFrom |
Returns the next visual position for the cursor, in either the east or west direction. |
int |
getNextVisualPositionFrom |
Provides a way to determine the next visually represented model location that one might place a caret. |
protected short |
getRightInset() |
Gets the right inset. |
protected short |
getTopInset() |
Gets the top inset. |
View |
getView |
Returns the n-th view in this container. |
protected View |
getViewAtPosition |
Fetches the child view that represents the given position in the model. |
int |
getViewCount() |
Returns the number of child views of this view. |
int |
getViewIndex |
Returns the child view index representing the given position in the model. |
Shape |
modelToView |
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it. |
protected void |
setInsets |
Sets the insets for the view. |
protected void |
setParagraphInsets |
Sets the insets from the paragraph attributes specified in the given attributes. |
void |
setParent |
Sets the parent of the view. |
Methods declared in class 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 | Modifier and Type | Method | Description |
|---|---|---|
void |
append |
Appends a single child view. |
View |
breakView |
Tries to break this view on the given axis. |
View |
createFragment |
Creates a view that represents a portion of the element. |
protected void |
forwardUpdateToView |
Forwards the DocumentEvent to the give child view. |
AttributeSet |
getAttributes() |
Fetches the attributes to use when rendering. |
int |
getBreakWeight |
Determines how attractive a break opportunity in this view is. |
Container |
getContainer() |
Fetches the container hosting the view. |
Document |
getDocument() |
Fetches the model associated with the view. |
Element |
getElement() |
Fetches the structural portion of the subject that this view is mapped to. |
int |
getEndOffset() |
Fetches the portion of the model for which this view is responsible. |
Graphics |
getGraphics() |
Fetch a Graphics for rendering. |
View |
getParent() |
Returns the parent of the view. |
int |
getStartOffset() |
Fetches the portion of the model for which this view is responsible. |
String |
getToolTipText |
Returns the tooltip text at the specified location. |
ViewFactory |
getViewFactory() |
Fetches the ViewFactory implementation that is feeding the view hierarchy. |
int |
getViewIndex |
Returns the child view index representing the given position in the view. |
void |
insert |
Inserts a single child view. |
boolean |
isVisible() |
Returns a boolean that indicates whether the view is visible or not. |
Shape |
modelToView |
Deprecated. |
void |
remove |
Removes one of the children at the given position. |
void |
removeAll() |
Removes all of the children. |
protected boolean |
updateChildren |
Updates the child views in response to receiving notification that the model changed, and there is change record for the element this view is responsible for. |
protected void |
updateLayout |
Updates the layout in response to receiving notification of change from the model. |
int |
viewToModel |
Deprecated. |
Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | Modifier and Type | Method | Description |
|---|---|---|
protected Object |
clone() |
Creates and returns a copy of this object. |
boolean |
equals |
Indicates whether some other object is "equal to" this one. |
protected void |
finalize() |
Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release. |
final Class |
getClass() |
Returns the runtime class of this Object. |
int |
hashCode() |
Returns a hash code value for this object. |
final void |
notify() |
Wakes up a single thread that is waiting on this object's monitor. |
final void |
notifyAll() |
Wakes up all threads that are waiting on this object's monitor. |
String |
toString() |
Returns a string representation of the object. |
final void |
wait() |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
Field Details
firstLineIndent
protected int firstLineIndent
Constructor Details
ParagraphView
public ParagraphView(Element elem)
ParagraphView for the given element.- Parameters:
-
elem- the element that this view is responsible for
Method Details
setJustification
protected void setJustification(int j)
- Parameters:
-
j- one of the following values:-
StyleConstants.ALIGN_LEFT -
StyleConstants.ALIGN_CENTER -
StyleConstants.ALIGN_RIGHT
-
setLineSpacing
protected void setLineSpacing(float ls)
- Parameters:
-
ls- the value is a factor of the line height
setFirstLineIndent
protected void setFirstLineIndent(float fi)
- Parameters:
-
fi- the value in points
setPropertiesFromAttributes
protected void setPropertiesFromAttributes()
getLayoutViewCount
protected int getLayoutViewCount()
Views 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.- Returns:
- the number of views that this
ParagraphViewis responsible for
getLayoutView
protected 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.- Parameters:
-
index- theindexof the desired view - Returns:
- the view at
index
getNextNorthSouthVisualPositionFrom
protected int getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) throws BadLocationException
CompositeView.- Overrides:
-
getNextNorthSouthVisualPositionFromin classCompositeView - Parameters:
-
pos- position into the model -
b- eitherPosition.Bias.ForwardorPosition.Bias.Backward -
a- the allocated region to render into -
direction- eitherSwingConstants.NORTHorSwingConstants.SOUTH -
biasRet- an array containing the bias that were checked in this method - Returns:
- the location in the model that represents the next location visual position
- Throws:
-
BadLocationException- for a bad location within a document model - See Also:
getClosestPositionTo
protected 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.- Parameters:
-
pos- position into the model -
b- the bias -
a- the allocated region to render into -
direction- one of the following values:-
SwingConstants.NORTH -
SwingConstants.SOUTH
-
-
biasRet- an array containing the bias that were checked in this method -
rowIndex- the index of the view -
x- the x coordinate of interest - Returns:
- the closest model position to
x - Throws:
-
BadLocationException- if a bad location is encountered
flipEastAndWestAtEnds
protected boolean flipEastAndWestAtEnds(int position, Position.Bias bias)
View at index n. Typically the Views 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 Views are laid out in descending order. This will return true if the text is laid out right to left at position, otherwise false.
- Overrides:
-
flipEastAndWestAtEndsin classBoxView - Parameters:
-
position- position into the model -
bias- eitherPosition.Bias.ForwardorPosition.Bias.Backward - Returns:
- true if the text is laid out right to left at position, otherwise false.
getFlowSpan
public int getFlowSpan(int index)
- Overrides:
-
getFlowSpanin classFlowView - Parameters:
-
index- the index of the view being queried - Returns:
- the constraining span for the given view at
index - Since:
- 1.3
- See Also:
getFlowStart
public int getFlowStart(int index)
- Overrides:
-
getFlowStartin classFlowView - Parameters:
-
index- the index of the view being queried - Returns:
- the location for the given view at
index - Since:
- 1.3
- See Also:
createRow
nextTabStop
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).
- Specified by:
-
nextTabStopin interfaceTabExpander - Parameters:
-
x- the X reference position -
tabOffset- the position within the text stream that the tab occurred at >= 0 - Returns:
- the trailing end of the tab expansion >= 0
- See Also:
getTabSet
protected TabSet getTabSet()
Tabset to be used in calculating tabs.- Returns:
- the
TabSet
getPartialSize
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.- Parameters:
-
startOffset- the starting document offset >= 0 -
endOffset- the ending document offset >= startOffset - Returns:
- the size >= 0
findOffsetToCharactersInString
protected int findOffsetToCharactersInString(char[] string, int start)
string, starting at offset start. If there are no characters found, -1 will be returned.- Parameters:
-
string- the string of characters -
start- where to start in the model >= 0 - Returns:
- the document offset, or -1 if no characters found
getTabBase
protected float getTabBase()
- Returns:
- where tabs are calculated from
paint
public void paint(Graphics g, Shape a)
getAlignment
public float getAlignment(int axis)
- Overrides:
-
getAlignmentin classBoxView - Parameters:
-
axis- may be eitherView.X_AXISorView.Y_AXIS - Returns:
- the desired alignment. This should be a value between 0.0 and 1.0 inclusive, where 0 indicates alignment at the origin and 1.0 indicates alignment to the full span away from the origin. An alignment of 0.5 would be the center of the view.
breakView
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.
- Parameters:
-
axis- may be eitherView.X_AXISorView.Y_AXIS -
len- specifies where a potential break is desired along the given axis >= 0 -
a- the current allocation of the view - Returns:
- the fragment of the view that represents the given span, if the view can be broken; if the view doesn't support breaking behavior, the view itself is returned
- See Also:
getBreakWeight
public 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.
- Parameters:
-
axis- may be eitherView.X_AXISorView.Y_AXIS -
len- specifies where a potential break is desired >= 0 - Returns:
- a value indicating the attractiveness of breaking here; either
GoodBreakWeightorBadBreakWeight - See Also:
calculateMinorAxisRequirements
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.
- Overrides:
-
calculateMinorAxisRequirementsin classFlowView - Parameters:
-
axis- the minor axis -
r- the inputSizeRequirementsobject - Returns:
- the new or adjusted
SizeRequirementsobject - Throws:
-
IllegalArgumentException- if theaxisparameter is invalid - See Also:
changedUpdate
public void changedUpdate(DocumentEvent changes, Shape a, ViewFactory f)
- Overrides:
-
changedUpdatein classFlowView - Parameters:
-
changes- the change information from the associated document -
a- the current allocation of the view -
f- the factory to use to rebuild if the view has children - See Also:
© 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.