com.acesoft.aceoffix
Class WordResponse

java.lang.Object
  extended by com.acesoft.aceoffix.WordResponse

public class WordResponse
extends java.lang.Object

Fills data into Word document and controls behavior of Word application. WordResponse is a important class. WordResponse object is the data source of AceoffixCtrl and the parameter of the AceoffixCtrl.bind method. If you need to fill data into Word document you have to create WordResponse object.

Version:
3.0
Author:
Acesoft Corporation

Constructor Summary
WordResponse()
          Initializes a new instance of the WordResponse class.
 
Method Summary
 WordResDataRegion openDataRegion(java.lang.String dataRegionName)
          Opens the specified DataRegion and returns a WordResDataRegion object.
 WordResTable openTable(int index)
          Opens the specified table and returns a WordResTable object.
 void setDisableWindowDoubleClick(boolean disableWindowDoubleClick)
          Sets a value that indicates whether or not double-click is disabled in current document.
 void setDisableWindowRightClick(boolean disableWindowRightClick)
          Sets a value that indicates whether or not right-click is disabled in current document.
 void setDisableWindowSelection(boolean disableWindowSelection)
          Sets a value that indicates whether or not selection is disabled in current document.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WordResponse

public WordResponse()
             throws java.lang.Exception,
                    java.io.IOException
Initializes a new instance of the WordResponse class.

Throws:
java.lang.Exception
java.io.IOException
Method Detail

setDisableWindowDoubleClick

public void setDisableWindowDoubleClick(boolean disableWindowDoubleClick)
Sets a value that indicates whether or not double-click is disabled in current document.

Parameters:
disableWindowDoubleClick - The default value is false.

setDisableWindowRightClick

public void setDisableWindowRightClick(boolean disableWindowRightClick)
Sets a value that indicates whether or not right-click is disabled in current document.

Parameters:
disableWindowRightClick - The default value is false.

setDisableWindowSelection

public void setDisableWindowSelection(boolean disableWindowSelection)
Sets a value that indicates whether or not selection is disabled in current document.

Parameters:
disableWindowSelection - The default value is false.

openDataRegion

public WordResDataRegion openDataRegion(java.lang.String dataRegionName)
                                 throws java.io.IOException
Opens the specified DataRegion and returns a WordResDataRegion object.

In Word document, developer can define any range of selection as a DataRegion object by inserting a bookmark with the prefix name "ACE_". In other words, the DataRegion is a bookmark object whose name begins with "ACE_" in Word document. The prefix name "ACE_" is used to differentiate DataRegions from bookmarks defined by users. The bookmark name of a DataRegion is "ACE_" + DataRegionName. For example, if you want to define a specified range as a DataRegion whose DataRegionName is "ProductName" in a Word document, you should manually insert a bookmark whose name is "ACE_ProductName" for the range before you openDocument this document.

Parameters:
dataRegionName - The name of DataRegion.
Throws:
java.io.IOException

openTable

public WordResTable openTable(int index)
Opens the specified table and returns a WordResTable object. The table object is the same as the table defined in Word document.

Parameters:
index - The index of the table is defined in Microsoft Word. The index number represents the position of the table in the Word document. The index is a 1-based index.