Class ParagraphView
java.lang.Object
javax.swing.text.View
javax.swing.text.CompositeView
javax.swing.text.BoxView
javax.swing.text.FlowView
javax.swing.text.ParagraphView
javax.swing.text.html.ParagraphView
- All Implemented Interfaces:
SwingConstants, TabExpander
Displays the paragraph and uses CSS attributes for its
configuration.
-
Nested Class Summary
Nested classes/interfaces declared in class FlowView
FlowView.FlowStrategy
Modifier and TypeClassDescriptionstatic class
Strategy for maintaining the physical form of the flow. -
Field Summary
Fields declared in class ParagraphView
firstLineIndent
Modifier and TypeFieldDescriptionprotected int
Indentation for the first line, from the left inset.Fields declared in class FlowView
layoutPool, layoutSpan, strategy
Modifier and TypeFieldDescriptionprotected View
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
Default constraint against which the flow is created against.protected FlowView.FlowStrategy
The behavior for keeping the flow updated.Fields declared in class View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
Modifier and TypeFieldDescriptionstatic final int
The weight to indicate a view is a bad break opportunity for the purpose of formatting.static final int
The weight to indicate a view supports breaking, and this represents a very attractive place to break.static final int
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
The weight to indicate a view supports breaking, but better opportunities probably exist.static final int
Axis for format/break operations.static final int
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 TypeFieldDescriptionstatic final int
Box-orientation constant used to specify the bottom of a box.static final int
The central position in an area.static final int
Compass-direction east (right).static final int
Horizontal orientation.static final int
Identifies the leading edge of text for use with left-to-right and right-to-left languages.static final int
Box-orientation constant used to specify the left side of a box.static final int
Identifies the next direction in a sequence.static final int
Compass-direction North (up).static final int
Compass-direction north-east (upper right).static final int
Compass-direction north west (upper left).static final int
Identifies the previous direction in a sequence.static final int
Box-orientation constant used to specify the right side of a box.static final int
Compass-direction south (down).static final int
Compass-direction south-east (lower right).static final int
Compass-direction south-west (lower left).static final int
Box-orientation constant used to specify the top of a box.static final int
Identifies the trailing edge of text for use with left-to-right and right-to-left languages.static final int
Vertical orientation.static final int
Compass-direction west (left). -
Constructor Summary
ConstructorsConstructorDescriptionParagraphView
(Element elem) Constructs a ParagraphView for the given element. -
Method Summary
Modifier and TypeMethodDescriptionprotected SizeRequirements
calculateMinorAxisRequirements
(int axis, SizeRequirements r) Calculate the needs for the paragraph along the minor axis.Fetches the attributes to use when rendering.float
getMaximumSpan
(int axis) Determines the maximum span for this view along an axis.float
getMinimumSpan
(int axis) Determines the minimum span for this view along an axis.float
getPreferredSpan
(int axis) Determines the preferred span for this view.protected StyleSheet
Convenient method to get the StyleSheet.boolean
Indicates whether or not this view should be displayed.void
Renders using the given rendering surface and area on that surface.void
Establishes the parent view for this view.protected void
Sets up the paragraph from css attributes instead of the values found in StyleConstants (i.e. which are used by the superclass).Methods declared in class ParagraphView
breakView, changedUpdate, createRow, findOffsetToCharactersInString, flipEastAndWestAtEnds, getAlignment, getBreakWeight, getClosestPositionTo, getFlowSpan, getFlowStart, getLayoutView, getLayoutViewCount, getNextNorthSouthVisualPositionFrom, getPartialSize, getTabBase, getTabSet, nextTabStop, setFirstLineIndent, setJustification, setLineSpacing
Modifier and TypeMethodDescriptionBreaks this view on the given axis at the given length.void
changedUpdate
(DocumentEvent changes, Shape a, ViewFactory f) Gives notification from the document that attributes were changed in a location that this view is responsible for.protected View
Create aView
that should be used to hold a a row's worth of children in a flow.protected int
findOffsetToCharactersInString
(char[] string, int start) Finds the next character in the document with a character instring
, starting at offsetstart
.protected boolean
flipEastAndWestAtEnds
(int position, Position.Bias bias) Determines in which direction the next view lays.float
getAlignment
(int axis) Determines the desired alignment for this view along an axis.int
getBreakWeight
(int axis, float len) Gets the break weight for a given location.protected int
getClosestPositionTo
(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet, int rowIndex, int x) Returns the closest model position tox
.int
getFlowSpan
(int index) Fetches the constraining span to flow against for the given child index.int
getFlowStart
(int index) Fetches the location along the flow axis that the flow span will start at.protected View
getLayoutView
(int index) Returns the view at a givenindex
.protected int
Returns the number of views that this view is responsible for.protected int
getNextNorthSouthVisualPositionFrom
(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) Returns the next visual position for the cursor, in either the east or west direction.protected float
getPartialSize
(int startOffset, int endOffset) Returns the size used by the views betweenstartOffset
andendOffset
.protected float
Returns where the tabs are calculated from.protected TabSet
Gets theTabset
to be used in calculating tabs.float
nextTabStop
(float x, int tabOffset) Returns the next tab stop position given a reference position.protected void
setFirstLineIndent
(float fi) Sets the indent on the first line.protected void
setJustification
(int j) Sets the type of justification.protected void
setLineSpacing
(float ls) Sets the line spacing.Methods declared in class FlowView
getFlowAxis, getViewIndexAtPosition, insertUpdate, layout, loadChildren, removeUpdate
Modifier and TypeMethodDescriptionint
Fetches the axis along which views should be flowed.protected int
getViewIndexAtPosition
(int pos) Fetches the child view index representing the given position in the model.void
insertUpdate
(DocumentEvent changes, Shape a, ViewFactory f) Gives notification that something was inserted into the document in a location that this view is responsible for.protected void
layout
(int width, int height) Lays out the children.protected void
Loads all of the children to initialize the view.void
removeUpdate
(DocumentEvent changes, Shape a, ViewFactory f) 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, getOffset, getResizeWeight, getSpan, getViewAtPoint, getWidth, isAfter, isAllocationValid, isBefore, isLayoutValid, layoutChanged, layoutMajorAxis, layoutMinorAxis, modelToView, paintChild, preferenceChanged, replace, setAxis, setSize, viewToModel
Modifier and TypeMethodDescriptionprotected void
baselineLayout
(int targetSpan, int axis, int[] offsets, int[] spans) Computes the location and extent of each child view in thisBoxView
given thetargetSpan
, which is the width (or height) of the region we have to work with.protected SizeRequirements
baselineRequirements
(int axis, SizeRequirements r) Calculates the size requirements for thisBoxView
by examining the size of each child view.protected SizeRequirements
calculateMajorAxisRequirements
(int axis, SizeRequirements r) Calculates the size requirements for the major axisaxis
.protected void
childAllocation
(int index, Rectangle alloc) Allocates a region for a child view.protected void
Forwards the givenDocumentEvent
to the child views that need to be notified of the change to the model.int
getAxis()
Fetches the tile axis property.getChildAllocation
(int index, Shape a) Fetches the allocation for the given child view.int
Returns the current height of the box.protected int
getOffset
(int axis, int childIndex) Fetches the offset of a particular child's current layout.int
getResizeWeight
(int axis) Gets the resize weight.protected int
getSpan
(int axis, int childIndex) Fetches the span of a particular child's current layout.protected View
getViewAtPoint
(int x, int y, Rectangle alloc) Fetches the child view at the given coordinates.int
getWidth()
Returns the current width of the box.protected boolean
Determines if a point falls after an allocated region.protected boolean
Are the allocations for the children still valid?protected boolean
Determines if a point falls before an allocated region.protected boolean
isLayoutValid
(int axis) Determines if the layout is valid along the given axis.void
layoutChanged
(int axis) Invalidates the layout along an axis.protected void
layoutMajorAxis
(int targetSpan, int axis, int[] offsets, int[] spans) Performs layout for the major axis of the box (i.e. the axis that it represents).protected void
layoutMinorAxis
(int targetSpan, int axis, int[] offsets, int[] spans) Performs layout for the minor axis of the box (i.e. the axis orthogonal to the axis that it represents).modelToView
(int pos, Shape a, Position.Bias b) Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.protected void
paintChild
(Graphics g, Rectangle alloc, int index) Paints a child.void
preferenceChanged
(View child, boolean width, boolean height) This is called by a child to indicate its preferred span has changed.void
Invalidates the layout and resizes the cache of requests/allocations.void
setAxis
(int axis) Sets the tile axis property.void
setSize
(float width, float height) Sets the size of the view.int
viewToModel
(float x, float y, Shape a, Position.Bias[] bias) 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
Modifier and TypeMethodDescriptionprotected short
Gets the bottom inset.protected Rectangle
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
Gets the left inset.protected int
getNextEastWestVisualPositionFrom
(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) Returns the next visual position for the cursor, in either the east or west direction.int
getNextVisualPositionFrom
(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) Provides a way to determine the next visually represented model location that one might place a caret.protected short
Gets the right inset.protected short
Gets the top inset.getView
(int n) Returns the n-th view in this container.protected View
getViewAtPosition
(int pos, Rectangle a) Fetches the child view that represents the given position in the model.int
Returns the number of child views of this view.int
getViewIndex
(int pos, Position.Bias b) Returns the child view index representing the given position in the model.modelToView
(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.protected void
setInsets
(short top, short left, short bottom, short right) Sets the insets for the view.protected void
Sets the insets from the paragraph attributes specified in the given attributes.Methods declared in class View
append, breakView, createFragment, forwardUpdateToView, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getGraphics, getParent, getStartOffset, getToolTipText, getViewFactory, getViewIndex, insert, modelToView, remove, removeAll, updateChildren, updateLayout, viewToModel
Modifier and TypeMethodDescriptionvoid
Appends a single child view.breakView
(int axis, int offset, float pos, float len) Tries to break this view on the given axis.createFragment
(int p0, int p1) Creates a view that represents a portion of the element.protected void
forwardUpdateToView
(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards theDocumentEvent
to the give child view.int
getBreakWeight
(int axis, float pos, float len) Determines how attractive a break opportunity in this view is.Fetches the container hosting the view.Fetches the model associated with the view.Fetches the structural portion of the subject that this view is mapped to.int
Fetches the portion of the model for which this view is responsible.Fetch aGraphics
for rendering.Returns the parent of the view.int
Fetches the portion of the model for which this view is responsible.getToolTipText
(float x, float y, Shape allocation) Returns the tooltip text at the specified location.Fetches theViewFactory
implementation that is feeding the view hierarchy.int
getViewIndex
(float x, float y, Shape allocation) Returns the child view index representing the given position in the view.void
Inserts a single child view.modelToView
(int pos, Shape a) Deprecated.void
remove
(int i) Removes one of the children at the given position.void
Removes all of the children.protected boolean
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
Updates the layout in response to receiving notification of change from the model.int
viewToModel
(float x, float y, Shape a) Deprecated.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
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 thisObject
.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
Wakes up all threads that are waiting on this object's monitor.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
(long timeoutMillis) 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
(long timeoutMillis, int nanos) 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.
-
Constructor Details
-
ParagraphView
Constructs a ParagraphView for the given element.- Parameters:
elem
- the element that this view is responsible for
-
-
Method Details
-
setParent
Establishes the parent view for this view. This is guaranteed to be called before any other methods if the parent view is functioning properly.This is implemented to forward to the superclass as well as call the
setPropertiesFromAttributes
method to set the paragraph properties from the css attributes. The call is made at this time to ensure the ability to resolve upward through the parents view attributes.- Overrides:
setParent
in classCompositeView
- Parameters:
parent
- the new parent, or null if the view is being removed from a parent it was previously added to
-
getAttributes
Fetches the attributes to use when rendering. This is implemented to multiplex the attributes specified in the model with a StyleSheet.- Overrides:
getAttributes
in classView
- Returns:
- the attributes to use when rendering
-
setPropertiesFromAttributes
protected void setPropertiesFromAttributes()Sets up the paragraph from css attributes instead of the values found in StyleConstants (i.e. which are used by the superclass). Since- Overrides:
setPropertiesFromAttributes
in classParagraphView
-
getStyleSheet
Convenient method to get the StyleSheet.- Returns:
- the StyleSheet
-
calculateMinorAxisRequirements
Calculate the needs for the paragraph along the minor axis.If size requirements are explicitly specified for the paragraph, use that requirements. Otherwise, use the requirements of the superclass
ParagraphView
.If the
axis
parameter is neitherView.X_AXIS
norView.Y_AXIS
,IllegalArgumentException
is thrown. If ther
parameter isnull,
a newSizeRequirements
object is created, otherwise the suppliedSizeRequirements
object is returned.- Overrides:
calculateMinorAxisRequirements
in classParagraphView
- Parameters:
axis
- the minor axisr
- the inputSizeRequirements
object- Returns:
- the new or adjusted
SizeRequirements
object - Throws:
IllegalArgumentException
- if theaxis
parameter is invalid- See Also:
-
isVisible
public boolean isVisible()Indicates whether or not this view should be displayed. If none of the children wish to be displayed and the only visible child is the break that ends the paragraph, the paragraph will not be considered visible. Otherwise, it will be considered visible and return true. -
paint
Renders using the given rendering surface and area on that surface. This is implemented to delegate to the superclass after stashing the base coordinate for tab calculations.- Overrides:
paint
in classParagraphView
- Parameters:
g
- the rendering surface to usea
- the allocated region to render into- See Also:
-
getPreferredSpan
public float getPreferredSpan(int axis) Determines the preferred span for this view. Returns 0 if the view is not visible, otherwise it calls the superclass method to get the preferred span. axis.- Overrides:
getPreferredSpan
in classBoxView
- Parameters:
axis
- may be either View.X_AXIS or View.Y_AXIS- Returns:
- the span the view would like to be rendered into; typically the view is told to render into the span that is returned, although there is no guarantee; the parent may choose to resize or break the view
- See Also:
-
getMinimumSpan
public float getMinimumSpan(int axis) Determines the minimum span for this view along an axis. Returns 0 if the view is not visible, otherwise it calls the superclass method to get the minimum span.- Overrides:
getMinimumSpan
in classBoxView
- Parameters:
axis
- may be eitherView.X_AXIS
orView.Y_AXIS
- Returns:
- the minimum span the view can be rendered into
- See Also:
-
getMaximumSpan
public float getMaximumSpan(int axis) Determines the maximum span for this view along an axis. Returns 0 if the view is not visible, otherwise it calls the superclass method ot get the maximum span.- Overrides:
getMaximumSpan
in classBoxView
- Parameters:
axis
- may be eitherView.X_AXIS
orView.Y_AXIS
- Returns:
- the maximum span the view can be rendered into
- See Also:
-