Package org.docx4j.convert.out.common

Interface Writer

All Known Implementing Classes:
AbstractBookmarkStartWriter, AbstractBrWriter, AbstractFldSimpleWriter, AbstractHyperlinkWriter, AbstractPictWriter, AbstractSimpleWriter, AbstractSymbolWriter, AbstractTableWriter, BookmarkStartWriter, BrWriter, FldSimpleWriter, HyperlinkWriter, SymbolWriter, TableWriter
public interface Writer
Note that Writer(s) must be registered in the corresponding instance (FO, HTML...) of the WriterRegistry. Writers are Singletons and shouldn't keep any state.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static interface  Writer.TransformState
    Tag interface for a transform state that may be used by the Writer

  • Method Summary

    Modifier and Type Method Description
    Writer.TransformState createTransformState()
    Create a new instance of the TransformState it uses.
    It may return null, then the passed value in toNode will be null.
    java.lang.String getID()
    Return the common ID of the Model/Converter/TransformState.
    org.w3c.dom.Node toNode​(AbstractWmlConversionContext context, java.lang.Object unmarshalledNode, org.w3c.dom.Node content, Writer.TransformState state, org.w3c.dom.Document doc)
    Generate the corresponding document fragment

  • Method Details

    • getID

      java.lang.String getID()
      Return the common ID of the Model/Converter/TransformState.
      Returns:

    • toNode

      org.w3c.dom.Node toNode​(AbstractWmlConversionContext context, java.lang.Object unmarshalledNode, org.w3c.dom.Node content, Writer.TransformState state, org.w3c.dom.Document doc) throws javax.xml.transform.TransformerException
      Generate the corresponding document fragment
      Parameters:
      context -
      model -
      state -
      doc -
      Returns:
      Throws:
      javax.xml.transform.TransformerException

    • createTransformState

      Writer.TransformState createTransformState()
      Create a new instance of the TransformState it uses.
      It may return null, then the passed value in toNode will be null.
      Returns: