com.aspose.words

Class InlineStory

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.InlineStory

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

Direct Known Subclasses:

Comment, Footnote

public abstract class InlineStory
extends CompositeNode

Base class for inline-level nodes that can contain paragraphs and tables.

To learn more, visit the Logical Levels of Nodes in a Document documentation article.

InlineStory is a container for block-level nodes Paragraph and Table.

The classes that derive from InlineStory are inline-level nodes that can contain their own text (paragraphs and tables). For example, a Comment node contains text of a comment and a Footnote contains text of a footnote.

Constructor Summary

Constructors

Constructor and Description
InlineStory()

Method Summary

Modifier and Type	Method and Description
void	clearRunAttrs()
void	ensureMinimum() If the last child is not a paragraph, creates and appends one empty paragraph.
java.lang.Object	fetchInheritedRunAttr(int fontAttr)
java.lang.Object	getDirectRunAttr(int fontAttr)
DocumentBase	getDocument_IInline()
Paragraph	getFirstParagraph() Gets the first paragraph in the story.
Font	getFont() Provides access to the font formatting of the anchor character of this object.
Paragraph	getLastParagraph() Gets the last paragraph in the story.
ParagraphCollection	getParagraphs() Gets a collection of paragraphs that are immediate children of the story.
Paragraph	getParentParagraph_IInline()
Paragraph	getParentParagraph() Retrieves the parent Paragraph of this node.
abstract int	getStoryType() Returns the type of the story.
TableCollection	getTables() Gets a collection of tables that are immediate children of the story.
boolean	isDeleteRevision() Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
boolean	isInsertRevision() Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
boolean	isMoveFromRevision() Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
boolean	isMoveToRevision() Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
void	removeRunAttr(int key)
void	setRunAttr(int fontAttr, java.lang.Object value)

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, getDocument, 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

InlineStory

public InlineStory()

Method Detail

getStoryType

public abstract int getStoryType()

Returns the type of the story.

Returns:

The type of the story. The returned value is one of StoryType constants.

getParentParagraph

public Paragraph getParentParagraph()

Retrieves the parent Paragraph of this node.

Returns:

The corresponding Paragraph value.

getFirstParagraph

public Paragraph getFirstParagraph()

Gets the first paragraph in the story.

Returns:

The first paragraph in the story.

getLastParagraph

public Paragraph getLastParagraph()

Gets the last paragraph in the story.

Returns:

The last paragraph in the story.

getParagraphs

public ParagraphCollection getParagraphs()

Gets a collection of paragraphs that are immediate children of the story.

Returns:

A collection of paragraphs that are immediate children of the story.

getTables

public TableCollection getTables()

Gets a collection of tables that are immediate children of the story.

Returns:

A collection of tables that are immediate children of the story.

isInsertRevision

public boolean isInsertRevision()

Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

Returns:

True if this object was inserted in Microsoft Word while change tracking was enabled.

isDeleteRevision

public boolean isDeleteRevision()

Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

Returns:

True if this object was deleted in Microsoft Word while change tracking was enabled.

isMoveFromRevision

public boolean isMoveFromRevision()

Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.

Returns:

true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.

isMoveToRevision

public boolean isMoveToRevision()

Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.

Returns:

true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.

getFont

public Font getFont()

Provides access to the font formatting of the anchor character of this object.

Returns:

The corresponding Font value.

ensureMinimum

public void ensureMinimum()

If the last child is not a paragraph, creates and appends one empty paragraph.

getParentParagraph_IInline

public Paragraph getParentParagraph_IInline()

getDocument_IInline

public DocumentBase getDocument_IInline()

getDirectRunAttr

public java.lang.Object getDirectRunAttr(int fontAttr)

fetchInheritedRunAttr

public java.lang.Object fetchInheritedRunAttr(int fontAttr)

setRunAttr

public void setRunAttr(int fontAttr,
                       java.lang.Object value)

removeRunAttr

public void removeRunAttr(int key)

clearRunAttrs

public void clearRunAttrs()