com.groupdocs.editor

Class EditableDocument

java.lang.Object

com.groupdocs.editor.EditableDocument

All Implemented Interfaces:

IAuxDisposable, IDisposable

public final class EditableDocument
extends Object
implements IAuxDisposable

Intermediate document, that contains content before and after editing

Instance of EditableDocument class can be produced by the Editor.edit() method or created by the user himself using static factories. EditableDocument internally stores document in its own closed format, which is compatible (convertible) with all import and export formats, that GroupDocs.Editor supports. In order to make document editable in any WYSIWYG client-side editor (like CKEditor or TinyMCE), EditableDocument provides methods for generating HTML markup and producing resources, that can be accepted by the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EditableDocument.InitialDocumentType

Field Summary

Fields

Modifier and Type	Field and Description
Event<EventHandler>	Disposed

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes this Editable document instance, disposing its content and making its methods and properties non-working
static EditableDocument	fromFile(String htmlFilePath, String resourceFolderPath) Static factory, that creates an instance of EditableDocument from a HTML file, that is specified by a path to the *.html file itself and a folder with linked resources
static EditableDocument	fromMarkup(String newHtmlContent, List<IHtmlResource> resources) Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources
static EditableDocument	fromMarkupAndResourceFolder(String newHtmlContent, String resourceFolderPath) Static factory, that creates an instance of EditableDocument from a specified HTML markup and from resources, located in the folder, specified by the full path
List<IHtmlResource>	getAllResources() Returns a list of all existing resources: all stylesheets, images from HTML and all stylesheets, fonts
List<Mp3Audio>	getAudio() Returns a list of audio resources
String	getBodyContent() Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string.
String	getBodyContent(String externalImagesTemplate) Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified prefix.
String	getContent() Returns overall content of the HTML document as a string.
OutputStream	getContent(OutputStream storage, Charset encoding) Returns overall content of the HTML document as a byte stream by writing this content into specified stream with specified text encoding
String	getContentString(String externalImagesTemplate, String externalCssTemplate) Returns overall content of the HTML document as a string, where links to the external resources contain specified prefix.
List<CssText>	getCss() Returns a list of CSS resources
List<String>	getCssContent() Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet.
List<String>	getCssContent(String externalImagesPrefix, String externalFontsPrefix) Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet.
String	getEmbeddedHtml() Returns all content of this HTML document with all related resources in a form of a single string, where all resources are embedded inside the HTML markup in a base64-encoded form.
List<FontResourceBase>	getFonts() Allows to obtain external font resources, which are used by this HTML document
List<IImageResource>	getImages() Allows to obtain external image resources (raster images), which are used by this HTML document
boolean	isDisposed() Determines whether this Editable document was already disposed (true) or not (false)
void	save(String htmlFilePath) Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources.
void	save(String htmlFilePath, String resourcesFolderPath) Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources, which is located on specified path.
void	save(Writer htmlMarkup, com.groupdocs.editor.options.HtmlSaveOptions saveOptions)

Methods inherited from class java.lang.Object

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

Field Detail

Disposed

public final Event<EventHandler> Disposed

Method Detail

dispose

public final void dispose()

Disposes this Editable document instance, disposing its content and making its methods and properties non-working

Specified by:

dispose in interface IDisposable

fromFile

public static EditableDocument fromFile(String htmlFilePath,
                                        String resourceFolderPath)

Static factory, that creates an instance of EditableDocument from a HTML file, that is specified by a path to the *.html file itself and a folder with linked resources

Parameters:

htmlFilePath - String, that contains a full path to the HTML file. Cannot be null, should be valid file path, and file itself should exists.

resourceFolderPath - Optional path to the folder with HTML resources. If NULL, invalid or such folder doesn't exist, Editor will try to find the this folder by itself, analyzing the HTML markup

Returns:

New non-null instance of EditableDocument

fromMarkup

public static EditableDocument fromMarkup(String newHtmlContent,
                                          List<IHtmlResource> resources)

Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources

Parameters:

newHtmlContent - String, that contains raw HTML markup, that should be parsed. Cannot be NULL, empty or invalid.

resources - Collection of all resources (images, stylesheets, fonts), that are used in the HTML-document, specified in newHtmlContent parameter. May be absent (NULL or empty collection).

Returns:

New non-null instance of EditableDocument

fromMarkupAndResourceFolder

public static EditableDocument fromMarkupAndResourceFolder(String newHtmlContent,
                                                           String resourceFolderPath)

Static factory, that creates an instance of EditableDocument from a specified HTML markup and from resources, located in the folder, specified by the full path

Parameters:

newHtmlContent - String, that contains raw HTML markup, that should be parsed. Cannot be NULL, empty or invalid.

resourceFolderPath - Mandatory path to the folder with resources. All stylesheets, which are located in this folder, will be used. Cannot be NULL or empty string, and this folder should exists.

This static factory is useful when content of HTML document is presented as a string, but all resources are located in some folder, and often links to these resources in HTML markup are invalid and absent. When invoking this method, it scans specified folder and automatically applies all found stylesheets to the document. This method is very useful when obtaining content from different HTML editors, which usually cut off the document metadata and so on.

Returns:

New non-null instance of EditableDocument

getAllResources

public final List<IHtmlResource> getAllResources()

Returns a list of all existing resources: all stylesheets, images from HTML and all stylesheets, fonts

This property returns a concatenated result of 'Images', 'Fonts', and 'Css' properties

getAudio

public final List<Mp3Audio> getAudio()

Returns a list of audio resources

getBodyContent

public final String getBodyContent()

Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string.

Returns:

String, which contains the body of the HTML document

WYSIWYG editors operate with the body of the document and cannot correctly process its meta information from the HEAD block. This method is designed for such cases. This overload doesn't allow to adjust URIs for external resource requests.

getBodyContent

public final String getBodyContent(String externalImagesTemplate)

Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified prefix.

Parameters:

externalImagesTemplate - Through this parameter used can specify a prefix, which will be added to the links to all external images in IMG elements, which will be present in the resultant HTML string. If NULL or empty, prefixes will not be added.

WYSIWYG editors operate with the body of the document and cannot correctly process its meta information from the HEAD block. This method is designed for such cases. This overload allows to adjust URIs for external resource requests.

Returns:

String, which contains the body of the HTML document with links, adjusted to the external images

getContent

public String getContent()

Returns overall content of the HTML document as a string.

Returns:

String, which contains the content of the HTML document

getContent

public OutputStream getContent(OutputStream storage,
                               Charset encoding)

Returns overall content of the HTML document as a byte stream by writing this content into specified stream with specified text encoding

Parameters:

storage - Non-null byte stream, which supports writing

encoding - Non-null text encoding, which should be apllied while writing text content into specified storage

TStream: Any implementation of the InputStream

Returns:

Instance of specified storage

Throws:

com.aspose.ms.System.ArgumentNullException - Any of input arguments are null

com.aspose.ms.System.ArgumentException - Specified stream is not writable

getContentString

public String getContentString(String externalImagesTemplate,
                               String externalCssTemplate)

Returns overall content of the HTML document as a string, where links to the external resources contain specified prefix.

Parameters:

externalImagesTemplate - Through this parameter used can specify a prefix, which will be added to the links to all external images in IMG elements, which will be present in the resultant HTML string. If NULL or empty, prefixes will not be added.

externalCssTemplate - Through this parameter used can specify a prefix, which will be added to the links to all external stylesheets in LINK elements, which will be present in the resultant HTML string. If NULL or empty, prefixes will not be added.

Returns:

String, which contains the content of the HTML document with links, adjusted to the external resources

getCss

public final List<CssText> getCss()

Returns a list of CSS resources

getCssContent

public final List<String> getCssContent()

Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Returns empty list, if there is no CSS for this document.

Returns:

A list of strings, where each string holds a content of one CSS document

getCssContent

public final List<String> getCssContent(String externalImagesPrefix,
                                        String externalFontsPrefix)

Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Specified prefix will be applied to every link to the external resource in every resultant stylesheet. Returns empty list, if there is no CSS for this document.

Parameters:

externalImagesPrefix - Through this parameter used can specify a prefix, which will be added to the links to all external images, which will be present in CSS declarations in the resultant CSS strings. If NULL or empty, prefixes will not be added.

externalFontsPrefix - Through this parameter used can specify a prefix, which will be added to the links to all external fonts in the

Returns:

A list of strings, where each string holds a content of one CSS document

getEmbeddedHtml

public final String getEmbeddedHtml()

Returns all content of this HTML document with all related resources in a form of a single string, where all resources are embedded inside the HTML markup in a base64-encoded form.

Returns:

String, which is not NULL or empty in any case

Throws:

com.aspose.ms.System.ObjectDisposedException - This EditableDocument instance was already disposed

This method converts this EditableDocument into HTML and serializes in into single string, where all resources are embedded into string along with HTML markup: * All images from HTML->BODY are converted to base64 format and are located in the IMG 'src' attribute; * All stylesheets are stored in the STYLE elements inside HTML->HEAD sections; * All images from stylesheets are converted to base64 format and located in the appropriate CSS declarations; * All fonts from stylesheets are converted to base64 format and located in the appropriate @font-face at-rules.

getFonts

public final List<FontResourceBase> getFonts()

Allows to obtain external font resources, which are used by this HTML document

getImages

public final List<IImageResource> getImages()

Allows to obtain external image resources (raster images), which are used by this HTML document

isDisposed

public final boolean isDisposed()

Determines whether this Editable document was already disposed (true) or not (false)

Specified by:

isDisposed in interface IAuxDisposable

save

public final void save(String htmlFilePath)

Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources.

Parameters:

htmlFilePath - Full path to the file, where HTML markup will be stored. File will be created or overwritten, if exists. Accompanying resource folder will be created in the same folder, where HTML file exist.

save

public final void save(String htmlFilePath,
                       String resourcesFolderPath)

Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources, which is located on specified path.

Parameters:

htmlFilePath - Full path to the file, where HTML markup will be stored. Cannot be NULL or empty. File will be created or overwritten, if exists.

resourcesFolderPath - Full path to the accompanying folder, where all related resources will be stored. If NULL or empty, folder will be created automatically in the same directory, where *.html file. If specified and not exists, will be created.

save

public void save(Writer htmlMarkup,
                 com.groupdocs.editor.options.HtmlSaveOptions saveOptions)
          throws Exception

Throws:

Exception