|
Class TTextHighlighter
TTextHighlighter class.
TTextHighlighter does syntax highlighting its body content, including static
text and rendering results of child controls. You can set 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 setShowLineNumbers ShowLineNumbers to true, the highlighted result may be shown
with line numbers.
Note, TTextHighlighter requires THead to be placed on the page
template because it needs to insert some CSS styles.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TTextProcessor
-
TTextHighlighter
Methods summary
protected
string
|
#
getTagName( )
Returns
string tag name of the panel
Overrides
|
public
string
|
#
getLanguage( )
Returns
string language whose syntax is to be used for highlighting. Defaults to 'php'.
|
public
|
#
setLanguage( string $value )
Parameters
- $value
string language (case-insensitive) whose syntax is to be used for highlighting. Valid
values are those file names (without suffix) that are contained in
'3rdParty/TextHighlighter/Text/Highlighter'. Currently, the following languages
are supported: ABAP, CPP, CSS, DIFF, DTD, HTML, JAVA, JAVASCRIPT, MYSQL, PERL,
PHP, PRADO, PYTHON, RUBY, SQL, XML If a language is not supported, it will be
displayed as plain text.
|
public
boolean
|
#
getShowLineNumbers( )
Returns
boolean whether to show line numbers in the highlighted result.
|
public
|
#
setShowLineNumbers( boolean $value )
Parameters
- $value
boolean whether to show line numbers in the highlighted result.
|
public
boolean
|
#
getEnableCopyCode( )
Returns
boolean true will show "Copy Code" link. Defaults to false.
|
public
|
#
setEnableCopyCode( boolean $value )
Parameters
- $value
boolean true to show the "Copy Code" link.
|
public
TTextHighlighterLineNumberStyle
|
|
public
|
|
public
integer
|
#
getTabSize( )
Returns
integer tab size. Defaults to 4.
|
public
|
#
setTabSize( integer $value )
|
public
|
#
onPreRender( THtmlWriter $writer )
Registers css style for the highlighted result. This method overrides parent
implementation.
Registers css style for the highlighted result. This method overrides parent
implementation.
Parameters
Overrides
|
protected
|
#
registerStyleSheet( )
Registers the stylesheet for presentation.
Registers the stylesheet for presentation.
|
public
string
|
#
processText( string $text )
Processes a text string. This method is required by the parent class.
Processes a text string. This method is required by the parent class.
Parameters
- $text
string text string to be processed
Returns
string the processed text result
|
public
|
#
render( THtmlWriter $writer )
Renders the control. This method overrides the parent implementation by
replacing it with the following sequence:
Renders the control. This method overrides the parent implementation by
replacing it with the following sequence:
Parameters
- $writer
THtmlWriter
the writer used for the rendering purpose
Overrides
|
Methods inherited from TWebControl
addAttributesToRender(),
clearStyle(),
copyBaseAttributes(),
createStyle(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getDisplay(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getToolTip(),
getWidth(),
renderBeginTag(),
renderEndTag(),
setAccessKey(),
setBackColor(),
setBorderColor(),
setBorderStyle(),
setBorderWidth(),
setCssClass(),
setDisplay(),
setEnsureId(),
setForeColor(),
setHeight(),
setStyle(),
setTabIndex(),
setToolTip(),
setWidth()
|
Methods inherited from TControl
__construct(),
__get(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
createChildControls(),
createControlCollection(),
dataBind(),
dataBindChildren(),
dataBindProperties(),
ensureChildControls(),
findControl(),
findControlsByID(),
findControlsByType(),
focus(),
getAdapter(),
getAllowChildControls(),
getAttribute(),
getAttributes(),
getChildControlsCreated(),
getClientID(),
getControlStage(),
getControlState(),
getControls(),
getCustomData(),
getEnableTheming(),
getEnableViewState(),
getEnabled(),
getHasAdapter(),
getHasAttributes(),
getHasChildInitialized(),
getHasControls(),
getHasInitialized(),
getHasLoaded(),
getHasLoadedPostData(),
getHasPreRendered(),
getID(),
getIsSkinApplied(),
getNamingContainer(),
getPage(),
getParent(),
getRegisteredObject(),
getSkinID(),
getSourceTemplateControl(),
getTemplateControl(),
getUniqueID(),
getViewState(),
getVisible(),
hasAttribute(),
initRecursive(),
isDescendentOf(),
isObjectRegistered(),
loadRecursive(),
loadState(),
loadStateRecursive(),
onDataBinding(),
onInit(),
onLoad(),
onUnload(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
renderChildren(),
renderControl(),
saveState(),
saveStateRecursive(),
setAdapter(),
setAttribute(),
setChildControlsCreated(),
setControlStage(),
setControlState(),
setCustomData(),
setEnableTheming(),
setEnableViewState(),
setEnabled(),
setID(),
setPage(),
setSkinID(),
setTemplateControl(),
setViewState(),
setVisible(),
trackViewState(),
traverseChildControls(),
unbindProperty(),
unloadRecursive(),
unregisterObject()
|
Methods inherited from TComponent
__call(),
__destruct(),
__isset(),
__set(),
__sleep(),
__unset(),
__wakeup(),
asa(),
attachBehavior(),
attachBehaviors(),
attachClassBehavior(),
attachEventHandler(),
canGetProperty(),
canSetProperty(),
clearBehaviors(),
createdOnTemplate(),
detachBehavior(),
detachBehaviors(),
detachClassBehavior(),
detachEventHandler(),
disableBehavior(),
disableBehaviors(),
enableBehavior(),
enableBehaviors(),
evaluateExpression(),
evaluateStatements(),
fxAttachClassBehavior(),
fxDetachClassBehavior(),
getAutoGlobalListen(),
getBehaviorsEnabled(),
getClassHierarchy(),
getEventHandlers(),
getListeningToGlobalEvents(),
getSubProperty(),
hasEvent(),
hasEventHandler(),
hasProperty(),
isa(),
listen(),
raiseEvent(),
setSubProperty(),
unlisten()
|
Constants inherited from TControl
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID
|
|