JavaFX 27 · jfx.incubator.scene.control.richtext.model.DataFormatHandler

Modifier and Type	Field and Description
private final DataFormat	format

Access	Constructor and Description
public	DataFormatHandler(DataFormat data format f) Creates a DataHandler instance for the specified format.

Method Summary

Modifier and Type	Method and Description
public abstract Object	Returns: an object to be placed to the Clipboard copy(StyledTextModel source model model, StyleResolver view-specific style resolver resolver, TextPos start text position start, TextPos end text position end) Creates an object to be put into the Clipboard for the given text range.
public abstract StyledInput	Returns: the StyledInput createStyledInput(Object the input data, never null input, StyleAttributeMap the style attributes (can be null) attr) Creates a StyledInput for the given input data.
public final DataFormat	Returns: the data format getDataFormat() Returns the `DataFormat` associated with this handler.
public abstract 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) Save the text range in the handler's format to the output stream (e.g. save to file).

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

format	back to summary
private final DataFormat format

DataFormatHandler	back to summary
public DataFormatHandler(DataFormat f) Creates a DataHandler instance for the specified format. Parameters f:DataFormat data format

Method Detail

copy back to summary

copy	back to summary
public abstract Object copy(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end) throws IOException 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 Exceptions IOException: when an I/O error occurs UnsupportedOperationException: if the copy operation is not supported

public abstract Object copy(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end) throws IOException

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

Exceptions

IOException:: when an I/O error occurs
UnsupportedOperationException:: if the copy operation is not supported

createStyledInput back to summary

createStyledInput	back to summary
public abstract StyledInput createStyledInput(Object input, StyleAttributeMap attr) throws IOException Creates a StyledInput for the given input data. 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:Object the input data, never null attr:StyleAttributeMap the style attributes (can be null) Returns:StyledInput the StyledInput Exceptions IOException: when operation is not supported or an I/O error occurs UnsupportedOperationException: if the copy operation is not supported ClassCastException: if the input data type is not supported by the handler Since 27

public abstract StyledInput createStyledInput(Object input, StyleAttributeMap attr) throws IOException

Creates a StyledInput for the given input data. 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:Object: the input data, never null
attr:StyleAttributeMap: the style attributes (can be null)

Returns:StyledInput

the StyledInput

Exceptions

IOException:: when operation is not supported or an I/O error occurs
UnsupportedOperationException:: if the copy operation is not supported
ClassCastException:: if the input data type is not supported by the handler

Since

getDataFormat back to summary

getDataFormat	back to summary
public final DataFormat getDataFormat() Returns the `DataFormat` associated with this handler. Returns:DataFormat the data format

public final DataFormat getDataFormat()

Returns the DataFormat associated with this handler.

Returns:DataFormat: the data format

save back to summary

save	back to summary
public abstract void save(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end, OutputStream out) throws IOException 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` Exceptions IOException: when an I/O error occurs UnsupportedOperationException: if the copy operation is not supported

public abstract void save(StyledTextModel model, StyleResolver resolver, TextPos start, TextPos end, OutputStream out) throws IOException

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

Exceptions

IOException:: when an I/O error occurs
UnsupportedOperationException:: if the copy operation is not supported

public abstract Class DataFormatHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail