Home » openjdk-7 » javax » swing » text » [javadoc | source]

javax.swing.text
public class: AbstractDocument.BranchElement [javadoc | source]

java.lang.Object
   javax.swing.text.AbstractDocument$AbstractElement
      javax.swing.text.AbstractDocument$BranchElement

All Implemented Interfaces:
    MutableAttributeSet, TreeNode, Serializable, Element

Direct Known Subclasses:
    BidiRootElement

Implements a composite element that contains other elements.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder .

Constructor:
public BranchElement(Element parent, AttributeSet a) { super(parent, a); children = new AbstractElement[1]; nchildren = 0; lastIndex = -1; } Constructs a composite element that initially contains no children. Parameters: parent - The parent element a - the attributes for the element since: 1.4 -

Method from javax.swing.text.AbstractDocument$BranchElement Summary:
children,   getAllowsChildren,   getElement,   getElementCount,   getElementIndex,   getEndOffset,   getName,   getStartOffset,   isLeaf,   positionToElement,   replace,   toString

Methods from javax.swing.text.AbstractDocument$AbstractElement:

addAttribute,   addAttributes,   children,   containsAttribute,   containsAttributes,   copyAttributes,   dump,   getAllowsChildren,   getAttribute,   getAttributeCount,   getAttributeNames,   getAttributes,   getChildAt,   getChildCount,   getDocument,   getElement,   getElementCount,   getElementIndex,   getEndOffset,   getIndex,   getName,   getParent,   getParentElement,   getResolveParent,   getStartOffset,   isDefined,   isEqual,   isLeaf,   removeAttribute,   removeAttributes,   removeAttributes,   setResolveParent

Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from javax.swing.text.AbstractDocument$BranchElement Detail:
public Enumeration children() { if(nchildren == 0) return null; Vector tempVector = new Vector(nchildren); for(int counter = 0; counter < nchildren; counter++) tempVector.addElement(children[counter]); return tempVector.elements(); } Returns the children of the receiver as an Enumeration.
public boolean getAllowsChildren() { return true; } Returns true if the receiver allows children.
public Element getElement(int index) { if (index < nchildren) { return children[index]; } return null; } Gets a child element.
public int getElementCount() { return nchildren; } Gets the number of children for the element.
public int getElementIndex(int offset) { int index; int lower = 0; int upper = nchildren - 1; int mid = 0; int p0 = getStartOffset(); int p1; if (nchildren == 0) { return 0; } if (offset >= getEndOffset()) { return nchildren - 1; } // see if the last index can be used. if ((lastIndex >= lower) && (lastIndex < = upper)) { Element lastHit = children[lastIndex]; p0 = lastHit.getStartOffset(); p1 = lastHit.getEndOffset(); if ((offset >= p0) && (offset < p1)) { return lastIndex; } // last index wasn't a hit, but it does give useful info about // where a hit (if any) would be. if (offset < p0) { upper = lastIndex; } else { lower = lastIndex; } } while (lower < = upper) { mid = lower + ((upper - lower) / 2); Element elem = children[mid]; p0 = elem.getStartOffset(); p1 = elem.getEndOffset(); if ((offset >= p0) && (offset < p1)) { // found the location index = mid; lastIndex = index; return index; } else if (offset < p0) { upper = mid - 1; } else { lower = mid + 1; } } // didn't find it, but we indicate the index of where it would belong if (offset < p0) { index = mid; } else { index = mid + 1; } lastIndex = index; return index; } Gets the child element index closest to the given model offset.
public int getEndOffset() { Element child = (nchildren > 0) ? children[nchildren - 1] : children[0]; return child.getEndOffset(); } Gets the ending offset in the model for the element.
public String getName() { String nm = super.getName(); if (nm == null) { nm = ParagraphElementName; } return nm; } Gets the element name.
public int getStartOffset() { return children[0].getStartOffset(); } Gets the starting offset in the model for the element.
public boolean isLeaf() { return false; } Checks whether the element is a leaf.
public Element positionToElement(int pos) { int index = getElementIndex(pos); Element child = children[index]; int p0 = child.getStartOffset(); int p1 = child.getEndOffset(); if ((pos >= p0) && (pos < p1)) { return child; } return null; } Gets the child element that contains the given model position.
public void replace(int offset, int length, Element[] elems) { int delta = elems.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); AbstractElement[] newChildren = new AbstractElement[newLength]; System.arraycopy(children, 0, newChildren, 0, offset); System.arraycopy(elems, 0, newChildren, offset, elems.length); System.arraycopy(children, src, newChildren, dest, nmove); children = newChildren; } else { // patch the existing array System.arraycopy(children, src, children, dest, nmove); System.arraycopy(elems, 0, children, offset, elems.length); } nchildren = nchildren + delta; } Replaces content with a new set of elements.
public String toString() { return "BranchElement(" + getName() + ") " + getStartOffset() + "," + getEndOffset() + "\n"; } Converts the element to a string.