java.lang.Object

org.docx4j.convert.out.common.AbstractConversionContext

org.docx4j.convert.out.common.AbstractWmlConversionContext

org.docx4j.convert.out.html.HTMLConversionContext

public class HTMLConversionContext
extends AbstractWmlConversionContext

See /docs/developer/Convert_Out.docx for an overview of the design.

Author:: Alberto

Field Summary

Fields
Modifier and Type	Field	Description
`protected static ConversionHTMLScriptElementHandler`	`DEFAULT_SCRIPT_ELEMENT_HANDLER`
`protected static ConversionHTMLStyleElementHandler`	`DEFAULT_STYLE_ELEMENT_HANDLER`
`protected Mapper`	`fontMapper`
`protected static AbstractMessageWriter`	`HTML_MESSAGE_WRITER`
`protected static AbstractWriterRegistry`	`HTML_WRITER_REGISTRY`
`protected ConversionHTMLScriptElementHandler`	`scriptElementHandler`
`protected ConversionHTMLStyleElementHandler`	`styleElementHandler`
`protected java.lang.String`	`userBodyTail`
`protected java.lang.String`	`userBodyTop`
`protected java.lang.String`	`userCSS`
`protected java.lang.String`	`userScript`

Fields inherited from class org.docx4j.convert.out.common.AbstractWmlConversionContext

complexFieldDefinitionLevel, conversionSectionWrappers, currentPart, endnoteNumberCounter, footnoteNumberCounter, styleTree

Fields inherited from class org.docx4j.convert.out.common.AbstractConversionContext

CONVERSION_CONTEXT_ID, DUMMY_HYPERLINK_HANDLER, DUMMY_WRITER

Constructor Summary

Constructors
Constructor	Description
`HTMLConversionContext(AbstractWriterRegistry writerRegistry, HTMLSettings settings, WordprocessingMLPackage preprocessedPackage, ConversionSectionWrappers conversionSectionWrappers)`	HTMLConversionContext using a customised WriterRegistry
`HTMLConversionContext(HTMLSettings settings, WordprocessingMLPackage preprocessedPackage, ConversionSectionWrappers conversionSectionWrappers)`	HTMLConversionContext used by default

Method Summary

Modifier and Type	Method	Description
`org.w3c.dom.Element`	`createScriptElement(org.w3c.dom.Document document, java.lang.String scriptDefinition)`
`org.w3c.dom.Element`	`createStyleElement(org.w3c.dom.Document document, java.lang.String styleDefinition)`
`CTBookmark`	`getBookmarkStart()`
`Mapper`	`getFontMapper()`
`java.lang.String`	`getUserBodyTail()`
`java.lang.String`	`getUserBodyTop()`
`java.lang.String`	`getUserCSS()`
`java.lang.String`	`getUserScript()`
`protected ConversionImageHandler`	`initializeImageHandler(AbstractConversionSettings settings, ConversionImageHandler handler)`
`protected void`	`initializeSettings(AbstractConversionSettings settings, OpcPackage localOpcPackage)`
`void`	`setBookmarkStart(CTBookmark bookmarkStart)`

Methods inherited from class org.docx4j.convert.out.common.AbstractWmlConversionContext

getCurrentPart, getNextEndnoteNumber, getNextFootnoteNumber, getPropertyResolver, getRunFontSelector, getSections, getStyleTree, getTransformState, getWmlPackage, getWriterRegistry, handleHyperlink, initializeOpcPackage, initializeStyleTree, initializeTransformStates, initializeWriterRegistry, isInComplexFieldDefinition, resolveLinkedAbstractNum, setCurrentPart, setCurrentPartMainDocument, updateComplexFieldDefinition

Methods inherited from class org.docx4j.convert.out.common.AbstractConversionContext

getConversionSettings, getHyperlinkHandler, getImageHandler, getLog, getMessageWriter, getOpcPackage, getXsltParameters, initializeHyperlinkHandler, initializeMessageWriter, initializeXsltParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- fontMapper
  
  protected Mapper fontMapper
- styleElementHandler
  
  protected ConversionHTMLStyleElementHandler styleElementHandler
- scriptElementHandler
  
  protected ConversionHTMLScriptElementHandler scriptElementHandler
- userCSS
  
  protected java.lang.String userCSS
- userScript
  
  protected java.lang.String userScript
- userBodyTop
  
  protected java.lang.String userBodyTop
- userBodyTail
  
  protected java.lang.String userBodyTail
- DEFAULT_STYLE_ELEMENT_HANDLER
  
  protected static final ConversionHTMLStyleElementHandler DEFAULT_STYLE_ELEMENT_HANDLER
- DEFAULT_SCRIPT_ELEMENT_HANDLER
  
  protected static final ConversionHTMLScriptElementHandler DEFAULT_SCRIPT_ELEMENT_HANDLER
- HTML_WRITER_REGISTRY
  
  protected static final AbstractWriterRegistry HTML_WRITER_REGISTRY
- HTML_MESSAGE_WRITER
  
  protected static final AbstractMessageWriter HTML_MESSAGE_WRITER
Constructor Details
- HTMLConversionContext
  
  public HTMLConversionContext(HTMLSettings settings, WordprocessingMLPackage preprocessedPackage, ConversionSectionWrappers conversionSectionWrappers)
  
  HTMLConversionContext used by default
  
  Parameters:
  
  settings -
  
  preprocessedPackage -
  
  conversionSectionWrappers -
- HTMLConversionContext
  
  public HTMLConversionContext(AbstractWriterRegistry writerRegistry, HTMLSettings settings, WordprocessingMLPackage preprocessedPackage, ConversionSectionWrappers conversionSectionWrappers)
  
  HTMLConversionContext using a customised WriterRegistry
  
  Parameters:
  
  writerRegistry -
  
  settings -
  
  preprocessedPackage -
  
  conversionSectionWrappers -
Method Details
- initializeSettings
  
  protected void initializeSettings(AbstractConversionSettings settings, OpcPackage localOpcPackage)
  
  Overrides:
  
  initializeSettings in class AbstractConversionContext
- initializeImageHandler
  
  protected ConversionImageHandler initializeImageHandler(AbstractConversionSettings settings, ConversionImageHandler handler)
  
  Overrides:
  
  initializeImageHandler in class AbstractConversionContext
- getFontMapper
  
  public Mapper getFontMapper()
- createStyleElement
  
  public org.w3c.dom.Element createStyleElement(org.w3c.dom.Document document, java.lang.String styleDefinition)
- createScriptElement
  
  public org.w3c.dom.Element createScriptElement(org.w3c.dom.Document document, java.lang.String scriptDefinition)
- getUserCSS
  
  public java.lang.String getUserCSS()
- getUserScript
  
  public java.lang.String getUserScript()
- getUserBodyTop
  
  public java.lang.String getUserBodyTop()
- getUserBodyTail
  
  public java.lang.String getUserBodyTail()
- getBookmarkStart
  
  public CTBookmark getBookmarkStart()
- setBookmarkStart
  
  public void setBookmarkStart(CTBookmark bookmarkStart)

Class HTMLConversionContext