diff options
Diffstat (limited to 'framework/Web/UI/WebControls/TTemplateColumn.php')
-rw-r--r-- | framework/Web/UI/WebControls/TTemplateColumn.php | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/framework/Web/UI/WebControls/TTemplateColumn.php b/framework/Web/UI/WebControls/TTemplateColumn.php index fe9674cc..bd3a2acb 100644 --- a/framework/Web/UI/WebControls/TTemplateColumn.php +++ b/framework/Web/UI/WebControls/TTemplateColumn.php @@ -24,8 +24,14 @@ Prado::using('System.Web.UI.WebControls.TDataGridColumn'); * and {@link setFooterTemplate FooterTemplate} to customize specific
* type of cells in the column.
*
- * Note, if {@link setHeaderTemplate HeaderTemplate} is not set, the column
- * header will be displayed with {@link setHeaderText HeaderText}.
+ * Since v3.1.0, TTemplateColumn has introduced two new properties {@link setItemRenderer ItemRenderer}
+ * and {@link setEditItemRenderer EditItemRenderer} which can be used to specify
+ * the layout of the datagrid cells in browsing and editing mode.
+ * A renderer refers to a control class that is to be instantiated as a control.
+ * For more details, see {@link TRepeater} and {@link TDataList}.
+ *
+ * When a renderer and a template are both defined for a type of item, the former
+ * takes precedence.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
@@ -57,6 +63,9 @@ class TTemplateColumn extends TDataGridColumn *
* If not empty, the class will be used to instantiate as a child control in the item cells of the column.
*
+ * If the class implements {@link IDataRenderer}, the <b>Data</b> property
+ * will be set as the row of the data associated with the datagrid item that this cell resides in.
+ *
* @param string the renderer class name in namespace format.
* @since 3.1.0
*/
@@ -79,6 +88,9 @@ class TTemplateColumn extends TDataGridColumn *
* If not empty, the class will be used to instantiate as a child control in the item cell that is in edit mode.
*
+ * If the class implements {@link IDataRenderer}, the <b>Data</b> property
+ * will be set as the row of the data associated with the datagrid item that this cell resides in.
+ *
* @param string the renderer class name in namespace format.
* @since 3.1.0
*/
|