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.FlowStrategyModifier and TypeClassDescriptionstatic classStrategy for maintaining the physical form of the flow. -
Field Summary
Fields declared in class ParagraphView
firstLineIndentModifier and TypeFieldDescriptionprotected intIndentation for the first line, from the left inset.Fields declared in class FlowView
layoutPool, layoutSpan, strategyModifier and TypeFieldDescriptionprotected ViewThese are the views that represent the child elements of the element this view represents (The logical view to translate to a physical view).protected intDefault constraint against which the flow is created against.protected FlowView.FlowStrategyThe behavior for keeping the flow updated.Fields declared in class View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXISModifier and TypeFieldDescriptionstatic final intThe weight to indicate a view is a bad break opportunity for the purpose of formatting.static final intThe weight to indicate a view supports breaking, and this represents a very attractive place to break.static final intThe 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 intThe weight to indicate a view supports breaking, but better opportunities probably exist.static final intAxis for format/break operations.static final intAxis 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, WESTModifier and TypeFieldDescriptionstatic final intBox-orientation constant used to specify the bottom of a box.static final intThe central position in an area.static final intCompass-direction east (right).static final intHorizontal orientation.static final intIdentifies the leading edge of text for use with left-to-right and right-to-left languages.static final intBox-orientation constant used to specify the left side of a box.static final intIdentifies the next direction in a sequence.static final intCompass-direction North (up).static final intCompass-direction north-east (upper right).static final intCompass-direction north west (upper left).static final intIdentifies the previous direction in a sequence.static final intBox-orientation constant used to specify the right side of a box.static final intCompass-direction south (down).static final intCompass-direction south-east (lower right).static final intCompass-direction south-west (lower left).static final intBox-orientation constant used to specify the top of a box.static final intIdentifies the trailing edge of text for use with left-to-right and right-to-left languages.static final intVertical orientation.static final intCompass-direction west (left). -
Constructor Summary
ConstructorsConstructorDescriptionParagraphView(Element elem) Constructs a ParagraphView for the given element. -
Method Summary
Modifier and TypeMethodDescriptionprotected SizeRequirementscalculateMinorAxisRequirements(int axis, SizeRequirements r) Calculate the needs for the paragraph along the minor axis.Fetches the attributes to use when rendering.floatgetMaximumSpan(int axis) Determines the maximum span for this view along an axis.floatgetMinimumSpan(int axis) Determines the minimum span for this view along an axis.floatgetPreferredSpan(int axis) Determines the preferred span for this view.protected StyleSheetConvenient method to get the StyleSheet.booleanIndicates whether or not this view should be displayed.voidRenders using the given rendering surface and area on that surface.voidEstablishes the parent view for this view.protected voidSets 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, setLineSpacingModifier and TypeMethodDescriptionBreaks this view on the given axis at the given length.voidchangedUpdate(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 ViewCreate aViewthat should be used to hold a a row's worth of children in a flow.protected intfindOffsetToCharactersInString(char[] string, int start) Finds the next character in the document with a character instring, starting at offsetstart.protected booleanflipEastAndWestAtEnds(int position, Position.Bias bias) Determines in which direction the next view lays.floatgetAlignment(int axis) Determines the desired alignment for this view along an axis.intgetBreakWeight(int axis, float len) Gets the break weight for a given location.protected intgetClosestPositionTo(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet, int rowIndex, int x) Returns the closest model position tox.intgetFlowSpan(int index) Fetches the constraining span to flow against for the given child index.intgetFlowStart(int index) Fetches the location along the flow axis that the flow span will start at.protected ViewgetLayoutView(int index) Returns the view at a givenindex.protected intReturns the number of views that this view is responsible for.protected intgetNextNorthSouthVisualPositionFrom(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 floatgetPartialSize(int startOffset, int endOffset) Returns the size used by the views betweenstartOffsetandendOffset.protected floatReturns where the tabs are calculated from.protected TabSetGets theTabsetto be used in calculating tabs.floatnextTabStop(float x, int tabOffset) Returns the next tab stop position given a reference position.protected voidsetFirstLineIndent(float fi) Sets the indent on the first line.protected voidsetJustification(int j) Sets the type of justification.protected voidsetLineSpacing(float ls) Sets the line spacing.Methods declared in class FlowView
getFlowAxis, getViewIndexAtPosition, insertUpdate, layout, loadChildren, removeUpdateModifier and TypeMethodDescriptionintFetches the axis along which views should be flowed.protected intgetViewIndexAtPosition(int pos) Fetches the child view index representing the given position in the model.voidinsertUpdate(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 voidlayout(int width, int height) Lays out the children.protected voidLoads all of the children to initialize the view.voidremoveUpdate(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, viewToModelModifier and TypeMethodDescriptionprotected voidbaselineLayout(int targetSpan, int axis, int[] offsets, int[] spans) Computes the location and extent of each child view in thisBoxViewgiven thetargetSpan, which is the width (or height) of the region we have to work with.protected SizeRequirementsbaselineRequirements(int axis, SizeRequirements r) Calculates the size requirements for thisBoxViewby examining the size of each child view.protected SizeRequirementscalculateMajorAxisRequirements(int axis, SizeRequirements r) Calculates the size requirements for the major axisaxis.protected voidchildAllocation(int index, Rectangle alloc) Allocates a region for a child view.protected voidForwards the givenDocumentEventto the child views that need to be notified of the change to the model.intgetAxis()Fetches the tile axis property.getChildAllocation(int index, Shape a) Fetches the allocation for the given child view.intReturns the current height of the box.protected intgetOffset(int axis, int childIndex) Fetches the offset of a particular child's current layout.intgetResizeWeight(int axis) Gets the resize weight.protected intgetSpan(int axis, int childIndex) Fetches the span of a particular child's current layout.protected ViewgetViewAtPoint(int x, int y, Rectangle alloc) Fetches the child view at the given coordinates.intgetWidth()Returns the current width of the box.protected booleanDetermines if a point falls after an allocated region.protected booleanAre the allocations for the children still valid?protected booleanDetermines if a point falls before an allocated region.protected booleanisLayoutValid(int axis) Determines if the layout is valid along the given axis.voidlayoutChanged(int axis) Invalidates the layout along an axis.protected voidlayoutMajorAxis(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 voidlayoutMinorAxis(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 voidpaintChild(Graphics g, Rectangle alloc, int index) Paints a child.voidpreferenceChanged(View child, boolean width, boolean height) This is called by a child to indicate its preferred span has changed.voidInvalidates the layout and resizes the cache of requests/allocations.voidsetAxis(int axis) Sets the tile axis property.voidsetSize(float width, float height) Sets the size of the view.intviewToModel(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, setParagraphInsetsModifier and TypeMethodDescriptionprotected shortGets the bottom inset.protected RectangleTranslates 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 shortGets the left inset.protected intgetNextEastWestVisualPositionFrom(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.intgetNextVisualPositionFrom(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 shortGets the right inset.protected shortGets the top inset.getView(int n) Returns the n-th view in this container.protected ViewgetViewAtPosition(int pos, Rectangle a) Fetches the child view that represents the given position in the model.intReturns the number of child views of this view.intgetViewIndex(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 voidsetInsets(short top, short left, short bottom, short right) Sets the insets for the view.protected voidSets 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, viewToModelModifier and TypeMethodDescriptionvoidAppends 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 voidforwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards theDocumentEventto the give child view.intgetBreakWeight(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.intFetches the portion of the model for which this view is responsible.Fetch aGraphicsfor rendering.Returns the parent of the view.intFetches 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 theViewFactoryimplementation that is feeding the view hierarchy.intgetViewIndex(float x, float y, Shape allocation) Returns the child view index representing the given position in the view.voidInserts a single child view.modelToView(int pos, Shape a) Deprecated.voidremove(int i) Removes one of the children at the given position.voidRemoves all of the children.protected booleanUpdates 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 voidUpdates the layout in response to receiving notification of change from the model.intviewToModel(float x, float y, Shape a) Deprecated.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitModifier and TypeMethodDescriptionprotected Objectclone()Creates and returns a copy of this object.booleanIndicates whether some other object is "equal to" this one.protected voidfinalize()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.inthashCode()Returns a hash code value for this object.final voidnotify()Wakes up a single thread that is waiting on this object's monitor.final voidWakes up all threads that are waiting on this object's monitor.toString()Returns a string representation of the object.final voidwait()Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final voidwait(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 voidwait(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
setPropertiesFromAttributesmethod 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:
setParentin 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:
getAttributesin 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:
setPropertiesFromAttributesin 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
axisparameter is neitherView.X_AXISnorView.Y_AXIS,IllegalArgumentExceptionis thrown. If therparameter isnull,a newSizeRequirementsobject is created, otherwise the suppliedSizeRequirementsobject is returned.- Overrides:
calculateMinorAxisRequirementsin classParagraphView- Parameters:
axis- the minor axisr- the inputSizeRequirementsobject- Returns:
- the new or adjusted
SizeRequirementsobject - Throws:
IllegalArgumentException- if theaxisparameter 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:
paintin 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:
getPreferredSpanin 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:
getMinimumSpanin classBoxView- Parameters:
axis- may be eitherView.X_AXISorView.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:
getMaximumSpanin classBoxView- Parameters:
axis- may be eitherView.X_AXISorView.Y_AXIS- Returns:
- the maximum span the view can be rendered into
- See Also:
-