All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.swing.text.DefaultStyledDocument

java.lang.Object
    |
    +----java.awt.swing.text.AbstractDocument
            |
            +----java.awt.swing.text.DefaultStyledDocument

public class DefaultStyledDocument

extends AbstractDocument

implements StyledDocument

See Also:

Document, AbstractDocument

DefaultStyledDocument.ElementBuffer

Class to manage changes to the element hierarchy.

DefaultStyledDocument.ElementSpec

Specification for building elements.

DefaultStyledDocument.SectionElement

Default root element for a document...

BUFFER_SIZE_DEFAULT

The default size of the initial content buffer.

DefaultStyledDocument()

Constructs a default styled document.

DefaultStyledDocument(AbstractDocument.Content, StyleContext)

Constructs a styled document.

DefaultStyledDocument(StyleContext)

Constructs a styled document with the default content storage implementation and a shared set of styles.

addStyle(String, Style)

Adds a new style into the logical style hierarchy.

createDefaultRoot()

Creates the root element to be used to represent the default document structure.

getAttributeContext()

Fetch the context for managing attributes.

getBackground(AttributeSet)

Gets the background color from an attribute set.

getCharacterElement(int)

Gets a character element based on a position.

getDefaultRootElement()

Gets the default root element.

getFont(AttributeSet)

Gets the font from an attribute set.

getForeground(AttributeSet)

Gets the foreground color from an attribute set.

getLogicalStyle(int)

Fetches the logical style assigned to the paragraph represented by the given position.

getParagraphElement(int)

Gets a paragraph element.

getStyle(String)

Fetches a named style previously added.

insert(int, DefaultStyledDocument.ElementSpec[])

Inserts new elements in bulk.

insertUpdate(DefaultDocumentEvent, AttributeSet)

Updates document structure as a result of text insertion.

removeStyle(String)

Removes a named style previously added to the document.

removeUpdate(DefaultDocumentEvent)

Updates document structure as a result of text removal.

setCharacterAttributes(int, int, AttributeSet, boolean)

Sets attributes for some part of the document.

setLogicalStyle(int, Style)

Sets the logical style to use for the paragraph at the given position.

setParagraphAttributes(int, int, AttributeSet, boolean)

Sets attributes for a paragraph.

public static final int BUFFER_SIZE_DEFAULT

The default size of the initial content buffer.

public DefaultStyledDocument(AbstractDocument.Content c,
                             StyleContext styles)

Constructs a styled document.

Parameters:

c - the container for the content

styles - resources and style definitions which may be shared across documents

public DefaultStyledDocument(StyleContext styles)

Constructs a styled document with the default content storage implementation and a shared set of styles.

Parameters:

styles - the styles

public DefaultStyledDocument()

Constructs a default styled document. This buffers input content by a size of BUFFER_SIZE_DEFAULT and has a style context that is scoped by the lifetime of the document and is not shared with other documents.

public Element getDefaultRootElement()

Gets the default root element.

Returns:

the root

Overrides:

getDefaultRootElement in class AbstractDocument

See Also:

getDefaultRootElement

protected AbstractDocument.AttributeContext getAttributeContext()

Fetch the context for managing attributes. This method effectively establishes the strategy used for compressing AttributeSet information.

Overrides:

getAttributeContext in class AbstractDocument

protected void insert(int offset,
                      DefaultStyledDocument.ElementSpec[] data) throws BadLocationException

Inserts new elements in bulk.

Parameters:

offset - the starting offset

data - the element data

Throws: BadLocationException

for an invalid starting offset

See Also:

StyledDocument#insert

public Style addStyle(String nm,
                      Style parent)

Adds a new style into the logical style hierarchy. Style attributes resolve from bottom up so an attribute specified in a child will override an attribute specified in the parent.

Parameters:

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.

Returns:

the style

public void removeStyle(String nm)

Removes a named style previously added to the document.

Parameters:

nm - the name of the style to remove

public Style getStyle(String nm)

Fetches a named style previously added.

Parameters:

nm - the name of the style

Returns:

the style

public void setLogicalStyle(int pos,
                            Style s)

Sets the logical style to use for the paragraph at the given position. If attributes aren't explicitly set for character and paragraph attributes they will resolve through the logical style assigned to the paragraph, which in turn may resolve through some hierarchy completely independent of the element hierarchy in the document.

Parameters:

pos - the offset from the start of the document

s - the logical style to assign to the paragraph

public Style getLogicalStyle(int p)

Fetches the logical style assigned to the paragraph represented by the given position.

Parameters:

p - the location to translate to a paragraph and determine the logical style assigned. This is an offset from the start of the document.

Returns:

the style

public void setCharacterAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)

Sets attributes for some part of the document. A write lock is held by this operation while changes are being made, and a DocumentEvent is sent to the listeners after the change has been successfully completed.

Parameters:

offset - the offset in the document

length - the length

s - the attributes

replace - true if the previous attributes should be replaced before setting the new attributes

public void setParagraphAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)

Sets attributes for a paragraph.

Parameters:

offset - the offset into the paragraph

length - the number of characters affected

s - the attributes

replace - whether to replace existing attributes, or merge them

public Element getParagraphElement(int pos)

Gets a paragraph element.

Parameters:

pos - the starting offset

Returns:

the element

public Element getCharacterElement(int pos)

Gets a character element based on a position.

Parameters:

pos - the position in the document

Returns:

the element

protected void insertUpdate(DefaultDocumentEvent chng,
                            AttributeSet attr)

Updates document structure as a result of text insertion. This will happen within a write lock. This implementation simply parses the inserted content for line breaks and builds up a set of instructions for the element buffer.

Parameters:

chng - a description of the document change

attr - the attributes

Overrides:

insertUpdate in class AbstractDocument

protected void removeUpdate(DefaultDocumentEvent chng)

Updates document structure as a result of text removal.

Parameters:

chng - a description of the document change

Overrides:

removeUpdate in class AbstractDocument

protected AbstractDocument.AbstractElement createDefaultRoot()

Creates the root element to be used to represent the default document structure.

Returns:

the element base

public Color getForeground(AttributeSet attr)

Gets the foreground color from an attribute set.

Parameters:

attr - the attribute set

Returns:

the color

public Color getBackground(AttributeSet attr)

Gets the background color from an attribute set.

Parameters:

attr - the attribute set

Returns:

the color

public Font getFont(AttributeSet attr)

Gets the font from an attribute set.

Parameters:

attr - the attribute set

Returns:

the font

All Packages  Class Hierarchy  This Package  Previous  Next  Index