This class implements an abstract RtfField.
This class is based on the RtfWriter-package from Mark Hall.
ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2.
| Method from com.lowagie.text.rtf.AbstractRtfField Detail: |
public final String content() {
return "";
}
empty implementation for Chunk. |
public final boolean isAlt() {
return this.rtfFieldIsAlt;
}
Determines whether this RtfField shall refer to an end
note. |
public final boolean isDirty() {
return this.rtfFieldIsDirty;
}
Determines whether the field was changed since the field was
last updated |
public final boolean isLocked() {
return this.rtfFieldIsLocked;
}
Determines whtether the field is locked, i.e. it cannot be
updated. |
public final boolean isPrivate() {
return this.rtfFieldIsPrivate;
}
Determines whether the field is in suitable form for display. |
public final void setAlt(boolean rtfFieldIsAlt) {
this.rtfFieldIsAlt = rtfFieldIsAlt;
}
Determines whether this RtfField shall refer to an end note. |
public final void setDirty(boolean rtfFieldIsDirty) {
this.rtfFieldIsDirty = rtfFieldIsDirty;
}
Set whether a formatting change has been made since the field
was last updated |
public final void setEdited(boolean rtfFieldWasEdited) {
this.rtfFieldWasEdited = rtfFieldWasEdited;
}
Set whether text has been added, removed from thre field result
since the field was last updated. |
public final void setLocked(boolean rtfFieldIsLocked) {
this.rtfFieldIsLocked = rtfFieldIsLocked;
}
Set whether the field can be updated. |
public final void setPrivate(boolean rtfFieldIsPrivate) {
this.rtfFieldIsPrivate = rtfFieldIsPrivate;
}
Set whether the field is in suitable form for
display. I.e. it's not a field with a picture as field result |
public final boolean wasEdited() {
return this.rtfFieldWasEdited;
}
Determines whether text has been added, removed from the field
result since the field was last updated. |
public void write(RtfWriter writer,
OutputStream out) throws IOException {
writeRtfFieldBegin(out);
writeRtfFieldModifiers(out);
writeRtfFieldInstBegin(out);
writer.writeInitialFontSignature( out, this );
writeRtfFieldInitializationStuff(out);
writeRtfFieldInstEnd(out);
writeRtfFieldResultBegin(out);
writer.writeInitialFontSignature( out, this );
writeRtfFieldResultStuff(out);
writeRtfFieldResultEnd(out);
writeRtfFieldEnd(out);
}
|
protected final void writeRtfFieldBegin(OutputStream out) throws IOException {
out.write(RtfWriter.openGroup);
out.write(RtfWriter.escape);
out.write(RtfWriter.field);
}
Write the beginning of an RtfField to the OutputStream. |
protected final void writeRtfFieldEnd(OutputStream out) throws IOException {
out.write( RtfWriter.closeGroup );
}
|
abstract public void writeRtfFieldInitializationStuff(OutputStream out) throws IOException
Abstract method for writing custom stuff to the Field
Initialization Stuff part of an RtfField. |
protected final void writeRtfFieldInstBegin(OutputStream out) throws IOException {
out.write( RtfWriter.openGroup );
out.write( RtfWriter.escape );
out.write( RtfWriter.fieldContent );
out.write( RtfWriter.delimiter );
}
Write RtfField Initialization Stuff to OutputStream. |
protected final void writeRtfFieldInstEnd(OutputStream out) throws IOException {
if (isAlt()) {
out.write( fldAlt );
out.write( RtfWriter.delimiter );
}
out.write( RtfWriter.closeGroup );
}
Write end of RtfField Initialization Stuff to OutputStream. |
protected final void writeRtfFieldModifiers(OutputStream out) throws IOException {
if (isDirty()) {
out.write(fldDirty);
}
if (wasEdited()) {
out.write(fldEdit);
}
if (isLocked()) {
out.write(fldLock);
}
if (isPrivate()) {
out.write(fldPriv);
}
}
Write the modifiers defined for a RtfField to the OutputStream. |
protected final void writeRtfFieldResultBegin(OutputStream out) throws IOException {
out.write( RtfWriter.openGroup );
out.write( RtfWriter.escape );
out.write( RtfWriter.fieldDisplay );
out.write( RtfWriter.delimiter );
}
Write beginning of RtfField Result to OutputStream. |
protected final void writeRtfFieldResultEnd(OutputStream out) throws IOException {
out.write( RtfWriter.delimiter );
out.write( RtfWriter.closeGroup );
}
Write end of RtfField Result to OutputStream. |
abstract public void writeRtfFieldResultStuff(OutputStream out) throws IOException
Abstract method for writing custom stuff to the Field Result
part of an RtfField. |