Bug 51548 - added the handler in the antlib.xml. Add more substantial javadocs....

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1151847 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/excelant/java/org/apache/poi/ss/excelant/ExcelAntHandlerTask.java b/src/excelant/java/org/apache/poi/ss/excelant/ExcelAntHandlerTask.java
index af210f63ef36a95ad0be34adc7dd2b0d3f762c62..eef50c7a925ec9d575788471b1db31cea53af0e8 100755 (executable)
--- a/src/excelant/java/org/apache/poi/ss/excelant/ExcelAntHandlerTask.java
+++ b/src/excelant/java/org/apache/poi/ss/excelant/ExcelAntHandlerTask.java
@@ -24,6 +24,21 @@ import org.apache.tools.ant.Task;
 \r
 /**\r
  * This is the class that backs the <handler> tag in the Ant task.\r
+ * <p>\r
+ * Its purpose is to provide a way to manipulate a workbook in the course\r
+ * of an ExcelAnt task.  The idea being to model a way for test writers to\r
+ * simulate the behaviors of the workbook. \r
+ * <p>\r
+ * Suppose, for example, you have a workbook that has a worksheet that\r
+ * reacts to values entered or selected by the user.  It's possible in\r
+ * Excel to change other cells based on this but this isn't easily possible\r
+ * in POI.  In ExcelAnt we handle this using the Handler, which is a Java\r
+ * class you write to manipulate the workbook. \r
+ * <p>\r
+ * In order to use this tag you must write a class that implements the \r
+ * <code>IExcelAntWorkbookHandler</code> interface.  After writing the\r
+ * class you should package it and it's dependencies into a jar file to \r
+ * add as library in your Ant build file.\r
  * \r
  * @author Jon Svede ( jon [at] loquatic [dot] com )\r
  * @author Brian Bush ( brian [dot] bush [at] nrel [dot] gov )\r

diff --git a/src/excelant/resources/org/apache/poi/ss/excelant/antlib.xml b/src/excelant/resources/org/apache/poi/ss/excelant/antlib.xml
index 31dadfaf607a346bfd626f29a03456ffd9f70953..af13cc649b4678b12ad37f6f1963c94023976ff7 100755 (executable)
--- a/src/excelant/resources/org/apache/poi/ss/excelant/antlib.xml
+++ b/src/excelant/resources/org/apache/poi/ss/excelant/antlib.xml
@@ -26,5 +26,6 @@ under the License.
     <typedef name="setFormula" classname="org.apache.poi.ss.excelant.ExcelAntSetFormulaCell"/>
     <typedef name="evaluate" classname="org.apache.poi.ss.excelant.ExcelAntEvaluateCell"/>
     <typedef name="udf" classname="org.apache.poi.ss.excelant.ExcelAntUserDefinedFunction"/>
+    <typedef name="handler" classname="org.apache.poi.ss.excelant.ExcelAntHandlerTask"/>
 
 </antlib>