Added TKeyboard.

2 files changed, 263 insertions, 0 deletions

diff --git a/framework/Web/UI/WebControls/TKeyboard.php b/framework/Web/UI/WebControls/TKeyboard.php
new file mode 100644
index 00000000..4ff15613
--- /dev/null
+++ b/framework/Web/UI/WebControls/TKeyboard.php
@@ -0,0 +1,183 @@
+<?php

+/**

+ * TKeyboard class file.

+ *

+ * @author Sergey Morkovkin <sergeymorkovkin@mail.ru> and Qiang Xue <qiang.xue@gmail.com>

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

+ * @copyright Copyright &copy; 2005-2007 PradoSoft

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

+ * @version $Id: $

+ * @package System.Web.UI.WebControls

+ * @since 3.1.1

+ */

+

+/**

+ * Class TKeyboard.

+ *

+ * TKeyboard displays a virtual keyboard that users can click on to enter input in

+ * an associated text box. It helps to reduce the keyboard recording hacking.

+ *

+ * To use TKeyboard, write a template like following:

+ * <code>

+ * <com:TTextBox ID="PasswordInput" />

+ * <com:TKeyboard ForControl="PasswordInput" />

+ * </code>

+ *

+ * A TKeyboard control is associated with a {@link TTextBox} control by specifying {@link setForControl ForControl}

+ * to be the ID of that control. When the textbox is in focus, a virtual keyboard will pop up; and when

+ * the text box is losing focus, the keyboard will hide automatically. Set {@link setAutoHide AutoHide} to

+ * false to keep the keyboard showing all the time.

+ *

+ * The appearance of the keyboard can also be changed by specifying a customized CSS file via

+ * {@link setCssUrl CssUrl}. By default, the CSS class name for the keyboard is 'Keyboard'. This may

+ * also be changed by specifying {@link setKeyboardCssClass KeyboardCssClass}.

+ *

+ * @author Sergey Morkovkin <sergeymorkovkin@mail.ru> and Qiang Xue <qiang.xue@gmail.com>

+ * @version $Id: $

+ * @since 3.1.1

+ */

+class TKeyboard extends TWebControl

+{

+	/**

+	 * @return string the ID path of the {@link TTextBox} control

+	 */

+	public function getForControl()

+	{

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

+	}

+

+	/**

+	 * Sets the ID path of the {@link TTextBox} control.

+	 * The ID path is the dot-connected IDs of the controls reaching from

+	 * the keyboard's naming container to the target control.

+	 * @param string the ID path

+	 */

+	public function setForControl($value)

+	{

+		$this->setViewState('ForControl', TPropertyValue::ensureString($value));

+	}

+

+	/**

+	 * @return boolean whether the keyboard should be hidden when the textbox is not in focus. Defaults to true.

+	 */

+	public function getAutoHide()

+	{

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

+	}

+

+	/**

+	 * @param boolean whether the keyboard should be hidden when the textbox is not in focus.

+	 */

+	public function setAutoHide($value)

+	{

+		$this->setViewState('AutoHide', TPropertyValue::ensureBoolean($value), true);

+	}

+

+	/**

+	 * @return string the CSS class name for the keyboard <div> element. Defaults to 'Keyboard'.

+	 */

+	public function getKeyboardCssClass()

+	{

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

+	}

+

+	/**

+	 * Sets a value indicating the CSS class name for the keyboard <div> element.

+	 * Note, if you change this property, make sure you also supply a customized CSS file

+	 * by specifying {@link setCssUrl CssUrl} which uses the new CSS class name for styling.

+	 * @param string the CSS class name for the keyboard <div> element.

+	 */

+	public function setKeyboardCssClass($value)

+	{

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

+	}

+

+	/**

+	 * @return string the URL for the CSS file to customize the appearance of the keyboard.

+	 */

+	public function getCssUrl()

+	{

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

+	}

+

+	/**

+	 * @param string the URL for the CSS file to customize the appearance of the keyboard.

+	 */

+	public function setCssUrl($value)

+	{

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

+	}

+

+	/**

+	 * Registers CSS and JS.

+	 * This method is invoked right before the control rendering, if the control is visible.

+	 * @param mixed event parameter

+	 */

+	public function onPreRender($param)

+	{

+		parent::onPreRender($param);

+		if($this->getPage()->getClientSupportsJavaScript())

+		{

+			$this->registerStyleSheet();

+			$this->registerClientScript();

+		}

+	}

+

+	/**

+	 * Adds attribute name-value pairs to renderer.

+	 * This method overrides the parent implementation with additional TKeyboard specific attributes.

+	 * @param THtmlWriter the writer used for the rendering purpose

+	 */

+	protected function addAttributesToRender($writer)

+	{

+		parent::addAttributesToRender($writer);

+		if($this->getPage()->getClientSupportsJavaScript())

+			$writer->addAttribute('id',$this->getClientID());

+	}

+

+	/**

+	 * Registers the CSS relevant to the TKeyboard.

+	 * It will register the CSS file specified by {@link getCssUrl CssUrl}.

+	 * If that is not set, it will use the default CSS.

+	 */

+	protected function registerStyleSheet()

+	{

+		if(($url=$this->getCssUrl())==='')

+			$url=$this->publishAsset('keyboard.css',__CLASS__);

+		$this->getPage()->getClientScript()->registerStyleSheetFile($url,$url);

+	}

+

+	/**

+	 * Registers the relevant JavaScript.

+	 */

+	protected function registerClientScript()

+	{

+		$options=TJavaScript::encode($this->getClientOptions());

+		$className=$this->getClientClassName();

+		$cs=$this->getPage()->getClientScript();

+		$cs->registerPradoScript('prado');

+		$cs->registerEndScript('prado:'.$this->getClientID(), "new $className($options);");

+	}

+

+	protected function getClientClassName()

+	{

+		return 'Prado.WebUI.TKeyboard';

+	}

+

+	protected function getClientOptions()

+	{

+		if(($forControl=$this->getForControl())==='')

+			throw new TConfigurationException('keyboard_forcontrol_required');

+	    if(($target=$this->findControl($forControl))===null)

+	        throw new TConfigurationException('keyboard_forcontrol_invalid',$forControl);

+

+	    $options['ID'] = $this->getClientID();

+	    $options['ForControl'] = $target->getClientID();

+	    $options['AutoHide'] = $this->getAutoHide();

+	    $options['CssClass'] = $this->getKeyboardCssClass();

+

+	    return $options;

+	}

+}

+

+?>
\ No newline at end of file
diff --git a/framework/Web/UI/WebControls/keyboard.css b/framework/Web/UI/WebControls/keyboard.css
new file mode 100644
index 00000000..ad88d76b
--- /dev/null
+++ b/framework/Web/UI/WebControls/keyboard.css
@@ -0,0 +1,80 @@
+div.Keyboard
+{
+    -moz-background-clip: -moz-initial;
+    -moz-background-origin: -moz-initial;
+    -moz-background-inline-policy: -moz-initial;
+    -moz-user-select: none;
+
+    display: block;
+    position: absolute;
+    border: 1px solid #698977;
+    background-color: #DDDDDD;
+    z-index: 1000 !important;
+    visibility: hidden;
+    padding: 4px 4px 4px 4px;
+    text-align: center;
+}
+
+div.Keyboard div.Line
+{
+    width: 267px;
+    height: 18px;
+}
+
+div.Keyboard div.Key
+{
+    width: 17px;
+    height: 17px;
+    margin: 1px 0px 0px 1px;
+    overflow: hidden;
+    float: left;
+    display: inline;
+}
+
+div.Keyboard div.Key div.Key1,
+div.Keyboard div.Key div.Key2
+{
+    overflow: hidden;
+    border: 1px solid #A5A5A5;
+    background-color: #F7F7F7;
+    font-family: Verdana, Arial, Helvetica, sans-serif;
+    font-size: 11px;
+    color: #556C5F;
+    font-weight: normal;
+    text-align: center;
+    line-height: 15px;
+    vertical-align: middle;
+    display: block;
+    cursor: pointer;
+}
+
+div.Keyboard div.Key div.Hover
+{
+    color: #E02C03;
+    border-color: #E0431D;
+}
+
+div.Keyboard div.Key div.Active
+{
+    color: #FFFFFF;
+    background-color: #E0431D;
+}
+
+div.Keyboard.Shift div.Key div.Key1,
+div.Keyboard.Caps div.L div.Key1,
+div.Keyboard.Off div.Key div.Key2
+{
+    display: none;
+}
+
+div.Keyboard.Caps div.L div.Key2
+{
+    display: block;
+}
+
+div.Keyboard div.Bksp {width: 31px;}
+div.Keyboard div.Exit {width: 33px;}
+div.Keyboard div.Caps {width: 33px;}
+div.Keyboard div.\\ {width: 24px;}
+div.Keyboard div.Del {width: 24px;}
+div.Keyboard div.Shift {width: 42px;}
\ No newline at end of file