This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.swing.text
class FlowView
- All Implemented Interfaces:
- SwingConstants
- Direct Known Subclasses:
- ParagraphView
public abstract class FlowView
extends BoxView
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.
Nested Class Summary |
static class |
Strategy for maintaining the physical form
of the flow. |
Field Summary |
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. |
Constructor Summary |
Constructs a FlowView for the given element.
|
Method Summary |
protected SizeRequirements |
Calculate equirements along the minor axis.
|
void |
Gives notification from the document that attributes were changed
in a location that this view is responsible for.
|
protected abstract View |
Create a View that should be used to hold a
a rows worth of children in a flow.
|
int |
Fetches the axis along which views should be
flowed.
|
int |
Fetch the constraining span to flow against for
the given child index.
|
int |
Fetch the location along the flow axis that the
flow span will start at.
|
protected int |
Fetches the child view index representing the given position in
the model.
|
void |
Gives notification that something was inserted into the document
in a location that this view is responsible for.
|
protected void |
Lays out the children.
|
protected void |
Loads all of the children to initialize the view.
|
void |
Gives notification that something was removed from the document
in a location that this view is responsible for.
|
void |
Sets the parent of the view.
|
Methods inherited from class javax.swing.text.BoxView |
baselineLayout, baselineRequirements, calculateMajorAxisRequirements, calculateMinorAxisRequirements, childAllocation, flipEastAndWestAtEnds, forwardUpdate, getAlignment, getAxis, getChildAllocation, getHeight, getMaximumSpan, getMinimumSpan, getOffset, getPreferredSpan, getResizeWeight, getSpan, getViewAtPoint, getWidth, isAfter, isAllocationValid, isBefore, isLayoutValid, layout, layoutChanged, layoutMajorAxis, layoutMinorAxis, modelToView, paint, paintChild, preferenceChanged, replace, setAxis, setSize, viewToModel |
Methods inherited from class javax.swing.text.CompositeView |
childAllocation, flipEastAndWestAtEnds, getBottomInset, getChildAllocation, getInsideAllocation, getLeftInset, getNextEastWestVisualPositionFrom, getNextNorthSouthVisualPositionFrom, getNextVisualPositionFrom, getRightInset, getTopInset, getView, getViewAtPoint, getViewAtPosition, getViewCount, getViewIndex, getViewIndexAtPosition, isAfter, isBefore, loadChildren, modelToView, modelToView, replace, setInsets, setParagraphInsets, setParent, viewToModel |
Methods inherited from class javax.swing.text.View |
append, breakView, changedUpdate, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, modelToView, paint, preferenceChanged, remove, removeAll, removeUpdate, replace, setParent, setSize, updateChildren, updateLayout, viewToModel, viewToModel |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
layoutPool
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.
layoutSpan
protected int layoutSpan
-
Default constraint against which the flow is
created against.
strategy
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.
FlowView
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
calculateMinorAxisRequirements
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.
- Overrides:
calculateMinorAxisRequirements
in class BoxView
- Parameters:
axis
r
changedUpdate
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.
- Overrides:
changedUpdate
in class View
- 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
createRow
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.
getFlowAxis
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
.
getFlowSpan
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().
getFlowStart
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().
getViewIndexAtPosition
protected int getViewIndexAtPosition(int pos)
-
Fetches the child view index representing the given position in
the model.
- Overrides:
getViewIndexAtPosition
in class CompositeView
- Parameters:
pos
- the position >= 0
- Returns:
- index of the view representing the given position, or
-1 if no view represents that position
insertUpdate
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.
- Overrides:
insertUpdate
in class View
- 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
layout
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.
- Overrides:
layout
in class BoxView
- 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.
loadChildren
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.
- Overrides:
loadChildren
in class CompositeView
- Parameters:
f
- the view factory
removeUpdate
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.
- Overrides:
removeUpdate
in class View
- 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
setParent
public void setParent(View parent)
-
{@inheritDoc}
- Overrides:
setParent
in class CompositeView
- Parameters:
parent
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.