Updated the docs.

rbgrouleff · Feb 3, 2009 · 56b07f0 · 56b07f0
1 parent c28cc31
commit 56b07f0
Show file tree

Hide file tree

Showing 120 changed files with 3,598 additions and 697 deletions.
diff --git a/Rakefile b/Rakefile
@@ -34,7 +34,7 @@ task :doc do
   packages = ['-package org.restfulx "Provides central access to a number of frequently used subsystems, configuration options and helpers."']
   packages << '-package org.restfulx.collections "ArrayCollection extensions that help dealing with RxModels."'
   packages << '-package org.restfulx.commands "Command pattern specific classes."'
-  packages << '-package org.restfulx.components "Reusable MXML components that maybe used the Code generation engine."'
+  packages << '-package org.restfulx.components.rx "Reusable MXML components that maybe used by the RestfulX code generation engine."'
   packages << '-package org.restfulx.controllers "Various framework controllers such as RXApplicationController and ModelsController."'
   packages << '-package org.restfulx.controllers.mock "Adds a few testing specific controllers."'
   packages << '-package org.restfulx.events "Events dispatched by the framework."'
@@ -47,7 +47,7 @@ task :doc do
   packages << '-package org.restfulx.services.mock "Adds a few testing specific service providers."'
   packages << '-package org.restfulx.utils "Framework utilties."'
   packages << '-package org.restfulx.validators "Validation classes for proxying server-side/service provider errors to the UI."'
-  system("#{get_executable('asdoc')} +configname=air -main-title 'RestfulX Framework 1.2.0 API Documenation' -source-path framework/src -doc-sources framework/src -library-path+=#{libs.join(',')} #{packages.join(" ")} -output doc/api")
+  system("#{get_executable('asdoc')} +configname=air -main-title 'RestfulX Framework 1.2.1 API Documenation' -source-path framework/src -doc-sources framework/src -library-path+=#{libs.join(',')} #{packages.join(" ")} -output doc/api")
 end
 
 namespace :test do  

diff --git a/doc/api/all-classes.html b/doc/api/all-classes.html
@@ -55,19 +55,19 @@ <h3>
 <td><a href="org/restfulx/commands/CommandsEventDispatcher.html">CommandsEventDispatcher</a></td>
 </tr>
 <tr>
-<td><a href="org/restfulx/serializers/CouchDBJSONSerializer.html">CouchDBJSONSerializer</a></td>
+<td><a href="org/restfulx/components/rx/ComponentWatcher.html">ComponentWatcher</a></td>
 </tr>
 <tr>
-<td><a href="org/restfulx/components/DateTextInput.html">DateTextInput</a></td>
+<td><a href="org/restfulx/serializers/CouchDBJSONSerializer.html">CouchDBJSONSerializer</a></td>
 </tr>
 <tr>
-<td><a href="org/restfulx/components/DateTimeTextInput.html">DateTimeTextInput</a></td>
+<td><a href="org/restfulx/components/rx/DateTextInput.html">DateTextInput</a></td>
 </tr>
 <tr>
-<td><a href="org/restfulx/services/as3http/DirectCouchDBHTTPServiceProvider.html">DirectCouchDBHTTPServiceProvider</a></td>
+<td><a href="org/restfulx/components/rx/DateTimeTextInput.html">DateTimeTextInput</a></td>
 </tr>
 <tr>
-<td><a href="com/adobe/data/encryption/EncryptionKeyGenerator.html">EncryptionKeyGenerator</a></td>
+<td><a href="org/restfulx/services/as3http/DirectCouchDBHTTPServiceProvider.html">DirectCouchDBHTTPServiceProvider</a></td>
 </tr>
 <tr>
 <td><a href="org/restfulx/services/http/GAEHTTPServiceProvider.html">GAEHTTPServiceProvider</a></td>
@@ -136,7 +136,7 @@ <h3>
 <td><a href="org/restfulx/utils/ModelsMetadata.html">ModelsMetadata</a></td>
 </tr>
 <tr>
-<td><a href="org/restfulx/components/MoneyTextInput.html">MoneyTextInput</a></td>
+<td><a href="org/restfulx/components/rx/MoneyTextInput.html">MoneyTextInput</a></td>
 </tr>
 <tr>
 <td><a href="org/restfulx/utils/MultiPartRequestBuilder.html">MultiPartRequestBuilder</a></td>
@@ -148,7 +148,7 @@ <h3>
 <td><a href="org/restfulx/controllers/RxApplicationController.html">RxApplicationController</a></td>
 </tr>
 <tr>
-<td><a href="org/restfulx/components/RxAutoComplete.html">RxAutoComplete</a></td>
+<td><a href="org/restfulx/components/rx/RxAutoComplete.html">RxAutoComplete</a></td>
 </tr>
 <tr>
 <td><a href="org/restfulx/collections/RxCollection.html">RxCollection</a></td>
@@ -199,9 +199,6 @@ <h3>
 <td><a href="org/restfulx/events/SyncStartEvent.html">SyncStartEvent</a></td>
 </tr>
 <tr>
-<td><a href="org/restfulx/components/TwoWayBinding.html">TwoWayBinding</a></td>
-</tr>
-<tr>
 <td><a href="org/restfulx/utils/TypedArray.html">TypedArray</a></td>
 </tr>
 <tr>

diff --git a/doc/api/all-index-A.html b/doc/api/all-index-A.html
@@ -15,7 +15,7 @@
 			--></script>
 <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
 <tr>
-<td align="left" class="titleTableTitle">RestfulX Framework 1.2.0 API Documenation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('all-classes.html')" href="package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('all-classes.html')" href="class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a href="index.html?all-index-A.html&amp;index-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="images/logo.jpg"></td>
+<td align="left" class="titleTableTitle">RestfulX Framework 1.2.1 API Documenation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('all-classes.html')" href="package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('all-classes.html')" href="class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a href="index.html?all-index-A.html&amp;index-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="images/logo.jpg"></td>
 </tr>
 <tr class="titleTableRow2">
 <td align="left" id="subTitle" class="titleTableSubTitle">A&nbsp;Index</td><td align="right" id="subNav" class="titleTableSubNav"></td>
@@ -38,7 +38,8 @@
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/UndoRedoController.html#addChangeAction()">addChangeAction</a>(action) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/UndoRedoController.html">UndoRedoController</a></td>
 </tr>
 <tr>
-<td width="20"></td><td></td>
+<td width="20"></td><td>
+     Pushes given composite action object onto the undo stack.</td>
 </tr>
 <tr>
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CommandsController.html#addCommand()">addCommand</a>(cmd, useWeakReference) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/CommandsController.html">CommandsController</a></td>
@@ -71,6 +72,16 @@
      is embedded in the URL.</td>
 </tr>
 <tr>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ServicesController.html#addServiceProvider()">addServiceProvider</a>(serviceProvider:<a href="org/restfulx/services/IServiceProvider.html" onclick="javascript:loadClassListFrame('org/restfulx/services./class-list.html');">org.restfulx.services:IServiceProvider</a>) &mdash; Method in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/ServicesController.html">ServicesController</a></td>
+</tr>
+<tr>
+<td width="20"></td><td>
+     Adds a specific service provider instance to the array of
+     available services
+
+     </td>
+</tr>
+<tr>
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/class-list.html');" href="org/restfulx/Rx.html#airDatabaseName">airDatabaseName</a> &mdash; Static property in class org.restfulx.<a onclick="javascript:loadClassListFrame('org/restfulx/class-list.html');" href="org/restfulx/Rx.html">Rx</a></td>
 </tr>
 <tr>
@@ -93,10 +104,11 @@
    AIR Service Provider implementation.</td>
 </tr>
 <tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/air/class-list.html');" href="org/restfulx/services/air/AIRServiceProvider.html#AIRServiceProvider()">AIRServiceProvider</a>() &mdash; Constructor in class org.restfulx.services.air.<a onclick="javascript:loadClassListFrame('org/restfulx/services/air/class-list.html');" href="org/restfulx/services/air/AIRServiceProvider.html">AIRServiceProvider</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/air/class-list.html');" href="org/restfulx/services/air/AIRServiceProvider.html#AIRServiceProvider()">AIRServiceProvider</a>(dbFile) &mdash; Constructor in class org.restfulx.services.air.<a onclick="javascript:loadClassListFrame('org/restfulx/services/air/class-list.html');" href="org/restfulx/services/air/AIRServiceProvider.html">AIRServiceProvider</a></td>
 </tr>
 <tr>
-<td width="20"></td><td></td>
+<td width="20"></td><td>
+     </td>
 </tr>
 <tr>
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3GAEHTTPServiceProvider.html">AS3GAEHTTPServiceProvider</a> &mdash; Class in package <a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/package-detail.html">org.restfulx.services.as3http</a></td>
@@ -106,10 +118,11 @@
    AS3 HTTP Client based GAE XML-over-HTTP service provider.</td>
 </tr>
 <tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3GAEHTTPServiceProvider.html#AS3GAEHTTPServiceProvider()">AS3GAEHTTPServiceProvider</a>() &mdash; Constructor in class org.restfulx.services.as3http.<a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3GAEHTTPServiceProvider.html">AS3GAEHTTPServiceProvider</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3GAEHTTPServiceProvider.html#AS3GAEHTTPServiceProvider()">AS3GAEHTTPServiceProvider</a>(httpRootUrl) &mdash; Constructor in class org.restfulx.services.as3http.<a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3GAEHTTPServiceProvider.html">AS3GAEHTTPServiceProvider</a></td>
 </tr>
 <tr>
-<td width="20"></td><td></td>
+<td width="20"></td><td>
+     </td>
 </tr>
 <tr>
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3JSONHTTPServiceProvider.html">AS3JSONHTTPServiceProvider</a> &mdash; Class in package <a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/package-detail.html">org.restfulx.services.as3http</a></td>
@@ -119,10 +132,11 @@
    AS3 HTTP Client based JSON-over-HTTP service provider.</td>
 </tr>
 <tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3JSONHTTPServiceProvider.html#AS3JSONHTTPServiceProvider()">AS3JSONHTTPServiceProvider</a>() &mdash; Constructor in class org.restfulx.services.as3http.<a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3JSONHTTPServiceProvider.html">AS3JSONHTTPServiceProvider</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3JSONHTTPServiceProvider.html#AS3JSONHTTPServiceProvider()">AS3JSONHTTPServiceProvider</a>(httpRootUrl) &mdash; Constructor in class org.restfulx.services.as3http.<a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3JSONHTTPServiceProvider.html">AS3JSONHTTPServiceProvider</a></td>
 </tr>
 <tr>
-<td width="20"></td><td></td>
+<td width="20"></td><td>
+     </td>
 </tr>
 <tr>
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3XMLHTTPServiceProvider.html">AS3XMLHTTPServiceProvider</a> &mdash; Class in package <a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/package-detail.html">org.restfulx.services.as3http</a></td>
@@ -132,7 +146,7 @@
    AS3 HTTP Client based XML-over-HTTP service provider.</td>
 </tr>
 <tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3XMLHTTPServiceProvider.html#AS3XMLHTTPServiceProvider()">AS3XMLHTTPServiceProvider</a>() &mdash; Constructor in class org.restfulx.services.as3http.<a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3XMLHTTPServiceProvider.html">AS3XMLHTTPServiceProvider</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3XMLHTTPServiceProvider.html#AS3XMLHTTPServiceProvider()">AS3XMLHTTPServiceProvider</a>(httpRootUrl) &mdash; Constructor in class org.restfulx.services.as3http.<a onclick="javascript:loadClassListFrame('org/restfulx/services/as3http/class-list.html');" href="org/restfulx/services/as3http/AS3XMLHTTPServiceProvider.html">AS3XMLHTTPServiceProvider</a></td>
 </tr>
 <tr>
 <td width="20"></td><td>
@@ -153,10 +167,11 @@
    opposed to CRUD on models) against local SQLite database.</td>
 </tr>
 <tr>
-<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html#AuxAIRController()">AuxAIRController</a>() &mdash; Constructor in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html">AuxAIRController</a></td>
+<td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html#AuxAIRController()">AuxAIRController</a>(optsOrOnResult, onFault, dbFile) &mdash; Constructor in class org.restfulx.controllers.<a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxAIRController.html">AuxAIRController</a></td>
 </tr>
 <tr>
-<td width="20"></td><td></td>
+<td width="20"></td><td>
+     </td>
 </tr>
 <tr>
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/AuxHTTPController.html">AuxHTTPController</a> &mdash; Class in package <a onclick="javascript:loadClassListFrame('org/restfulx/controllers/class-list.html');" href="org/restfulx/controllers/package-detail.html">org.restfulx.controllers</a></td>

diff --git a/doc/api/all-index-B.html b/doc/api/all-index-B.html
@@ -15,7 +15,7 @@
 			--></script>
 <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
 <tr>
-<td align="left" class="titleTableTitle">RestfulX Framework 1.2.0 API Documenation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('all-classes.html')" href="package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('all-classes.html')" href="class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a href="index.html?all-index-B.html&amp;index-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="images/logo.jpg"></td>
+<td align="left" class="titleTableTitle">RestfulX Framework 1.2.1 API Documenation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('all-classes.html')" href="package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('all-classes.html')" href="class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a href="index.html?all-index-B.html&amp;index-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="images/logo.jpg"></td>
 </tr>
 <tr class="titleTableRow2">
 <td align="left" id="subTitle" class="titleTableSubTitle">B&nbsp;Index</td><td align="right" id="subNav" class="titleTableSubNav"></td>
@@ -38,7 +38,9 @@
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/BinaryAttachment.html">BinaryAttachment</a> &mdash; Class in package <a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/package-detail.html">org.restfulx.utils</a></td>
 </tr>
 <tr>
-<td width="20"></td><td></td>
+<td width="20"></td><td>
+   BinaryAttachments work much the same way RxFileReferences do, except they allow
+   you to attach arbitrary binary data to models instead of files.</td>
 </tr>
 <tr>
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/BinaryAttachment.html#BinaryAttachment()">BinaryAttachment</a>(name, key, data) &mdash; Constructor in class org.restfulx.utils.<a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/BinaryAttachment.html">BinaryAttachment</a></td>
@@ -50,7 +52,8 @@
 <td colspan="2" class="idxrow"><a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/MultiPartRequestBuilder.html#build()">build</a>() &mdash; Method in class org.restfulx.utils.<a onclick="javascript:loadClassListFrame('org/restfulx/utils/class-list.html');" href="org/restfulx/utils/MultiPartRequestBuilder.html">MultiPartRequestBuilder</a></td>
 </tr>
 <tr>
-<td width="20"></td><td></td>
+<td width="20"></td><td>
+     Build the multipart request.</td>
 </tr>
 <tr>
 <td style="padding-bottom:20px" colspan="2"></td>