org.fxmisc.richtext.model.GenericEditableStyledDocument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of richtextfx Show documentation

Rich-text area for JavaFX

There is a newer version: 0.11.4

package org.fxmisc.richtext.model;

/**
 * Provides a basic implementation of {@link EditableStyledDocument} while still allowing a developer to specify its
 * generics. See {@link SimpleEditableStyledDocument} for a version that specifies its segment style to {@link String}.
 *
 * @param  type of style that can be applied to paragraphs (e.g. {@link javafx.scene.text.TextFlow}.
 * @param  type of segment used in {@link Paragraph}. Can be only {@link org.fxmisc.richtext.TextExt text}
 *             (plain or styled) or a type that combines text and other {@link javafx.scene.Node}s via
 *             {@code Either}.
 * @param  type of style that can be applied to a segment.
 */
public final class GenericEditableStyledDocument extends GenericEditableStyledDocumentBase
        implements EditableStyledDocument {

    /**
     * Creates an {@link EditableStyledDocument} with the given document as its initial content
     */
    public GenericEditableStyledDocument(ReadOnlyStyledDocument initialContent) {
        super(initialContent);
    }

    /**
     * Creates an {@link EditableStyledDocument} with given paragraph as its initial content
     */
    public GenericEditableStyledDocument(Paragraph initialParagraph) {
        super(initialParagraph);
    }

    /**
     * Creates an empty {@link EditableStyledDocument}
     */
    public GenericEditableStyledDocument(PS initialParagraphStyle, S initialStyle, SegmentOps segmentOps) {
        super(initialParagraphStyle, initialStyle, segmentOps);
    }

}