public CompositeView(Element elem) 
{
        super(elem);
        children = new View[1];
        nchildren = 0;
        childAlloc = new Rectangle();
}

Constructs a CompositeView for the given element.

Parameters:

elem - the element this view is responsible for

 abstract protected  void childAllocation(int index,
    Rectangle a)
Returns the allocation for a given child.

 protected boolean flipEastAndWestAtEnds(int position,
    Bias bias) 
{
        return false;
}

Determines in which direction the next view lays. Consider the View at index n. Typically the Views are layed out from left to right, so that the View to the EAST will be at index n + 1, and the View to the WEST will be at index n - 1. In certain situations, such as with bidirectional text, it is possible that the View to EAST is not at index n + 1, but rather at index n - 1, or that the View to the WEST is not at index n - 1, but index n + 1. In this case this method would return true, indicating the Views are layed out in descending order.

This unconditionally returns false, subclasses should override this method if there is the possibility for laying Views in descending order.

 protected short getBottomInset() 
{
        return bottom;
}

Gets the bottom inset.

 public Shape getChildAllocation(int index,
    Shape a) 
{
        Rectangle alloc = getInsideAllocation(a);
        childAllocation(index, alloc);
        return alloc;
}

Fetches the allocation for the given child view to render into. This enables finding out where various views are located.

 protected Rectangle getInsideAllocation(Shape a) 
{
        if (a != null) {
            // get the bounds, hopefully without allocating
            // a new rectangle.  The Shape argument should
            // not be modified... we copy it into the
            // child allocation.
            Rectangle alloc;
            if (a instanceof Rectangle) {
                alloc = (Rectangle) a;
            } else {
                alloc = a.getBounds();
            }
            childAlloc.setBounds(alloc);
            childAlloc.x += getLeftInset();
            childAlloc.y += getTopInset();
            childAlloc.width -= getLeftInset() + getRightInset();
            childAlloc.height -= getTopInset() + getBottomInset();
            return childAlloc;
        }
        return null;
}

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. It is expected that the returned value would be further mutated to represent an allocation to a child view. This is implemented to reuse an instance variable so it avoids creating excessive Rectangles. Typically the result of calling this method would be fed to the childAllocation method.

 protected short getLeftInset() 
{
        return left;
}

Gets the left inset.

 protected int getNextEastWestVisualPositionFrom(int pos,
    Bias b,
    Shape a,
    int direction,
    Bias[] biasRet) throws BadLocationException 
{
        return Utilities.getNextVisualPositionFrom(
                            this, pos, b, a, direction, biasRet);
}

Returns the next visual position for the cursor, in either the east or west direction.

 protected int getNextNorthSouthVisualPositionFrom(int pos,
    Bias b,
    Shape a,
    int direction,
    Bias[] biasRet) throws BadLocationException 
{
        return Utilities.getNextVisualPositionFrom(
                            this, pos, b, a, direction, biasRet);
}

Returns the next visual position for the cursor, in either the north or south direction.

 public int getNextVisualPositionFrom(int pos,
    Bias b,
    Shape a,
    int direction,
    Bias[] biasRet) throws BadLocationException 
{
        Rectangle alloc = getInsideAllocation(a);
        switch (direction) {
        case NORTH:
            return getNextNorthSouthVisualPositionFrom(pos, b, a, direction,
                                                       biasRet);
        case SOUTH:
            return getNextNorthSouthVisualPositionFrom(pos, b, a, direction,
                                                       biasRet);
        case EAST:
            return getNextEastWestVisualPositionFrom(pos, b, a, direction,
                                                     biasRet);
        case WEST:
            return getNextEastWestVisualPositionFrom(pos, b, a, direction,
                                                     biasRet);
        default:
            throw new IllegalArgumentException("Bad direction: " + direction);
        }
}

Provides a way to determine the next visually represented model location that one might place a caret. Some views may not be visible, they might not be in the same order found in the model, or they just might not allow access to some of the locations in the model. This is a convenience method for #getNextNorthSouthVisualPositionFrom and #getNextEastWestVisualPositionFrom .

 protected short getRightInset() 
{
        return right;
}

Gets the right inset.

 protected short getTopInset() 
{
        return top;
}

Gets the top inset.

 public View getView(int n) 
{
        return children[n];
}

Returns the n-th view in this container.

 abstract protected View getViewAtPoint(int x,
    int y,
    Rectangle alloc)
Fetches the child view at the given coordinates.

 protected View getViewAtPosition(int pos,
    Rectangle a) 
{
        int index = getViewIndexAtPosition(pos);
        if ((index  >= 0) && (index <  getViewCount())) {
            View v = getView(index);
            if (a != null) {
                childAllocation(index, a);
            }
            return v;
        }
        return null;
}

Fetches the child view that represents the given position in the model. This is implemented to fetch the view in the case where there is a child view for each child element.

 public int getViewCount() 
{
        return nchildren;
}

Returns the number of child views of this view.

 public int getViewIndex(int pos,
    Bias b) 
{
        if(b == Position.Bias.Backward) {
            pos -= 1;
        }
        if ((pos  >= getStartOffset()) && (pos <  getEndOffset())) {
            return getViewIndexAtPosition(pos);
        }
        return -1;
}

Returns the child view index representing the given position in the model. This is implemented to call the getViewIndexByPosition method for backward compatibility.

 protected int getViewIndexAtPosition(int pos) 
{
        Element elem = getElement();
        return elem.getElementIndex(pos);
}

Fetches the child view index representing the given position in the model. This is implemented to fetch the view in the case where there is a child view for each child element.

 abstract protected boolean isAfter(int x,
    int y,
    Rectangle alloc)
Tests whether a point lies after the rectangle range.

 abstract protected boolean isBefore(int x,
    int y,
    Rectangle alloc)
Tests whether a point lies before the rectangle range.

 protected  void loadChildren(ViewFactory f) 
{
        if (f == null) {
            // No factory. This most likely indicates the parent view
            // has changed out from under us, bail!
            return;
        }
        Element e = getElement();
        int n = e.getElementCount();
        if (n  > 0) {
            View[] added = new View[n];
            for (int i = 0; i <  n; i++) {
                added[i] = f.create(e.getElement(i));
            }
            replace(0, 0, added);
        }
}

Loads all of the children to initialize the view. This is called by the #setParent method. Subclasses can reimplement this to initialize their child views in a different manner. The default implementation creates a child view for each child element.

 public Shape modelToView(int pos,
    Shape a,
    Bias b) throws BadLocationException 
{
        boolean isBackward = (b == Position.Bias.Backward);
        int testPos = (isBackward) ? Math.max(0, pos - 1) : pos;
        if(isBackward && testPos <  getStartOffset()) {
            return null;
        }
        int vIndex = getViewIndexAtPosition(testPos);
        if ((vIndex != -1) && (vIndex <  getViewCount())) {
            View v = getView(vIndex);
            if(v != null && testPos  >= v.getStartOffset() &&
               testPos <  v.getEndOffset()) {
                Shape childShape = getChildAllocation(vIndex, a);
                if (childShape == null) {
                    // We are likely invalid, fail.
                    return null;
                }
                Shape retShape = v.modelToView(pos, childShape, b);
                if(retShape == null && v.getEndOffset() == pos) {
                    if(++vIndex <  getViewCount()) {
                        v = getView(vIndex);
                        retShape = v.modelToView(pos, getChildAllocation(vIndex, a), b);
                    }
                }
                return retShape;
            }
        }
        throw new BadLocationException("Position not represented by view",
                                       pos);
}

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

 public Shape modelToView(int p0,
    Bias b0,
    int p1,
    Bias b1,
    Shape a) throws BadLocationException 
{
        if (p0 == getStartOffset() && p1 == getEndOffset()) {
            return a;
        }
        Rectangle alloc = getInsideAllocation(a);
        Rectangle r0 = new Rectangle(alloc);
        View v0 = getViewAtPosition((b0 == Position.Bias.Backward) ?
                                    Math.max(0, p0 - 1) : p0, r0);
        Rectangle r1 = new Rectangle(alloc);
        View v1 = getViewAtPosition((b1 == Position.Bias.Backward) ?
                                    Math.max(0, p1 - 1) : p1, r1);
        if (v0 == v1) {
            if (v0 == null) {
                return a;
            }
            // Range contained in one view
            return v0.modelToView(p0, b0, p1, b1, r0);
        }
        // Straddles some views.
        int viewCount = getViewCount();
        int counter = 0;
        while (counter <  viewCount) {
            View v;
            // Views may not be in same order as model.
            // v0 or v1 may be null if there is a gap in the range this
            // view contains.
            if ((v = getView(counter)) == v0 || v == v1) {
                View endView;
                Rectangle retRect;
                Rectangle tempRect = new Rectangle();
                if (v == v0) {
                    retRect = v0.modelToView(p0, b0, v0.getEndOffset(),
                                             Position.Bias.Backward, r0).
                              getBounds();
                    endView = v1;
                }
                else {
                    retRect = v1.modelToView(v1.getStartOffset(),
                                             Position.Bias.Forward,
                                             p1, b1, r1).getBounds();
                    endView = v0;
                }
                // Views entirely covered by range.
                while (++counter <  viewCount &&
                       (v = getView(counter)) != endView) {
                    tempRect.setBounds(alloc);
                    childAllocation(counter, tempRect);
                    retRect.add(tempRect);
                }
                // End view.
                if (endView != null) {
                    Shape endShape;
                    if (endView == v1) {
                        endShape = v1.modelToView(v1.getStartOffset(),
                                                  Position.Bias.Forward,
                                                  p1, b1, r1);
                    }
                    else {
                        endShape = v0.modelToView(p0, b0, v0.getEndOffset(),
                                                  Position.Bias.Backward, r0);
                    }
                    if (endShape instanceof Rectangle) {
                        retRect.add((Rectangle)endShape);
                    }
                    else {
                        retRect.add(endShape.getBounds());
                    }
                }
                return retRect;
            }
            counter++;
        }
        throw new BadLocationException("Position not represented by view", p0);
}

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

 public  void replace(int offset,
    int length,
    View[] views) 
{
        // make sure an array exists
        if (views == null) {
            views = ZERO;
        }
        // update parent reference on removed views
        for (int i = offset; i <  offset + length; i++) {
            if (children[i].getParent() == this) {
                // in FlowView.java view might be referenced
                // from two super-views as a child. see logicalView
                children[i].setParent(null);
            }
            children[i] = null;
        }
        // update the array
        int delta = views.length - length;
        int src = offset + length;
        int nmove = nchildren - src;
        int dest = src + delta;
        if ((nchildren + delta)  >= children.length) {
            // need to grow the array
            int newLength = Math.max(2*children.length, nchildren + delta);
            View[] newChildren = new View[newLength];
            System.arraycopy(children, 0, newChildren, 0, offset);
            System.arraycopy(views, 0, newChildren, offset, views.length);
            System.arraycopy(children, src, newChildren, dest, nmove);
            children = newChildren;
        } else {
            // patch the existing array
            System.arraycopy(children, src, children, dest, nmove);
            System.arraycopy(views, 0, children, offset, views.length);
        }
        nchildren = nchildren + delta;
        // update parent reference on added views
        for (int i = 0; i <  views.length; i++) {
            views[i].setParent(this);
        }
}

Replaces child views. If there are no views to remove this acts as an insert. If there are no views to add this acts as a remove. Views being removed will have the parent set to null, and the internal reference to them removed so that they may be garbage collected.

 protected  void setInsets(short top,
    short left,
    short bottom,
    short right) 
{
        this.top = top;
        this.left = left;
        this.right = right;
        this.bottom = bottom;
}

Sets the insets for the view.

 protected  void setParagraphInsets(AttributeSet attr) 
{
        // Since version 1.1 doesn't have scaling and assumes
        // a pixel is equal to a point, we just cast the point
        // sizes to integers.
        top = (short) StyleConstants.getSpaceAbove(attr);
        left = (short) StyleConstants.getLeftIndent(attr);
        bottom = (short) StyleConstants.getSpaceBelow(attr);
        right = (short) StyleConstants.getRightIndent(attr);
}

Sets the insets from the paragraph attributes specified in the given attributes.

 public  void setParent(View parent) 
{
        super.setParent(parent);
        if ((parent != null) && (nchildren == 0)) {
            ViewFactory f = getViewFactory();
            loadChildren(f);
        }
}

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.

 public int viewToModel(float x,
    float y,
    Shape a,
    Bias[] bias) 
{
        Rectangle alloc = getInsideAllocation(a);
        if (isBefore((int) x, (int) y, alloc)) {
            // point is before the range represented
            int retValue = -1;
            try {
                retValue = getNextVisualPositionFrom(-1, Position.Bias.Forward,
                                                     a, EAST, bias);
            } catch (BadLocationException ble) { }
            catch (IllegalArgumentException iae) { }
            if(retValue == -1) {
                retValue = getStartOffset();
                bias[0] = Position.Bias.Forward;
            }
            return retValue;
        } else if (isAfter((int) x, (int) y, alloc)) {
            // point is after the range represented.
            int retValue = -1;
            try {
                retValue = getNextVisualPositionFrom(-1, Position.Bias.Forward,
                                                     a, WEST, bias);
            } catch (BadLocationException ble) { }
            catch (IllegalArgumentException iae) { }
            if(retValue == -1) {
                // NOTE: this could actually use end offset with backward.
                retValue = getEndOffset() - 1;
                bias[0] = Position.Bias.Forward;
            }
            return retValue;
        } else {
            // locate the child and pass along the request
            View v = getViewAtPoint((int) x, (int) y, alloc);
            if (v != null) {
              return v.viewToModel(x, y, alloc, bias);
            }
        }
        return -1;
}

Provides a mapping from the view coordinate space to the logical coordinate space of the model.