com.spire.doc
Class DocumentObject

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject

All Implemented Interfaces:

IDocumentObject, IDocumentSerializable

Direct Known Subclasses:

DocumentBase

public abstract class DocumentObject
extends DocumentSerializable
implements IDocumentObject

Constructor Summary

protected

DocumentObject(Document doc, DocumentObject owner)

Method Summary

DocumentObject	deepClone() Creates a duplicate of the document object.
abstract DocumentObjectCollection	getChildObjects() Gets the child objects of the entity.
abstract DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
DocumentObject	getFirstChild() Gets the first child of the Element.
DocumentObject	getLastChild() Gets the last child of the Element.
IDocumentObject	getNextSibling() Gets the next sibling.
IDocumentObject	getNextWidgetSibling() Gets the next sibling.
DocumentObject	getOwner() Gets the owner of this entity.
IDocumentObject	getPreviousSibling() Gets the previous sibling.
IDocumentObject	getPreviousWidgetSibling() Gets the previous widget sibling.
boolean	isComposite() Indicating whether this instance is composite.
DocumentObject	prependChild(DocumentObject newChild)
java.lang.String	toString(java.lang.String seperator) Exports the name and index in container of the object into a string in the specified seperator.

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

getDocument

Constructor Detail

DocumentObject

protected DocumentObject(Document doc,
                         DocumentObject owner)

Method Detail

getChildObjects

public abstract DocumentObjectCollection getChildObjects()

Gets the child objects of the entity.

getDocumentObjectType

public abstract DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Returns:

The type of the document object.

getOwner

public DocumentObject getOwner()

Gets the owner of this entity.

Specified by:

getOwner in interface IDocumentObject

Overrides:

getOwner in class OwnerHolder

Returns:

getPreviousSibling

public IDocumentObject getPreviousSibling()

Gets the previous sibling.

Specified by:

getPreviousSibling in interface IDocumentObject

Returns:

the previous sibling.

getNextSibling

public IDocumentObject getNextSibling()

Gets the next sibling.

Specified by:

getNextSibling in interface IDocumentObject

Returns:

The next sibling.

isComposite

public boolean isComposite()

Indicating whether this instance is composite. If this instance is composite, set to true.

Specified by:

isComposite in interface IDocumentObject

Returns:

getFirstChild

public DocumentObject getFirstChild()

Gets the first child of the Element.

If there is no first child Element, a null is returned.

getLastChild

public DocumentObject getLastChild()

Gets the last child of the Element.

If there is no last child Element, a null is returned.

deepClone

public DocumentObject deepClone()

Creates a duplicate of the document object.

Specified by:

deepClone in interface IDocumentObject

Returns:

toString

public java.lang.String toString(java.lang.String seperator)

Exports the name and index in container of the object into a string in the specified seperator.

Parameters:

seperator -

Returns:

getPreviousWidgetSibling

public IDocumentObject getPreviousWidgetSibling()

Gets the previous widget sibling.

getNextWidgetSibling

public IDocumentObject getNextWidgetSibling()

Gets the next sibling.

Returns:

The next sibling.

prependChild

public DocumentObject prependChild(DocumentObject newChild)