de.must.util

Class AbstractWordProcessing

java.lang.Object

de.must.util.AbstractWordProcessing

Direct Known Subclasses:

BatchWordProcessing, InteractiveWordProcessing, RemoteWordProcessing

public abstract class AbstractWordProcessing
extends java.lang.Object

Native interface to Word for Windows.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	dataFolder

Constructor Summary

Constructors

Constructor and Description
AbstractWordProcessing() Creates word processing driver.
AbstractWordProcessing(java.lang.String inputFileName, java.lang.String logFileName) Creates word processing driver.

Method Summary

Modifier and Type	Method and Description
void	beginWorkingWithTable() Starts working with table 1.
void	beginWorkingWithTable(int index) Starts working with table to be specified.
void	changeDocumentDirectory(java.lang.String documentDirectory) Sets the document directory for future document saving.
void	closeDocument() Closes the active document.
protected void	closeWordInput()
void	createNewDocumentFromTemplate(java.lang.String templateName) Creates a new document based on the desired template.
void	endWorkingWithTable() Starts working with table.
void	exec() Starts the execution of the above instructions without waiting for end of process.
void	exec(boolean waitForExecution) Starts the execution of the above instructions.
void	executeMacro(java.lang.String macroName) Executes an arbitrary WordBasic macro.
void	exportDocumentAsPdf(java.lang.String documentName) Exports the active document using the indicated name.
void	exportDocumentAsPdfAndClose(java.lang.String documentName) Exports the active document using the indicated name and closes it.
protected void	finalize()
protected abstract java.lang.String	getDriverExecutableName()
void	newRow() Tells WordAPI to place bookmark text into a new table row.
protected void	output(java.lang.String key, java.lang.String value)
void	printAndForget() Prints the document on the standard printer and closes the document without saving.
void	printAndForget(int copies)
void	printAndForget(java.lang.String printerName) Prints the document on the specified printer and closes the document without saving.
void	quitApplication() Quits the word processing application.
void	quitApplicationAfterWaiting(int milliseconds) Quits the word processing application after a pause.
void	saveDocumentAs(java.lang.String documentName) Saves the active document using the indicated name (usually without extension).
void	saveDocumentAsAndClose(java.lang.String documentName) Saves the active document using the indicated name and closes it.
void	setNoteNotMatchingBookmarks(boolean noteNotMatchingBookmarks) Set the warning flag about not matching bookmarks Decides whether the user shall be informed that the template didn't include certain bookmarks.
void	setPrinterName(java.lang.String printerName)
void	typeTextAtBookmark(java.lang.String bookmark, java.lang.String textToType) Goes to the specified bookmark and types the desired text.
void	typeTextAtBookmark(java.lang.String bookmark, java.lang.String[] linesToType) Goes to the specified bookmark and types the desired text with line feed.

Methods inherited from class java.lang.Object

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

Field Detail

dataFolder

public static java.lang.String dataFolder

Constructor Detail

AbstractWordProcessing

public AbstractWordProcessing()
                       throws java.io.IOException

Creates word processing driver.

Throws:

java.io.IOException

AbstractWordProcessing

public AbstractWordProcessing(java.lang.String inputFileName,
                              java.lang.String logFileName)
                       throws java.io.IOException

Creates word processing driver.

Parameters:

inputFileName - the name of the input file to be used by the driver

logFileName - the name of the log file to be used by the driver

Throws:

java.io.IOException

Method Detail

createNewDocumentFromTemplate

public void createNewDocumentFromTemplate(java.lang.String templateName)

Creates a new document based on the desired template.

Parameters:

templateName - the name of the template to be used

setNoteNotMatchingBookmarks

public void setNoteNotMatchingBookmarks(boolean noteNotMatchingBookmarks)

Set the warning flag about not matching bookmarks Decides whether the user shall be informed that the template didn't include certain bookmarks.

Parameters:

noteNotMatchingBookmarks - whether the user should be warned

beginWorkingWithTable

public void beginWorkingWithTable()

Starts working with table 1. Place bookmarks into table header row of your word template. It is recommended to have one data row in your table. Thus, different fonts may be used in header and data rows. In consequence, it is necessary to call newRow() from the second row on.

See Also:

newRow(), endWorkingWithTable()

beginWorkingWithTable

public void beginWorkingWithTable(int index)

Starts working with table to be specified. Place bookmarks into table header row of your word template. It is recommended to have one data row in your table. Thus, different fonts may be used in header and data rows. In consequence, it is necessary to call newRow() from the second row on.

Parameters:

index - the index of the table to work with, beginning with 1

See Also:

newRow(), endWorkingWithTable()

newRow

public void newRow()

Tells WordAPI to place bookmark text into a new table row.

endWorkingWithTable

public void endWorkingWithTable()

Starts working with table.

typeTextAtBookmark

public void typeTextAtBookmark(java.lang.String bookmark,
                               java.lang.String textToType)

Goes to the specified bookmark and types the desired text.

Parameters:

bookmark - the bookmark where text type starts

textToType - the text to be included

typeTextAtBookmark

public void typeTextAtBookmark(java.lang.String bookmark,
                               java.lang.String[] linesToType)

Goes to the specified bookmark and types the desired text with line feed.

Parameters:

bookmark - the bookmark where text type starts

linesToType - the lines to be included

changeDocumentDirectory

public void changeDocumentDirectory(java.lang.String documentDirectory)

Sets the document directory for future document saving.

Parameters:

documentDirectory - the name of the directory

saveDocumentAs

public void saveDocumentAs(java.lang.String documentName)

Saves the active document using the indicated name (usually without extension).

Parameters:

documentName - the name of the document

saveDocumentAsAndClose

public void saveDocumentAsAndClose(java.lang.String documentName)

Saves the active document using the indicated name and closes it.

Parameters:

documentName - the name of the document

exportDocumentAsPdf

public void exportDocumentAsPdf(java.lang.String documentName)

Exports the active document using the indicated name. This function requires a newer version of the WordAPI that is not generally available.

Parameters:

documentName - the name of the document

exportDocumentAsPdfAndClose

public void exportDocumentAsPdfAndClose(java.lang.String documentName)

Exports the active document using the indicated name and closes it. This function requires a newer version of the WordAPI that is not generally available.

Parameters:

documentName - the name of the document

closeDocument

public void closeDocument()

Closes the active document.

setPrinterName

public void setPrinterName(java.lang.String printerName)

printAndForget

public void printAndForget()

Prints the document on the standard printer and closes the document without saving.

printAndForget

public void printAndForget(java.lang.String printerName)

Prints the document on the specified printer and closes the document without saving.

Parameters:

printerName - the name of the desired printer

printAndForget

public void printAndForget(int copies)

executeMacro

public void executeMacro(java.lang.String macroName)

Executes an arbitrary WordBasic macro.

Parameters:

macroName - the name of the macro to be executed

quitApplication

public void quitApplication()

Quits the word processing application.

quitApplicationAfterWaiting

public void quitApplicationAfterWaiting(int milliseconds)

Quits the word processing application after a pause. This gives the word processing time to finish e.g. a print job. This avoids dialogs by the word processing system whether the print job is to stop

Parameters:

milliseconds - waiting time in milliseconds prior leaving application

output

protected void output(java.lang.String key,
                      java.lang.String value)

closeWordInput

protected void closeWordInput()

exec

public void exec()

Starts the execution of the above instructions without waiting for end of process. (This stacking is particularly helpful at large numbers of standard letters.) Always use use this as the last method of a sequence.

exec

public void exec(boolean waitForExecution)

Starts the execution of the above instructions. (This stacking is particularly helpful at large numbers of standard letters.) Always use use this as the last method of a sequence.

Parameters:

waitForExecution - whether or not the application should wait until process is finished

getDriverExecutableName

protected abstract java.lang.String getDriverExecutableName()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable