com.lowagie.text.rtf.field
public abstract class RtfField extends Chunk implements RtfBasicElement
Version: $Id: RtfField.java 2776 2007-05-23 20:01:40Z hallm $
Field Summary | |
---|---|
protected RtfDocument | document
The RtfDocument this RtfField belongs to |
boolean | fieldAlt
Is it an alt field |
boolean | fieldDirty
Is the field dirty |
boolean | fieldEdit
Is the field edited |
boolean | fieldLocked
Is the field locked |
boolean | fieldPrivate
Is the field private |
RtfFont | font
The RtfFont of this RtfField |
static byte[] | FIELD
Constant for a rtf field |
static byte[] | FIELD_ALT
Constant for an alt field |
static byte[] | FIELD_DIRTY
Constant for a dirty field |
static byte[] | FIELD_EDIT
Constant for a edited field |
static byte[] | FIELD_INSTRUCTIONS
Constant for the field instructions |
static byte[] | FIELD_LOCKED
Constant for a locked field |
static byte[] | FIELD_PRIVATE
Constant for a private field |
static byte[] | FIELD_RESULT
Constant for the field result |
boolean | inHeader
Whether this RtfElement is in a header |
boolean | inTable
Whether this RtfField is in a table |
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 | setFont(Font font)
Override setFont to perform the correct font handling. |
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.
|
void | writeContent(OutputStream result)
Writes the element content to the given output stream. |
byte[] | writeFieldBegin()
Writes the field beginning. |
void | writeFieldBegin(OutputStream result)
Writes the field beginning. |
byte[] | writeFieldEnd()
Writes the end of the field
|
void | writeFieldEnd(OutputStream result)
Writes the end of the field |
byte[] | writeFieldInstBegin()
Writes the beginning of the field instruction area.
|
void | writeFieldInstBegin(OutputStream result)
Writes the beginning of the field instruction area.
|
protected abstract byte[] | writeFieldInstContent()
Writes the content of the field instruction area. |
protected void | writeFieldInstContent(OutputStream out)
Writes the content of the field instruction area. |
byte[] | writeFieldInstEnd()
Writes the end of the field instruction area.
|
void | writeFieldInstEnd(OutputStream result)
Writes the end of the field instruction area. |
byte[] | writeFieldResultBegin()
Writes the beginning of the field result area
|
void | writeFieldResultBegin(OutputStream result)
Writes the beginning of the field result area |
protected abstract byte[] | writeFieldResultContent()
Writes the content of the pre-calculated field result. |
protected void | writeFieldResultContent(OutputStream out)
Writes the content of the pre-calculated field result. |
byte[] | writeFieldResultEnd()
Writes the end of the field result area
|
void | writeFieldResultEnd(OutputStream result)
Writes the end of the field result area |
Parameters: doc The RtfDocument this RtfField belongs to.
Parameters: doc The RtfDocument this RtfField belongs to. font The Font this RtfField should use
Returns: Returns whether this field is an alt field
Returns: Returns whether this field is dirty
Returns: Returns whether this field is edited
Returns: Returns the fieldLocked.
Returns: Returns the fieldPrivate.
Parameters: fieldAlt The value to use
Parameters: fieldDirty The value to use
Parameters: fieldEdit The value to use
Parameters: fieldLocked The value to use
Parameters: fieldPrivate The value to use
Parameters: inHeader True
if this RtfField is in a header, false
otherwise
Parameters: inTable True
if this RtfField is in a table, false
otherwise
Parameters: doc The RtfDocument to use
Deprecated: replaced by writeContent
Write the content of this RtfField.Returns: A byte array containing the content of this RtfField
Deprecated: replaced by writeFieldBegin
Writes the field beginning. Also writes field properties.Returns: A byte array with the field beginning.
Throws: IOException
Returns: A byte array with the field beginning.
Throws: IOException
Deprecated: replaced by writeFieldEnd
Writes the end of the fieldReturns: A byte array containing the end of the field
Throws: IOException
Deprecated: replaced by writeFieldInstBegin
Writes the beginning of the field instruction area.Returns: The beginning of the field instruction area
Throws: IOException
Returns: The beginning of the field instruction area
Throws: IOException
Deprecated: replaced by writeFieldInstContent
Writes the content of the field instruction area. Override this method in your subclasses.Returns: The content of the field instruction area
Throws: IOException If an error occurs.
Deprecated: replaced by writeFieldInstEnd
Writes the end of the field instruction area.Returns: A byte array containing the end of the field instruction area
Throws: IOException
Deprecated: replaced by writeFieldResultBegin
Writes the beginning of the field result areaReturns: A byte array containing the beginning of the field result area
Throws: IOException
Deprecated: replaced by writeFieldResultContent
Writes the content of the pre-calculated field result. Override this method in your subclasses.Returns: A byte array containing the field result
Throws: IOException If an error occurs
Deprecated: replaced by writeFieldResultEnd
Writes the end of the field result areaReturns: A byte array containing the end of the field result area
Throws: IOException