public class StoryType
extends java.lang.Object
StoryType identifies a story.
Examples:
Shows how to remove all shapes from a node.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Use a DocumentBuilder to insert a shape. This is an inline shape,
// which has a parent Paragraph, which is a child node of the first section's Body.
builder.insertShape(ShapeType.CUBE, 100.0, 100.0);
Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 1);
// We can delete all shapes from the child paragraphs of this Body.
Assert.assertEquals(doc.getFirstSection().getBody().getStoryType(), StoryType.MAIN_TEXT);
doc.getFirstSection().getBody().deleteShapes();
Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 0);
| Modifier and Type | Field and Description |
|---|---|
static int |
COMMENTS
Contains document comments (annotations), represented by
Comment. |
static int |
ENDNOTE_CONTINUATION_NOTICE
Contains the text of the endnote continuation notice separator.
|
static int |
ENDNOTE_CONTINUATION_SEPARATOR
Contains the text of the endnote continuation separator.
|
static int |
ENDNOTE_SEPARATOR
Contains the text of the endnote separator.
|
static int |
ENDNOTES
Contains endnotes text, represented by
Footnote. |
static int |
EVEN_PAGES_FOOTER
Contains text of the even pages footer, represented by
HeaderFooter. |
static int |
EVEN_PAGES_HEADER
Contains text of the even pages header, represented by
HeaderFooter. |
static int |
FIRST_PAGE_FOOTER
Contains text of the first page footer, represented by
HeaderFooter. |
static int |
FIRST_PAGE_HEADER
Contains text of the first page header, represented by
HeaderFooter. |
static int |
FOOTNOTE_CONTINUATION_NOTICE
Contains the text of the footnote continuation notice separator.
|
static int |
FOOTNOTE_CONTINUATION_SEPARATOR
Contains the text of the footnote continuation separator.
|
static int |
FOOTNOTE_SEPARATOR
Contains the text of the footnote separator.
|
static int |
FOOTNOTES
Contains footnote text, represented by
Footnote. |
static int |
length |
static int |
MAIN_TEXT
Contains the main text of the document, represented by
Body. |
static int |
NONE
Default value.
|
static int |
PRIMARY_FOOTER
Contains text of the primary footer.
|
static int |
PRIMARY_HEADER
Contains text of the primary header.
|
static int |
TEXTBOX
Contains shape or textbox text, represented by
Shape. |
| Modifier and Type | Method and Description |
|---|---|
static int |
fromName(java.lang.String storyTypeName) |
static java.lang.String |
getName(int storyType) |
static int[] |
getValues() |
static java.lang.String |
toString(int storyType) |
public static int NONE
public static int MAIN_TEXT
Body.public static int FOOTNOTES
Footnote.public static int ENDNOTES
Footnote.public static int COMMENTS
Comment.public static int TEXTBOX
Shape.public static int EVEN_PAGES_HEADER
HeaderFooter.public static int PRIMARY_HEADER
HeaderFooter.public static int EVEN_PAGES_FOOTER
HeaderFooter.public static int PRIMARY_FOOTER
HeaderFooter.public static int FIRST_PAGE_HEADER
HeaderFooter.public static int FIRST_PAGE_FOOTER
HeaderFooter.public static int FOOTNOTE_SEPARATOR
public static int FOOTNOTE_CONTINUATION_SEPARATOR
public static int FOOTNOTE_CONTINUATION_NOTICE
public static int ENDNOTE_SEPARATOR
public static int ENDNOTE_CONTINUATION_SEPARATOR
public static int ENDNOTE_CONTINUATION_NOTICE
public static int length