Class ImageFormatHandler

java.lang.Object
jfx.incubator.scene.control.richtext.model.DataFormatHandler
jfx.incubator.scene.control.richtext.model.ImageFormatHandler

public class ImageFormatHandler extends DataFormatHandler
Facilitates importing of images into the RichTextModel. The image is imported via lossless compression (PNG).
Since:
28
  • Method Details

    • getInstance

      public static final ImageFormatHandler getInstance()
      Returns the singleton instance of ImageFormatHandler.
      Returns:
      the singleton instance of ImageFormatHandler
    • createStyledInput

      public 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).

      The type of input must be Image.

      Specified by:
      createStyledInput in class DataFormatHandler
      Parameters:
      input - the input data, never null
      attr - the style attributes (can be null)
      Returns:
      the StyledInput
      Throws:
      IOException - when operation is not supported or an I/O error occurs
    • copy

      public Object copy(StyledTextModel m, StyleResolver r, TextPos start, TextPos end) throws IOException
      Description copied from class: DataFormatHandler
      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.

      Specified by:
      copy in class DataFormatHandler
      Parameters:
      m - source model
      r - view-specific style resolver
      start - start text position
      end - end text position
      Returns:
      an object to be placed to the Clipboard
      Throws:
      IOException - when an I/O error occurs
    • save

      public void save(StyledTextModel m, StyleResolver r, TextPos start, TextPos end, OutputStream out) throws IOException
      Description copied from class: DataFormatHandler
      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.

      Specified by:
      save in class DataFormatHandler
      Parameters:
      m - source model
      r - view-specific style resolver
      start - start text position
      end - end text position
      out - target OutputStream
      Throws:
      IOException - when an I/O error occurs