Class \Prado\Web\UI\ActiveControls\TCallbackClientScript

TCallbackClientScript class.

The TCallbackClientScript class provides corresponding methods that can be executed on the client-side (i.e. the browser client that is viewing the page) during a callback response.

The available methods includes setting/clicking input elements, changing Css styles, hiding/showing elements, and adding visual effects to elements on the page. The client-side methods can be access through the CallbackClient property available in TPage.

For example, to hide "$myTextBox" element during callback response, do

$this->getPage()->getCallbackClient()->hide($myTextBox);

To call a specific jQuery method on an element, use the jQuery method:

// simple example: focus a textbox
$this->getCallbackClient()->jQuery($myTextBox, 'focus');

// complex example: resize a textbox using an animation
	$this->getCallbackClient()->jQuery($myTextBox, 'animate', array(
	array(	'width' => '+=100',
			'height' => '+=50'
		),
	array('duration' => 1000)
	));

To call a jQueryUI effect on an element, use the juiEffect method:

// simple example: focus a textbox
$this->getCallbackClient()->juiEffect($myTextBox, 'highlight');

In order to use the jQueryUI effects, the jqueryui script must be registered:

$this->getPage()->getClientScript()->registerPradoScript('jqueryui');

Class hierarchy

\Prado\Web\UI\ActiveControls\TCallbackClientScript

\Prado\TApplicationComponent

\Prado\TComponent

Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Author: Fabio Bas <ctrlaltca[at]gmail[dot]com>
Since: 3.1

Methods summary
`public`	`__construct() : mixed` Constructor.
`public`	`addCssClass(TControl $element, string $cssClass) : mixed` Add a Css class name to the element.
`public deprecated`	`appear(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Alias of fadeIn()
`public`	`appendContent(TControl $element, string $content) : mixed` Append a HTML fragement to the element.
`public`	`appendScriptBlock(THtmlWriter $content) : mixed` Appends a block of inline javascript enclosed in a boundary. Similar to to evaluateScript(), but functions declared in the inline block will be available to page elements.
`public`	`blind(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Blind. This effect needs jQueryUI.
`public deprecated`	`blindDown(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Alias of blind(), presets the direction to 'down'
`public deprecated`	`blindUp(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Alias of blind(), presets the direction to 'up'
`public`	`callClientFunction(string $function[, array<string\|int, mixed> $params = [] ]) : mixed` Executes a client-side statement.
`public`	`check(TControl $checkbox[, bool $checked = true ]) : mixed` Client script to check or uncheck a checkbox or radio button.
`public`	`click(TControl $control) : mixed` Client script to click on an element. <b>This client-side function is unpredictable.</b>
`public`	`drop(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Drop out. This effect needs jQueryUI.
`public deprecated`	`dropOut(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Alias of drop()
`public`	`evaluateScript(THtmlWriter\|string $writer) : mixed` Evaluate a block of javascript enclosed in a boundary.
`public deprecated`	`fade(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Alias of fadeOut()
`public`	`fadeIn(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Gradually make the element appear. This effect doesn't need jQueryUI.
`public`	`fadeOut(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Gradually fade the element. This effect doesn't need jQueryUI.
`public`	`fadeTo(TControl $element, float $value[, int $duration = 500 ]) : mixed` Set the opacity on a html element or control. This effect doesn't need jQueryUI.
`public`	`focus(TControl $element) : mixed` Focus on a particular element.
`public`	`fold(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Fold. This effect needs jQueryUI.
`public`	`getClientFunctionsToExecute() : array<string\|int, mixed>`
`public deprecated`	`grow(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Alias of size()
`public`	`hide(TControl $element) : mixed` Hides an element by changing its CSS display style to "none".
`public`	`highlight(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: High light the element for about 2 seconds. This effect needs jQueryUI.
`public`	`insertContentAfter(TControl $element, string $content) : mixed` Insert a HTML fragement after the element.
`public`	`insertContentBefore(TControl $element, string $content) : mixed` Insert a HTML fragement in before the element.
`public`	`jQuery(string $element, string $method[, array<string\|int, mixed> $params = [] ]) : mixed` Executes a jQuery client-side method over an element.
`public`	`juiEffect(TControl $element, string $effect[, array<string\|int, mixed> $options = [] ]) : mixed` Add a jQuery-ui effect the element. This method needs jQueryUI.
`public`	`prependContent(TControl $element, string $content) : mixed` Prepend a HTML fragement to the element.
`public`	`puff(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Gradually grow and fade the element. This effect needs jQueryUI.
`public`	`pulsate(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Pulsate. This effect needs jQueryUI.
`public`	`raiseClientEvent(TControl $control, string $eventName) : mixed` Raise the client side event (given by $eventName) on a particular element.
`public`	`remove(TControl $element) : mixed` Removes an element from the HTML page.
`public`	`removeCssClass(TControl $element, string $cssClass) : mixed` Remove a Css class name from the element.
`public`	`replaceContent(TControl $element, string $content[, bool $self = true ]) : mixed` Replace the content of an element with new content contained in writer.
`public`	`scale(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Scale the element. This effect needs jQueryUI.
`public`	`scrollTo(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Scroll the top of the browser viewing area to the location of the element.
`public`	`select(TListControl $control[, string $method = 'Value' ][, null\|int\|string $value = null ][, null\|string $type = null ]) : mixed` Client script to select/clear/check a drop down list, check box list, or radio button list. The second parameter determines the selection method. Valid methods are Value, select or check by value Values, select or check by a list of values Index, select or check by index (zero based index) Indices, select or check by a list of index (zero based index) Clear, clears or selections or checks in the list All, select all Invert, invert the selection.
`public`	`setAttribute(TControl $control, string $name, string $value) : mixed` Sets the attribute of a particular control.
`public`	`setListItems(TControl $control, array<string\|int, mixed>\|TListControl $items) : mixed` Sets the options of a select input element.
`public deprecated`	`setOpacity(TControl $element, float $value) : mixed` Alias of fadeTo()
`public`	`setStyle(TControl $element, array<string\|int, mixed> $styles) : mixed` Sets the style of element. The style must be a key-value array where the key is the style property and the value is the style value.
`public`	`setValue(TControl $input, string $text) : mixed` Client script to set the value of a particular input element.
`public`	`shake(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Shake the element. This effect needs jQueryUI.
`public`	`show(TControl $element) : mixed` Shows an element by changing its CSS display style as empty.
`public deprecated`	`shrink(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Alias of scale()
`public`	`size(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Gradually make an element grow to a predetermined size. This effect needs jQueryUI.
`public`	`slideDown(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Slide down. This effect doesn't need jQueryUI.
`public`	`slideUp(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Visual Effect: Slide up. This effect doesn't need jQueryUI.
`public deprecated`	`squish(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Alias of scale()
`public deprecated`	`switchOff(TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Alias of scale()
`public`	`toggle(TControl $element[, null\|string $effect = null ][, array<string\|int, mixed> $options = [] ]) : mixed` Toggles the visibility of the element.
`public`	`update(TControl $element, TControl $content) : mixed` Update the element's innerHTML with new content.
`public`	`visualEffect(string $type, TControl $element[, array<string\|int, mixed> $options = [] ]) : mixed` Add a visual effect the element.
`protected`	`replace(TControl $element, string $content, bool $self) : mixed` Replace the content of an element with new content. The new content can be a string or a TControl component. If the <tt>content</tt> parameter is a TControl component, its rendered method will be called and its contents will be used for replacement.
`private`	`getRenderedContentBoundary(TControl $control) : string` Renders the control and return the content boundary from TCallbackResponseWriter. This method should only be used by framework component developers. The render() method is defered to be called in the TActivePageAdapter class.
`private`	`getResponseContentBoundary(THtmlWriter $html) : string`
`private`	`getSelectionControlIsListType(mixed $control) : mixed`
`private`	`getSelectionControlType(mixed $control) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, publishAsset, publishFilePath, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\ActiveControls\TCallbackClientScript

Class hierarchy