Added TLiteralColumn.

4 files changed, 157 insertions, 0 deletions

diff --git a/.gitattributes b/.gitattributes
index 78a35823..7fd94360 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1524,6 +1524,7 @@ framework/Web/UI/WebControls/TListControl.php -text
 framework/Web/UI/WebControls/TListControlValidator.php -text
 framework/Web/UI/WebControls/TListItem.php -text
 framework/Web/UI/WebControls/TLiteral.php -text
+framework/Web/UI/WebControls/TLiteralColumn.php -text
 framework/Web/UI/WebControls/TMarkdown.php -text
 framework/Web/UI/WebControls/TMultiView.php -text
 framework/Web/UI/WebControls/TPager.php -text
diff --git a/HISTORY b/HISTORY
index cce08b77..c4c89ce4 100644
--- a/HISTORY
+++ b/HISTORY
@@ -3,6 +3,7 @@ Version 3.0.5 October 8, 2006
 CHG: Ticket#358 - TFileUpload::saveAs() now returns false instead of exception when error (Qiang)
 ENH: Ticket#361 - Introduced include template tag that supports including external templates (Qiang)
 ENH: Ticket#366 - white spaces are now allowed around attribute names in template (Qiang)
+NEW: TLiteralColumn (Qiang)
 
 Version 3.0.4 September 4, 2006
 ===============================
diff --git a/demos/quickstart/protected/pages/Controls/DataGrid.page b/demos/quickstart/protected/pages/Controls/DataGrid.page
index 2a51a3de..4697d0e5 100644
--- a/demos/quickstart/protected/pages/Controls/DataGrid.page
+++ b/demos/quickstart/protected/pages/Controls/DataGrid.page
@@ -21,6 +21,7 @@ PRADO provides five types of columns:
 </p>

 <ul>

   <li><tt>TBoundColumn</tt> associates cells with a specific field of data and displays the cells according to their modes.</li>

+  <li><tt>TLiteralColumn</tt> associates cells with a specific field of data and displays the cells with static texts.</li>

   <li><tt>TCheckBoxColumn</tt> associates cells with a specific field of data and displays in each cell a checkbox whose check state is determined by the data field value.</li>

   <li><tt>TDropDownListColumn</tt> associates cells with a specific field of data and displays the cells according to their modes. If in edit mode, a cell will be displayed with a <tt>TDropDownList</tt>.</li>

   <li><tt>THyperLinkColumn</tt> displays in the cells a hyperlink whose caption and URL can be either statically specified or bound to some fields of data.</li>

diff --git a/framework/Web/UI/WebControls/TLiteralColumn.php b/framework/Web/UI/WebControls/TLiteralColumn.php
new file mode 100644
index 00000000..e78c4e6d
--- /dev/null
+++ b/framework/Web/UI/WebControls/TLiteralColumn.php
@@ -0,0 +1,154 @@
+<?php

+/**

+ * TLiteralColumn class file

+ *

+ * @author Qiang Xue <qiang.xue@gmail.com>

+ * @link http://www.pradosoft.com/

+ * @copyright Copyright &copy; 2005 PradoSoft

+ * @license http://www.pradosoft.com/license/

+ * @version $Id: TLiteralColumn.php 1397 2006-09-07 07:55:53Z wei $

+ * @package System.Web.UI.WebControls

+ */

+

+/**

+ * TDataGridColumn class file

+ */

+Prado::using('System.Web.UI.WebControls.TDataGridColumn');

+

+/**

+ * TLiteralColumn class

+ *

+ * TLiteralColumn represents a static text column that is bound to a field in a data source.

+ * The cells in the column will be displayed with static texts using the data indexed by

+ * {@link setDataField DataField}. You can customize the display by

+ * setting {@link setDataFormatString DataFormatString}.

+ *

+ * If {@link setDataField DataField} is not specified, the cells will be filled

+ * with {@link setText Text}.

+ *

+ * If {@link setEncode Encode} is true, the static texts will be HTML-encoded.

+ *

+ * @author Qiang Xue <qiang.xue@gmail.com>

+ * @version $Id: TLiteralColumn.php 1397 2006-09-07 07:55:53Z wei $

+ * @package System.Web.UI.WebControls

+ * @since 3.0.5

+ */

+class TLiteralColumn extends TDataGridColumn

+{

+	/**

+	 * @return string the field name from the data source to bind to the column

+	 */

+	public function getDataField()

+	{

+		return $this->getViewState('DataField','');

+	}

+

+	/**

+	 * @param string the field name from the data source to bind to the column

+	 */

+	public function setDataField($value)

+	{

+		$this->setViewState('DataField',$value,'');

+	}

+

+	/**

+	 * @return string the formatting string used to control how the bound data will be displayed.

+	 */

+	public function getDataFormatString()

+	{

+		return $this->getViewState('DataFormatString','');

+	}

+

+	/**

+	 * @param string the formatting string used to control how the bound data will be displayed.

+	 */

+	public function setDataFormatString($value)

+	{

+		$this->setViewState('DataFormatString',$value,'');

+	}

+

+	/**

+	 * @return string static text to be displayed in the column. Defaults to empty.

+	 */

+	public function getText()

+	{

+		return $this->getViewState('Text','');

+	}

+

+	/**

+	 * @param string static text to be displayed in the column.

+	 */

+	public function setText($value)

+	{

+		$this->setViewState('Text',$value,'');

+	}

+

+	/**

+	 * @return boolean whether the rendered text should be HTML-encoded. Defaults to false.

+	 */

+	public function getEncode()

+	{

+		return $this->getViewState('Encode',false);

+	}

+

+	/**

+	 * @param boolean  whether the rendered text should be HTML-encoded.

+	 */

+	public function setEncode($value)

+	{

+		$this->setViewState('Encode',TPropertyValue::ensureBoolean($value),false);

+	}

+

+	/**

+	 * Initializes the specified cell to its initial values.

+	 * This method overrides the parent implementation.

+	 * @param TTableCell the cell to be initialized.

+	 * @param integer the index to the Columns property that the cell resides in.

+	 * @param string the type of cell (Header,Footer,Item,AlternatingItem,EditItem,SelectedItem)

+	 */

+	public function initializeCell($cell,$columnIndex,$itemType)

+	{

+		parent::initializeCell($cell,$columnIndex,$itemType);

+		if($itemType===TListItemType::Item || $itemType===TListItemType::AlternatingItem || $itemType===TListItemType::EditItem || $itemType===TListItemType::SelectedItem)

+		{

+			if($this->getDataField()!=='')

+				$cell->attachEventHandler('OnDataBinding',array($this,'dataBindColumn'));

+			else

+			{

+				if(($dataField=$this->getDataField())!=='')

+					$control->attachEventHandler('OnDataBinding',array($this,'dataBindColumn'));

+				else

+				{

+					$text=$this->getText();

+					if($this->getEncode())

+						$text=THttpUtility::htmlEncode($text);

+					$cell->setText($text);

+				}

+			}

+		}

+	}

+

+	/**

+	 * Databinds a cell in the column.

+	 * This method is invoked when datagrid performs databinding.

+	 * It populates the content of the cell with the relevant data from data source.

+	 */

+	public function dataBindColumn($sender,$param)

+	{

+		$item=$sender->getNamingContainer();

+		$data=$item->getDataItem();

+		$formatString=$this->getDataFormatString();

+		if(($field=$this->getDataField())!=='')

+			$value=$this->formatDataValue($formatString,$this->getDataFieldValue($data,$field));

+		else

+			$value=$this->formatDataValue($formatString,$data);

+		if($sender instanceof TTableCell)

+		{

+			if($this->getEncode())

+				$value=THttpUtility::htmlEncode($value);

+			$sender->setText($value);

+		}

+	}

+}

+

+?>
\ No newline at end of file