How to use

HTMLSettings

in

org.docx4j.convert.out

/**
 *  Convert the document to HTML
 */	
public static void toHTML(WordprocessingMLPackage wmlPackage, String imageDirPath, String imageTargetUri, OutputStream outputStream) throws Docx4JException {
  StartEvent startEvent = new StartEvent( wmlPackage, WellKnownProcessSteps.HTML_OUT );
  startEvent.publish();
  
  HTMLSettings settings = createHTMLSettings();
  settings.setWmlPackage(wmlPackage);
  if (imageDirPath != null) {
    settings.setImageDirPath(imageDirPath);
  }
  if (imageTargetUri != null) {
    settings.setImageTargetUri(imageTargetUri);
  }
  toHTML(settings, outputStream, FLAG_NONE);
  
  new EventFinished(startEvent).publish();
}
 

@Override
protected void initializeSettings(AbstractConversionSettings settings, OpcPackage localOpcPackage) {
HTMLSettings htmlSettings = null;
  if (settings == null) {
    settings = new HTMLSettings();
  }
  else if (!(settings instanceof HTMLSettings)) {
    throw new IllegalArgumentException("The class of the settings isn't HtmlSettings, it is " + settings.getClass().getName());
  }
  htmlSettings = (HTMLSettings)settings;
  super.initializeSettings(htmlSettings, localOpcPackage);
  fontMapper = htmlSettings.getFontMapper();
  if (fontMapper == null) {
    fontMapper = getWmlPackage().getFontMapper();
  }
  userCSS = htmlSettings.getUserCSS();
  userScript = htmlSettings.getUserScript();
  userBodyTop = htmlSettings.getUserBodyTop();
  userBodyTail = htmlSettings.getUserBodyTail();
  styleElementHandler = htmlSettings.getStyleElementHandler();
  if (styleElementHandler == null) {
    styleElementHandler = DEFAULT_STYLE_ELEMENT_HANDLER;
  }
  scriptElementHandler = htmlSettings.getScriptElementHandler();
  if (scriptElementHandler == null) {
    scriptElementHandler = DEFAULT_SCRIPT_ELEMENT_HANDLER;
  }
}

public HTMLSettings() {
  settings.put(CONDITIONAL_COMMENTS, Boolean.FALSE);
  settings.put(FONT_FAMILY_STACK,     Boolean.FALSE);
  
  settings.put(USER_CSS, "");
  settings.put(USER_SCRIPT, "");
  settings.put(USER_BODY_TOP, "<!-- userBodyTop goes here -->");
  settings.put(USER_BODY_TAIL, "<!-- userBodyTail goes here -->");
  addFeatures(ConversionFeatures.DEFAULT_HTML_FEATURES);
}
 

public HtmlExporterNonXSLT(WordprocessingMLPackage wordMLPackage, 
    ConversionImageHandler conversionImageHandler) {
  
  htmlSettings = new HTMLSettings();
  htmlSettings.setWmlPackage(wordMLPackage);
  htmlSettings.setImageHandler(conversionImageHandler);
}
 

if ((xslt != null) && (htmlSettings.getCustomXsltTemplates() == null)) {
  htmlSettings.setCustomXsltTemplates(xslt);
if ((wmlPackage != null) && (htmlSettings.getWmlPackage() == null)) {
  htmlSettings.setWmlPackage(wmlPackage);

} else {
  HTMLSettings htmlSettings = Docx4J.createHTMLSettings();
  htmlSettings.setWmlPackage(wordprocessingMLPackage);
  Docx4J.toHTML(htmlSettings, outputStream, Docx4J.FLAG_NONE);
  outputStream.flush();

/**
 *  Create the configuration object for conversions to html
 */	
public static HTMLSettings createHTMLSettings() {
  return new HTMLSettings();
}
 

if ((xslt != null) && (htmlSettings.getCustomXsltTemplates() == null)) {
  htmlSettings.setCustomXsltTemplates(xslt);
if ((wmlPackage != null) && (htmlSettings.getWmlPackage() == null)) {
  htmlSettings.setWmlPackage(wmlPackage);

public HtmlExporterNonXSLT(WordprocessingMLPackage wordMLPackage, 
    ConversionImageHandler conversionImageHandler) {
  
  htmlSettings = new HTMLSettings();
  htmlSettings.setWmlPackage(wordMLPackage);
  htmlSettings.setImageHandler(conversionImageHandler);
}
 

} else {
  HTMLSettings htmlSettings = Docx4J.createHTMLSettings();
  htmlSettings.setWmlPackage(wordprocessingMLPackage);
  Docx4J.toHTML(htmlSettings, outputStream, Docx4J.FLAG_NONE);
  outputStream.flush();

@Override
public void output(javax.xml.transform.Result result) throws Docx4JException {
  
  if (wmlPackage==null) {
    throw new Docx4JException("Must setWmlPackage");
  }
  
  if (htmlSettings==null) {
    log.debug("Using empty HtmlSettings");
    htmlSettings = new HTMLSettings();			
  }        
  
  try {
    html(wmlPackage, result, htmlSettings);
  } catch (Exception e) {
    throw new Docx4JException("Failed to create HTML output", e);
  }        
  
}
 

htmlSettings.setImageDirPath(inputfilepath + "_files");
htmlSettings.setImageTargetUri(inputfilepath.substring(inputfilepath
    .lastIndexOf("/") + 1) + "_files");
htmlSettings.setWmlPackage(wordMLPackage);

@Override
protected void initializeSettings(AbstractConversionSettings settings, OpcPackage localOpcPackage) {
HTMLSettings htmlSettings = null;
  if (settings == null) {
    settings = new HTMLSettings();
  }
  else if (!(settings instanceof HTMLSettings)) {
    throw new IllegalArgumentException("The class of the settings isn't HtmlSettings, it is " + settings.getClass().getName());
  }
  htmlSettings = (HTMLSettings)settings;
  super.initializeSettings(htmlSettings, localOpcPackage);
  fontMapper = htmlSettings.getFontMapper();
  if (fontMapper == null) {
    fontMapper = getWmlPackage().getFontMapper();
  }
  userCSS = htmlSettings.getUserCSS();
  userScript = htmlSettings.getUserScript();
  userBodyTop = htmlSettings.getUserBodyTop();
  userBodyTail = htmlSettings.getUserBodyTail();
  styleElementHandler = htmlSettings.getStyleElementHandler();
  if (styleElementHandler == null) {
    styleElementHandler = DEFAULT_STYLE_ELEMENT_HANDLER;
  }
  scriptElementHandler = htmlSettings.getScriptElementHandler();
  if (scriptElementHandler == null) {
    scriptElementHandler = DEFAULT_SCRIPT_ELEMENT_HANDLER;
  }
}

/**
 *  Create the configuration object for conversions to html
 */	
public static HTMLSettings createHTMLSettings() {
  return new HTMLSettings();
}
 

public HTMLSettings() {
  settings.put(CONDITIONAL_COMMENTS, Boolean.FALSE);
  settings.put(FONT_FAMILY_STACK,     Boolean.FALSE);
  
  settings.put(USER_CSS, "");
  settings.put(USER_SCRIPT, "");
  settings.put(USER_BODY_TOP, "<!-- userBodyTop goes here -->");
  settings.put(USER_BODY_TAIL, "<!-- userBodyTail goes here -->");
  addFeatures(ConversionFeatures.DEFAULT_HTML_FEATURES);
}
 

/**
 *  Convert the document to HTML
 */	
public static void toHTML(WordprocessingMLPackage wmlPackage, String imageDirPath, String imageTargetUri, OutputStream outputStream) throws Docx4JException {
  StartEvent startEvent = new StartEvent( wmlPackage, WellKnownProcessSteps.HTML_OUT );
  startEvent.publish();
  
  HTMLSettings settings = createHTMLSettings();
  settings.setWmlPackage(wmlPackage);
  if (imageDirPath != null) {
    settings.setImageDirPath(imageDirPath);
  }
  if (imageTargetUri != null) {
    settings.setImageTargetUri(imageTargetUri);
  }
  toHTML(settings, outputStream, FLAG_NONE);
  
  new EventFinished(startEvent).publish();
}
 

@Override
public void output(javax.xml.transform.Result result) throws Docx4JException {
  
  if (wmlPackage==null) {
    throw new Docx4JException("Must setWmlPackage");
  }
  
  if (htmlSettings==null) {
    log.debug("Using empty HtmlSettings");
    htmlSettings = new HTMLSettings();			
  }        
  
  try {
    html(wmlPackage, result, htmlSettings);
  } catch (Exception e) {
    throw new Docx4JException("Failed to create HTML output", e);
  }        
  
}