com.lowagie.text.rtf.field
public abstract class RtfField extends Chunk implements RtfBasicElement
Version: $Id: RtfField.java 3373 2008-05-12 16:21:24Z xlv $
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
|
boolean | isInHeader()
Gets whether this RtfField is in a header.
|
boolean | isInTable()
Gets whether this RtfField is in a table.
|
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
|
void | writeContent(OutputStream result)
Writes the field to the OutputStream .
|
void | writeFieldBegin(OutputStream result)
Writes the field beginning. |
void | writeFieldEnd(OutputStream result)
Writes the end of the field
|
void | writeFieldInstBegin(OutputStream result)
Writes the beginning of the field instruction area.
|
protected abstract void | writeFieldInstContent(OutputStream result)
Writes the content of the field instruction area. |
void | writeFieldInstEnd(OutputStream result)
Writes the end of the field instruction area.
|
void | writeFieldResultBegin(OutputStream result)
Writes the beginning of the field result area
|
protected abstract void | writeFieldResultContent(OutputStream result)
Writes the content of the pre-calculated field result. |
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.
RtfField
is in a header.
Returns: True
if this RtfField
is in a header, false
otherwise
Since: 2.1.0
RtfField
is in a table.
Returns: True
if this RtfField
is in a table, false
otherwise
Since: 2.1.0
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
OutputStream
.
Parameters: result The OutputStream
to write to.
Throws: IOException on i/o errors.
Parameters: result The OutputStream
to write to.
Throws: IOException
Parameters: result The OutputStream
to write to.
Throws: IOException on i/o errors.
Parameters: result The OutputStream
to write to.
Throws: IOException
Parameters: result The OutputStream
to write to.
Parameters: result The OutputStream
to write to.
Parameters: result The OutputStream
to write to.
Parameters: result The OutputStream
to write to.
Throws: IOException on i/o errors.
Parameters: result The OutputStream
to write to.
Throws: IOException on i/o errors.