public abstract class

FlowView

extends BoxView

java.lang.Object
↳	javax.swing.text.View
	↳	javax.swing.text.CompositeView
		↳	javax.swing.text.BoxView
			↳	javax.swing.text.FlowView

Known Direct Subclasses

ParagraphView

Known Indirect Subclasses

ParagraphView

Class Overview

A View that tries to flow it's children into some partially constrained space. This can be used to build things like paragraphs, pages, etc. The flow is made up of the following pieces of functionality.

A logical set of child views, which as used as a layout pool from which a physical view is formed.
A strategy for translating the logical view to a physical (flowed) view.
Constraints for the strategy to work against.
A physical structure, that represents the flow. The children of this view are where the pieces of of the logical views are placed to create the flow.

Summary

Nested Classes
class	FlowView.FlowStrategy	Strategy for maintaining the physical form of the flow.

[Expand]

Inherited Constants

From class javax.swing.text.View

From interface javax.swing.SwingConstants

Fields
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.

Public Constructors
	FlowView(Element elem, int axis) Constructs a FlowView for the given element.

Public Methods
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.
int	getFlowAxis() Fetches the axis along which views should be flowed.
int	getFlowSpan(int index) Fetch the constraining span to flow against for the given child index.
int	getFlowStart(int index) Fetch the location along the flow axis that the flow span will start at.
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.
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.
void	setParent(View parent) Sets the parent of the view.

Protected Methods
SizeRequirements	calculateMinorAxisRequirements(int axis, SizeRequirements r) Calculate equirements along the minor axis.
abstract View	createRow() Create a View that should be used to hold a a rows worth of children in a flow.
int	getViewIndexAtPosition(int pos) Fetches the child view index representing the given position in the model.
void	layout(int width, int height) Lays out the children.
void	loadChildren(ViewFactory f) Loads all of the children to initialize the view.

[Expand]

Inherited Methods

From class javax.swing.text.BoxView

void	baselineLayout(int targetSpan, int axis, int[] offsets, int[] spans) 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.
SizeRequirements	baselineRequirements(int axis, SizeRequirements r) Calculates the size requirements for this `BoxView` by examining the size of each child view.
SizeRequirements	calculateMajorAxisRequirements(int axis, SizeRequirements r) Calculates the size requirements for the major axis `axis`.
SizeRequirements	calculateMinorAxisRequirements(int axis, SizeRequirements r) Calculates the size requirements for the minor axis `axis`.
void	childAllocation(int index, Rectangle alloc) Allocates a region for a child view.
boolean	flipEastAndWestAtEnds(int position, Position.Bias bias) Determines in which direction the next view lays.
void	forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) Forwards the given `DocumentEvent` to the child views that need to be notified of the change to the model.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
int	getAxis() Fetches the tile axis property.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view.
int	getHeight() Returns the current height of the box.
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.
int	getOffset(int axis, int childIndex) Fetches the offset of a particular child's current layout.
float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getResizeWeight(int axis) Gets the resize weight.
int	getSpan(int axis, int childIndex) Fetches the span of a particular childs current layout.
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.
boolean	isAfter(int x, int y, Rectangle innerAlloc) Determines if a point falls after an allocated region.
boolean	isAllocationValid() Are the allocations for the children still valid?
boolean	isBefore(int x, int y, Rectangle innerAlloc) Determines if a point falls before an allocated region.
boolean	isLayoutValid(int axis) Determines if the layout is valid along the given axis.
void	layout(int width, int height) Perform layout on the box
void	layoutChanged(int axis) Invalidates the layout along an axis.
void	layoutMajorAxis(int targetSpan, int axis, int[] offsets, int[] spans) Performs layout for the major axis of the box (i.e.
void	layoutMinorAxis(int targetSpan, int axis, int[] offsets, int[] spans) Performs layout for the minor axis of the box (i.e.
Shape	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.
void	paint(Graphics g, Shape allocation) Renders the `BoxView` using the given rendering surface and area on that surface.
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	replace(int index, int length, View[] elems) 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, Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class javax.swing.text.CompositeView

abstract void	childAllocation(int index, Rectangle a) Returns the allocation for a given child.
boolean	flipEastAndWestAtEnds(int position, Position.Bias bias) Determines in which direction the next view lays.
short	getBottomInset() Gets the bottom inset.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view to render into.
Rectangle	getInsideAllocation(Shape a) Translates the immutable allocation given to the view to a mutable allocation that represents the interior allocation (i.e.
short	getLeftInset() Gets the left inset.
int	getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Returns the next visual position for the cursor, in either the east or west direction.
int	getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Returns the next visual position for the cursor, in either the north or south direction.
int	getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Provides a way to determine the next visually represented model location that one might place a caret.
short	getRightInset() Gets the right inset.
short	getTopInset() Gets the top inset.
View	getView(int n) Returns the n-th view in this container.
abstract View	getViewAtPoint(int x, int y, Rectangle alloc) Fetches the child view at the given coordinates.
View	getViewAtPosition(int pos, Rectangle a) 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(int pos, Position.Bias b) Returns the child view index representing the given position in the model.
int	getViewIndexAtPosition(int pos) Fetches the child view index representing the given position in the model.
abstract boolean	isAfter(int x, int y, Rectangle alloc) Tests whether a point lies after the rectangle range.
abstract boolean	isBefore(int x, int y, Rectangle alloc) Tests whether a point lies before the rectangle range.
void	loadChildren(ViewFactory f) Loads all of the children to initialize the view.
Shape	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.
Shape	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.
void	replace(int offset, int length, View[] views) Replaces child views.
void	setInsets(short top, short left, short bottom, short right) Sets the insets for the view.
void	setParagraphInsets(AttributeSet attr) Sets the insets from the paragraph attributes specified in the given attributes.
void	setParent(View parent) Sets the parent of the view.
int	viewToModel(float x, float y, Shape a, Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class javax.swing.text.View

void	append(View v) Appends a single child view.
View	breakView(int axis, int offset, float pos, float len) Tries to break this view on the given axis.
void	changedUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification from the document that attributes were changed in a location that this view is responsible for.
View	createFragment(int p0, int p1) Creates a view that represents a portion of the element.
void	forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) Forwards the given `DocumentEvent` to the child views that need to be notified of the change to the model.
void	forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards the `DocumentEvent` to the give child view.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
AttributeSet	getAttributes() Fetches the attributes to use when rendering.
int	getBreakWeight(int axis, float pos, float len) Determines how attractive a break opportunity in this view is.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view.
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.
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.
int	getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Provides a way to determine the next visually represented model location at which one might place a caret.
View	getParent() Returns the parent of the view.
abstract float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getResizeWeight(int axis) Determines the resizability of the view along the given axis.
int	getStartOffset() Fetches the portion of the model for which this view is responsible.
String	getToolTipText(float x, float y, Shape allocation) Returns the tooltip text at the specified location.
View	getView(int n) Gets the nth child view.
int	getViewCount() Returns the number of views in this view.
ViewFactory	getViewFactory() Fetches the `ViewFactory` 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.
int	getViewIndex(int pos, Position.Bias b) Returns the child view index representing the given position in the model.
void	insert(int offs, View v) Inserts a single child view.
void	insertUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was inserted into the document in a location that this view is responsible for.
boolean	isVisible() Returns a boolean that indicates whether the view is visible or not.
Shape	modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space.
Shape	modelToView(int pos, Shape a) This method is deprecated. No replacement.
abstract Shape	modelToView(int pos, Shape a, Position.Bias b) Provides a mapping, for a given character, from the document model coordinate space to the view coordinate space.
abstract void	paint(Graphics g, Shape allocation) Renders using the given rendering surface and area on that surface.
void	preferenceChanged(View child, boolean width, boolean height) Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout.
void	remove(int i) Removes one of the children at the given position.
void	removeAll() Removes all of the children.
void	removeUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was removed from the document in a location that this view is responsible for.
void	replace(int offset, int length, View[] views) Replaces child views.
void	setParent(View parent) Establishes the parent view for this view.
void	setSize(float width, float height) Sets the size of the view.
boolean	updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f) 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.
void	updateLayout(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a) Updates the layout in response to receiving notification of change from the model.
int	viewToModel(float x, float y, Shape a) This method is deprecated. No replacement.
abstract int	viewToModel(float x, float y, Shape a, Bias[] biasReturn) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the 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 another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Fields

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). These are not directly children of this view. These are either placed into the rows directly or used for the purpose of breaking into smaller chunks, to form the 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. By default this is a singleton shared by all instances of FlowView (FlowStrategy is stateless). Subclasses can create an alternative strategy, which might keep state.

Public Constructors

public FlowView (Element elem, int axis)

Constructs a FlowView for the given element.

Parameters

elem	the element that this view is responsible for
axis	may be either View.X_AXIS or View.Y_AXIS

Public Methods

public 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.

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

public int getFlowAxis ()

Fetches the axis along which views should be flowed. By default, this will be the axis orthogonal to the axis along which the flow rows are tiled (the axis of the default flow rows themselves). This is typically used by the FlowStrategy.

public int getFlowSpan (int index)

Fetch the constraining span to flow against for the given child index. This is called by the FlowStrategy while it is updating the flow. A flow can be shaped by providing different values for the row constraints. By default, the entire span inside of the insets along the flow axis is returned.

Parameters

index	the index of the row being updated. This should be a value >= 0 and < getViewCount().

public int getFlowStart (int index)

Fetch the location along the flow axis that the flow span will start at. This is called by the FlowStrategy while it is updating the flow. A flow can be shaped by providing different values for the row constraints.

Parameters

index	the index of the row being updated. This should be a value >= 0 and < getViewCount().

public 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.

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

public 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.

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

public void setParent (View parent)

Sets the parent of the view. This is reimplemented to provide the superclass behavior as well as calling the loadChildren method if this view does not already have children. The children should not be loaded in the constructor because the act of setting the parent may cause them to try to search up the hierarchy (to get the hosting Container for example). If this view has children (the view is being moved from one place in the view hierarchy to another), the loadChildren method will not be called.

Parameters

parent	the parent of the view, `null` if none

Protected Methods

protected SizeRequirements calculateMinorAxisRequirements (int axis, SizeRequirements r)

Calculate equirements along the minor axis. This is implemented to forward the request to the logical view by calling getMinimumSpan, getPreferredSpan, and getMaximumSpan on it.

Parameters

axis	the axis being studied
r	the `SizeRequirements` object; if `null` one will be created

Returns

the newly initialized SizeRequirements object

protected abstract View createRow ()

Create a View that should be used to hold a a rows worth of children in a flow. This is called by the FlowStrategy when new children are added or removed (i.e. rows are added or removed) in the process of updating the flow.

protected int getViewIndexAtPosition (int pos)

Fetches the child view index representing the given position in the model.

Parameters

pos	the position >= 0

Returns

index of the view representing the given position, or -1 if no view represents that position

protected void layout (int width, int height)

Lays out the children. If the span along the flow axis has changed, layout is marked as invalid which which will cause the superclass behavior to recalculate the layout along the box axis. The FlowStrategy.layout method will be called to rebuild the flow rows as appropriate. If the height of this view changes (determined by the perferred size along the box axis), a preferenceChanged is called. Following all of that, the normal box layout of the superclass is performed.

Parameters

width	the width to lay out against >= 0. This is the width inside of the inset area.
height	the height to lay out against >= 0 This is the height inside of the inset area.

protected void loadChildren (ViewFactory f)

Loads all of the children to initialize the view. This is called by the setParent method. This is reimplemented to not load any children directly (as they are created in the process of formatting). If the layoutPool variable is null, an instance of LogicalView is created to represent the logical view that is used in the process of formatting.

Parameters

f	the view factory

Interfaces

Classes

Exceptions

FlowView

Class Overview

See Also

Summary

Fields

protected View layoutPool

protected int layoutSpan

protected FlowView.FlowStrategy strategy

Public Constructors

public FlowView (Element elem, int axis)

Parameters

Public Methods

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

Parameters

See Also

public int getFlowAxis ()

public int getFlowSpan (int index)

Parameters

See Also

public int getFlowStart (int index)

Parameters

See Also

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

Parameters

See Also

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

Parameters

See Also

public void setParent (View parent)

Parameters

Protected Methods

protected SizeRequirements calculateMinorAxisRequirements (int axis, SizeRequirements r)

Parameters

Returns

protected abstract View createRow ()

protected int getViewIndexAtPosition (int pos)

Parameters

Returns

protected void layout (int width, int height)

Parameters

protected void loadChildren (ViewFactory f)

Parameters