From d1384deb9b3ac872defd08fd01fbf8cf11442b45 Mon Sep 17 00:00:00 2001
From: xue <>
Date: Wed, 4 Jan 2006 04:59:01 +0000
Subject: Added documentation.

---
 framework/Web/UI/WebControls/TRadioButtonList.php | 38 +++++++++++++++++++++++
 1 file changed, 38 insertions(+)

(limited to 'framework/Web/UI/WebControls/TRadioButtonList.php')

diff --git a/framework/Web/UI/WebControls/TRadioButtonList.php b/framework/Web/UI/WebControls/TRadioButtonList.php
index e434e709..2f12369b 100644
--- a/framework/Web/UI/WebControls/TRadioButtonList.php
+++ b/framework/Web/UI/WebControls/TRadioButtonList.php
@@ -1,17 +1,55 @@
 <?php
+/**
+ * TRadioButtonList 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 $Revision: $  $Date: $
+ * @package System.Web.UI.WebControls
+ */
 
+/**
+ * TRadioButtonList class
+ *
+ * TRadioButtonList displays a list of radiobuttons on a Web page.
+ *
+ * TRadioButtonList inherits all properties and events of {@link TCheckBoxList}.
+ * Each TRadioButtonList displays one group of radiobuttons, i.e., at most
+ * one radiobutton can be selected at a time.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Revision: $  $Date: $
+ * @package System.Web.UI.WebControls
+ * @since 3.0
+ */
 class TRadioButtonList extends TCheckBoxList
 {
+	/**
+	 * @return boolean whether this control supports multiple selection. Always false for radiobutton list.
+	 */
 	protected function getIsMultiSelect()
 	{
 		return false;
 	}
 
+	/**
+	 * Creates a control used for repetition (used as a template).
+	 * @return TControl the control to be repeated
+	 */
 	protected function createRepeatedControl()
 	{
 		return new TRadioButton;
 	}
 
+	/**
+	 * Loads user input data.
+	 * This method is primarly used by framework developers.
+	 * @param string the key that can be used to retrieve data from the input data collection
+	 * @param array the input data collection
+	 * @return boolean whether the data of the control has been changed
+	 */
 	public function loadPostData($key,$values)
 	{
 		$value=isset($values[$key])?$values[$key]:'';
-- 
cgit v1.2.3