This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.text
interface StyledDocument

All Superinterfaces:
Document
All Known Implementing Classes:
DefaultStyledDocument, HTMLDocument

Most common way to construct:

JTextPane textPane = …;

StyledDocument doc = textPane.getStyledDocument();

Based on 26 examples


public interface StyledDocument
extends Document

Interface for a generic styled document.


Field Summary
 
Fields inherited from class javax.swing.text.Document
StreamDescriptionProperty, TitleProperty
 
Method Summary
 Style
addStyle(String nm, Style parent)

          Adds a new style into the logical style hierarchy.
 Color

          Takes a set of attributes and turn it into a background color specification.
 Element

          Gets the element that represents the character that is at the given offset within the document.
 Font

          Takes a set of attributes and turn it into a font specification.
 Color

          Takes a set of attributes and turn it into a foreground color specification.
 Style

          Gets a logical style for a given position in a paragraph.
 Element

          Gets the element that represents the paragraph that encloses the given offset within the document.
 Style

          Fetches a named style previously added.
 void

          Removes a named style previously added to the document.
 void
setCharacterAttributes(int offset, int length, AttributeSet s, boolean replace)

          Changes the content element attributes used for the given range of existing content in 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 paragraph attributes.
 
Methods inherited from class javax.swing.text.Document
addDocumentListener, addUndoableEditListener, createPosition, getDefaultRootElement, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeDocumentListener, removeUndoableEditListener, render
 

Method Detail

addStyle

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

getBackground

public Color getBackground(AttributeSet attr)
Takes a set of attributes and turn it into a background color specification. This might be used to specify things like brighter, more hue, etc.

Parameters:
attr - the set of attributes
Returns:
the color

getCharacterElement

public Element getCharacterElement(int pos)
Gets the element that represents the character that is at the given offset within the document.

Parameters:
pos - the offset >= 0
Returns:
the element

getFont

public Font getFont(AttributeSet attr)
Takes a set of attributes and turn it into a font specification. This can be used to turn things like family, style, size, etc into a font that is available on the system the document is currently being used on.

Parameters:
attr - the set of attributes
Returns:
the font

getForeground

public Color getForeground(AttributeSet attr)
Takes a set of attributes and turn it into a foreground color specification. This might be used to specify things like brighter, more hue, etc.

Parameters:
attr - the set of attributes
Returns:
the color

getLogicalStyle

public Style getLogicalStyle(int p)
Gets a logical style for a given position in a paragraph.

Parameters:
p - the position >= 0
Returns:
the style

getParagraphElement

public Element getParagraphElement(int pos)
Gets the element that represents the paragraph that encloses the given offset within the document.

Parameters:
pos - the offset >= 0
Returns:
the element

getStyle

public Style getStyle(String nm)
Fetches a named style previously added.

Parameters:
nm - the name of the style
Returns:
the style

removeStyle

public void removeStyle(String nm)
Removes a named style previously added to the document.

Parameters:
nm - the name of the style to remove

setCharacterAttributes

public void setCharacterAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)
Changes the content element attributes used for the given range of existing content in the document. All of the attributes defined in the given Attributes argument are applied to the given range. This method can be used to completely remove all content level attributes for the given range by giving an Attributes argument that has no attributes defined and setting replace to true.

Parameters:
offset - the start of the change >= 0
length - the length of the change >= 0
s - the non-null attributes to change to. Any attributes defined will be applied to the text for the given range.
replace - indicates whether or not the previous attributes should be cleared before the new attributes as set. If true, the operation will replace the previous attributes entirely. If false, the new attributes will be merged with the previous attributes.

setLogicalStyle

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 starting position >= 0
s - the style to set

setParagraphAttributes

public void setParagraphAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)
Sets paragraph attributes.

Parameters:
offset - the start of the change >= 0
length - the length of the change >= 0
s - the non-null attributes to change to. Any attributes defined will be applied to the text for the given range.
replace - indicates whether or not the previous attributes should be cleared before the new attributes are set. If true, the operation will replace the previous attributes entirely. If false, the new attributes will be merged with the previous attributes.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.