Class EditImageHandler

  • Direct Known Subclasses:
    XMLImageHandler

    @API(type=EXTENDABLE,
         src=PUBLIC)
    public abstract class EditImageHandler
    extends ImageHandler
    Special handler for editing images which are either embedded or referenced.
    Since:
    18
    • Constructor Detail

      • EditImageHandler

        public EditImageHandler()
    • Method Detail

      • editImage

        public abstract java.lang.String editImage​(EmbeddedImageContentProvider contentProvider)
                                            throws CannotEditException
        Edits the document fragment that represents an embedded image.
        Parameters:
        contentProvider - The image content provider.
        Returns:
        The fragment representing the result of the edit, or null if the edit was canceled.
        Throws:
        CannotEditException - If this handler does not support resource editing.
      • editImage

        public abstract boolean editImage​(java.net.URL url)
                                   throws CannotEditException
        Edit the URL that represents an embedded image.
        Parameters:
        url - The URL to be edited.
        Returns:
        true If the URL content was modified.
        Throws:
        CannotEditException - If this handler does not support resource editing.