|
|||||||||||
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
The RtfField class is an abstract base class for all rtf field functionality. Subclasses only need to implement the two abstract methods writeFieldInstContent and writeFieldResultContent. All other field functionality is handled by the RtfField class.
Field Summary | |
---|---|
protected RtfDocument |
document
The RtfDocument this RtfField belongs to |
private static byte[] |
FIELD
Constant for a rtf field |
private static byte[] |
FIELD_ALT
Constant for an alt field |
private static byte[] |
FIELD_DIRTY
Constant for a dirty field |
private static byte[] |
FIELD_EDIT
Constant for a edited field |
private static byte[] |
FIELD_INSTRUCTIONS
Constant for the field instructions |
private static byte[] |
FIELD_LOCKED
Constant for a locked field |
private static byte[] |
FIELD_PRIVATE
Constant for a private field |
private static byte[] |
FIELD_RESULT
Constant for the field result |
private boolean |
fieldAlt
Is it an alt field |
private boolean |
fieldDirty
Is the field dirty |
private boolean |
fieldEdit
Is the field edited |
private boolean |
fieldLocked
Is the field locked |
private boolean |
fieldPrivate
Is the field private |
private RtfFont |
font
The RtfFont of this RtfField |
private boolean |
inHeader
Whether this RtfElement is in a header |
private boolean |
inTable
Whether this RtfField is in a table |
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 | |
---|---|
protected |
RtfField(RtfDocument doc)
Constructs a RtfField for a RtfDocument. |
protected |
RtfField(RtfDocument doc,
Font font)
Constructs a RtfField for a RtfDocument. |
Method Summary | |
---|---|
boolean |
isEmpty()
An RtfField is never empty. |
boolean |
isFieldAlt()
Get whether this field is an alt field |
boolean |
isFieldDirty()
Get whether this field is dirty |
boolean |
isFieldEdit()
Get whether this field is edited |
boolean |
isFieldLocked()
Get whether this field is locked |
boolean |
isFieldPrivate()
Get whether this field is private |
void |
setFieldAlt(boolean fieldAlt)
Set whether this field is an alt field |
void |
setFieldDirty(boolean fieldDirty)
Set whether this field is dirty |
void |
setFieldEdit(boolean fieldEdit)
Set whether this field is edited. |
void |
setFieldLocked(boolean fieldLocked)
Set whether this field is locked |
void |
setFieldPrivate(boolean fieldPrivate)
Set whether this field is private |
void |
setInHeader(boolean inHeader)
Sets whether this RtfField is in a header |
void |
setInTable(boolean inTable)
Sets whether this RtfField is in a table |
void |
setRtfDocument(RtfDocument doc)
Sets the RtfDocument this RtfElement belongs to |
byte[] |
write()
Write the content of this RtfField. |
private byte[] |
writeFieldBegin()
Writes the field beginning. |
private byte[] |
writeFieldEnd()
Writes the end of the field |
private byte[] |
writeFieldInstBegin()
Writes the beginning of the field instruction area. |
protected abstract byte[] |
writeFieldInstContent()
Writes the content of the field instruction area. |
private byte[] |
writeFieldInstEnd()
Writes the end of the field instruction area. |
private byte[] |
writeFieldResultBegin()
Writes the beginning of the field result area |
protected abstract byte[] |
writeFieldResultContent()
Writes the content of the pre-calculated field result. |
private byte[] |
writeFieldResultEnd()
Writes the end of the field result area |
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, type |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.lowagie.text.Element |
---|
toString |
Field Detail |
private static final byte[] FIELD
private static final byte[] FIELD_DIRTY
private static final byte[] FIELD_PRIVATE
private static final byte[] FIELD_LOCKED
private static final byte[] FIELD_EDIT
private static final byte[] FIELD_ALT
private static final byte[] FIELD_INSTRUCTIONS
private static final byte[] FIELD_RESULT
private boolean fieldDirty
private boolean fieldEdit
private boolean fieldLocked
private boolean fieldPrivate
private boolean fieldAlt
private boolean inTable
private boolean inHeader
protected RtfDocument document
private RtfFont font
Constructor Detail |
protected RtfField(RtfDocument doc)
doc
- The RtfDocument this RtfField belongs to.protected RtfField(RtfDocument doc, Font font)
doc
- The RtfDocument this RtfField belongs to.font
- The Font this RtfField should useMethod Detail |
public void setRtfDocument(RtfDocument doc)
setRtfDocument
in interface RtfBasicElement
doc
- The RtfDocument to useprivate byte[] writeFieldBegin() throws IOException
IOException
private byte[] writeFieldInstBegin() throws IOException
IOException
protected abstract byte[] writeFieldInstContent() throws IOException
IOException
- If an error occurs.private byte[] writeFieldInstEnd() throws IOException
IOException
private byte[] writeFieldResultBegin() throws IOException
IOException
protected abstract byte[] writeFieldResultContent() throws IOException
IOException
- If an error occursprivate byte[] writeFieldResultEnd() throws IOException
IOException
private byte[] writeFieldEnd() throws IOException
IOException
public byte[] write()
write
in interface RtfBasicElement
public boolean isFieldAlt()
public void setFieldAlt(boolean fieldAlt)
fieldAlt
- The value to usepublic boolean isFieldDirty()
public void setFieldDirty(boolean fieldDirty)
fieldDirty
- The value to usepublic boolean isFieldEdit()
public void setFieldEdit(boolean fieldEdit)
fieldEdit
- The value to usepublic boolean isFieldLocked()
public void setFieldLocked(boolean fieldLocked)
fieldLocked
- The value to usepublic boolean isFieldPrivate()
public void setFieldPrivate(boolean fieldPrivate)
fieldPrivate
- The value to usepublic void setInTable(boolean inTable)
setInTable
in interface RtfBasicElement
inTable
- True
if this RtfField is in a table, false
otherwisepublic void setInHeader(boolean inHeader)
setInHeader
in interface RtfBasicElement
inHeader
- True
if this RtfField is in a header, false
otherwisepublic boolean isEmpty()
isEmpty
in class Chunk
false
if the Chunk contains other characters than space.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |