PHP Class Prado\Web\UI\WebControls\THtmlArea

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 Text property. To enable the visual editting on the client side, set the property EnableVisualEdit to true (which is default value). To set the size of the editor when the visual editting is enabled, set the Width and Height properties instead of Columns and Rows 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 {@link setOptions Options} property to add 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.



     
          plugins : "contextmenu,paste"
          language : "zh_cn"

Since: 3.0

Inheritance: extends TTextBox

Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode	Description
__construct ( )	Constructor.
getAutoPostBack ( ) : boolean
getAvailablePlugins ( ) : array	Returns a list of plugins to be loaded.
getAvailableThemes ( ) : array
getCulture ( ) : string	Gets the current culture.
getCustomPluginPath ( ) : string
getEnableCompression ( ) : boolean
getEnableVisualEdit ( ) : boolean
getOptions ( ) : string	Gets the list of options for the WYSIWYG (TinyMCE) editor
getTextMode ( ) : string	Overrides the parent implementation.
setCulture ( $value )	Sets the culture/language for the html area
setCustomPluginPath ( $value )
setEnableCompression ( $value )
setEnableVisualEdit ( $value )	Sets whether to show WYSIWYG text editor.
setOptions ( $value )	Sets the list of options for the WYSIWYG (TinyMCE) editor
setTextMode ( $value )	Overrides the parent implementation.

Méthodes protégées

Méthode	Description
addAttributesToRender ( $writer )	Adds attribute name-value pairs to renderer.
copyCustomPlugins ( $url )
getClientClassName ( ) : string	Gets the name of the javascript class responsible for performing postback for this control.
getEditorOptions ( ) : array	Default editor options gives basic tool bar only.
getLanguageSuffix ( $culture ) : string
getScriptDeploymentPath ( ) : string	Gets the editor script base URL by publishing the tarred source via TTarAssetManager.
getScriptUrl ( ) : string
loadJavascriptLibrary ( )
parseEditorOptions ( $string ) : array	Parse additional options set in the Options property.
registerEditorClientScript ( $writer )	Registers the editor javascript file and code to initialize the editor.

Method Details

__construct() public méthode

Sets default width and height.

public __construct ( )

addAttributesToRender() protected méthode

This method overrides the parent implementation by registering additional javacript code.

protected addAttributesToRender ( $writer )

copyCustomPlugins() protected méthode

protected copyCustomPlugins ( $url )

getAutoPostBack() public méthode

public getAutoPostBack ( ) : boolean
Résultat	boolean	whether change of the content should cause postback. Return false if EnableVisualEdit is true.

getAvailablePlugins() public méthode

Override this method to customize.

public getAvailablePlugins ( ) : array
Résultat	array	list of plugins to be loaded

getAvailableThemes() public méthode

public getAvailableThemes ( ) : array
Résultat	array	list of available themese

getClientClassName() protected méthode

This method overrides the parent implementation.

protected getClientClassName ( ) : string
Résultat	string	the javascript class name

getCulture() public méthode

Gets the current culture.

public getCulture ( ) : string
Résultat	string	current culture, e.g. en_AU.

getCustomPluginPath() public méthode

public getCustomPluginPath ( ) : string
Résultat	string	path to custom plugins to be copied.

getEditorOptions() protected méthode

Default editor options gives basic tool bar only.

protected getEditorOptions ( ) : array
Résultat	array	editor initialization options.

getEnableCompression() public méthode

Deprecation: since 4.0

public getEnableCompression ( ) : boolean
Résultat	boolean	enable compression of the javascript files, default is false.

getEnableVisualEdit() public méthode

public getEnableVisualEdit ( ) : boolean
Résultat	boolean	whether to show WYSIWYG text editor. Defaults to true.

getLanguageSuffix() protected méthode

protected getLanguageSuffix ( $culture ) : string
Résultat	string	localized editor interface language extension.

getOptions() public méthode

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

See also: http://tinymce.moxiecode.com/tinymce/docs/index.html

public getOptions ( ) : string
Résultat	string	options

getScriptDeploymentPath() protected méthode

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

protected getScriptDeploymentPath ( ) : string
Résultat	string	URL base path to the published editor script

getScriptUrl() protected méthode

protected getScriptUrl ( ) : string
Résultat	string	editor script URL.

getTextMode() public méthode

TextMode for THtmlArea control is always 'MultiLine'

public getTextMode ( ) : string
Résultat	string	the behavior mode of the THtmlArea component.

loadJavascriptLibrary() protected méthode

protected loadJavascriptLibrary ( )

parseEditorOptions() protected méthode

Parse additional options set in the Options property.

protected parseEditorOptions ( $string ) : array
Résultat	array	additional custom options

registerEditorClientScript() protected méthode

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

protected registerEditorClientScript ( $writer )

setCulture() public méthode

Sets the culture/language for the html area

public setCulture ( $value )

setCustomPluginPath() public méthode

public setCustomPluginPath ( $value )

setEnableCompression() public méthode

Deprecation: since 4.0

public setEnableCompression ( $value )

setEnableVisualEdit() public méthode

Sets whether to show WYSIWYG text editor.

public setEnableVisualEdit ( $value )

setOptions() public méthode

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

See also: http://tinymce.moxiecode.com/tinymce/docs/index.html

public setOptions ( $value )

setTextMode() public méthode

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

public setTextMode ( $value )