Serializable
, Document
, StyledDocument
HTMLDocument
public class DefaultStyledDocument extends AbstractDocument implements StyledDocument
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
.
Modifier and Type | Class | Description |
---|---|---|
static class |
DefaultStyledDocument.AttributeUndoableEdit |
An UndoableEdit used to remember AttributeSet changes to an Element. |
class |
DefaultStyledDocument.ElementBuffer |
Class to manage changes to the element hierarchy. |
static class |
DefaultStyledDocument.ElementSpec |
Specification for building elements. |
protected class |
DefaultStyledDocument.SectionElement |
Default root element for a document... maps out the paragraphs/lines contained. |
AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement
Modifier and Type | Field | Description |
---|---|---|
protected DefaultStyledDocument.ElementBuffer |
buffer |
The element buffer. |
static final int |
BUFFER_SIZE_DEFAULT |
The default size of the initial content buffer. |
BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName
StreamDescriptionProperty, TitleProperty
Constructor | Description |
---|---|
DefaultStyledDocument() |
Constructs a default styled document. |
DefaultStyledDocument |
Constructs a styled document. |
DefaultStyledDocument |
Constructs a styled document with the default content storage implementation and a shared set of styles. |
Modifier and Type | Method | Description |
---|---|---|
void |
addDocumentListener |
Adds a document listener for notification of any changes. |
Style |
addStyle |
Adds a new style into the logical style hierarchy. |
protected void |
create |
Initialize the document to reflect the given element structure (i.e. the structure reported by the getDefaultRootElement method. |
protected AbstractDocument.AbstractElement |
createDefaultRoot() |
Creates the root element to be used to represent the default document structure. |
Color |
getBackground |
Gets the background color from an attribute set. |
Element |
getCharacterElement |
Gets a character element based on a position. |
Element |
getDefaultRootElement() |
Gets the default root element. |
Font |
getFont |
Gets the font from an attribute set. |
Color |
getForeground |
Gets the foreground color from an attribute set. |
Style |
getLogicalStyle |
Fetches the logical style assigned to the paragraph represented by the given position. |
Element |
getParagraphElement |
Gets the paragraph element at the offset pos . |
Style |
getStyle |
Fetches a named style previously added. |
Enumeration |
getStyleNames() |
Fetches the list of style names. |
protected void |
insert |
Inserts new elements in bulk. |
protected void |
insertUpdate |
Updates document structure as a result of text insertion. |
void |
removeDocumentListener |
Removes a document listener. |
void |
removeElement |
Removes an element from this document. |
void |
removeStyle |
Removes a named style previously added to the document. |
protected void |
removeUpdate |
Updates document structure as a result of text removal. |
void |
setCharacterAttributes |
Sets attributes for some part of the document. |
void |
setLogicalStyle |
Sets the logical style to use for the paragraph at the given position. |
void |
setParagraphAttributes |
Sets attributes for a paragraph. |
protected void |
styleChanged |
Called when any of this document's styles have changed. |
addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, insertString, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeUndoableEditListener, render
public static final int BUFFER_SIZE_DEFAULT
protected DefaultStyledDocument.ElementBuffer buffer
public DefaultStyledDocument(AbstractDocument.Content c, StyleContext styles)
c
- the container for the contentstyles
- resources and style definitions which may be shared across documentspublic DefaultStyledDocument(StyleContext styles)
styles
- the stylespublic DefaultStyledDocument()
public Element getDefaultRootElement()
getDefaultRootElement
in interface Document
getDefaultRootElement
in class AbstractDocument
protected void create(DefaultStyledDocument.ElementSpec[] data)
getDefaultRootElement
method. If the document contained any data it will first be removed.data
- the element dataprotected void insert(int offset, DefaultStyledDocument.ElementSpec[] data) throws BadLocationException
This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.
offset
- the starting offset >= 0data
- the element dataBadLocationException
- for an invalid starting offsetpublic void removeElement(Element elem)
The element is removed from its parent element, as well as the text in the range identified by the element. If the element isn't associated with the document,
IllegalArgumentException
is thrown.
As empty branch elements are not allowed in the document, if the element is the sole child, its parent element is removed as well, recursively. This means that when replacing all the children of a particular element, new children should be added before removing old children.
Element removal results in two events being fired, the DocumentEvent
for changes in element structure and
UndoableEditEvent
for changes in document content.
If the element contains end-of-content mark (the last
"\n"
character in document), this character is not removed; instead, preceding leaf element is extended to cover the character. If the last leaf already ends with "\n",
it is included in content removal.
If the element is null,
NullPointerException
is thrown. If the element structure would become invalid after the removal, for example if the element is the document root element,
IllegalArgumentException
is thrown. If the current element structure is invalid, IllegalStateException
is thrown.
elem
- the element to removeNullPointerException
- if the element is null
IllegalArgumentException
- if the element could not be removedIllegalStateException
- if the element structure is invalidpublic Style addStyle(String nm, Style parent)
addStyle
in interface StyledDocument
nm
- the name of the style (must be unique within the collection of named styles). The name may be null if the style is unnamed, but the caller is responsible for managing the reference returned as an unnamed style can't be fetched by name. An unnamed style may be useful for things like character attribute overrides such as found in a style run.parent
- the parent style. This may be null if unspecified attributes need not be resolved in some other style.public void removeStyle(String nm)
removeStyle
in interface StyledDocument
nm
- the name of the style to removepublic Style getStyle(String nm)
getStyle
in interface StyledDocument
nm
- the name of the stylepublic Enumeration<?> getStyleNames()
public void setLogicalStyle(int pos, Style s)
This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.
setLogicalStyle
in interface StyledDocument
pos
- the offset from the start of the document >= 0s
- the logical style to assign to the paragraph, null if nonepublic Style getLogicalStyle(int p)
getLogicalStyle
in interface StyledDocument
p
- the location to translate to a paragraph and determine the logical style assigned >= 0. This is an offset from the start of the document.public void setCharacterAttributes(int offset, int length, AttributeSet s, boolean replace)
offset
and length
define the range of the text over which the attributes are set. If the length is <= 0, then no action is taken and the method just returns. If the offset is <=0 or > the length of the text then no action is taken, and the method just returns. Otherwise if offset + length
will exceed the length of the text then the affected range is truncated.
This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.
setCharacterAttributes
in interface StyledDocument
offset
- the offset in the document >= 0length
- the length > 0s
- the attributesreplace
- true if the previous attributes should be replaced before setting the new attributespublic void setParagraphAttributes(int offset, int length, AttributeSet s, boolean replace)
This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.
setParagraphAttributes
in interface StyledDocument
offset
- the offset into the paragraph >= 0length
- the number of characters affected >= 0s
- the attributesreplace
- whether to replace existing attributes, or merge thempublic Element getParagraphElement(int pos)
pos
. A paragraph consists of at least one child Element, which is usually a leaf.getParagraphElement
in interface StyledDocument
getParagraphElement
in class AbstractDocument
pos
- the starting offset >= 0public Element getCharacterElement(int pos)
getCharacterElement
in interface StyledDocument
pos
- the position in the document >= 0protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr)
insertUpdate
in class AbstractDocument
chng
- a description of the document changeattr
- the attributesprotected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)
removeUpdate
in class AbstractDocument
chng
- a description of the document changeprotected AbstractDocument.AbstractElement createDefaultRoot()
public Color getForeground(AttributeSet attr)
getForeground
in interface StyledDocument
attr
- the attribute setpublic Color getBackground(AttributeSet attr)
getBackground
in interface StyledDocument
attr
- the attribute setpublic Font getFont(AttributeSet attr)
getFont
in interface StyledDocument
attr
- the attribute setprotected void styleChanged(Style style)
style
- The Style that has changed.public void addDocumentListener(DocumentListener listener)
addDocumentListener
in interface Document
addDocumentListener
in class AbstractDocument
listener
- the listenerpublic void removeDocumentListener(DocumentListener listener)
removeDocumentListener
in interface Document
removeDocumentListener
in class AbstractDocument
listener
- the listener
© 1993, 2023, 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/21/docs/api/java.desktop/javax/swing/text/DefaultStyledDocument.html