|
Class TClientScript
TClientScript class
Allows importing of Prado Client Scripts from template via the setPradoScripts PradoScripts property. Multiple Prado client-scripts can be
specified using comma delimited string of the javascript library to include on
the page. For example,
<com:TClientScript PradoScripts="effects, rico" />
Custom javascript files can be register using the setScriptUrl
ScriptUrl property.
<com:TClientScript ScriptUrl=<%~ test.js %> />
Contents within TClientScript will be treated as javascript code and will be
rendered in place.
Since Prado 3.2 the property setFlushScriptFiles FlushScriptFiles
controls whether Prado will flush the script files defined in the page before
rendering the TClientScript contents. If you're not using any external functions
in your TClientScript block, you should set the setFlushScriptFiles
FlushScriptFiles property to false, so Prado can postpone the loading of all
the referenced script files further down the page generation cycle.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TClientScript
Methods summary
public
string
|
#
getPradoScripts( )
Returns
string comma delimited list of javascript libraries to included on the page.
|
public
|
#
setPradoScripts( string $value )
Include javascript library to the current page. The current supported
libraries are: "prado", "effects", "ajax", "validator", "logger", "datepicker",
"colorpicker". Library dependencies are automatically resolved.
Include javascript library to the current page. The current supported
libraries are: "prado", "effects", "ajax", "validator", "logger", "datepicker",
"colorpicker". Library dependencies are automatically resolved.
Parameters
- $value
string comma delimited list of javascript libraries to include.
|
public
string
|
#
getScriptUrl( )
Returns
string custom javascript file url.
|
public
|
#
setScriptUrl( string $value )
Parameters
- $value
string custom javascript file url.
|
public
boolean
|
#
getFlushScriptFiles( )
Returns
boolean whether to flush script files using TClientScriptManager::flushScriptFiles()
before rendering the script block
|
public
|
#
setFlushScriptFiles( boolean $value )
Parameters
- $value
boolean whether to flush script files using TClientScriptManager::flushScriptFiles()
before rendering the script block
|
public
|
#
onPreRender( mixed $param )
Calls the client script manager to add each of the requested client script
libraries.
Calls the client script manager to add each of the requested client script
libraries.
Parameters
- $param
mixed event parameter
Overrides
|
public
|
#
render( THtmlWriter $writer )
Renders the body content as javascript block. Overrides parent
implementation, parent renderChildren method is called during registerCustomScript.
Renders the body content as javascript block. Overrides parent
implementation, parent renderChildren method is called during registerCustomScript.
Parameters
Overrides
|
protected
|
#
renderCustomScriptFile( THtmLWriter $writer )
Renders the custom script file.
Renders the custom script file.
Parameters
- $writer
THtmLWriter the renderer
|
protected
|
#
renderCustomScript( THtmlWriter $writer )
Registers the body content as javascript.
Registers the body content as javascript.
Parameters
|
Methods inherited from TControl
__construct(),
__get(),
addParsedObject(),
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
|
|