Package com.nomagic.reportwizard.tools.importer

Class DOCXImporterTool

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.Tool

com.nomagic.reportwizard.tools.ImportTool

com.nomagic.reportwizard.tools.importer.DefaultImporterTool

com.nomagic.reportwizard.tools.importer.DOCXImporterTool

All Implemented Interfaces:

IChildEngine, ITool, IVariable, Serializable, Cloneable, Observer

@OpenApiAll
public class DOCXImporterTool
extends DefaultImporterTool

This tool will allow user to import docx template.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

ITool.HTMLString, ITool.RetainedString, ITool.Void

Field Summary

Fields inherited from class com.nomagic.magicreport.engine.Tool

context, properties

Fields inherited from interface com.nomagic.magicreport.engine.ITool

VOID

Constructor Summary

Constructors

Constructor	Description
DOCXImporterTool(ITemplateEngine iTemplateEngine)	Constructor.

Method Summary

Modifier and Type	Method	Description
CharSequence	importer(File importedFile, String importedSectionName)	Gets the String content of the imported file.
protected boolean	isSupport(String engineType)	CHeck supported engine type
protected void	setupEngine(ITemplateEngine engine)	Set up engine. Add properties and context to engine.

Methods inherited from class com.nomagic.reportwizard.tools.importer.DefaultImporterTool

getCanonicalTemplate, getEngineType, getTemplateFile, importer, importer, setEngineType, setTemplateEngine

Methods inherited from class com.nomagic.reportwizard.tools.ImportTool

fileImporter, getParentEngine, importer, include, include, include, include, includeSection, includeSection, isParentSupportChild, setParentEngine, setupTool, update

Methods inherited from class com.nomagic.magicreport.engine.Tool

clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nomagic.magicreport.engine.ITool

clearTool

Constructor Details

DOCXImporterTool

public DOCXImporterTool(ITemplateEngine iTemplateEngine)

Constructor.

Parameters:

iTemplateEngine - parent engine

Method Details

importer

public CharSequence importer(File importedFile,
 String importedSectionName)

Description copied from class: DefaultImporterTool

Gets the String content of the imported file. This will do all the importTool's work. It is called by both public methods, with the difference that section is null if we want to include the whole file. Else it has a section name and only that subsection will be included.

Overrides:

importer in class DefaultImporterTool

Parameters:

importedFile - the childTemplate file to be evaluated

importedSectionName - if there is a section else this is null

Returns:

the evaluated and validated output from childTemplate

isSupport

protected boolean isSupport(String engineType)

Description copied from class: DefaultImporterTool

CHeck supported engine type

Overrides:

isSupport in class DefaultImporterTool

Parameters:

engineType - engine type

Returns:

true if the specific engine is supported, otherwise; false

setupEngine

protected void setupEngine(ITemplateEngine engine)

Description copied from class: DefaultImporterTool

Set up engine.
Add properties and context to engine.

Overrides:

setupEngine in class DefaultImporterTool

Parameters:

engine - current engine