com.groupdocs.editor

Class Editor

java.lang.Object

com.groupdocs.editor.Editor

All Implemented Interfaces:

IAuxDisposable, IDisposable

public final class Editor
extends Object
implements IAuxDisposable

Main class, which encapsulates conversion methods. Editor class provides methods for loading, editing, and saving documents of all supportable formats. It is disposable, so use a 'using' directive or dispose its resources manually via 'Dispose()' method call. Document loading is performed through constructors. Document editing - through method 'Edit', and saving back to the resultant document after edit - through method 'Save'.

Editor class should be considered as an entry point and the root object of the GroupDocs.Editor. All operations are performed using this class. Typical usage of the Editor class for performing a full document editing pipeline is the next:

• Load a document into the Editor instance through its constructor.
• Optionally, detect a document type using a method.
• Open a document for editing by calling an method and obtaining an instance of class from it..
• Editing a document content on client-side using any WYSIWYG HTML-editor.
• Creating a new instance of from edited document content.
• Saving an edited document to some output format by calling a method.
• Disposing an instance of Editor class via 'using' operator or manually.

Field Summary

Fields inherited from interface com.groupdocs.editor.htmlcss.resources.IAuxDisposable

Disposed

Constructor Summary

Constructors

Constructor and Description
Editor(com.groupdocs.editor.formats.abstraction.DocumentFormatBase format) Initializes a new instance of the Editor class and creates a new empty document based on the specified format.
Editor(InputStream document) Initializes new Editor instance with specified input document (as a stream)
Editor(InputStream document, ILoadOptions loadOptions) Initializes new Editor instance with specified input document (as a stream) with its load options and Editor settings
Editor(String filePath) Initializes new Editor instance with specified input document (as a full file path)
Editor(String filePath, ILoadOptions loadOptions) Initializes new Editor instance with specified input document (as a full file path) with its load options

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes this instance of Editor, so that it releases all internal resources and becomes unavailable for further usage
EditableDocument	edit() Opens a previously loaded document for editing using default options by generating and returning an instance of 'EditableDocument' class, that, in turn, contains methods for producing HTML markup and associated resources.
EditableDocument	edit(IEditOptions editOptions) Opens a previously loaded document for editing using specified format-specific options by generating and returning an instance of '' class, that, in turn, contains methods for producing HTML markup and associated resources.
IDocumentInfo	getDocumentInfo(String password) Returns metadata about the document, that was loaded to this 'Editor' instance
com.groupdocs.editor.FormFieldManager	getFormFieldManager() Provides access to functionality for managing form fields within the document.
boolean	isDisposed() Indicates whether this Editor instance was already disposed and cannot be used anymore (true) or not and is active (false)
void	save(EditableDocument inputDocument, OutputStream outputDocument, ISaveOptions saveOptions) Converts specified edited document, represented as instance of 'EditableDocument', to the resultant document of specified format and saves its content to specified stream
void	save(EditableDocument inputDocument, String filePath, ISaveOptions saveOptions) Converts specified edited document, represented as instance of '', to the resultant document of specified format and saves its content to file by specified file path
OutputStream	save(OutputStream outputDocument) Save the current document content to the specified output stream.
OutputStream	save(OutputStream outputDocument, WordProcessingSaveOptions saveOptions) Converts the original document after modification (for example, FormFieldManager(getFormFieldManager())), to the resultant document of the specified format and saves its content to the provided stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Editor

public Editor(com.groupdocs.editor.formats.abstraction.DocumentFormatBase format)
       throws Exception

Initializes a new instance of the Editor class and creates a new empty document based on the specified format.

 
 IDocumentFormat format = WordProcessingFormats.Docx;
 Editor editor = new Editor(format);
 {
     // Use the editor instance to edit and save documents
 }
 
 

Parameters:

format - represents the file format of the document that will be created. Learn more

• More about file types supported by GroupDocs.Editor: Document formats supported by GroupDocs.Editor
• More about GroupDocs.Editor for Java features: Developer Guide

Throws:

Exception

Editor

public Editor(InputStream document)

Initializes new Editor instance with specified input document (as a stream)

Parameters:

document - Delegate, that should return a stream with document content. Should not be NULL. Learn more

• More about file types supported by GroupDocs.Editor: Document formats supported by GroupDocs.Editor
• More about GroupDocs.Editor for Java features: Developer Guide

Editor

public Editor(InputStream document,
              ILoadOptions loadOptions)

Initializes new Editor instance with specified input document (as a stream) with its load options and Editor settings

Parameters:

document - Delegate, that should return a stream with document content. Should not be NULL.

loadOptions - Delegate, that should return a document load options. May be NULL and may return null - in that case document type will be detected automatically and default load options for that type will be applied.

Editor

public Editor(String filePath)

Initializes new Editor instance with specified input document (as a full file path)

Parameters:

filePath - Full path to the file. Should not be NULL. Should be valid, and file should exist. Learn more

• More about file types supported by GroupDocs.Editor: Document formats supported by GroupDocs.Editor
• More about GroupDocs.Editor for Java features: Developer Guide

Editor

public Editor(String filePath,
              ILoadOptions loadOptions)

Initializes new Editor instance with specified input document (as a full file path) with its load options

Parameters:

filePath - Full path to the file. Should not be NULL. Should be valid, and file should exist.

loadOptions - Delegate, that should return a document load options. May be NULL and may return null - in that case document type will be detected automatically and default load options for that type will be applied. Learn more

• More about file types supported by GroupDocs.Editor: Document formats supported by GroupDocs.Editor
• More about GroupDocs.Editor for Java features: Developer Guide
• More about how to open and edit password-protected documents and document from different storages: Load and edit documents using GroupDocs.Editor

Method Detail

dispose

public final void dispose()

Disposes this instance of Editor, so that it releases all internal resources and becomes unavailable for further usage

Specified by:

dispose in interface IDisposable

edit

public final EditableDocument edit()

Opens a previously loaded document for editing using default options by generating and returning an instance of 'EditableDocument' class, that, in turn, contains methods for producing HTML markup and associated resources.

Returns:

Instance of the 'EditableDocument' class, which encapsulates overall input document with all its resources in intermediate format. This method, if successfully finished, never returns NULL.

When input original document is loaded to the 'Editor' instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of 'EditableDocument' class. 'EditableDocument', returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload applies edit options, which are default for the format, to which the input document belongs.

Learn more

• More about editing documents using GroupDocs.Editor: How to edit document using GroupDocs.Editor

edit

public final EditableDocument edit(IEditOptions editOptions)

Opens a previously loaded document for editing using specified format-specific options by generating and returning an instance of '' class, that, in turn, contains methods for producing HTML markup and associated resources.

Parameters:

editOptions - Format-specific document options, which allows to tune-up conversion process. Should not be NULL. Should not conflict with previously applied load options.

When input original document is loaded to the 'Editor' instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of 'EditableDocument' class. 'EditableDocument', returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload obtains edit options, which are specific for family formats.

Learn more

• More about editing documents using GroupDocs.Editor: How to edit document using GroupDocs.Editor

getDocumentInfo

public final IDocumentInfo getDocumentInfo(String password)

Returns metadata about the document, that was loaded to this 'Editor' instance

Parameters:

password - User can specify a password for a document, if this document is encrypted with the password. May be NULL or empty string, that is equivalent to the absent password. For those document formats, which do not have a password protection feature, this argument will be ignored. If the document is encrypted, and password in not specified in this parameter, but it was specified before in the load options while creating this instance, it will be used. Learn more

• Learn more about obtaining document specific properties in code: How to get document info using GroupDocs.Editor

getFormFieldManager

public com.groupdocs.editor.FormFieldManager getFormFieldManager()

Provides access to functionality for managing form fields within the document.

Returns:

A FormFieldManager(getFormFieldManager()) instance for managing form fields within the document.

The FormFieldManager(getFormFieldManager()) property creates a new instance of the FormFieldManager(getFormFieldManager()) class, which allows access to methods and properties for managing form fields within the document. Form fields are interactive elements within the document that can capture user input or trigger actions. The FormFieldManager(getFormFieldManager()) instance provides methods for various form field operations, including checking for invalid form fields, updating form field data, and fixing naming issues. It also facilitates the retrieval of form field names and their associated data. This property is useful for interacting with and manipulating form fields programmatically, enabling tasks such as form field validation, synchronization, and customization.

isDisposed

public final boolean isDisposed()

Indicates whether this Editor instance was already disposed and cannot be used anymore (true) or not and is active (false)

Specified by:

isDisposed in interface IAuxDisposable

save

public final void save(EditableDocument inputDocument,
                       OutputStream outputDocument,
                       ISaveOptions saveOptions)

Converts specified edited document, represented as instance of 'EditableDocument', to the resultant document of specified format and saves its content to specified stream

Parameters:

inputDocument - Version of the input document, that was edited in WYSIWYG HTML-editor and is stored as instance of 'EditableDocument' class, which should be converted to output document of some specific format

outputDocument - Output stream, in which the content of the resultant document will be recorded. Should not be NULL, disposed, should support writing.

saveOptions - Document saving options, which define the format of the resultant document, and also general and format-specific saving options. Learn more

• More about saving document after edit using GroupDocs.Editor: How to save edited document using GroupDocs.Editor

save

public final void save(EditableDocument inputDocument,
                       String filePath,
                       ISaveOptions saveOptions)

Converts specified edited document, represented as instance of '', to the resultant document of specified format and saves its content to file by specified file path

Parameters:

inputDocument - Version of the input document, that was edited in WYSIWYG HTML-editor and is stored as instance of '' class, which should be converted to output document of some specific format. Must not be null or disposed.

filePath - Path to the file, in which the output document will be saved. It file with the same name exists, it will be completely rewritten. String with path must not be null, empty or contain only whitespaces.

saveOptions - Document saving options, which define the format of the resultant document, and also general and format-specific saving options. Must not be null. Learn more

• More about saving document after edit using GroupDocs.Editor: How to save edited document using GroupDocs.Editor

save

public final OutputStream save(OutputStream outputDocument)
                        throws Exception

Save the current document content to the specified output stream.

Parameters:

outputDocument - The stream to which the document content will be saved. This cannot be null.

This method copies the content from the internal document representation to the provided output stream. The stream's original position is preserved after the save operation.

Returns:

The stream with the saved document content.

Throws:

NullPointerException - Thrown when outputDocument is null or if the document content is missing.

Exception

save

public final OutputStream save(OutputStream outputDocument,
                               WordProcessingSaveOptions saveOptions)
                        throws Exception

Converts the original document after modification (for example, FormFieldManager(getFormFieldManager())), to the resultant document of the specified format and saves its content to the provided stream.

Parameters:

outputDocument - The stream to which the output document will be saved. This stream should be writable and positioned at the start of the document content. Must not be null.

saveOptions - Document saving options that define the format of the resultant document, as well as general and format-specific saving options. Must not be null.

If the outputDocument or saveOptions is null, an NullPointerException will be thrown. If the document to save is missing, an NullPointerException will be thrown.

<b>Learn more:</b>

Returns:

The stream containing the saved document content.

Throws:

NullPointerException - Thrown when outputDocument or saveOptions is null, or when the document to save is missing.

Exception

See Also:

WordProcessingSaveOptions