de.must.util

Class WordProcessing

java.lang.Object

de.must.util.WordProcessing

public class WordProcessing
extends java.lang.Object

Native interface to Word for Windows. Simple version as presented via Internet. To create a new document and to serve bookmarks by your java application code like this:

       WordProcessing.createNewDocumentFromTemplate("SampleTemplate");
       WordProcessing.typeTextAtBookmark("AddressLine1", "O'Reilly & Associated, Inc.");
       WordProcessing.typeTextAtBookmark("AddressLine2", "Mr Miller");
       WordProcessing.typeTextAtBookmark("AddressLine3", "101 Moris Street");
       WordProcessing.typeTextAtBookmark("AddressLine4", "Sebastopol, CA 95472-9902");
       WordProcessing.typeTextAtBookmark("Salutation", "Dear Mr Miller,");
       WordProcessing.exec();
 

See Also:

InteractiveWordProcessing, BatchWordProcessing

Constructor Summary

Constructors

Constructor and Description
WordProcessing()

Method Summary

Modifier and Type	Method and Description
static void	cancel() Cancels the word processing.
static void	changeDocumentDirectory(java.lang.String documentDirectory) Sets the document directory for future document saving.
static void	closeDocument() Closes the active document.
static void	createNewDocumentFromTemplate(java.lang.String templateName) Creates a new document based on the desired template.
static void	createNewDocumentFromTemplateToSelectByUser() Triggers to the template selection dialog and creates a new document based on the chosen template.
static boolean	exec() Starts the execution of the above instructions.
static void	executeMacro(java.lang.String macroName) Executes an arbitrary WordBasic macro.
static void	printAndForget() Prints the document on the standard printer and closes the document without saving.
static void	printAndForget(java.lang.String printerName) Prints the document on the specified printer and closes the document without saving.
static void	printToPrinterToSelectByUserAndForget() Triggers to the printer selection dialog, prints the document on the selected printer and closes the document without saving.
static void	quitApplication() Quits the word processing application.
static void	quitApplicationAfterWaiting(int milliseconds) Quits the word processing application after a pause.
static void	saveDocumentAs(java.lang.String documentName) Saves the active document using the indicated name (usually without extension).
static void	saveDocumentAsAndClose(java.lang.String documentName) Saves the active document using the indicated name and closes it.
static 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.
static void	typeTextAtBookmark(java.lang.String bookmark, java.lang.String textToType) Goes to the specified bookmark and types the desired text.
static 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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WordProcessing

public WordProcessing()

Method Detail

createNewDocumentFromTemplateToSelectByUser

public static void createNewDocumentFromTemplateToSelectByUser()

Triggers to the template selection dialog and creates a new document based on the chosen template.

createNewDocumentFromTemplate

public static 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 static 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

typeTextAtBookmark

public static 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 static 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 static void changeDocumentDirectory(java.lang.String documentDirectory)

Sets the document directory for future document saving.

Parameters:

documentDirectory - the name of the directory

saveDocumentAs

public static 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 static void saveDocumentAsAndClose(java.lang.String documentName)

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

Parameters:

documentName - the name of the document

closeDocument

public static void closeDocument()

Closes the active document.

printAndForget

public static void printAndForget()

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

printAndForget

public static 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

printToPrinterToSelectByUserAndForget

public static void printToPrinterToSelectByUserAndForget()

Triggers to the printer selection dialog, prints the document on the selected printer and closes the document without saving.

executeMacro

public static void executeMacro(java.lang.String macroName)

Executes an arbitrary WordBasic macro.

Parameters:

macroName - the name of the macro to be executed

quitApplication

public static void quitApplication()

Quits the word processing application.

quitApplicationAfterWaiting

public static 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

exec

public static boolean exec()

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.

Returns:

cancel

public static void cancel()

Cancels the word processing.