com.spire.doc.fields
Class ParagraphBase

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

All Implemented Interfaces:

IDocumentObject, IDocumentSerializable, IParagraphBase

Direct Known Subclasses:

BookmarkEnd, BookmarkStart, Break, Comment, CommentMark, FieldMark, Footnote, OfficeMath, PermissionEnd, PermissionStart, ShapeBase, StructureDocumentTagInline, Symbol, TableOfContent, TextRange, WatermarkBase

public abstract class ParagraphBase
extends DocumentBase
implements IParagraphBase

Constructor Summary

protected

ParagraphBase(Document doc)

Method Summary

void	applyCharacterFormat(CharacterFormat charFormat) Sets the character format.
void	applyStyle(java.lang.String styleName) Applies the specified style.
CharacterFormat	getCharacterFormat() Gets the character format.
DocumentObjectCollection	getChildObjects() Gets the child objects of the entity.
EditRevision	getDeleteRevision() Gets the delete revision for this objects.
EditRevision	getInsertRevision() Gets the insert revision for this objects.
IDocumentObject	getNextWidgetSibling() Gets the next widget sibling.
Paragraph	getOwnerParagraph() Gets owner paragraph.
IDocumentObject	getPreviousWidgetSibling() Gets the previous widget sibling.
java.lang.String	getStyleName() Gets the style name.
boolean	isDeleteRevision() Gets or set a value indicating whether this item was deleted from the document, when "Track Changes" is or was set to "true".
boolean	isInsertRevision() Gets a value indicating whether this item was inserted to the document, when "Track Changes" is or was set to "true".

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getDocumentObjectType, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, prependChild, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

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

deepClone, getDocument, getDocumentObjectType, getNextSibling, getOwner, getPreviousSibling, isComposite

Constructor Detail

ParagraphBase

protected ParagraphBase(Document doc)

Method Detail

getChildObjects

public DocumentObjectCollection getChildObjects()

Gets the child objects of the entity.

Specified by:

getChildObjects in class DocumentObject

getOwnerParagraph

public Paragraph getOwnerParagraph()

Gets owner paragraph.

Specified by:

getOwnerParagraph in interface IParagraphBase

Returns:

isInsertRevision

public boolean isInsertRevision()

Gets a value indicating whether this item was inserted to the document, when "Track Changes" is or was set to "true".

Returns:

if this instance was inserted, set to true.

isDeleteRevision

public boolean isDeleteRevision()

Gets or set a value indicating whether this item was deleted from the document, when "Track Changes" is or was set to "true".

Returns:

if this instance is delete revision, set to true.

getDeleteRevision

public EditRevision getDeleteRevision()

Gets the delete revision for this objects. Note this can be null. If null does not have delete revision.

getInsertRevision

public EditRevision getInsertRevision()

Gets the insert revision for this objects. Note this can be null. If null does not have insert revision.

getStyleName

public java.lang.String getStyleName()

Gets the style name.

Specified by:

getStyleName in interface IParagraphBase

Returns:

style name

getCharacterFormat

public CharacterFormat getCharacterFormat()

Gets the character format.

Returns:

The paragraph item character format.

applyCharacterFormat

public void applyCharacterFormat(CharacterFormat charFormat)

Sets the character format.

Parameters:

charFormat - The character format.

applyStyle

public void applyStyle(java.lang.String styleName)

Applies the specified style.

Specified by:

applyStyle in interface IParagraphBase

Parameters:

styleName - The style name.

getPreviousWidgetSibling

public IDocumentObject getPreviousWidgetSibling()

Gets the previous widget sibling.

Overrides:

getPreviousWidgetSibling in class DocumentObject

getNextWidgetSibling

public IDocumentObject getNextWidgetSibling()

Gets the next widget sibling.

Overrides:

getNextWidgetSibling in class DocumentObject

Returns:

The next sibling.