You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ca...@apache.org on 2020/08/13 14:19:44 UTC
[royale-asjs] branch develop updated: jewel-containers: update docs
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 6263a66 jewel-containers: update docs
6263a66 is described below
commit 6263a66af90ca3c428b08072d0df5aaf213236fa
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Thu Aug 13 16:19:18 2020 +0200
jewel-containers: update docs
---
.../royale/org/apache/royale/jewel/Container.as | 4 ++--
.../org/apache/royale/jewel/DataContainer.as | 25 ++++++++++++++++------
2 files changed, 21 insertions(+), 8 deletions(-)
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Container.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Container.as
index 7584535..f6430e5 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Container.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Container.as
@@ -106,8 +106,6 @@ package org.apache.royale.jewel
dispatchEvent(new Event("initBindings"));
dispatchEvent(new Event("initComplete"));
_initialized = true;
-
- //?? why is this here? childrenAdded(); //?? Is this needed since MXMLDataInterpreter will have already called it
}
}
@@ -147,6 +145,8 @@ package org.apache.royale.jewel
}
/**
+ * The array of childs for this group. Is the `DefaultProperty`.
+ *
* @copy org.apache.royale.core.ItemRendererClassFactory#mxmlContent
*
* @langversion 3.0
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/DataContainer.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/DataContainer.as
index c591456..a094845 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/DataContainer.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/DataContainer.as
@@ -36,17 +36,31 @@ package org.apache.royale.jewel
[Event(name="initComplete", type="org.apache.royale.events.Event")]
[DefaultProperty("dataProvider")]
-
+
/**
- * The DataContainer class is a component that displays multiple data items. The DataContainer uses
- * the following bead types:
+ * The Jewel DataContainer class is a component that displays multiple data items.
+ *
+ * This component gets the data through its `dataProvider` property that receives
+ * an `ArrayList` of data objects. To represent each item the component use
+ * an [ItemRenderer](/features/item-renderers) class that can be configured and customized.
+ *
+ * The component generate dynamically as many instances of ItemRenderer as items in the
+ * data provider array and fill each instance with the appropiate data.
+ * By default it uses `StringItemRenderer` as the item renderer.
+ *
+ * By default items are layout vertically using Jewel `VerticalLayout`. This component
+ * has a `Viewport` that clip generated items.
+ *
+ * The DataContainer uses the following bead types:
*
* org.apache.royale.core.IBeadModel: the data model, which includes the dataProvider.
* org.apache.royale.core.IBeadView: the bead that constructs the visual parts of the list.
- * org.apache.royale.core.IBeadController: the bead that handles input and output.
* org.apache.royale.core.IBeadLayout: the bead responsible for the size and position of the itemRenderers.
* org.apache.royale.core.IDataProviderItemRendererMapper: the bead responsible for creating the itemRenders.
- * org.apache.royale.core.IItemRenderer: the class or factory used to display an item in the list.
+ * org.apache.royale.core.IItemRendererClassFactory: the factory for the itemrenders.
+ * org.apache.royale.core.IItemRenderer: the class that describes the each piece of data.
+ * org.apache.royale.core.IItemRendererInitializer: the class that initialize the renderer and provide additional configuration.
+ * org.apache.royale.core.IViewport: the class that defines the area that display content
*
* @langversion 3.0
* @playerversion Flash 10.2
@@ -112,7 +126,6 @@ package org.apache.royale.jewel
IDataProviderModel(model).dataProvider = value;
}
-
/**
* The presentation model for the list.
*