Class DefaultStyledDocument.ElementBuffer

java.lang.Object
javax.swing.text.DefaultStyledDocument.ElementBuffer
All Implemented Interfaces:
Serializable
Enclosing class:
DefaultStyledDocument
public class DefaultStyledDocument.ElementBuffer extends Object implements Serializable
Class to manage changes to the element hierarchy.

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 has been added to the java.beans package. Please see XMLEncoder.

Constructor Summary

Constructor Description
ElementBuffer(Element root)
Creates a new ElementBuffer.

Method Summary

Modifier and Type Method Description
void change(int offset, int length, AbstractDocument.DefaultDocumentEvent de)
Changes content.
protected void changeUpdate()
Updates the element structure in response to a change in the document.
Element clone(Element parent, Element clonee)
Creates a copy of this element, with a different parent.
Element getRootElement()
Gets the root element.
void insert(int offset, int length, DefaultStyledDocument.ElementSpec[] data, AbstractDocument.DefaultDocumentEvent de)
Inserts new content.
protected void insertUpdate(DefaultStyledDocument.ElementSpec[] data)
Inserts an update into the document.
void remove(int offset, int length, AbstractDocument.DefaultDocumentEvent de)
Removes content.
protected void removeUpdate()
Updates the element structure in response to a removal from the associated sequence in the document.

Methods declared in 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.
Parameters:
root - the root element
Since:
1.4

Method Details

getRootElement

public Element getRootElement()
Gets the root element.
Returns:
the root element

insert

public void insert(int offset, int length, DefaultStyledDocument.ElementSpec[] data, AbstractDocument.DefaultDocumentEvent de)
Inserts new content.
Parameters:
offset - the starting offset >= 0
length - the length >= 0
data - the data to insert
de - the event capturing this edit

remove

public void remove(int offset, int length, AbstractDocument.DefaultDocumentEvent de)
Removes content.
Parameters:
offset - the starting offset >= 0
length - the length >= 0
de - the event capturing this edit

change

public void change(int offset, int length, AbstractDocument.DefaultDocumentEvent de)
Changes content.
Parameters:
offset - the starting offset >= 0
length - the length >= 0
de - the event capturing this edit

insertUpdate

protected void insertUpdate(DefaultStyledDocument.ElementSpec[] data)
Inserts an update into the document.
Parameters:
data - the elements to insert

removeUpdate

protected void removeUpdate()
Updates the element structure in response to a removal from the associated sequence in the document. Any elements consumed by the span of the removal are removed.

changeUpdate

protected void changeUpdate()
Updates the element structure in response to a change in the document.

clone

public Element clone(Element parent, Element clonee)
Creates a copy of this element, with a different parent.
Parameters:
parent - the parent element
clonee - the element to be cloned
Returns:
the copy

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/text/DefaultStyledDocument.ElementBuffer.html