|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.Chunk
com.lowagie.text.rtf.field.RtfField
com.lowagie.text.rtf.field.RtfTOCEntry
public class RtfTOCEntry
The RtfTOCEntry is used together with the RtfTableOfContents to generate a table of contents. Add the RtfTOCEntry in those locations in the document where table of contents entries should link to
Field Summary | |
---|---|
private String |
entry
The entry text of this RtfTOCEntry |
private boolean |
showPageNumber
Whether to show page numbers in the table of contents |
private static byte[] |
TEXT_HIDDEN_OFF
Constant for the end of hidden text |
private static byte[] |
TEXT_HIDDEN_ON
Constant for the beginning of hidden text |
private static byte[] |
TOC_ENTRY_NO_PAGE_NUMBER
Constant for a TOC entry without page numbers |
private static byte[] |
TOC_ENTRY_PAGE_NUMBER
Constant for a TOC entry with page numbers |
Fields inherited from class com.lowagie.text.rtf.field.RtfField |
---|
document |
Fields inherited from class com.lowagie.text.Chunk |
---|
ACTION, attributes, BACKGROUND, COLOR, content, ENCODING, GENERICTAG, HSCALE, HYPHENATION, IMAGE, LOCALDESTINATION, LOCALGOTO, markupAttributes, NEWLINE, NEWPAGE, NEXTPAGE, OBJECT_REPLACEMENT_CHARACTER, PDFANNOTATION, REMOTEGOTO, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TEXTRENDERMODE, UNDERLINE |
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement |
---|
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR |
Fields inherited from interface com.lowagie.text.Element |
---|
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE |
Constructor Summary | |
---|---|
RtfTOCEntry(String entry,
Font font)
Constructs a RtfTOCEntry with a certain entry text. |
Method Summary | |
---|---|
void |
setShowPageNumber(boolean showPageNumber)
Sets whether to display a page number in the table of contents, or not |
byte[] |
write()
Writes the content of the RtfTOCEntry |
protected byte[] |
writeFieldInstContent()
UNUSED |
protected byte[] |
writeFieldResultContent()
UNUSED |
Methods inherited from class com.lowagie.text.rtf.field.RtfField |
---|
isEmpty, isFieldAlt, isFieldDirty, isFieldEdit, isFieldLocked, isFieldPrivate, setFieldAlt, setFieldDirty, setFieldEdit, setFieldLocked, setFieldPrivate, setInHeader, setInTable, setRtfDocument |
Methods inherited from class com.lowagie.text.Chunk |
---|
addToArray, append, content, font, getAttributes, getChunks, getHorizontalScaling, getImage, getKeySet, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getTextRise, getWidthPoint, hasAttributes, isTag, process, setAction, setAnchor, setAnchor, setAnnotation, setBackground, setBackground, setFont, setGenericTag, setHorizontalScaling, setHyphenation, setLocalDestination, setLocalGoto, setMarkupAttribute, setMarkupAttributes, setNewPage, setRemoteGoto, setRemoteGoto, setSkew, setSplitCharacter, setTextRenderMode, setTextRise, setUnderline, setUnderline, toString, type |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private static final byte[] TEXT_HIDDEN_ON
private static final byte[] TEXT_HIDDEN_OFF
private static final byte[] TOC_ENTRY_PAGE_NUMBER
private static final byte[] TOC_ENTRY_NO_PAGE_NUMBER
private String entry
private boolean showPageNumber
Constructor Detail |
---|
public RtfTOCEntry(String entry, Font font)
entry
- The entry text to displayfont
- The Font to useMethod Detail |
---|
public byte[] write()
write
in interface RtfBasicElement
write
in class RtfField
public void setShowPageNumber(boolean showPageNumber)
showPageNumber
- Whether to display a page number or notprotected byte[] writeFieldInstContent() throws IOException
writeFieldInstContent
in class RtfField
IOException
- never thrownprotected byte[] writeFieldResultContent() throws IOException
writeFieldResultContent
in class RtfField
IOException
- never thrown
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |