javax.swing.text

Class DefaultStyledDocument.ElementBuffer

Enclosing Class:
DefaultStyledDocument
Implemented Interfaces:
Serializable

public class DefaultStyledDocument.ElementBuffer
extends Object
implements Serializable

Performs all structural changes to the Element hierarchy.

See Also:
Serialized Form

Constructor Summary

ElementBuffer(Element root)
Creates a new ElementBuffer for the specified root element.

Method Summary

void
change(int offset, int length, AbstractDocument.DefaultDocumentEvent ev)
Modifies the element structure so that the specified interval starts and ends at an element boundary.
protected void
changeUpdate()
Performs the actual work for change(int,int,AbstractDocument.DefaultDocumentEvent).
Element
getRootElement()
Returns the root element of this ElementBuffer.
void
insert(int offset, int length, DefaultStyledDocument.ElementSpec[] data, AbstractDocument.DefaultDocumentEvent ev)
Inserts new Element in the document at the specified position.
protected void
insertUpdate(DefaultStyledDocument.ElementSpec[] data)
Performs the actual structural change for insert(int,int,DefaultStyledDocument.ElementSpec[],AbstractDocument.DefaultDocumentEvent).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ElementBuffer

public ElementBuffer(Element root)
Creates a new ElementBuffer for the specified root element.

Parameters:
root - the root element for this ElementBuffer

Method Details

change

public void change(int offset,
                   int length,
                   AbstractDocument.DefaultDocumentEvent ev)
Modifies the element structure so that the specified interval starts and ends at an element boundary. Content and paragraph elements are split and created as necessary. This also updates the DefaultDocumentEvent to reflect the structural changes. The bulk work is delegated to changeUpdate().

Parameters:
offset - the start index of the interval to be changed
length - the length of the interval to be changed
ev - the DefaultDocumentEvent describing the change


changeUpdate

protected void changeUpdate()
Performs the actual work for change(int,int,AbstractDocument.DefaultDocumentEvent). The elements at the interval boundaries are split up (if necessary) so that the interval boundaries are located at element boundaries.


getRootElement

public Element getRootElement()
Returns the root element of this ElementBuffer.

Returns:
the root element of this ElementBuffer


insert

public void insert(int offset,
                   int length,
                   DefaultStyledDocument.ElementSpec[] data,
                   AbstractDocument.DefaultDocumentEvent ev)
Inserts new Element in the document at the specified position. Most of the work is done by insertUpdate(DefaultStyledDocument.ElementSpec[]), after some fields have been prepared for it.

Parameters:
offset - the location in the document at which the content is inserted
length - the length of the inserted content
data - the element specifications for the content to be inserted
ev - the document event that is updated to reflect the structural changes


insertUpdate

protected void insertUpdate(DefaultStyledDocument.ElementSpec[] data)
Performs the actual structural change for insert(int,int,DefaultStyledDocument.ElementSpec[],AbstractDocument.DefaultDocumentEvent). This creates a bunch of Elements as specified by data and inserts it into the document as specified in the arguments to insert(int,int,DefaultStyledDocument.ElementSpec[],AbstractDocument.DefaultDocumentEvent).

Parameters:
data - the element specifications for the elements to be inserte


DefaultStyledDocument.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.