FilterStyledDocument (Text API)

java.lang.Object
- org.openide.text.FilterDocument
- - org.openide.text.FilterStyledDocument

```
public class FilterStyledDocument
extends FilterDocument
```
Document that delegates all functionality to a given StyledDocument. Useful if a subclass wants to modify the behaviour of a document.
Note that unlike FilterDocument, no methods are faked here, since a real styled document is available.

Field Summary
- Fields inherited from interface javax.swing.text.Document
  StreamDescriptionProperty, TitleProperty
- Fields inherited from class org.openide.text.FilterDocument
  original

Constructor Summary

Constructors
Constructor Description

FilterStyledDocument(javax.swing.text.StyledDocument original)
Create new document instance.

Constructors
Constructor	Description
`FilterStyledDocument(javax.swing.text.StyledDocument original)`	Create new document instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`javax.swing.text.Style`	`addStyle(java.lang.String nm, javax.swing.text.Style parent)`
`java.awt.Color`	`getBackground(javax.swing.text.AttributeSet attr)`
`javax.swing.text.Element`	`getCharacterElement(int pos)`
`java.awt.Font`	`getFont(javax.swing.text.AttributeSet attr)`
`java.awt.Color`	`getForeground(javax.swing.text.AttributeSet attr)`
`javax.swing.text.Style`	`getLogicalStyle(int p)`
`javax.swing.text.Element`	`getParagraphElement(int pos)`
`javax.swing.text.Style`	`getStyle(java.lang.String nm)`
`void`	`removeStyle(java.lang.String nm)`
`void`	`setCharacterAttributes(int offset, int length, javax.swing.text.AttributeSet s, boolean replace)`
`void`	`setLogicalStyle(int pos, javax.swing.text.Style s)`
`void`	`setParagraphAttributes(int offset, int length, javax.swing.text.AttributeSet s, boolean replace)`

Methods inherited from class org.openide.text.FilterDocument
addDocumentListener, addUndoableEditListener, createPosition, getDefaultRootElement, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeDocumentListener, removeUndoableEditListener, render

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- FilterStyledDocument
```
public FilterStyledDocument(javax.swing.text.StyledDocument original)
```
  Create new document instance.
  
  Parameters:
  
  original - the delegated-to styled document

Method Detail

addStyle

public javax.swing.text.Style addStyle(java.lang.String nm,
                                       javax.swing.text.Style parent)

Overrides:: addStyle in class FilterDocument

removeStyle
```
public void removeStyle(java.lang.String nm)
```
Overrides:

removeStyle in class FilterDocument

getStyle

public javax.swing.text.Style getStyle(java.lang.String nm)

Overrides:: getStyle in class FilterDocument

setCharacterAttributes

public void setCharacterAttributes(int offset,
                                   int length,
                                   javax.swing.text.AttributeSet s,
                                   boolean replace)

Overrides:: setCharacterAttributes in class FilterDocument

setParagraphAttributes

public void setParagraphAttributes(int offset,
                                   int length,
                                   javax.swing.text.AttributeSet s,
                                   boolean replace)

Overrides:: setParagraphAttributes in class FilterDocument

setLogicalStyle

public void setLogicalStyle(int pos,
                            javax.swing.text.Style s)

Overrides:: setLogicalStyle in class FilterDocument

getLogicalStyle
```
public javax.swing.text.Style getLogicalStyle(int p)
```
Overrides:

getLogicalStyle in class FilterDocument

getParagraphElement
```
public javax.swing.text.Element getParagraphElement(int pos)
```
Overrides:

getParagraphElement in class FilterDocument

getCharacterElement
```
public javax.swing.text.Element getCharacterElement(int pos)
```
Overrides:

getCharacterElement in class FilterDocument

getForeground

public java.awt.Color getForeground(javax.swing.text.AttributeSet attr)

Overrides:: getForeground in class FilterDocument

getBackground

public java.awt.Color getBackground(javax.swing.text.AttributeSet attr)

Overrides:: getBackground in class FilterDocument

getFont

public java.awt.Font getFont(javax.swing.text.AttributeSet attr)

Overrides:: getFont in class FilterDocument

Class FilterStyledDocument

Field Summary

Fields inherited from interface javax.swing.text.Document

Fields inherited from class org.openide.text.FilterDocument

Constructor Summary

Method Summary

Methods inherited from class org.openide.text.FilterDocument

Methods inherited from class java.lang.Object

Constructor Detail

FilterStyledDocument

Method Detail

addStyle

removeStyle

getStyle

setCharacterAttributes

setParagraphAttributes

setLogicalStyle

getLogicalStyle

getParagraphElement

getCharacterElement

getForeground

getBackground

getFont