JavaFX 24 · jfx.incubator.scene.control.richtext.model.RtfFormatHandler

Modifier and Type	Field and Description
private static final RtfFormatHandler	instance

Access	Constructor and Description
private	RtfFormatHandler() The constructor

Method Summary

Modifier and Type	Method and Description
public Object	copy(StyledTextModel source model model, StyleResolver view-specific style resolver resolver, 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 text, 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 void	export(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end, Writer wr)
public static final RtfFormatHandler	Returns: the singleton instance of `RtfFormatHandler` getInstance() Returns the singleton instance of `RtfFormatHandler`.
public void	save(StyledTextModel source model model, StyleResolver view-specific style resolver resolver, 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

instance	back to summary
private static final RtfFormatHandler instance

RtfFormatHandler	back to summary
private RtfFormatHandler() The constructor

Method Detail

copy back to summary

copy	back to summary
public Object copy(StyledTextModel model, StyleResolver resolver, 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 model:StyledTextModel source model resolver: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 model, StyleResolver resolver, 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

model:StyledTextModel: source model
resolver: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 text, StyleAttributeMap attr) throws IOException 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 text:String the input string attr:StyleAttributeMap the style attributes (can be null) Returns:StyledInput the StyledInput Annotations @Override Exceptions IOException: when operation is not supported or an I/O error occurs

public StyledInput createStyledInput(String text, StyleAttributeMap attr) throws IOException

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

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

Returns:StyledInput

the StyledInput

Annotations

@Override

Exceptions

IOException:: when operation is not supported or an I/O error occurs

export	back to summary
private void export(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end, Writer wr) throws IOException

getInstance back to summary

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

public static final RtfFormatHandler getInstance()

Returns the singleton instance of RtfFormatHandler.

Returns:RtfFormatHandler: the singleton instance of RtfFormatHandler

save back to summary

save	back to summary
public void save(StyledTextModel model, StyleResolver resolver, 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 model:StyledTextModel source model resolver: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 model, StyleResolver resolver, 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

model:StyledTextModel: source model
resolver: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 Class RtfFormatHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail