diff options
| author | xue <> | 2007-02-05 21:55:51 +0000 |
|---|---|---|
| committer | xue <> | 2007-02-05 21:55:51 +0000 |
| commit | 81b323cf3d27949a5c78d44bd016044be3197b6c (patch) | |
| tree | 73b3cb8f214b96237812e33ed4f1b0637172ae53 /framework/Web/UI/WebControls/TDataGridItemRenderer.php | |
| parent | 0aaa8b5ef02479653c0a532d9249b423ef34c7ca (diff) | |
Added renderer feature to TDataGrid.
Diffstat (limited to 'framework/Web/UI/WebControls/TDataGridItemRenderer.php')
| -rw-r--r-- | framework/Web/UI/WebControls/TDataGridItemRenderer.php | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/framework/Web/UI/WebControls/TDataGridItemRenderer.php b/framework/Web/UI/WebControls/TDataGridItemRenderer.php new file mode 100644 index 00000000..24b080c1 --- /dev/null +++ b/framework/Web/UI/WebControls/TDataGridItemRenderer.php @@ -0,0 +1,105 @@ +<?php
+/**
+ * TDataGridItemRenderer class file
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright © 2007 PradoSoft
+ * @license http://www.pradosoft.com/license/
+ * @version $Id$
+ * @package System.Web.UI.WebControls
+ */
+
+Prado::using('System.Web.UI.WebControls.TDataGrid');
+
+/**
+ * TDataGridItemRenderer class
+ *
+ * TDataGridItemRenderer can be used as a convenient base class to
+ * define an item renderer class for {@link TDataGrid}.
+ *
+ * Because TDataGridItemRenderer extends from {@link TTemplateControl}, derived child classes
+ * can have templates to define their presentational layout.
+ *
+ * TDataGridItemRenderer implements {@link IItemDataRenderer} interface,
+ * which enables the following properties that are related with data-bound controls:
+ * - {@link getItemIndex ItemIndex}: zero-based index of the datagrid item containing this control.
+ * - {@link getItemType ItemType}: type of the datagrid item containing this control, such as TListItemType::AlternatingItem
+ * - {@link getData Data}: the data row associated with the datagrid item that this control resides in
+
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id$
+ * @package System.Web.UI.WebControls
+ * @since 3.1.0
+ */
+class TDataGridItemRenderer extends TTemplateControl implements IItemDataRenderer
+{
+ /**
+ * index of the data item in the Items collection of datalist
+ */
+ private $_itemIndex;
+ /**
+ * type of the TDataGridItem
+ * @var TListItemType
+ */
+ private $_itemType;
+ /**
+ * data associated with this item
+ * @var mixed
+ */
+ private $_data;
+
+ /**
+ * @return TListItemType item type
+ */
+ public function getItemType()
+ {
+ return $this->_itemType;
+ }
+
+ /**
+ * @param TListItemType item type.
+ */
+ public function setItemType($value)
+ {
+ $this->_itemType=TPropertyValue::ensureEnum($value,'TListItemType');
+ }
+
+ /**
+ * Returns a value indicating the zero-based index of the item in the corresponding data control's item collection.
+ * If the item is not in the collection (e.g. it is a header item), it returns -1.
+ * @return integer zero-based index of the item.
+ */
+ public function getItemIndex()
+ {
+ return $this->_itemIndex;
+ }
+
+ /**
+ * Sets the zero-based index for the item.
+ * If the item is not in the item collection (e.g. it is a header item), -1 should be used.
+ * @param integer zero-based index of the item.
+ */
+ public function setItemIndex($value)
+ {
+ $this->_itemIndex=TPropertyValue::ensureInteger($value);
+ }
+
+ /**
+ * @return mixed the data row associated with the datagrid item
+ */
+ public function getData()
+ {
+ return $this->_data;
+ }
+
+ /**
+ * @param mixed the data row to be associated with the datagrid item
+ */
+ public function setData($value)
+ {
+ $this->_data=$value;
+ }
+}
+
+?>
\ No newline at end of file |