|
||||||||||
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.GenericRtfField
com.lowagie.text.rtf.RtfPageNumber
public class RtfPageNumber
A rtf page number field. ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2. This class is based on the RtfWriter-package from Mark Hall.
Field Summary |
---|
Fields inherited from class com.lowagie.text.rtf.GenericRtfField |
---|
fieldInst, fieldResult |
Fields inherited from class com.lowagie.text.Chunk |
---|
ACTION, attributes, BACKGROUND, COLOR, ENCODING, font, GENERICTAG, HSCALE, HYPHENATION, IMAGE, LOCALDESTINATION, LOCALGOTO, markupAttributes, NEWLINE, NEWPAGE, NEXTPAGE, OBJECT_REPLACEMENT_CHARACTER, PDFANNOTATION, REMOTEGOTO, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TEXTRENDERMODE, UNDERLINE |
Constructor Summary | |
---|---|
RtfPageNumber(String content,
Font contentFont)
Deprecated. construct a RtfPageNumber. |
Method Summary | |
---|---|
String |
content()
Deprecated. empty implementation for Chunk. |
boolean |
isAlt()
Deprecated. Determines whether this RtfField shall refer to an end note. |
boolean |
isDirty()
Deprecated. Determines whether the field was changed since the field was last updated |
boolean |
isLocked()
Deprecated. Determines whtether the field is locked, i.e. it cannot be updated. |
boolean |
isPrivate()
Deprecated. Determines whether the field is in suitable form for display. |
void |
setAlt(boolean rtfFieldIsAlt)
Deprecated. Determines whether this RtfField shall refer to an end note. |
void |
setDirty(boolean rtfFieldIsDirty)
Deprecated. Set whether a formatting change has been made since the field was last updated |
void |
setEdited(boolean rtfFieldWasEdited)
Deprecated. Set whether text has been added, removed from thre field result since the field was last updated. |
void |
setLocked(boolean rtfFieldIsLocked)
Deprecated. Set whether the field can be updated. |
void |
setPrivate(boolean rtfFieldIsPrivate)
Deprecated. Set whether the field is in suitable form for display. |
String |
toString()
Deprecated. Returns the content of this Chunk . |
boolean |
wasEdited()
Deprecated. Determines whether text has been added, removed from the field result since the field was last updated. |
void |
write(RtfWriter writer,
OutputStream out)
Deprecated. write this RtfField into a stream using the writer given as first argument. |
protected void |
writeRtfFieldBegin(OutputStream out)
Deprecated. Write the beginning of an RtfField to the OutputStream. |
protected void |
writeRtfFieldEnd(OutputStream out)
Deprecated. Close the RtfField. |
protected void |
writeRtfFieldInstBegin(OutputStream out)
Deprecated. Write RtfField Initialization Stuff to OutputStream. |
protected void |
writeRtfFieldInstEnd(OutputStream out)
Deprecated. Write end of RtfField Initialization Stuff to OutputStream. |
protected void |
writeRtfFieldModifiers(OutputStream out)
Deprecated. Write the modifiers defined for a RtfField to the OutputStream. |
protected void |
writeRtfFieldResultBegin(OutputStream out)
Deprecated. Write beginning of RtfField Result to OutputStream. |
protected void |
writeRtfFieldResultEnd(OutputStream out)
Deprecated. Write end of RtfField Result to OutputStream. |
Methods inherited from class com.lowagie.text.rtf.GenericRtfField |
---|
writeRtfFieldInitializationStuff, writeRtfFieldResultStuff |
Methods inherited from class com.lowagie.text.Chunk |
---|
addToArray, append, font, getAttributes, getChunks, getHorizontalScaling, getImage, getKeySet, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getTextRise, getWidthPoint, hasAttributes, isEmpty, 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, type |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RtfPageNumber(String content, Font contentFont)
content
- the String that will be displayed in front of the page numbercontentFont
- the font to use to display this page numberMethod Detail |
---|
public void write(RtfWriter writer, OutputStream out) throws IOException
write
in interface RtfField
writer
- the RtfWriter to use to write this RtfFieldout
- the Stream to write this RtfField into.
IOException
public String toString()
Chunk
Chunk
.
toString
in interface Element
toString
in class Chunk
String
Element.toString()
public final boolean isLocked()
public final void setLocked(boolean rtfFieldIsLocked)
rtfFieldIsLocked
- true if the field cannot be
updated, false otherwise.public final void setDirty(boolean rtfFieldIsDirty)
rtfFieldIsDirty
- true if the field was
changed since the field was last updated, false
otherwise.public final boolean isDirty()
public final void setEdited(boolean rtfFieldWasEdited)
rtfFieldWasEdited
- Determines whether text has been
added, removed from the field result since the field was last
updated (true, false otherwise..public final boolean wasEdited()
public final void setPrivate(boolean rtfFieldIsPrivate)
rtfFieldIsPrivate
- Determines whether the field is in
suitable form for display: true it can be displayed,
false it cannot be displayed.public final boolean isPrivate()
public final void setAlt(boolean rtfFieldIsAlt)
rtfFieldIsAlt
- true if this RtfField shall refer
to an end note, false otherwisepublic final boolean isAlt()
public final String content()
content
in class Chunk
protected final void writeRtfFieldBegin(OutputStream out) throws IOException
out
-
IOException
protected final void writeRtfFieldModifiers(OutputStream out) throws IOException
out
-
IOException
protected final void writeRtfFieldInstBegin(OutputStream out) throws IOException
out
-
IOException
protected final void writeRtfFieldInstEnd(OutputStream out) throws IOException
out
-
IOException
protected final void writeRtfFieldResultBegin(OutputStream out) throws IOException
out
-
IOException
protected final void writeRtfFieldResultEnd(OutputStream out) throws IOException
out
-
IOException
protected final void writeRtfFieldEnd(OutputStream out) throws IOException
out
-
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |