This is an automated email from the ASF dual-hosted git repository.
carlosrovira pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-asjs.git
The following commit(s) were added to refs/heads/develop by this push:
new 070b662 basic-dataprovidernotifier: use interface IArrayList instead
of ArrayList, clean imports and add a bit more docs
070b662 is described below
commit 070b662247bb026969f0d8ee661879728499371a
Author: Carlos Rovira <[email protected]>
AuthorDate: Mon Dec 21 19:06:10 2020 +0100
basic-dataprovidernotifier: use interface IArrayList instead of ArrayList,
clean imports and add a bit more docs
---
.../html/beads/DataProviderChangeNotifier.as | 13 ++++++-----
.../html/beads/DataProviderItemsChangeNotifier.as | 10 ++++++---
.../html/beads/EasyDataProviderChangeNotifier.as | 7 +++---
.../supportClasses/DataProviderNotifierBase.as | 26 ++++++++++++----------
4 files changed, 31 insertions(+), 25 deletions(-)
diff --git
a/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/DataProviderChangeNotifier.as
b/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/DataProviderChangeNotifier.as
index f30f90a..db3e8a4 100644
---
a/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/DataProviderChangeNotifier.as
+++
b/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/DataProviderChangeNotifier.as
@@ -18,11 +18,10 @@
////////////////////////////////////////////////////////////////////////////////
package org.apache.royale.html.beads
{
+ import org.apache.royale.collections.IArrayList;
import org.apache.royale.core.ISelectionModel;
- import org.apache.royale.events.IEventDispatcher;
import org.apache.royale.events.Event;
- import org.apache.royale.collections.ArrayList;
- import org.apache.royale.html.supportClasses.DataProviderNotifierBase;
+ import org.apache.royale.html.supportClasses.DataProviderNotifierBase;
/**
* The DataProviderChangeNotifier notifies listeners when a selection
model's
@@ -48,8 +47,9 @@ package org.apache.royale.html.beads
}
/**
- * @royaleignorecoercion
org.apache.royale.collections.ArrayList
- *
+ * The change handler function that will be called when
change event is thrown
+ *
+ * @royaleignorecoercion
org.apache.royale.collections.IArrayList
*/
override protected function
destinationChangedHandler(event:Event):void
{
@@ -60,9 +60,10 @@ package org.apache.royale.html.beads
return;
detachEventListeners();
}
- dataProvider = object[propertyName] as ArrayList;
+ dataProvider = object[propertyName] as IArrayList;
attachEventListeners();
}
+
/**
* @royaleignorecoercion
org.apache.royale.core.ISelectionModel
*/
diff --git
a/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/DataProviderItemsChangeNotifier.as
b/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/DataProviderItemsChangeNotifier.as
index 53ccde9..8c77262 100644
---
a/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/DataProviderItemsChangeNotifier.as
+++
b/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/DataProviderItemsChangeNotifier.as
@@ -19,9 +19,8 @@
package org.apache.royale.html.beads
{
import org.apache.royale.core.ISelectionModel;
- import org.apache.royale.events.IEventDispatcher;
import org.apache.royale.events.Event;
- import org.apache.royale.collections.ArrayList;
+ import org.apache.royale.collections.IArrayList;
import org.apache.royale.events.CollectionEvent;
import org.apache.royale.html.supportClasses.DataProviderNotifierBase;
@@ -48,6 +47,11 @@ package org.apache.royale.html.beads
{
}
+ /**
+ * The change handler function that will be called when
change event is thrown
+ *
+ * @royaleignorecoercion
org.apache.royale.collections.IArrayList
+ */
override protected function
destinationChangedHandler(event:Event):void
{
var object:Object = document[sourceID];
@@ -59,7 +63,7 @@ package org.apache.royale.html.beads
dataProvider.removeEventListener(CollectionEvent.ITEM_REMOVED,
handleItemRemoved);
dataProvider.removeEventListener(CollectionEvent.ITEM_UPDATED,
handleItemUpdated);
}
- dataProvider = object[propertyName] as ArrayList;
+ dataProvider = object[propertyName] as IArrayList;
dataProvider.addEventListener(CollectionEvent.ITEM_ADDED, handleItemAdded);
dataProvider.addEventListener(CollectionEvent.ITEM_REMOVED, handleItemRemoved);
dataProvider.addEventListener(CollectionEvent.ITEM_UPDATED,
handleItemUpdated);
diff --git
a/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/EasyDataProviderChangeNotifier.as
b/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/EasyDataProviderChangeNotifier.as
index 74a6b26..81df4d7 100644
---
a/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/EasyDataProviderChangeNotifier.as
+++
b/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/beads/EasyDataProviderChangeNotifier.as
@@ -18,12 +18,11 @@
////////////////////////////////////////////////////////////////////////////////
package org.apache.royale.html.beads
{
- import org.apache.royale.collections.ArrayList;
+ import org.apache.royale.collections.IArrayList;
import org.apache.royale.core.ISelectionModel;
import org.apache.royale.core.IStrand;
- import org.apache.royale.events.Event;
import org.apache.royale.core.UIBase;
- import org.apache.royale.events.IEventDispatcher;
+ import org.apache.royale.events.Event;
/**
* The EasyDataProviderChangeNotifier is similar to
DataProviderChangeNotifier
@@ -90,7 +89,7 @@ package org.apache.royale.html.beads
*/
private function setDataProvider():void
{
- dataProvider = selectionModel.dataProvider as ArrayList;
+ dataProvider = selectionModel.dataProvider as
IArrayList;
if(dataProvider)
attachEventListeners();
}
diff --git
a/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/supportClasses/DataProviderNotifierBase.as
b/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/supportClasses/DataProviderNotifierBase.as
index b377d2e..44312df 100644
---
a/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/supportClasses/DataProviderNotifierBase.as
+++
b/frameworks/projects/Basic/src/main/royale/org/apache/royale/html/supportClasses/DataProviderNotifierBase.as
@@ -18,17 +18,15 @@
////////////////////////////////////////////////////////////////////////////////
package org.apache.royale.html.supportClasses
{
- import org.apache.royale.core.IBead;
+ import org.apache.royale.collections.IArrayList;
+ import org.apache.royale.core.Bead;
import org.apache.royale.core.IBeadModel;
import org.apache.royale.core.IDataProviderNotifier;
import org.apache.royale.core.IDocument;
- import org.apache.royale.core.ISelectionModel;
import org.apache.royale.core.IStrand;
import org.apache.royale.core.UIBase;
- import org.apache.royale.events.IEventDispatcher;
import org.apache.royale.events.Event;
- import org.apache.royale.collections.ArrayList;
- import org.apache.royale.core.Bead;
+ import org.apache.royale.events.IEventDispatcher;
/**
* Base class for all data provider notifiers.
@@ -52,7 +50,7 @@ package org.apache.royale.html.supportClasses
{
}
- protected var dataProvider:ArrayList;
+ protected var dataProvider:IArrayList;
/**
* @copy org.apache.royale.core.IBead#strand
@@ -78,13 +76,15 @@ package org.apache.royale.html.supportClasses
}
}
+ /**
+ * The change handler function that will be called when change
event is thrown
+ */
protected function destinationChangedHandler(event:Event):void
{
-
+ // to implement in subclasses
}
protected var document:Object;
-
/**
* @private
*/
@@ -94,7 +94,9 @@ package org.apache.royale.html.supportClasses
}
private var _destinationPropertyName:String;
-
+ /**
+ * The property in the component, usually dataProvider
+ */
public function get destinationPropertyName():String
{
return _destinationPropertyName;
@@ -105,7 +107,9 @@ package org.apache.royale.html.supportClasses
}
private var _changeEventName:String;
-
+ /**
+ * the event name, usually "dataProviderChanged"
+ */
public function get changeEventName():String
{
return _changeEventName;
@@ -116,7 +120,6 @@ package org.apache.royale.html.supportClasses
}
private var _sourceID:String;
-
/**
* The ID of the object holding the ArrayList, usually a model.
*
@@ -135,7 +138,6 @@ package org.apache.royale.html.supportClasses
}
private var _propertyName:String;
-
/**
* The property in the sourceID that is the ArrayList.
*
