com.aspose.words

Class Story

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.Story

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

Direct Known Subclasses:

Body, HeaderFooter

public abstract class Story
extends CompositeNode

Base class for elements that contain block-level nodes Paragraph and Table.

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

Text of a Word document is said to consist of several stories. The main text is stored in the main text story represented by Body, each header and footer is stored in a separate story represented by HeaderFooter.

Constructor Summary

Constructors

Constructor and Description
Story()

Method Summary

Modifier and Type	Method and Description
Paragraph	appendParagraph(java.lang.String text) A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object.
void	deleteShapes() Deletes all shapes from the text of this story.
Paragraph	getFirstParagraph() Gets the first paragraph in the story.
Paragraph	getLastParagraph() Gets the last paragraph in the story.
ParagraphCollection	getParagraphs() Gets a collection of paragraphs that are immediate children of the story.
int	getStoryType() Gets the type of this story.
TableCollection	getTables() Gets a collection of tables that are immediate children of the story.

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

Story

public Story()

Method Detail

getStoryType

public int getStoryType()

Gets the type of this story.

Returns:

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

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.

deleteShapes

public void deleteShapes()

Deletes all shapes from the text of this story.

appendParagraph

public Paragraph appendParagraph(java.lang.String text)

A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object.

Parameters:

text - The text for the paragraph. Can be null or empty string.

Returns:

The newly created and appended paragraph.