javax.swing.text.rtf: public class: RTFEditorKit

javax.swing.text.rtf
public class: RTFEditorKit [javadoc | source]

java.lang.Object
   javax.swing.text.EditorKit
      javax.swing.text.DefaultEditorKit
         javax.swing.text.StyledEditorKit
            javax.swing.text.rtf.RTFEditorKit

All Implemented Interfaces:
Cloneable, Serializable

This is the default implementation of RTF editing functionality. The RTF support was not written by the Swing team. In the future we hope to improve the support provided.

author: Timothy - Prinzing (of this class, not the package!)

Fields inherited from javax.swing.text.StyledEditorKit:
currentRun, currentParagraph, inputAttributes

Fields inherited from javax.swing.text.DefaultEditorKit:
EndOfLineStringProperty, insertContentAction, insertBreakAction, insertTabAction, deletePrevCharAction, deleteNextCharAction, deleteNextWordAction, deletePrevWordAction, readOnlyAction, writableAction, cutAction, copyAction, pasteAction, beepAction, pageUpAction, pageDownAction, selectionPageUpAction, selectionPageDownAction, selectionPageLeftAction, selectionPageRightAction, forwardAction, backwardAction, selectionForwardAction, selectionBackwardAction, upAction, downAction, selectionUpAction, selectionDownAction, beginWordAction, endWordAction, selectionBeginWordAction, selectionEndWordAction, previousWordAction, nextWordAction, selectionPreviousWordAction, selectionNextWordAction, beginLineAction, endLineAction, selectionBeginLineAction, selectionEndLineAction, beginParagraphAction, endParagraphAction, selectionBeginParagraphAction, selectionEndParagraphAction, beginAction, endAction, selectionBeginAction, selectionEndAction, selectWordAction, selectLineAction, selectParagraphAction, selectAllAction, unselectAction, toggleComponentOrientationAction, defaultKeyTypedAction

Fields inherited from javax.swing.text.DefaultEditorKit:

EndOfLineStringProperty, insertContentAction, insertBreakAction, insertTabAction, deletePrevCharAction, deleteNextCharAction, deleteNextWordAction, deletePrevWordAction, readOnlyAction, writableAction, cutAction, copyAction, pasteAction, beepAction, pageUpAction, pageDownAction, selectionPageUpAction, selectionPageDownAction, selectionPageLeftAction, selectionPageRightAction, forwardAction, backwardAction, selectionForwardAction, selectionBackwardAction, upAction, downAction, selectionUpAction, selectionDownAction, beginWordAction, endWordAction, selectionBeginWordAction, selectionEndWordAction, previousWordAction, nextWordAction, selectionPreviousWordAction, selectionNextWordAction, beginLineAction, endLineAction, selectionBeginLineAction, selectionEndLineAction, beginParagraphAction, endParagraphAction, selectionBeginParagraphAction, selectionEndParagraphAction, beginAction, endAction, selectionBeginAction, selectionEndAction, selectWordAction, selectLineAction, selectParagraphAction, selectAllAction, unselectAction, toggleComponentOrientationAction, defaultKeyTypedAction

Constructor:
public RTFEditorKit() { super(); } Constructs an RTFEditorKit.

Constructor:

 public RTFEditorKit() {
        super();
}

Constructs an RTFEditorKit.

Method from javax.swing.text.rtf.RTFEditorKit Summary:
getContentType, read, read, write, write

Methods from javax.swing.text.StyledEditorKit:
clone, createDefaultDocument, createInputAttributes, deinstall, getActions, getCharacterAttributeRun, getInputAttributes, getViewFactory, install

Methods from javax.swing.text.DefaultEditorKit:
createCaret, createDefaultDocument, getActions, getContentType, getInputAttributes, getViewFactory, read, read, write, write

Methods from javax.swing.text.EditorKit:
clone, createCaret, createDefaultDocument, deinstall, getActions, getContentType, getViewFactory, install, read, read, write, write

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

Method from javax.swing.text.rtf.RTFEditorKit Detail:
public String getContentType() { return "text/rtf"; } Get the MIME type of the data that this kit represents support for. This kit supports the type `text/rtf`.
public void read(InputStream in, Document doc, int pos) throws IOException, BadLocationException { if (doc instanceof StyledDocument) { // PENDING(prinz) this needs to be fixed to // insert to the given position. RTFReader rdr = new RTFReader((StyledDocument) doc); rdr.readFromStream(in); rdr.close(); } else { // treat as text/plain super.read(in, doc, pos); } } Insert content from the given stream which is expected to be in a format appropriate for this kind of content handler.
public void read(Reader in, Document doc, int pos) throws IOException, BadLocationException { if (doc instanceof StyledDocument) { RTFReader rdr = new RTFReader((StyledDocument) doc); rdr.readFromReader(in); rdr.close(); } else { // treat as text/plain super.read(in, doc, pos); } } Insert content from the given stream, which will be treated as plain text.
public void write(OutputStream out, Document doc, int pos, int len) throws IOException, BadLocationException { // PENDING(prinz) this needs to be fixed to // use the given document range. RTFGenerator.writeDocument(doc, out); } Write content from a document to the given stream in a format appropriate for this kind of content handler.
public void write(Writer out, Document doc, int pos, int len) throws IOException, BadLocationException { throw new IOException("RTF is an 8-bit format"); } Write content from a document to the given stream as plain text.

Method from javax.swing.text.rtf.RTFEditorKit Detail:

 public String getContentType() {
        return "text/rtf";
}

text/rtf

 public  void read(InputStream in,
    Document doc,
    int pos) throws IOException, BadLocationException {
        if (doc instanceof StyledDocument) {
            // PENDING(prinz) this needs to be fixed to
            // insert to the given position.
            RTFReader rdr = new RTFReader((StyledDocument) doc);
            rdr.readFromStream(in);
            rdr.close();
        } else {
            // treat as text/plain
            super.read(in, doc, pos);
        }
}

Insert content from the given stream which is expected to be in a format appropriate for this kind of content handler.

 public  void read(Reader in,
    Document doc,
    int pos) throws IOException, BadLocationException {
        if (doc instanceof StyledDocument) {
            RTFReader rdr = new RTFReader((StyledDocument) doc);
            rdr.readFromReader(in);
            rdr.close();
        } else {
            // treat as text/plain
            super.read(in, doc, pos);
        }
}

Insert content from the given stream, which will be treated as plain text.

 public  void write(OutputStream out,
    Document doc,
    int pos,
    int len) throws IOException, BadLocationException {
            // PENDING(prinz) this needs to be fixed to
            // use the given document range.
            RTFGenerator.writeDocument(doc, out);
}

Write content from a document to the given stream in a format appropriate for this kind of content handler.

 public  void write(Writer out,
    Document doc,
    int pos,
    int len) throws IOException, BadLocationException {
        throw new IOException("RTF is an 8-bit format");
}

Write content from a document to the given stream as plain text.