From 67666aaccb4b4743a084b214722e1173e827e9d1 Mon Sep 17 00:00:00 2001 From: "ctrlaltca@gmail.com" <> Date: Wed, 1 Jun 2011 22:14:00 +0000 Subject: upported recent documentation changes from branch/3.1 to trunk/ --- .../Web/UI/ActiveControls/TActiveImageButton.php | 2 +- framework/Web/UI/ActiveControls/TActiveTextBox.php | 4 ++-- framework/Web/UI/WebControls/TColorPicker.php | 25 ++++++++++++++++++---- framework/Web/UI/WebControls/TDatePicker.php | 2 +- framework/Web/UI/WebControls/THead.php | 2 +- 5 files changed, 26 insertions(+), 9 deletions(-) (limited to 'framework/Web/UI') diff --git a/framework/Web/UI/ActiveControls/TActiveImageButton.php b/framework/Web/UI/ActiveControls/TActiveImageButton.php index f8cd6e12..4e7b5149 100644 --- a/framework/Web/UI/ActiveControls/TActiveImageButton.php +++ b/framework/Web/UI/ActiveControls/TActiveImageButton.php @@ -13,7 +13,7 @@ /** * TActiveImageButton class. * - * TActiveImageButton is the active control counter part to TLinkButton. + * TActiveImageButton is the active control counter part to TImageButton. * When a TActiveImageButton is clicked, rather than a normal post back request a * callback request is initiated. * diff --git a/framework/Web/UI/ActiveControls/TActiveTextBox.php b/framework/Web/UI/ActiveControls/TActiveTextBox.php index 97efe008..63f5e191 100644 --- a/framework/Web/UI/ActiveControls/TActiveTextBox.php +++ b/framework/Web/UI/ActiveControls/TActiveTextBox.php @@ -4,7 +4,7 @@ * * @author Wei Zhuo * @link http://www.pradosoft.com/ - * @copyright Copyright © 2005-2008 PradoSoft + * @copyright Copyright © 2005-2008 PradoSoft * @license http://www.pradosoft.com/license/ * @version $Id$ * @package System.Web.UI.ActiveControls @@ -21,7 +21,7 @@ Prado::using('System.Web.UI.ActiveControls.TActiveControlAdapter'); * TActiveTextBox allows the {@link setText Text} property of the textbox to * be changed during callback. When {@link setAutoPostBack AutoPostBack} property * is true, changes to the textbox contents will perform a callback request causing - * {@link onTextChanged OnTextChange} to be fired first followed by {@link onCallback OnCallback} + * {@link onTextChanged OnTextChanged} to be fired first followed by {@link onCallback OnCallback} * event. * * @author Wei Zhuo 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 ShowColorPicker 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 Modes: + * # Simple - Grid with 12 simple colors. + * # Basic - Grid with the most common 70 colors. This is the default mode. + * # Full - Full-featured color picker. + * + * The CssClass property can be used to override the CSS class name + * for the color picker panel. The ColorStyle property sets the packages + * styles available. E.g. default. + * + * If the Mode property is set to Full, the color picker panel will + * display an "Ok" and "Cancel" buttons. You can customize the button labels setting the OKButtonText + * and CancelButtonText properties. + * * @author Wei Zhuo * @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 * @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 InputMode property can be set to "TextBox" or "DropDownList" with * default as "TextBox". - * In DropDownList mode, in addition to the popup date picker, three + * In DropDownList mode, in addition to the popup date picker, three * drop down list (day, month and year) are presented to select the date . * * The PositionMode property can be set to "Top" or "Bottom" with default diff --git a/framework/Web/UI/WebControls/THead.php b/framework/Web/UI/WebControls/THead.php index 36b81648..9daa6d3b 100644 --- a/framework/Web/UI/WebControls/THead.php +++ b/framework/Web/UI/WebControls/THead.php @@ -31,7 +31,7 @@ * * * Note, {@link TPage} has a property {@link TPage::getHead Head} that refers to - * the THead control currently on the page. A page can have at most once THead + * the THead control currently on the page. A page can have at most one THead * control. Although not required, it is recommended to place a THead on your page. * Without a THead on the page, stylesheets and javascripts in the current page * theme will not be rendered. -- cgit v1.2.3