Adding THtmlArea.

1 files changed, 307 insertions, 0 deletions

diff --git a/framework/Web/UI/WebControls/THtmlArea.php b/framework/Web/UI/WebControls/THtmlArea.php
new file mode 100644
index 00000000..4196de3a
--- /dev/null
+++ b/framework/Web/UI/WebControls/THtmlArea.php
@@ -0,0 +1,307 @@
+<?php

+/**

+ * THtmlArea class file.

+ *

+ * @author Wei Zhuo <weizhuo[at]gmail[dot]com>

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

+ * @copyright Copyright &copy; 2006 PradoSoft

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

+ * @version $Revision: $  $Date: $

+ * @package System.Web.UI

+ */

+

+/**

+ * THtmlArea class

+ *

+ * THtmlArea wraps the visual editting functionalities provided by the

+ * TinyMCE project {@link http://tinymce.moxiecode.com/}.

+ *

+ * THtmlArea displays a WYSIWYG text area on the Web page for user input

+ * in the HTML format. The text displayed in the THtmlArea component is 

+ * specified or determined by using the <b>Text</b> property.

+ *

+ * To enable the visual editting on the client side, set the property

+ * <b>EnableVisualEdit</b> to true (which is default value).

+ * To set the size of the editor when the visual editting is enabled, 

+ * set the <b>Width</b> and <b>Height</b> properties instead of

+ * <b>Columns</b> and <b>Rows</b> because the latter has no meaning

+ * under the situation.

+ *

+ * The default editor gives only the basic tool bar. To change or add

+ * additional tool bars, use the Options property add to additional

+ * editor options with each options on a new line. 

+ * See http://tinymce.moxiecode.com/tinymce/docs/index.html

+ * for a list of options. The options can be change/added as shown in the

+ * following example.

+ * <code>

+ * <com:THtmlArea>

+ *      <prop:Options>

+ *           plugins : "contextmenu,paste"

+ *           language : "zh_CN"

+ *      </prop:Options>

+ * </com:THtmlArea>

+ * </code>

+ *

+ * Compatibility

+ * The client-side visual editting capability is supported by 

+ * Internet Explorer 5.0+ for Windows and Gecko-based browser. 

+ * If the browser does not support the visual editting,

+ * a traditional textarea will be displayed.

+ * 

+ * Browser support

+ *

+ * <code>

+ *                    Windows XP        MacOS X 10.4

+ * ----------------------------------------------------

+ * MSIE 6                  OK

+ * MSIE 5.5 SP2            OK

+ * MSIE 5.0                OK

+ * Mozilla 1.7.x           OK              OK

+ * Firefox 1.0.x           OK              OK

+ * Firefox 1.5b2           OK              OK

+ * Safari 2.0 (412)                        OK(1)

+ * Opera 9 Preview 1       OK(1)           OK(1)

+ * ----------------------------------------------------

+ *    * (1) - Partialy working

+ * ----------------------------------------------------

+ * </code>

+ * 

+ * @author Wei Zhuo <weizhuo[at]gmail[dot]com>

+ * @version $Revision: $  $Date: $

+ * @package System.Web.UI.WebControls

+ * @since 3.0

+ */

+class THtmlArea extends TTextBox

+{

+	/**

+	 * Overrides the parent implementation.

+	 * TextMode for THtmlArea control is always 'MultiLine'

+	 * @return string the behavior mode of the THtmlArea component.

+	 */

+	public function getTextMode()

+	{

+		return 'MultiLine';

+	}

+

+	/**

+	 * Overrides the parent implementation.

+	 * TextMode for THtmlArea is always 'MultiLine' and cannot be changed to others.

+	 * @param string the text mode

+	 */

+	public function setTextMode($value)

+	{

+		throw new TInvalidOperationException("You cannot set 'TextMode' property.");

+	}

+

+	/**

+	 * Overrides the parent implementation. Return always false if EnableVisualEdit

+	 * is false, otherwise normal settings are returned.

+	 * @return boolean false

+	 */

+	public function getAutoPostBack()

+	{

+		if(!$this->getEnableVisualEdit())

+			return false;

+		return parent::getAutoPostBack();

+	}

+

+	/**

+	 * @return boolean whether to show WYSIWYG text editor

+	 */

+	public function getEnableVisualEdit()

+	{

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

+	}

+

+	/**

+	 * Sets whether to show WYSIWYG text editor.

+	 * @param boolean whether to show WYSIWYG text editor

+	 */

+	public function setEnableVisualEdit($value)

+	{

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

+	}

+

+	/**

+	 * Gets the current culture.

+	 * @return string current culture, e.g. en_AU.

+	 */

+	public function getCulture()

+	{

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

+	}

+

+	/**

+	 * Sets the culture/language for the date picker.

+	 * @param string a culture string, e.g. en_AU.

+	 */

+	public function setCulture($value)

+	{

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

+	}

+

+	/**

+	 * Gets the list of options for the WYSIWYG (TinyMCE) editor

+	 * @see http://tinymce.moxiecode.com/tinymce/docs/index.html

+	 * @return string options

+	 */

+	public function getOptions()

+	{

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

+	}

+

+	/**

+	 * Sets the list of options for the WYSIWYG (TinyMCE) editor

+	 * @see http://tinymce.moxiecode.com/tinymce/docs/index.html

+	 * @param string options

+	 */

+	public function setOptions($value)

+	{

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

+	}

+

+	/**

+	 * Overrides parent implement, provide default width of '450px'.

+	 * @param string editor width (CSS)

+	 */

+	public function setWidth($value)

+	{

+		$this->setViewState('Width', $value, '450px');

+	}

+

+	/**

+	 * @param string editor width, default '450px'.

+	 */

+	public function getWidth()

+	{

+		return $this->getViewState('Width', '450px');

+	}

+

+	/**

+	 * @param string editor height, default '200px'.

+	 */

+	public function getHeight()

+	{

+		return $this->getViewState('Height', '200px');

+	}

+

+	/**

+	 * Overrides parent implement, provide default height of '200px'.

+	 * @param string editor height (CSS)

+	 */

+	public function setHeight($value)

+	{

+		$this->setViewState('Height', $value, '200px');

+	}

+

+	/**

+	 * Adds attribute name-value pairs to renderer.

+	 * This method overrides the parent implementation by registering 

+	 * additional javacript code.

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

+	 */

+	protected function addAttributesToRender($writer)

+	{

+		if($this->getEnableVisualEdit())

+		{

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

+			if(($width=$this->getWidth()) != '')

+				$this->getStyle()->setWidth($width);

+			if(($height=$this->getHeight()) != '')

+				$this->getStyle()->setHeight($height);

+			

+			$this->registerEditorClientScript($writer);

+		}

+		parent::addAttributesToRender($writer);

+	}

+

+	/**

+	 * Registers the editor javascript file and code to initialize the editor.

+	 */

+	protected function registerEditorClientScript($writer)

+	{

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

+		if(!$scripts->isScriptFileRegistered('prado:THtmlArea'))

+			$scripts->registerScriptFile('prado:THtmlArea', $this->getScriptUrl());

+		$serializer = new TJavascriptSerializer($this->getEditorOptions());

+		$options = $serializer->toJavascript(true);

+		$script = "if(tinyMCE){ tinyMCE.init($options); }";

+		$scripts->registerEndScript('THtmlArea'.$this->ClientID,$script);

+	}

+

+	/**

+	 * @return string editor script URL.

+	 */

+	protected function getScriptUrl()

+	{

+		return $this->getScriptDeploymentPath().'/tiny_mce/tiny_mce_gzip.php';

+	}

+

+	/**

+	 * Gets the editor script base URL by publishing the tarred source via TTarAssetManager. 

+	 * @return string URL base path to the published editor script

+	 */

+	protected function getScriptDeploymentPath()

+	{

+		$manager = Prado::createComponent('System.Web.UI.TTarAssetManager');

+		$manager->init(null);

+		$tarfile = Prado::getPathOfNamespace('System.3rdParty.TinyMCE.tiny_mce', '.tar');

+		$md5sum = Prado::getPathOfNamespace('System.3rdParty.TinyMCE.tiny_mce', '.md5');

+		return $manager->publishTarFile($tarfile, $md5sum);

+	}

+

+	/**

+	 * Default editor options gives basic tool bar only.

+	 * @return array editor initialization options.

+	 */ 

+	protected function getEditorOptions()

+	{

+		$options['mode'] = 'exact';

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

+		$options['language'] = $this->getLanguageSuffix($this->getCulture());

+		$options['theme'] = 'advanced';

+		$options['theme_advanced_buttons1'] = 'bold,italic,underline,strikethrough,separator,justifyleft,justifycenter,justifyright, justifyfull,separator,bullist,numlist,separator,undo,redo,separator,link,unlink,separator,code,help';

+		$options['theme_advanced_buttons2'] = '';

+		$options['theme_advanced_buttons3'] = '';

+		$options['theme_advanced_toolbar_location'] = 'top';

+		$options['theme_advanced_toolbar_align'] = 'left';

+		$options['theme_advanced_path_location'] = 'bottom';

+		$options['extended_valid_elements'] = 'a[name|href|target|title|onclick],img[class|src|border=0|alt|title|hspace|vspace|width|height|align|onmouseover|onmouseout|name],hr[class|width|size|noshade],font[face|size|color|style],span[class|align|style]';

+

+		$options = array_merge($options, $this->parseEditorOptions($this->getOptions()));

+		return $options;

+	}

+

+	/**

+	 * Parse additional options set in the Options property.

+	 * @return array additional custom options

+	 */

+	protected function parseEditorOptions($string)

+	{

+		$options = array();

+		$substrings = preg_split('/\n|,\n/', trim($string));

+		foreach($substrings as $bits)

+		{

+			$option = explode(":",$bits);

+			if(count($option) == 2)

+				$options[trim($option[0])] = trim(preg_replace('/\'|"/','',  $option[1]));

+		}

+		return $options;

+	}

+

+	/**

+	 * @return string localized editor interface language extension.

+	 */

+	protected function getLanguageSuffix($culture)

+	{		

+		if(empty($culture))

+		{

+			$app = $this->getApplication()->getGlobalization();			

+			if(!is_null($app))

+				$culture = $app->Culture;

+		}

+		return empty($culture) ? 'en' : strtolower($culture);

+	}

+}

+

+?>
\ No newline at end of file