org.docx4j.convert.out.common

Class AbstractVisitorExporterGenerator<CC extends AbstractWmlConversionContext>

java.lang.Object

org.docx4j.TraversalUtil.CallbackImpl

org.docx4j.convert.out.common.AbstractVisitorExporterGenerator<CC>

All Implemented Interfaces:

TraversalUtil.Callback

Direct Known Subclasses:

HTMLExporterVisitorGenerator

public abstract class AbstractVisitorExporterGenerator<CC extends AbstractWmlConversionContext>
extends TraversalUtil.CallbackImpl

The …ExporterGenerator is the visitor, that gets used in those cases where a document is done as a NonXSLT. (docx4j supports convert.out via both xslt and non-xslt based approaches)

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	anchorOrInline
protected CC	conversionContext
protected Element	currentP
protected Element	currentSpan
protected Document	document
protected static int	IMAGE_E10
protected static int	IMAGE_E20
protected static int	NODE_BLOCK
protected static int	NODE_INLINE
protected Node	parentNode
protected PPr	pPr
protected RPr	rPr
protected static String	TAB_DUMMY
protected LinkedList<Element>	tc
protected LinkedList<Element>	tr

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVisitorExporterGenerator(CC conversionContext, Document document, Node parentNode)

Method Summary

Modifier and Type	Method and Description
List<Object>	apply(Object o) Visits a node in pre order (before its children have been visited).
protected void	convertTabToNode(CC conversionContext, Document document)
protected void	convertToNode(CC conversionContext, Object unmarshalledNode, String modelId, Document document, Node parentNode)
protected abstract DocumentFragment	createImage(int imgType, CC conversionContext, Object anchorOrInline)
protected abstract Element	createNode(Document doc, int nodeType)
protected Node	getCurrentParent()
protected abstract AbstractVisitorExporterDelegate.AbstractVisitorExporterGeneratorFactory<CC>	getFactory()
protected org.slf4j.Logger	getLog()
protected int	getPos(List list, Object wanted)
protected abstract void	handleBr(Br o)
protected abstract Element	handlePPr(CC conversionContext, PPr pPrDirect, boolean sdt, Element currentParent)
protected abstract void	handleRPr(CC conversionContext, PPr pPrDirect, RPr rPrDirect, Element currentParent) On a block representing a run, we just put run properties from this rPr node.
protected void	rtlAwareAppendChildToCurrentP(Element child)
boolean	shouldTraverse(Object o) Decide whether this node's children should be traversed.
void	walkJAXBElements(Object o)

Methods inherited from class org.docx4j.TraversalUtil.CallbackImpl

getChildren

Methods inherited from class java.lang.Object

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

Field Detail

TAB_DUMMY

protected static final String TAB_DUMMY

See Also:

Constant Field Values

NODE_BLOCK

protected static final int NODE_BLOCK

See Also:

Constant Field Values

NODE_INLINE

protected static final int NODE_INLINE

See Also:

Constant Field Values

IMAGE_E10

protected static final int IMAGE_E10

See Also:

Constant Field Values

IMAGE_E20

protected static final int IMAGE_E20

See Also:

Constant Field Values

conversionContext

protected CC extends AbstractWmlConversionContext conversionContext

document

protected Document document

parentNode

protected Node parentNode

currentP

protected Element currentP

currentSpan

protected Element currentSpan

tr

protected LinkedList<Element> tr

tc

protected LinkedList<Element> tc

pPr

protected PPr pPr

rPr

protected RPr rPr

anchorOrInline

protected Object anchorOrInline

Constructor Detail

AbstractVisitorExporterGenerator

protected AbstractVisitorExporterGenerator(CC conversionContext,
                                           Document document,
                                           Node parentNode)

Method Detail

shouldTraverse

public boolean shouldTraverse(Object o)

Description copied from class: TraversalUtil.CallbackImpl

Decide whether this node's children should be traversed.

Specified by:

shouldTraverse in interface TraversalUtil.Callback

Overrides:

shouldTraverse in class TraversalUtil.CallbackImpl

Returns:

whether the children of this node should be visited

getCurrentParent

protected Node getCurrentParent()

convertToNode

protected void convertToNode(CC conversionContext,
                             Object unmarshalledNode,
                             String modelId,
                             Document document,
                             Node parentNode)
                      throws DOMException

Throws:

DOMException

rtlAwareAppendChildToCurrentP

protected void rtlAwareAppendChildToCurrentP(Element child)

walkJAXBElements

public void walkJAXBElements(Object o)

Specified by:

walkJAXBElements in interface TraversalUtil.Callback

Overrides:

walkJAXBElements in class TraversalUtil.CallbackImpl

apply

public List<Object> apply(Object o)

Description copied from class: TraversalUtil.CallbackImpl

Visits a node in pre order (before its children have been visited). A node is visited only if all its parents have been traversed ( TraversalUtil.CallbackImpl.shouldTraverse(Object)).

Implementations can have side effects.

Specified by:

apply in interface TraversalUtil.Callback

Specified by:

apply in class TraversalUtil.CallbackImpl

handleBr

protected abstract void handleBr(Br o)

getPos

protected int getPos(List list,
                     Object wanted)

convertTabToNode

protected void convertTabToNode(CC conversionContext,
                                Document document)
                         throws DOMException

Throws:

DOMException

handlePPr

protected abstract Element handlePPr(CC conversionContext,
                                     PPr pPrDirect,
                                     boolean sdt,
                                     Element currentParent)

handleRPr

protected abstract void handleRPr(CC conversionContext,
                                  PPr pPrDirect,
                                  RPr rPrDirect,
                                  Element currentParent)

On a block representing a run, we just put run properties from this rPr node. The paragraph style rPr's have been taken care of on the fo block which represents the paragraph.

getFactory

protected abstract AbstractVisitorExporterDelegate.AbstractVisitorExporterGeneratorFactory<CC> getFactory()

createImage

protected abstract DocumentFragment createImage(int imgType,
                                                CC conversionContext,
                                                Object anchorOrInline)

createNode

protected abstract Element createNode(Document doc,
                                      int nodeType)

getLog

protected org.slf4j.Logger getLog()