A DataFormatHandler for use with attribute-based rich text models.

The handler uses a simple text-based format:

(*) denotes an optional element.

PARAGRAPH[]

PARAGRAPH: {
    PARAGRAPH_ATTRIBUTE[]*,
    TEXT_SEGMENT[],
    "\n"
}

PARAGRAPH_ATTRIBUTE: {
    "{!"
    (name)
    ATTRIBUTE_VALUE[]*
    "}"
}

ATTRIBUTE: {
    "{"
    (name)
    ATTRIBUTE_VALUE[]*
    "}"
}

ATTRIBUTE_VALUE: {
    |
    (value)
}

TEXT_SEGMENT: {
    ATTRIBUTE[]*
    (text string with escaped special characters)
}

Attribute sequences are further deduplicated, using a single {number} token which specifies the index into the list of unique sets of attributes. Paragraph attribute sets are treated as separate from the segment attrubite sets.

The following characters are escaped in text segments: {,%,} The escape format is %XX where XX is a hexadecimal value.

Example:

{c|ff00ff}text{b}bold{!rtl}\n
{1}line 2{!0}\n

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	RichTextFormatHandler.Handler<T> attribute handler
private class	RichTextFormatHandler.RichStyledInput importer
private class	RichTextFormatHandler.RichStyledOutput exporter

Field Summary

Modifier and Type	Field and Description
private static final StringConverter<Boolean>	BOOLEAN_CONVERTER
private static final StringConverter<Color>	COLOR_CONVERTER
public static final DataFormat	DATA_FORMAT The data format identifier
private static final boolean	DEBUG
private static final StringConverter<ParagraphDirection>	DIRECTION_CONVERTER
private static final DoubleStringConverter	DOUBLE_CONVERTER
private final HashMap<Object, RichTextFormatHandler.Handler<T>>	handlers
private static final RichTextFormatHandler	instance
private static final StringConverter<String>	STRING_CONVERTER
private static final StringConverter<TextAlignment>	TEXT_ALIGNMENT_CONVERTER

Constructor Summary

Access	Constructor and Description
private	RichTextFormatHandler() Constructor.

Method Summary

Modifier and Type	Method and Description
private <T> void	addHandler(StyleAttribute<T> a, String id, StringConverter<T> converter)
private <T> void	addHandler(RichTextFormatHandler.Handler<T> h)
private void	addHandlerBoolean(StyleAttribute<Boolean> a, String id)
private void	addHandlerString(StyleAttribute<String> a, String id)
public Object	copy(StyledTextModel source model m, StyleResolver view-specific style resolver r, TextPos start text position start, TextPos end text position end) Implements abstract jfx.incubator.scene.control.richtext.model.DataFormatHandler.copy. Creates an object to be put into the Clipboard for the given text range.
public StyledInput	createStyledInput(String the input string input, StyleAttributeMap the style attributes (can be null) attr) Implements abstract jfx.incubator.scene.control.richtext.model.DataFormatHandler.createStyledInput. Creates a StyledInput for the given input string.
private StyledOutput	createStyledOutput(StyleResolver r, Writer wr)
public static final RichTextFormatHandler	Returns: the singleton instance of `RtfFormatHandler` getInstance() Returns the singleton instance of `RtfFormatHandler`.
private static void	initAccessor()
private static boolean	isBuffered(Writer x)
private static void	log(Object x)
public void	save(StyledTextModel source model m, StyleResolver view-specific style resolver r, TextPos start text position start, TextPos end text position end, OutputStream target `OutputStream` out) Implements abstract jfx.incubator.scene.control.richtext.model.DataFormatHandler.save. Save the text range in the handler's format to the output stream (e.g. save to file).

Inherited from jfx.incubator.scene.control.richtext.model.DataFormatHandler:: getDataFormat

Field Detail

BOOLEAN_CONVERTER	back to summary
private static final StringConverter<Boolean> BOOLEAN_CONVERTER

COLOR_CONVERTER	back to summary
private static final StringConverter<Color> COLOR_CONVERTER

DATA_FORMAT	back to summary
public static final DataFormat DATA_FORMAT The data format identifier

DEBUG	back to summary
private static final boolean DEBUG

DIRECTION_CONVERTER	back to summary
private static final StringConverter<ParagraphDirection> DIRECTION_CONVERTER

DOUBLE_CONVERTER	back to summary
private static final DoubleStringConverter DOUBLE_CONVERTER

handlers	back to summary
private final HashMap<Object, RichTextFormatHandler.Handler<T>> handlers

instance	back to summary
private static final RichTextFormatHandler instance

STRING_CONVERTER	back to summary
private static final StringConverter<String> STRING_CONVERTER

TEXT_ALIGNMENT_CONVERTER	back to summary
private static final StringConverter<TextAlignment> TEXT_ALIGNMENT_CONVERTER

Constructor Detail

RichTextFormatHandler	back to summary
private RichTextFormatHandler() Constructor.

Method Detail

addHandler	back to summary
private <T> void addHandler(StyleAttribute<T> a, String id, StringConverter<T> converter)

addHandler	back to summary
private <T> void addHandler(RichTextFormatHandler.Handler<T> h)

addHandlerBoolean	back to summary
private void addHandlerBoolean(StyleAttribute<Boolean> a, String id)

addHandlerString	back to summary
private void addHandlerString(StyleAttribute<String> a, String id)

copy back to summary

copy	back to summary
public Object copy(StyledTextModel m, StyleResolver r, TextPos start, TextPos end) throws IOException Implements abstract jfx.incubator.scene.control.richtext.model.DataFormatHandler.copy. Doc from jfx.incubator.scene.control.richtext.model.DataFormatHandler.copy. Creates an object to be put into the Clipboard for the given text range. The caller must guarantee that the `start` precedes the `end` position. Typically, the implementation creates an instance of `StyledOutput` and calls `StyledTextModel#export(TextPos, TextPos, StyledOutput)` method. Parameters m:StyledTextModel source model r:StyleResolver view-specific style resolver start:TextPos start text position end:TextPos end text position Returns:Object an object to be placed to the Clipboard Annotations @Override Exceptions IOException: when an I/O error occurs

public Object copy(StyledTextModel m, StyleResolver r, TextPos start, TextPos end) throws IOException

Implements abstract jfx.incubator.scene.control.richtext.model.DataFormatHandler.copy.

Doc from jfx.incubator.scene.control.richtext.model.DataFormatHandler.copy.

Creates an object to be put into the Clipboard for the given text range. The caller must guarantee that the start precedes the end position.

Typically, the implementation creates an instance of StyledOutput and calls StyledTextModel#export(TextPos, TextPos, StyledOutput) method.

Parameters

m:StyledTextModel: source model
r:StyleResolver: view-specific style resolver
start:TextPos: start text position
end:TextPos: end text position

Returns:Object

an object to be placed to the Clipboard

Annotations

@Override

Exceptions

IOException:: when an I/O error occurs

createStyledInput back to summary

createStyledInput	back to summary
public StyledInput createStyledInput(String input, StyleAttributeMap attr) Implements abstract jfx.incubator.scene.control.richtext.model.DataFormatHandler.createStyledInput. Doc from jfx.incubator.scene.control.richtext.model.DataFormatHandler.createStyledInput. Creates a StyledInput for the given input string. When pasting, the caller may pass the style attributes `attr` at the insertion point. This argument may be used by the implementation if the format contains no styles on its own (for example, in the plain text format case). Parameters input:String the input string attr:StyleAttributeMap the style attributes (can be null) Returns:StyledInput the StyledInput Annotations @Override

public StyledInput createStyledInput(String input, StyleAttributeMap attr)

Implements abstract jfx.incubator.scene.control.richtext.model.DataFormatHandler.createStyledInput.

Doc from jfx.incubator.scene.control.richtext.model.DataFormatHandler.createStyledInput.

Creates a StyledInput for the given input string. When pasting, the caller may pass the style attributes attr at the insertion point. This argument may be used by the implementation if the format contains no styles on its own (for example, in the plain text format case).

Parameters

input:String: the input string
attr:StyleAttributeMap: the style attributes (can be null)

Returns:StyledInput

the StyledInput

Annotations

@Override

createStyledOutput	back to summary
private StyledOutput createStyledOutput(StyleResolver r, Writer wr)

getInstance back to summary

getInstance	back to summary
public static final RichTextFormatHandler getInstance() Returns the singleton instance of `RtfFormatHandler`. Returns:RichTextFormatHandler the singleton instance of `RtfFormatHandler`

public static final RichTextFormatHandler getInstance()

Returns the singleton instance of RtfFormatHandler.

Returns:RichTextFormatHandler: the singleton instance of RtfFormatHandler

initAccessor	back to summary
private static void initAccessor()

isBuffered	back to summary
private static boolean isBuffered(Writer x)

log	back to summary
private static void log(Object x)

save back to summary

save	back to summary
public void save(StyledTextModel m, StyleResolver r, TextPos start, TextPos end, OutputStream out) throws IOException Implements abstract jfx.incubator.scene.control.richtext.model.DataFormatHandler.save. Doc from jfx.incubator.scene.control.richtext.model.DataFormatHandler.save. Save the text range in the handler's format to the output stream (e.g. save to file). The caller must guarantee that the `start` precedes the `end` position. It is the responsibility of the caller to close the `OutputStream`. Typically, the implementation creates an instance of `StyledOutput` and calls `StyledTextModel#export(TextPos, TextPos, StyledOutput)` method. Parameters m:StyledTextModel source model r:StyleResolver view-specific style resolver start:TextPos start text position end:TextPos end text position out:OutputStream target `OutputStream` Annotations @Override Exceptions IOException: when an I/O error occurs

public void save(StyledTextModel m, StyleResolver r, TextPos start, TextPos end, OutputStream out) throws IOException

Implements abstract jfx.incubator.scene.control.richtext.model.DataFormatHandler.save.

Doc from jfx.incubator.scene.control.richtext.model.DataFormatHandler.save.

Save the text range in the handler's format to the output stream (e.g. save to file). The caller must guarantee that the start precedes the end position. It is the responsibility of the caller to close the OutputStream.

Typically, the implementation creates an instance of StyledOutput and calls StyledTextModel#export(TextPos, TextPos, StyledOutput) method.

Parameters

m:StyledTextModel: source model
r:StyleResolver: view-specific style resolver
start:TextPos: start text position
end:TextPos: end text position
out:OutputStream: target OutputStream

Annotations

@Override

Exceptions

IOException:: when an I/O error occurs

jfx.incubator.scene.control.richtext.model back to summary

pack-priv Class RichTextFormatHandler.Handler<T>

Class Inheritance

extends Object

java.lang.Object
jfx.incubator.scene.control.richtext.model.RichTextFormatHandler.Handler

attribute handler

Field Summary

Modifier and Type	Field and Description
private final StyleAttribute<T>	attribute
private final StringConverter<T>	converter
private final String	id

Constructor Summary

Access	Constructor and Description
public	Handler(StyleAttribute<T> attribute, String id, StringConverter<T> converter)

Method Summary

Modifier and Type	Method and Description
public String	getId()
public StyleAttribute<T>	getStyleAttribute()
public boolean	isAllowed(T value)
public T	read(String s)
public String	write(T value)

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

Field Detail

attribute	back to summary
private final StyleAttribute<T> attribute

converter	back to summary
private final StringConverter<T> converter

id	back to summary
private final String id

Constructor Detail

Handler	back to summary
public Handler(StyleAttribute<T> attribute, String id, StringConverter<T> converter)

Method Detail

getId	back to summary
public String getId()

getStyleAttribute	back to summary
public StyleAttribute<T> getStyleAttribute()

isAllowed	back to summary
public boolean isAllowed(T value)

read	back to summary
public T read(String s)

write	back to summary
public String write(T value)

jfx.incubator.scene.control.richtext.model back to summary

private Class RichTextFormatHandler.RichStyledInput

Class Inheritance

extends Object
implements StyledInput

java.lang.Object
jfx.incubator.scene.control.richtext.model.RichTextFormatHandler.RichStyledInput

All Implemented Interfaces

jfx.incubator.scene.control.richtext.model.StyledInput, java.io.Closeable, java.lang.AutoCloseable

importer

Field Summary

Modifier and Type	Field and Description
private int	index
private int	line
private StringBuilder	sb
private final ArrayList<StyleAttributeMap>	styles
private final String	text

Constructor Summary

Access	Constructor and Description
public	RichStyledInput(String text)

Method Summary

Modifier and Type	Method and Description
private int	charAt(int delta)
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
private static int	decodeHex(int ch)
private int	decodeHexByte()
private String	decodeText()
private String	decodeText(int start, int ix)
private IOException	err(Object text)
public StyledSegment	nextSegment() Implements jfx.incubator.scene.control.richtext.model.StyledInput.nextSegment. Returns the next segment, or null if no more segments.
private StyleAttributeMap	parseAttributes(boolean forParagraph)
private int	parseStyleNumber(String s)

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

Field Detail

index	back to summary
private int index

line	back to summary
private int line

sb	back to summary
private StringBuilder sb

styles	back to summary
private final ArrayList<StyleAttributeMap> styles

text	back to summary
private final String text

Constructor Detail

RichStyledInput	back to summary
public RichStyledInput(String text)

Method Detail

charAt	back to summary
private int charAt(int delta)

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

decodeHex	back to summary
private static int decodeHex(int ch) throws IOException

decodeHexByte	back to summary
private int decodeHexByte() throws IOException

decodeText	back to summary
private String decodeText() throws IOException

decodeText	back to summary
private String decodeText(int start, int ix) throws IOException

err	back to summary
private IOException err(Object text)

nextSegment

back to summary

public StyledSegment nextSegment()

Implements jfx.incubator.scene.control.richtext.model.StyledInput.nextSegment.

Doc from jfx.incubator.scene.control.richtext.model.StyledInput.nextSegment.

Returns the next segment, or null if no more segments.

Returns:StyledSegment

the next segment, or null if no more segments

Annotations

@Override

parseAttributes	back to summary
private StyleAttributeMap parseAttributes(boolean forParagraph) throws IOException

parseStyleNumber	back to summary
private int parseStyleNumber(String s) throws IOException

jfx.incubator.scene.control.richtext.model back to summary

private Class RichTextFormatHandler.RichStyledOutput

Class Inheritance

extends Object
implements StyledOutput

java.lang.Object
jfx.incubator.scene.control.richtext.model.RichTextFormatHandler.RichStyledOutput

All Implemented Interfaces

jfx.incubator.scene.control.richtext.model.StyledOutput, java.io.Closeable, java.lang.AutoCloseable

exporter

Field Summary

Modifier and Type	Field and Description
private final StyleResolver	resolver
private HashMap<StyleAttributeMap, Integer>	styles
private final Writer	wr

Constructor Summary

Access	Constructor and Description
public	RichStyledOutput(StyleResolver r, Writer wr)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public void	consume(StyledSegment the segment to output seg) Implements jfx.incubator.scene.control.richtext.model.StyledOutput.consume. Consumes the next styled segment.
private void	emitAttributes(StyleAttributeMap attrs, boolean forParagraph)
private static String	encode(String text)
public void	flush() Implements jfx.incubator.scene.control.richtext.model.StyledOutput.flush. Flushes this output stream.
private static int	indexOfSpecialChar(String text)
private static boolean	isSpecialChar(char c)