From ad30a2e5e2bbe11908a78e7731ed5d2d8c55c9b9 Mon Sep 17 00:00:00 2001
From: "ctrlaltca@gmail.com" <>
Date: Wed, 1 Jun 2011 19:49:56 +0000
Subject: added documentation for TColorPicker class

---
 framework/Web/UI/WebControls/TColorPicker.php | 25 +++++++++++++++++++++----
 framework/Web/UI/WebControls/TDatePicker.php  |  2 +-
 2 files changed, 22 insertions(+), 5 deletions(-)

(limited to 'framework/Web/UI/WebControls')

diff --git a/framework/Web/UI/WebControls/TColorPicker.php b/framework/Web/UI/WebControls/TColorPicker.php
index 0fc7eef4..1066bf76 100644
--- a/framework/Web/UI/WebControls/TColorPicker.php
+++ b/framework/Web/UI/WebControls/TColorPicker.php
@@ -13,8 +13,25 @@
 /**
  * TColorPicker class.
  *
- * Be aware, this control is EXPERIMENTAL and is not stablized yet.
+ * TColorPicker displays a text box for color input purpose.
+ * Next to the textbox there's a button filled with the current chosen color.
+ * Users can write a color name directly in the text box as an hex triplet (also known as HTML notation, eg: #FF00FF).
+ * Alternatively, if the <b>ShowColorPicker</b> property is enabled (it is by default), users can click the button
+ * to have a color picker UI appear. A color chan be chosen directly by clicking on the color picker.
  *
+ * TColorPicker has three different color picker UI <b>Mode</b>s:
+ *  # <b>Simple</b> - Grid with 12 simple colors.
+ *  # <b>Basic</b> - Grid with the most common 70 colors. This is the default mode.
+ *  # <b>Full</b> - Full-featured color picker.
+ * 
+ * The <b>CssClass</b> property can be used to override the CSS class name
+ * for the color picker panel. The <b>ColorStyle</b> property sets the packages
+ * styles available. E.g. <b>default</b>.
+ * 
+ * If the <b>Mode</b> property is set to <b>Full</b>, the color picker panel will
+ * display an "Ok" and "Cancel" buttons. You can customize the button labels setting the <b>OKButtonText</b>
+ * and <b>CancelButtonText</b> properties.
+ * 
  * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
  * @version $Id$
  * @package System.Web.UI.WebControls
@@ -226,9 +243,9 @@ class TColorPicker extends TTextBox
  * that a {@link TColorPicker} control can take.
  *
  * The following enumerable values are defined:
- * - Simple
- * - Basic
- * - Full
+ * # Simple - Grid with 12 simple colors.
+ * # Basic - Grid with the most common 70 colors. This is the default mode.
+ * # Full - Full-featured color picker.
  *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @version $Id$
diff --git a/framework/Web/UI/WebControls/TDatePicker.php b/framework/Web/UI/WebControls/TDatePicker.php
index 1bac5a1c..5d5a17e6 100644
--- a/framework/Web/UI/WebControls/TDatePicker.php
+++ b/framework/Web/UI/WebControls/TDatePicker.php
@@ -56,7 +56,7 @@ Prado::using('System.Web.UI.WebControls.TTextBox');
  *
  * The <b>InputMode</b> property can be set to "TextBox" or "DropDownList" with
  * default as "TextBox".
- * In <tt>DropDownList</tt> mode, in addition to the popup date picker, three
+ * In <b>DropDownList</b> mode, in addition to the popup date picker, three
  * drop down list (day, month and year) are presented to select the date .
  *
  * The <b>PositionMode</b> property can be set to "Top" or "Bottom" with default
-- 
cgit v1.2.3