DocumentFormatInstance Leave feedback

Inheritance: java.lang.Object

public abstract class DocumentFormatInstance

Represents a specific format of a document. Implement this class to add your own document types.

Learn more

• More details about implementing custom formats: Create custom format handler

The following example demonstrates how to create an empty stub for a custom format handler.

  public class DummyDocument extends DocumentFormatInstance
 {
     {@literal @}Override
     public void load(InputStream output) throws java.lang.Exception
     {
         // load file content
     }
     {@literal @}Override
     public void save(OutputStream output) throws java.lang.Exception
     {
         // save changes to file;
     }
 }
 

public DocumentFormatInstance()

public static DocumentFormatInstance createInstance(Class docType)

Parameters:

Returns: DocumentFormatInstance

public final String getPassword()

Gets a password for password protected documents.

Returns: java.lang.String - A password for password protected documents.

public final void setPassword(String value)

Sets a password for password protected documents.

Parameters:

public boolean getRequiresRasterization()

Gets value, indicating if the format instance is read-only and cannot be saved in original format.

Returns: boolean - Value, indicating if the format instance is read-only and cannot be saved in original format.

public final boolean isAccessGranted()

Returns: boolean

public void initialize(DocumentFormatConfiguration config, RedactorSettings settings)

Performs initialization of the instance of document format handler.

Parameters:

public void load(InputStream input)

Loads the document from a stream.

Parameters:

public abstract void save(OutputStream output)

Saves the document to a stream.

Parameters:

public final boolean isRedactionAccepted(RedactionDescription description)

Checks for IRedactionCallback implementation and invokes it, if specified.

Parameters:

Returns: boolean - True (by default) if redaction is accepted

public boolean performBinaryCheck(InputStream input)

Checks if the given stream contains a document, supported by this format instance.

Parameters:

Returns: boolean - True, if the document can be loaded by this format instance and false otherwise

public static RedactorConfiguration getDefaultConfiguration()

Provides a singleton instance with default configuration of built-in formats.

Returns: RedactorConfiguration - Configuration instance