Home » openjdk-7 » javax » swing » text » [javadoc | source]
javax.swing.text
public interface: StyledDocument [javadoc | source]

All Implemented Interfaces:
    Document

All Known Implementing Classes:
    DefaultStyledDocument, HTMLDocument, BasicDocument

Interface for a generic styled document.
Method from javax.swing.text.StyledDocument Summary:
addStyle,   getBackground,   getCharacterElement,   getFont,   getForeground,   getLogicalStyle,   getParagraphElement,   getStyle,   removeStyle,   setCharacterAttributes,   setLogicalStyle,   setParagraphAttributes
Method from javax.swing.text.StyledDocument Detail:
 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.
 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.
 public Element getCharacterElement(int pos)
    Gets the element that represents the character that is at the given offset within the document.
 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.
 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.
 public Style getLogicalStyle(int p)
    Gets a logical style for a given position in a paragraph.
 public Element getParagraphElement(int pos)
    Gets the element that represents the paragraph that encloses the given offset within the document.
 public Style getStyle(String nm)
    Fetches a named style previously added.
 public  void removeStyle(String nm)
    Removes a named style previously added to the document.
 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.
 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.
 public  void setParagraphAttributes(int offset,
    int length,
    AttributeSet s,
    boolean replace)
    Sets paragraph attributes.