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 2019/12/29 10:52:32 UTC
[royale-asjs] branch develop updated: Jewel IDataGridColumn
comments refactored
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 5136672 Jewel IDataGridColumn comments refactored
5136672 is described below
commit 5136672dd061efb3dbd416ce28fc059866c85616
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Sun Dec 29 11:52:21 2019 +0100
Jewel IDataGridColumn comments refactored
---
.../jewel/supportClasses/datagrid/IDataGridColumn.as | 20 ++++++++++++++------
1 file changed, 14 insertions(+), 6 deletions(-)
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/datagrid/IDataGridColumn.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/datagrid/IDataGridColumn.as
index 3708dd5..f7a06f1 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/datagrid/IDataGridColumn.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/datagrid/IDataGridColumn.as
@@ -21,10 +21,17 @@ package org.apache.royale.jewel.supportClasses.datagrid
import org.apache.royale.core.IFactory;
import org.apache.royale.core.IUIBase;
+ /**
+ * Jewel IDataGridColumn is the interface used by Jewel DataGridColumn in the Jewel DataGrid.
+ *
+ * Define which renderer to use for each cell in the column, and other optional data like
+ * the width, the label (used in header), and the name of the field in the data containing the value to display
+ * in the column (for the simplest ItemRenderer).
+ */
public interface IDataGridColumn
{
/**
- * The itemRenderer class or factory to use to make instances of itemRenderers for
+ * The ItemRenderer class or factory to use to make instances of itemRenderers for
* display of data.
*
* @langversion 3.0
@@ -36,7 +43,8 @@ package org.apache.royale.jewel.supportClasses.datagrid
function set itemRenderer(value:IFactory):void;
/**
- * The width of the column (default is 100 pixels).
+ * The width of the column.
+ * DataGrid defaults to "numColumns/n %", where n is the number of columns
*
* @langversion 3.0
* @playerversion Flash 10.2
@@ -70,8 +78,8 @@ package org.apache.royale.jewel.supportClasses.datagrid
function set dataField(value:String):void;
/**
- * The name of the style class to use for this column. If this is not set
- * it defaults to DataGridColumnList.
+ * The name of the style class to use for this column.
+ * DataGrid uses ".jewel.list.column"
*
* @langversion 3.0
* @playerversion Flash 10.2
@@ -82,8 +90,8 @@ package org.apache.royale.jewel.supportClasses.datagrid
function set className(value:String):void;
/**
- * Returns a new instance of a UIBase component to be used as the actual
- * column in the grid.
+ * Returns a new instance of a UIBase component to be used as the actual
+ * column in the grid.
*
* @langversion 3.0
* @playerversion Flash 10.2