com.aspose.words

Class DocumentBase

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.DocumentBase

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

Direct Known Subclasses:

Document, GlossaryDocument

public abstract class DocumentBase
extends CompositeNode

Provides the abstract base class for a main document and a glossary document of a Word document.

To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

Aspose.Words represents a Word document as a tree of nodes. DocumentBase is a root node of the tree that contains all other nodes of the document.

DocumentBase also stores document-wide information such as getStyles() and getLists() that the tree nodes might refer to.

See Also:

Document, DocumentBase

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocumentBase() Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
Shape	getBackgroundShape() Gets the background shape of the document.
DocumentBase	getDocument() Gets the document to which this node belongs.
FontInfoCollection	getFontInfos() Provides access to properties of fonts used in this document.
ListCollection	getLists() Provides access to the list formatting used in the document.
INodeChangingCallback	getNodeChangingCallback() Called when a node is inserted or removed in the document.
java.awt.Color	getPageColor() Gets the page color of the document.
IResourceLoadingCallback	getResourceLoadingCallback() Allows to control how external resources are loaded.
StyleCollection	getStyles() Returns a collection of styles defined in the document.
IWarningCallback	getWarningCallback() Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss.
Node	importNode(Node srcNode, boolean isImportChildren) Imports a node from another document to the current document.
Node	importNode(Node srcNode, boolean isImportChildren, int importFormatMode)
protected void	resetState()
void	setBackgroundShape(Shape value) Sets the background shape of the document.
void	setNodeChangingCallback(INodeChangingCallback value) Called when a node is inserted or removed in the document.
void	setPageColor(java.awt.Color value) Sets the page color of the document.
void	setResourceLoadingCallback(IResourceLoadingCallback value) Allows to control how external resources are loaded.
void	setWarningCallback(IWarningCallback value) Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss.

Methods inherited from class com.aspose.words.CompositeNode

acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, getText, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node

accept, dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getNextSibling, getNodeType, getParentNode, getPreviousSibling, getRange, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DocumentBase

protected DocumentBase()

Initializes a new instance of this class.

Method Detail

resetState

protected void resetState()

importNode

public Node importNode(Node srcNode,
                       boolean isImportChildren)

Imports a node from another document to the current document.

Imports a node from another document to the current document.

This method uses the ImportFormatMode.USE_DESTINATION_STYLES option to resolve formatting.

Importing a node creates a copy of the source node belonging to the importing document. The returned node has no parent. The source node is not altered or removed from the original document.

Before a node from another document can be inserted into this document, it must be imported. During import, document-specific properties such as references to styles and lists are translated from the original to the importing document. After the node was imported, it can be inserted into the appropriate place in the document using CompositeNode.insertBefore(com.aspose.words.Node, com.aspose.words.Node) or CompositeNode.insertAfter(com.aspose.words.Node, com.aspose.words.Node).

If the source node already belongs to the destination document, then simply a deep clone of the source node is created.

Parameters:

srcNode - The node being imported.

isImportChildren - True to import all child nodes recursively; otherwise, false.

Returns:

The cloned node that belongs to the current document.

See Also:

NodeImporter

importNode

public Node importNode(Node srcNode,
                       boolean isImportChildren,
                       int importFormatMode)

getDocument

public DocumentBase getDocument()

Description copied from class: Node

Gets the document to which this node belongs.

The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.

Overrides:

getDocument in class Node

Returns:

The document to which this node belongs.

getNodeChangingCallback

public INodeChangingCallback getNodeChangingCallback()

Called when a node is inserted or removed in the document.

Returns:

The corresponding INodeChangingCallback value.

setNodeChangingCallback

public void setNodeChangingCallback(INodeChangingCallback value)

Called when a node is inserted or removed in the document.

Parameters:

value - The corresponding INodeChangingCallback value.

getResourceLoadingCallback

public IResourceLoadingCallback getResourceLoadingCallback()

Allows to control how external resources are loaded.

Returns:

The corresponding IResourceLoadingCallback value.

setResourceLoadingCallback

public void setResourceLoadingCallback(IResourceLoadingCallback value)

Allows to control how external resources are loaded.

Parameters:

value - The corresponding IResourceLoadingCallback value.

getFontInfos

public FontInfoCollection getFontInfos()

Provides access to properties of fonts used in this document.

This collection of font definitions is loaded as is from the document. Font definitions might be optional, missing or incomplete in some documents.

Do not rely on this collection to ascertain that a particular font is used in the document. You should only use this collection to get information about fonts that might be used in the document.

Returns:

The corresponding FontInfoCollection value.

See Also:

FontInfoCollection, FontInfo

getStyles

public StyleCollection getStyles()

Returns a collection of styles defined in the document.

For more information see the description of the StyleCollection class.

Returns:

A collection of styles defined in the document.

See Also:

StyleCollection, Style

getLists

public ListCollection getLists()

Provides access to the list formatting used in the document.

For more information see the description of the ListCollection class.

Returns:

The corresponding ListCollection value.

See Also:

ListCollection, List, ListFormat

getWarningCallback

public IWarningCallback getWarningCallback()

Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss. Document may generate warnings at any stage of its existence, so it's important to setup warning callback as early as possible to avoid the warnings loss. E.g. such properties as Document.getPageCount() actually build the document layout which is used later for rendering, and the layout warnings may be lost if warning callback is specified just for the rendering calls later.

Returns:

The corresponding IWarningCallback value.

setWarningCallback

public void setWarningCallback(IWarningCallback value)

Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss. Document may generate warnings at any stage of its existence, so it's important to setup warning callback as early as possible to avoid the warnings loss. E.g. such properties as Document.getPageCount() actually build the document layout which is used later for rendering, and the layout warnings may be lost if warning callback is specified just for the rendering calls later.

Parameters:

value - The corresponding IWarningCallback value.

getBackgroundShape

public Shape getBackgroundShape()

Gets the background shape of the document. Can be null.

Microsoft Word allows only a shape that has its ShapeBase.getShapeType() property equal to ShapeType.RECTANGLE to be used as a background shape for a document.

Microsoft Word supports only the fill properties of a background shape. All other properties are ignored.

Setting this property to a non-null value will also set the ViewOptions.getDisplayBackgroundShape() / ViewOptions.setDisplayBackgroundShape(boolean) to true.

Returns:

The background shape of the document.

See Also:

ViewOptions.getDisplayBackgroundShape(), ViewOptions.setDisplayBackgroundShape(boolean), getPageColor(), setPageColor(java.awt.Color)

setBackgroundShape

public void setBackgroundShape(Shape value)

Sets the background shape of the document. Can be null.

Microsoft Word allows only a shape that has its ShapeBase.getShapeType() property equal to ShapeType.RECTANGLE to be used as a background shape for a document.

Microsoft Word supports only the fill properties of a background shape. All other properties are ignored.

Setting this property to a non-null value will also set the ViewOptions.getDisplayBackgroundShape() / ViewOptions.setDisplayBackgroundShape(boolean) to true.

Parameters:

value - The background shape of the document.

See Also:

ViewOptions.getDisplayBackgroundShape(), ViewOptions.setDisplayBackgroundShape(boolean), getPageColor(), setPageColor(java.awt.Color)

getPageColor

public java.awt.Color getPageColor()

Gets the page color of the document. This property is a simpler version of getBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

This property provides a simple way to specify a solid page color for the document. Setting this property creates and sets an appropriate getBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

If the page color is not set (e.g. there is no background shape in the document) returns a zero color.

Returns:

The page color of the document.

See Also:

getBackgroundShape(), setBackgroundShape(com.aspose.words.Shape)

setPageColor

public void setPageColor(java.awt.Color value)

Sets the page color of the document. This property is a simpler version of getBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

This property provides a simple way to specify a solid page color for the document. Setting this property creates and sets an appropriate getBackgroundShape() / setBackgroundShape(com.aspose.words.Shape).

If the page color is not set (e.g. there is no background shape in the document) returns a zero color.

Parameters:

value - The page color of the document.

See Also:

getBackgroundShape(), setBackgroundShape(com.aspose.words.Shape)