|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
|
+--javax.swing.text.AbstractDocument
|
+--javax.swing.text.DefaultStyledDocument
A document that can be marked up with character and paragraph styles in a manner similar to the Rich Text Format. The element structure for this document represents style crossings for style runs. These style runs are mapped into a paragraph element structure (which may reside in some other structure). The style runs break at paragraph boundaries since logical styles are assigned to paragraph boundaries.
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. A future release of Swing will provide support for long term persistence.
Document,
AbstractDocument, Serialized Form| Inner Class Summary | |
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... |
| Inner classes inherited from class javax.swing.text.AbstractDocument |
AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement |
| Field Summary | |
protected DefaultStyledDocument.ElementBuffer |
buffer
|
static int |
BUFFER_SIZE_DEFAULT
The default size of the initial content buffer. |
| Fields inherited from class javax.swing.text.AbstractDocument |
BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName |
| Fields inherited from interface javax.swing.text.Document |
StreamDescriptionProperty, TitleProperty |
| Constructor Summary | |
DefaultStyledDocument()
Constructs a default styled document. |
|
DefaultStyledDocument(AbstractDocument.Content c,
StyleContext styles)
Constructs a styled document. |
|
DefaultStyledDocument(StyleContext styles)
Constructs a styled document with the default content storage implementation and a shared set of styles. |
|
| Method Summary | |
void |
addDocumentListener(DocumentListener listener)
Adds a document listener for notification of any changes. |
Style |
addStyle(String nm,
Style parent)
Adds a new style into the logical style hierarchy. |
protected void |
create(DefaultStyledDocument.ElementSpec[] data)
Initialize the document to reflect the given element structure (i.e. |
protected AbstractDocument.AbstractElement |
createDefaultRoot()
Creates the root element to be used to represent the default document structure. |
Color |
getBackground(AttributeSet attr)
Gets the background color from an attribute set. |
Element |
getCharacterElement(int pos)
Gets a character element based on a position. |
Element |
getDefaultRootElement()
Gets the default root element. |
Font |
getFont(AttributeSet attr)
Gets the font from an attribute set. |
Color |
getForeground(AttributeSet attr)
Gets the foreground color from an attribute set. |
Style |
getLogicalStyle(int p)
Fetches the logical style assigned to the paragraph represented by the given position. |
Element |
getParagraphElement(int pos)
Gets the paragraph element at the offset pos. |
Style |
getStyle(String nm)
Fetches a named style previously added. |
Enumeration |
getStyleNames()
Fetches the list of of style names. |
protected void |
insert(int offset,
DefaultStyledDocument.ElementSpec[] data)
Inserts new elements in bulk. |
protected void |
insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
AttributeSet attr)
Updates document structure as a result of text insertion. |
void |
removeDocumentListener(DocumentListener listener)
Removes a document listener. |
void |
removeStyle(String nm)
Removes a named style previously added to the document. |
protected void |
removeUpdate(AbstractDocument.DefaultDocumentEvent chng)
Updates document structure as a result of text removal. |
void |
setCharacterAttributes(int offset,
int length,
AttributeSet s,
boolean replace)
Sets attributes for some part of the document. |
void |
setLogicalStyle(int pos,
Style s)
Sets the logical style to use for the paragraph at the given position. |
void |
setParagraphAttributes(int offset,
int length,
AttributeSet s,
boolean replace)
Sets attributes for a paragraph. |
protected void |
styleChanged(Style style)
Creates a change event for the whole document and propagates it to the listeners. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.swing.text.Document |
addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeUndoableEditListener, render |
| Field Detail |
public static final int BUFFER_SIZE_DEFAULT
protected DefaultStyledDocument.ElementBuffer buffer
| Constructor Detail |
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()
| Method Detail |
public Element getDefaultRootElement()
getDefaultRootElement in interface DocumentgetDefaultRootElement in class AbstractDocumentDocument.getDefaultRootElement()protected void create(DefaultStyledDocument.ElementSpec[] data)
getDefaultRootElement method. If the
document contained any data it will first be removed.
protected void insert(int offset,
DefaultStyledDocument.ElementSpec[] data)
throws BadLocationException
This method is thread safe, although most Swing methods are not. Please see Threads and Swing for more information.
offset - the starting offset >= 0data - the element dataBadLocationException - for an invalid starting offset
public Style addStyle(String nm,
Style parent)
addStyle in interface StyledDocumentnm - 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 StyledDocumentnm - the name of the style to removepublic Style getStyle(String nm)
getStyle in interface StyledDocumentnm - 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 Threads and Swing for more information.
setLogicalStyle in interface StyledDocumentpos - 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 StyledDocumentp - 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)
This method is thread safe, although most Swing methods are not. Please see Threads and Swing for more information.
setCharacterAttributes in interface StyledDocumentoffset - the offset in the document >= 0length - the length >= 0s - the attributesreplace - true if the previous attributes should be replaced
before setting the new attributes
public void setParagraphAttributes(int offset,
int length,
AttributeSet s,
boolean replace)
This method is thread safe, although most Swing methods are not. Please see Threads and Swing for more information.
setParagraphAttributes in interface StyledDocumentoffset - 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 StyledDocumentgetParagraphElement in class AbstractDocumentpos - the starting offset >= 0public Element getCharacterElement(int pos)
getCharacterElement in interface StyledDocumentpos - the position in the document >= 0
protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
AttributeSet attr)
insertUpdate in class AbstractDocumentchng - a description of the document changeattr - the attributesprotected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)
removeUpdate in class AbstractDocumentchng - a description of the document changeprotected AbstractDocument.AbstractElement createDefaultRoot()
public Color getForeground(AttributeSet attr)
getForeground in interface StyledDocumentattr - the attribute setpublic Color getBackground(AttributeSet attr)
getBackground in interface StyledDocumentattr - the attribute setpublic Font getFont(AttributeSet attr)
getFont in interface StyledDocumentattr - the attribute setprotected void styleChanged(Style style)
style - The Style that has changed.public void addDocumentListener(DocumentListener listener)
addDocumentListener in interface DocumentaddDocumentListener in class AbstractDocumentlistener - the listenerDocument.addDocumentListener(javax.swing.event.DocumentListener)public void removeDocumentListener(DocumentListener listener)
removeDocumentListener in interface DocumentremoveDocumentListener in class AbstractDocumentlistener - the listenerDocument.removeDocumentListener(javax.swing.event.DocumentListener)
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.