Package com.scroogexhtml.converter

Interface FieldWriter

All Known Subinterfaces:
Writer
All Known Implementing Classes:
AbstractWriter, XMLDOMWriter
public interface FieldWriter
Interface for writing field expressions to a StringBuilder.
See Also:

  • Method Details

    • getCurrentFieldExpression

      StringBuilder getCurrentFieldExpression()
      Retrieve the current field expression.
      Returns:
      the current field expression as a StringBuilder object

    • setFieldExpression

      void setFieldExpression(String value)
      Sets the field expression for the current field being written. The field expression is a string value that represents the type of field and any additional parameters. For example, "HYPERLINK index.html" is a field expression.
      Parameters:
      value - the field expression to set

    • addAnchor

      void addAnchor(String value)
      Adds an anchor to the current document.
      Parameters:
      value - The anchor value to add.

    • finishFldInst

      void finishFldInst()
      Finishes the field instruction.

      This method is called to indicate that the field instruction has finished processing. It is typically called when leaving the Destination.DG_FLDINST destination in the RTF document.

    • finishFldRslt

      void finishFldRslt()
      Finish the field result.

    • finishField

      void finishField()
      Finish the current field expression.