PHP Класс Prado\Web\UI\WebControls\THtmlArea4

THtmlArea4 wraps the visual editing functionalities provided by the version 4 of TinyMCE project {@link http://tinymce.com/}. It has been developed as a plug'n'play substitute for {@link THtmlArea}, that is based on the previous iteration (version 3) of the same project. Please note that both components can't be used together in the same page. 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://www.tinymce.com/wiki.php/Configuration for a list of options. The options can be change/added as shown in the following example. language : "de" plugins: [ advlist anchor autolink autoresize autosave bbcode charmap code contextmenu directionality emoticons fullpage fullscreen hr image importcss insertdatetime layer legacyoutput link lists media nonbreaking noneditable pagebreak paste preview print save searchreplace spellchecker tabfocus table template textcolor visualblocks visualchars wordcount ] toolbar: "undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image | print preview media", statusbar: false
С версии: 3.0
Наследование: extends TTextBox
Показать файл Открыть проект

Открытые методы

Метод Описание
__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.

Защищенные методы

Метод Описание
addAttributesToRender ( $writer ) Adds attribute name-value pairs to renderer.
copyCustomPlugins ( )
getClientClassName ( ) : string Gets the name of the javascript class responsible for performing postback for this control.
getCompressionOptions ( )
getEditorOptions ( ) : array Default editor options gives basic tool bar only.
getLanguageSuffix ( $culture ) : 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.

Описание методов

__construct() публичный Метод

Sets default width and height.
public __construct ( )

addAttributesToRender() защищенный Метод

This method overrides the parent implementation by registering additional javacript code.
protected addAttributesToRender ( $writer )

copyCustomPlugins() защищенный Метод

protected copyCustomPlugins ( )

getAutoPostBack() публичный Метод

public getAutoPostBack ( ) : boolean
Результат boolean whether change of the content should cause postback. Return false if EnableVisualEdit is true.

getAvailablePlugins() публичный Метод

Override this method to customize.
public getAvailablePlugins ( ) : array
Результат array list of plugins to be loaded

getAvailableThemes() публичный Метод

public getAvailableThemes ( ) : array
Результат array list of available themese

getClientClassName() защищенный Метод

This method overrides the parent implementation.
protected getClientClassName ( ) : string
Результат string the javascript class name

getCompressionOptions() защищенный Метод

Устаревший: since 3.2.3. tinyMCE4 doesn's use this anymore
protected getCompressionOptions ( )

getCulture() публичный Метод

Gets the current culture.
public getCulture ( ) : string
Результат string current culture, e.g. de_AT.

getCustomPluginPath() публичный Метод

public getCustomPluginPath ( ) : string
Результат string path to custom plugins to be copied.

getEditorOptions() защищенный Метод

Default editor options gives basic tool bar only.
protected getEditorOptions ( ) : array
Результат array editor initialization options.

getEnableCompression() публичный Метод

Устаревший: since 3.2.3: tinyMCE 4 doesn't support this anymore
public getEnableCompression ( ) : boolean
Результат boolean enable compression of the javascript files, default is true.

getEnableVisualEdit() публичный Метод

public getEnableVisualEdit ( ) : boolean
Результат boolean whether to show WYSIWYG text editor. Defaults to true.

getLanguageSuffix() защищенный Метод

protected getLanguageSuffix ( $culture ) : string
Результат string localized editor interface language extension.

getOptions() публичный Метод

Gets the list of options for the WYSIWYG (TinyMCE) editor
См. также: http://www.tinymce.com/wiki.php/Configuration
public getOptions ( ) : string
Результат string options

getTextMode() публичный Метод

TextMode for THtmlArea control is always 'MultiLine'
public getTextMode ( ) : string
Результат string the behavior mode of the THtmlArea component.

loadJavascriptLibrary() защищенный Метод

protected loadJavascriptLibrary ( )

parseEditorOptions() защищенный Метод

Parse additional options set in the Options property.
protected parseEditorOptions ( $string ) : array
Результат array additional custom options

registerEditorClientScript() защищенный Метод

Registers the editor javascript file and code to initialize the editor.
protected registerEditorClientScript ( $writer )

setCulture() публичный Метод

Sets the culture/language for the html area
public setCulture ( $value )

setCustomPluginPath() публичный Метод

public setCustomPluginPath ( $value )

setEnableCompression() публичный Метод

Устаревший: since 3.2.3: tinyMCE 4 doesn't support this anymore
public setEnableCompression ( $value )

setEnableVisualEdit() публичный Метод

Sets whether to show WYSIWYG text editor.
public setEnableVisualEdit ( $value )

setOptions() публичный Метод

Sets the list of options for the WYSIWYG (TinyMCE) editor
См. также: http://www.tinymce.com/wiki.php/Configuration
public setOptions ( $value )

setTextMode() публичный Метод

TextMode for THtmlArea is always 'MultiLine' and cannot be changed to others.
public setTextMode ( $value )