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

TTextHighlighter does syntax highlighting its body content, including static text and rendering results of child controls. You can set {@link setLanguage Language} to specify what kind of syntax the body content is. Currently, TTextHighlighter supports the following languages: ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL, PHP, PYTHON, RUBY, SQL, XML and PRADO, where PRADO refers to PRADO template syntax. By setting {@link setShowLineNumbers ShowLineNumbers} to true, the highlighted result may be shown with line numbers. Note, TTextHighlighter requires {@link THead} to be placed on the page template because it needs to insert some CSS styles.
С версии: 3.0
Наследование: extends TTextProcessor
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
getEnableCopyCode ( ) : boolean
getLanguage ( ) : string
getLineNumberStyle ( ) : TTextHighlighterLineNumberStyle
getShowLineNumbers ( ) : boolean
getTabSize ( ) : integer
onPreRender ( $writer ) Registers css style for the highlighted result.
processText ( $text ) : string Processes a text string.
render ( $writer )
setEnableCopyCode ( $value )
setLanguage ( $value )
setLineNumberStyle ( $value )
setShowLineNumbers ( $value )
setTabSize ( $value )

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

Метод Описание
getHeaderTemplate ( ) : string
getTagName ( ) : string
registerStyleSheet ( ) Registers the stylesheet for presentation.

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

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

public getEnableCopyCode ( ) : boolean
Результат boolean true will show "Copy Code" link. Defaults to false.

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

protected getHeaderTemplate ( ) : string
Результат string header template with "Copy code" link.

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

public getLanguage ( ) : string
Результат string language whose syntax is to be used for highlighting. Defaults to 'php'.

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

public getLineNumberStyle ( ) : TTextHighlighterLineNumberStyle
Результат TTextHighlighterLineNumberStyle style of row number, Table by default

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

public getShowLineNumbers ( ) : boolean
Результат boolean whether to show line numbers in the highlighted result.

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

public getTabSize ( ) : integer
Результат integer tab size. Defaults to 4.

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

protected getTagName ( ) : string
Результат string tag name of the panel

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

This method overrides parent implementation.
public onPreRender ( $writer )

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

This method is required by the parent class.
public processText ( $text ) : string
Результат string the processed text result

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

Registers the stylesheet for presentation.
protected registerStyleSheet ( )

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

public render ( $writer )

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

public setEnableCopyCode ( $value )

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

public setLanguage ( $value )

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

public setLineNumberStyle ( $value )

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

public setShowLineNumbers ( $value )

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

public setTabSize ( $value )