org.docx4j.events

Class Docx4jEvent

java.lang.Object

org.docx4j.events.Docx4jEvent

Direct Known Subclasses:

EventFinished, StartEvent

public abstract class Docx4jEvent
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Docx4jEvent(JobIdentifier job) Use this to signal the start or end of a Job.
Docx4jEvent(JobIdentifier job, PackageIdentifier pkgIdentifier) Use this to signal the start or end of work on a specific pkg in a job.
Docx4jEvent(JobIdentifier job, PackageIdentifier pkgIdentifier, ProcessStep processStep) Use this to signal the start or end of a process step, on some pkg in some overall job.
Docx4jEvent(PackageIdentifier pkgIdentifier) Use this to signal the start or end of work on a specific pkg, where you didn't define an overall job.
Docx4jEvent(PackageIdentifier pkgIdentifier, ProcessStep processStep) Use this to signal the start or end of a process step, where you didn't define an overall job.

Method Summary

Modifier and Type	Method and Description
JobIdentifier	getJob()
PackageIdentifier	getPkgIdentifier()
ProcessStep	getProcessStep() Retrieve the step in the process, if set.
void	publish()
static java.lang.Boolean	publishAsynch()
static void	setEventNotifier(net.engio.mbassy.bus.MBassador<Docx4jEvent> bus)
void	setProcessStep(ProcessStep processStep)
static void	setPublishAsynch(java.lang.Boolean publishAsynch)

Methods inherited from class java.lang.Object

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

Constructor Detail

Docx4jEvent

public Docx4jEvent(JobIdentifier job)

Use this to signal the start or end of a Job.

Parameters:

job -

eventType -

Docx4jEvent

public Docx4jEvent(JobIdentifier job,
                   PackageIdentifier pkgIdentifier)

Use this to signal the start or end of work on a specific pkg in a job.

Parameters:

job -

eventType -

Docx4jEvent

public Docx4jEvent(PackageIdentifier pkgIdentifier)

Use this to signal the start or end of work on a specific pkg, where you didn't define an overall job.

Parameters:

job -

eventType -

Docx4jEvent

public Docx4jEvent(PackageIdentifier pkgIdentifier,
                   ProcessStep processStep)

Use this to signal the start or end of a process step, where you didn't define an overall job.

Parameters:

job -

eventType -

Docx4jEvent

public Docx4jEvent(JobIdentifier job,
                   PackageIdentifier pkgIdentifier,
                   ProcessStep processStep)

Use this to signal the start or end of a process step, on some pkg in some overall job.

Parameters:

job -

eventType -

Method Detail

setEventNotifier

public static void setEventNotifier(net.engio.mbassy.bus.MBassador<Docx4jEvent> bus)

publishAsynch

public static java.lang.Boolean publishAsynch()

setPublishAsynch

public static void setPublishAsynch(java.lang.Boolean publishAsynch)

getPkgIdentifier

public PackageIdentifier getPkgIdentifier()

publish

public void publish()

getJob

public JobIdentifier getJob()

getProcessStep

public ProcessStep getProcessStep()

Retrieve the step in the process, if set. You can create your own set of steps (for things which happen in your user code ie outside docx4j's source code) by implementing the ProcessStep interface.

Returns:

setProcessStep

public void setProcessStep(ProcessStep processStep)