|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.odftoolkit.simple.Component
org.odftoolkit.simple.common.field.Field
org.odftoolkit.simple.common.field.ChapterField
public class ChapterField
ChapterField is placed inside a header or footer, it displays the current chapter name or number on every page.
NOTE: Before the document is opened in any editor, the value of this field maybe invalid.
Nested Class Summary | |
---|---|
static class |
ChapterField.DisplayType
A DisplayType specifies the information that a chapter field should display. |
Nested classes/interfaces inherited from class org.odftoolkit.simple.common.field.Field |
---|
Field.FieldType |
Method Summary | |
---|---|
Field.FieldType |
getFieldType()
Return the type of this field. |
TextChapterElement |
getOdfElement()
Return an instance of TextChapterElement which represents
this feature. |
void |
setDisplayPage(ChapterField.DisplayType type)
Specifies the information that a chapter field should display. |
void |
setOutlineLevel(int level)
Specifies the outline level to be displayed. |
Methods inherited from class org.odftoolkit.simple.Component |
---|
getComponentByElement, getOwnerDocument, registerComponent, unregisterComponent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void setDisplayPage(ChapterField.DisplayType type)
type
- the display type which is predefined in
DisplayType
.public void setOutlineLevel(int level)
level
- the outline level to be displayed.public TextChapterElement getOdfElement()
TextChapterElement
which represents
this feature.
getOdfElement
in class Component
TextChapterElement
public Field.FieldType getFieldType()
Field
getFieldType
in class Field
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |