FileDocCategorySizeDatePackage
FlowView.javaAPI DocJava SE 6 API28397Tue Jun 10 00:26:56 BST 2008javax.swing.text

FlowView

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.
author
Timothy Prinzing
version
1.54 08/17/06
see
View
since
1.3

Fields Summary
protected int
layoutSpan
Default constraint against which the flow is created against.
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 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.
Constructors Summary
public FlowView(Element elem, int axis)
Constructs a FlowView for the given element.

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

	super(elem, axis);
        layoutSpan = Integer.MAX_VALUE;
	strategy = new FlowStrategy();
    
Methods Summary
protected javax.swing.SizeRequirementscalculateMinorAxisRequirements(int axis, javax.swing.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.

	if (r == null) {
	    r = new SizeRequirements();
	}
	float pref = layoutPool.getPreferredSpan(axis);
	float min = layoutPool.getMinimumSpan(axis);
        // Don't include insets, Box.getXXXSpan will include them.
	r.minimum = (int)min;
	r.preferred = Math.max(r.minimum, (int) pref);
	r.maximum = Integer.MAX_VALUE;
	r.alignment = 0.5f;
	return r;
    
public voidchangedUpdate(javax.swing.event.DocumentEvent changes, java.awt.Shape a, javax.swing.text.ViewFactory f)
Gives notification from the document that attributes were changed in a location that this view is responsible for.

param
changes the change information from the associated document
param
a the current allocation of the view
param
f the factory to use to rebuild if the view has children
see
View#changedUpdate

	layoutPool.changedUpdate(changes, a, f);
	strategy.changedUpdate(this, changes, getInsideAllocation(a));
    
protected abstract javax.swing.text.ViewcreateRow()
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.

public intgetFlowAxis()
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.

	if (getAxis() == Y_AXIS) {
	    return X_AXIS;
	}
	return Y_AXIS;
    
public intgetFlowSpan(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.

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

	return layoutSpan;
    
public intgetFlowStart(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.

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

	return 0;
    
protected intgetViewIndexAtPosition(int pos)
Fetches the child view index representing the given position in the model.

param
pos the position >= 0
return
index of the view representing the given position, or -1 if no view represents that position

	if (pos >= getStartOffset() && (pos < getEndOffset())) {
	    for (int counter = 0; counter < getViewCount(); counter++) {
		View v = getView(counter);
		if(pos >= v.getStartOffset() &&
		   pos < v.getEndOffset()) {
		    return counter;
		}
	    }
	}
	return -1;
    
public voidinsertUpdate(javax.swing.event.DocumentEvent changes, java.awt.Shape a, javax.swing.text.ViewFactory f)
Gives notification that something was inserted into the document in a location that this view is responsible for.

param
changes the change information from the associated document
param
a the current allocation of the view
param
f the factory to use to rebuild if the view has children
see
View#insertUpdate

	layoutPool.insertUpdate(changes, a, f);
	strategy.insertUpdate(this, changes, getInsideAllocation(a));
    
protected voidlayout(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.

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

	final int faxis = getFlowAxis();
	int newSpan;
	if (faxis == X_AXIS) {
	    newSpan = (int)width;
	} else {
	    newSpan = (int)height;
	}
	if (layoutSpan != newSpan) {
	    layoutChanged(faxis);
	    layoutChanged(getAxis());
	    layoutSpan = newSpan;
	}

	// repair the flow if necessary
	if (! isLayoutValid(faxis)) {
	    final int heightAxis = getAxis();
	    int oldFlowHeight = (int)((heightAxis == X_AXIS)? getWidth() : getHeight());
	    strategy.layout(this);
	    int newFlowHeight = (int) getPreferredSpan(heightAxis);
	    if (oldFlowHeight != newFlowHeight) {
		View p = getParent();
		if (p != null) {
		    p.preferenceChanged(this, (heightAxis == X_AXIS), (heightAxis == Y_AXIS));
		}

                // PENDING(shannonh)
                // Temporary fix for 4250847
                // Can be removed when TraversalContext is added
		Component host = getContainer();
		if (host != null) {
		    //nb idk 12/12/2001 host should not be equal to null. We need to add assertion here
		    host.repaint();
		}
	    }
	}

	super.layout(width, height);
    
protected voidloadChildren(javax.swing.text.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.

param
f the view factory

	if (layoutPool == null) {
	    layoutPool = new LogicalView(getElement());
	}
        layoutPool.setParent(this);

        // This synthetic insertUpdate call gives the strategy a chance
        // to initialize.
        strategy.insertUpdate(this, null, null);
    
public voidremoveUpdate(javax.swing.event.DocumentEvent changes, java.awt.Shape a, javax.swing.text.ViewFactory f)
Gives notification that something was removed from the document in a location that this view is responsible for.

param
changes the change information from the associated document
param
a the current allocation of the view
param
f the factory to use to rebuild if the view has children
see
View#removeUpdate

	layoutPool.removeUpdate(changes, a, f);
	strategy.removeUpdate(this, changes, getInsideAllocation(a));
    
public voidsetParent(javax.swing.text.View parent)
{@inheritDoc}

	super.setParent(parent);
        if (parent == null 
                && layoutPool != null ) {
            layoutPool.setParent(null);
        }