You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by an...@apache.org on 2022/01/05 18:48:09 UTC

[royale-docs] branch master updated: Update item-renderers.md

This is an automated email from the ASF dual-hosted git repository.

andreww pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git


The following commit(s) were added to refs/heads/master by this push:
     new beea558  Update item-renderers.md
beea558 is described below

commit beea5589da75f650556833a083e49defa2c8dca0
Author: Andrew Wetmore <an...@cottage14.com>
AuthorDate: Wed Jan 5 14:43:43 2022 -0400

    Update item-renderers.md
    
    Made minor corrections to the text to improve readabilty.
---
 features/item-renderers.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/features/item-renderers.md b/features/item-renderers.md
index aa1b7af..b6dbb29 100644
--- a/features/item-renderers.md
+++ b/features/item-renderers.md
@@ -20,15 +20,15 @@ description: Visual representation of data items in lists and other collection c
 permalink: /features/item-renderers
 ---
 
-# ItemRenderers
+# Item Renderers
 
 Visual representation of data items in lists and other collection components
 
-Collections of data are composed by objects or items. Several components in Royale can show collections of data to the user like _List_, _DataGrid_, _TabBar_ or _ButtonBar_. Those components need to describe each item and adapt the visaluzation to the data inside each object. Apache Royale uses Item Renderers components along with the before mentioned collection components to realize the visualization of each piece of data stored in each collection object.
+Collections of data contain objects or items. Several components in Royale, like _List_, _DataGrid_, _TabBar_ or _ButtonBar_, can show collections of data to the user in different ways. Those components need to describe each item and adapt the visaluzation to the data inside each object. Apache Royale uses **Item Renderer** components to render, or visualize, each piece of data in each collection object in a collection component.
 
 ## Inline
 
-Although Item Renders use to be declared in a separate file (and this is the recommended way), you can also declare an item renderer inline for convenience:
+The standard method is to declare an item renderer in a separate file which you then import into the component where you will be displaying the rendered data, but you can also declare an item renderer inline for convenience:
 
 ```mxml
 <j:DataContainer width="100%" labelField="name" dataProvider="{dataList}">
@@ -69,6 +69,6 @@ Although Item Renders use to be declared in a separate file (and this is the rec
 </j:DataContainer>
 ```
 
-## Examples
+## Example
 
 - [Using an item renderer with a list](https://royale.apache.org/using-an-item-renderer-with-a-list){:target='_blank'}

Re: [royale-docs] branch master updated: Update item-renderers.md

Posted by Harbs <ha...@gmail.com>.
Good point.

> On Jan 5, 2022, at 9:21 PM, Yishay Weiss <yi...@hotmail.com> wrote:
> 
> A general note, that maybe applies here as well, is that Flex and AS3 documentation is still out there. I believe Harman has taken upon itself to maintain (or at least archive) it for now. “Flex in Action” is still available for purchase. I know Royale is not Flex, but it may make sense to at least point out the similarities and reference these docs to save us some effort. Maybe not, just a thought.
> 
> From: Harbs<mailto:harbs.lists@gmail.com <ma...@gmail.com>>
> Sent: Wednesday, January 5, 2022 9:11 PM
> To: Apache Royale Development<mailto:dev@royale.apache.org <ma...@royale.apache.org>>
> Subject: Re: [royale-docs] branch master updated: Update item-renderers.md
> 
> Trying to looking at the page from the eyes of a beginner, I noticed that we don’t explain how dataProviders, factories and item renderers all work together.
> 
> I’d like to write a page that explains this, but I’m not sure how best to organize it.
> 
> I was thinking of renaming the page to be “Data and Renderers” and include the whole shpiel on that page. Is there a better way to do it?
> 
> Thanks,
> Harbs
> 
>> On Jan 5, 2022, at 8:48 PM, andreww@apache.org wrote:
>> 
>> This is an automated email from the ASF dual-hosted git repository.
>> 
>> andreww pushed a commit to branch master
>> in repository https://gitbox.apache.org/repos/asf/royale-docs.git
>> 
>> 
>> The following commit(s) were added to refs/heads/master by this push:
>>    new beea558  Update item-renderers.md
>> beea558 is described below
>> 
>> commit beea5589da75f650556833a083e49defa2c8dca0
>> Author: Andrew Wetmore <an...@cottage14.com>
>> AuthorDate: Wed Jan 5 14:43:43 2022 -0400
>> 
>>   Update item-renderers.md
>> 
>>   Made minor corrections to the text to improve readabilty.
>> ---
>> features/item-renderers.md | 8 ++++----
>> 1 file changed, 4 insertions(+), 4 deletions(-)
>> 
>> diff --git a/features/item-renderers.md b/features/item-renderers.md
>> index aa1b7af..b6dbb29 100644
>> --- a/features/item-renderers.md
>> +++ b/features/item-renderers.md
>> @@ -20,15 +20,15 @@ description: Visual representation of data items in lists and other collection c
>> permalink: /features/item-renderers
>> ---
>> 
>> -# ItemRenderers
>> +# Item Renderers
>> 
>> Visual representation of data items in lists and other collection components
>> 
>> -Collections of data are composed by objects or items. Several components in Royale can show collections of data to the user like _List_, _DataGrid_, _TabBar_ or _ButtonBar_. Those components need to describe each item and adapt the visaluzation to the data inside each object. Apache Royale uses Item Renderers components along with the before mentioned collection components to realize the visualization of each piece of data stored in each collection object.
>> +Collections of data contain objects or items. Several components in Royale, like _List_, _DataGrid_, _TabBar_ or _ButtonBar_, can show collections of data to the user in different ways. Those components need to describe each item and adapt the visaluzation to the data inside each object. Apache Royale uses **Item Renderer** components to render, or visualize, each piece of data in each collection object in a collection component.
>> 
>> ## Inline
>> 
>> -Although Item Renders use to be declared in a separate file (and this is the recommended way), you can also declare an item renderer inline for convenience:
>> +The standard method is to declare an item renderer in a separate file which you then import into the component where you will be displaying the rendered data, but you can also declare an item renderer inline for convenience:
>> 
>> ```mxml
>> <j:DataContainer width="100%" labelField="name" dataProvider="{dataList}">
>> @@ -69,6 +69,6 @@ Although Item Renders use to be declared in a separate file (and this is the rec
>> </j:DataContainer>
>> ```
>> 
>> -## Examples
>> +## Example
>> 
>> - [Using an item renderer with a list](https://royale.apache.org/using-an-item-renderer-with-a-list <https://royale.apache.org/using-an-item-renderer-with-a-list>){:target='_blank<https://royale.apache.org/using-an-item-renderer-with-a-list <https://royale.apache.org/using-an-item-renderer-with-a-list>)%7b:target='_blank>'}


RE: [royale-docs] branch master updated: Update item-renderers.md

Posted by Yishay Weiss <yi...@hotmail.com>.
A general note, that maybe applies here as well, is that Flex and AS3 documentation is still out there. I believe Harman has taken upon itself to maintain (or at least archive) it for now. “Flex in Action” is still available for purchase. I know Royale is not Flex, but it may make sense to at least point out the similarities and reference these docs to save us some effort. Maybe not, just a thought.

From: Harbs<ma...@gmail.com>
Sent: Wednesday, January 5, 2022 9:11 PM
To: Apache Royale Development<ma...@royale.apache.org>
Subject: Re: [royale-docs] branch master updated: Update item-renderers.md

Trying to looking at the page from the eyes of a beginner, I noticed that we don’t explain how dataProviders, factories and item renderers all work together.

I’d like to write a page that explains this, but I’m not sure how best to organize it.

I was thinking of renaming the page to be “Data and Renderers” and include the whole shpiel on that page. Is there a better way to do it?

Thanks,
Harbs

> On Jan 5, 2022, at 8:48 PM, andreww@apache.org wrote:
>
> This is an automated email from the ASF dual-hosted git repository.
>
> andreww pushed a commit to branch master
> in repository https://gitbox.apache.org/repos/asf/royale-docs.git
>
>
> The following commit(s) were added to refs/heads/master by this push:
>     new beea558  Update item-renderers.md
> beea558 is described below
>
> commit beea5589da75f650556833a083e49defa2c8dca0
> Author: Andrew Wetmore <an...@cottage14.com>
> AuthorDate: Wed Jan 5 14:43:43 2022 -0400
>
>    Update item-renderers.md
>
>    Made minor corrections to the text to improve readabilty.
> ---
> features/item-renderers.md | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/features/item-renderers.md b/features/item-renderers.md
> index aa1b7af..b6dbb29 100644
> --- a/features/item-renderers.md
> +++ b/features/item-renderers.md
> @@ -20,15 +20,15 @@ description: Visual representation of data items in lists and other collection c
> permalink: /features/item-renderers
> ---
>
> -# ItemRenderers
> +# Item Renderers
>
> Visual representation of data items in lists and other collection components
>
> -Collections of data are composed by objects or items. Several components in Royale can show collections of data to the user like _List_, _DataGrid_, _TabBar_ or _ButtonBar_. Those components need to describe each item and adapt the visaluzation to the data inside each object. Apache Royale uses Item Renderers components along with the before mentioned collection components to realize the visualization of each piece of data stored in each collection object.
> +Collections of data contain objects or items. Several components in Royale, like _List_, _DataGrid_, _TabBar_ or _ButtonBar_, can show collections of data to the user in different ways. Those components need to describe each item and adapt the visaluzation to the data inside each object. Apache Royale uses **Item Renderer** components to render, or visualize, each piece of data in each collection object in a collection component.
>
> ## Inline
>
> -Although Item Renders use to be declared in a separate file (and this is the recommended way), you can also declare an item renderer inline for convenience:
> +The standard method is to declare an item renderer in a separate file which you then import into the component where you will be displaying the rendered data, but you can also declare an item renderer inline for convenience:
>
> ```mxml
> <j:DataContainer width="100%" labelField="name" dataProvider="{dataList}">
> @@ -69,6 +69,6 @@ Although Item Renders use to be declared in a separate file (and this is the rec
> </j:DataContainer>
> ```
>
> -## Examples
> +## Example
>
> - [Using an item renderer with a list](https://royale.apache.org/using-an-item-renderer-with-a-list){:target='_blank<https://royale.apache.org/using-an-item-renderer-with-a-list)%7b:target='_blank>'}


Re: [royale-docs] branch master updated: Update item-renderers.md

Posted by Harbs <ha...@gmail.com>.
Trying to looking at the page from the eyes of a beginner, I noticed that we don’t explain how dataProviders, factories and item renderers all work together.

I’d like to write a page that explains this, but I’m not sure how best to organize it.

I was thinking of renaming the page to be “Data and Renderers” and include the whole shpiel on that page. Is there a better way to do it?

Thanks,
Harbs

> On Jan 5, 2022, at 8:48 PM, andreww@apache.org wrote:
> 
> This is an automated email from the ASF dual-hosted git repository.
> 
> andreww pushed a commit to branch master
> in repository https://gitbox.apache.org/repos/asf/royale-docs.git
> 
> 
> The following commit(s) were added to refs/heads/master by this push:
>     new beea558  Update item-renderers.md
> beea558 is described below
> 
> commit beea5589da75f650556833a083e49defa2c8dca0
> Author: Andrew Wetmore <an...@cottage14.com>
> AuthorDate: Wed Jan 5 14:43:43 2022 -0400
> 
>    Update item-renderers.md
> 
>    Made minor corrections to the text to improve readabilty.
> ---
> features/item-renderers.md | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/features/item-renderers.md b/features/item-renderers.md
> index aa1b7af..b6dbb29 100644
> --- a/features/item-renderers.md
> +++ b/features/item-renderers.md
> @@ -20,15 +20,15 @@ description: Visual representation of data items in lists and other collection c
> permalink: /features/item-renderers
> ---
> 
> -# ItemRenderers
> +# Item Renderers
> 
> Visual representation of data items in lists and other collection components
> 
> -Collections of data are composed by objects or items. Several components in Royale can show collections of data to the user like _List_, _DataGrid_, _TabBar_ or _ButtonBar_. Those components need to describe each item and adapt the visaluzation to the data inside each object. Apache Royale uses Item Renderers components along with the before mentioned collection components to realize the visualization of each piece of data stored in each collection object.
> +Collections of data contain objects or items. Several components in Royale, like _List_, _DataGrid_, _TabBar_ or _ButtonBar_, can show collections of data to the user in different ways. Those components need to describe each item and adapt the visaluzation to the data inside each object. Apache Royale uses **Item Renderer** components to render, or visualize, each piece of data in each collection object in a collection component.
> 
> ## Inline
> 
> -Although Item Renders use to be declared in a separate file (and this is the recommended way), you can also declare an item renderer inline for convenience:
> +The standard method is to declare an item renderer in a separate file which you then import into the component where you will be displaying the rendered data, but you can also declare an item renderer inline for convenience:
> 
> ```mxml
> <j:DataContainer width="100%" labelField="name" dataProvider="{dataList}">
> @@ -69,6 +69,6 @@ Although Item Renders use to be declared in a separate file (and this is the rec
> </j:DataContainer>
> ```
> 
> -## Examples
> +## Example
> 
> - [Using an item renderer with a list](https://royale.apache.org/using-an-item-renderer-with-a-list){:target='_blank'}