Versions
Look up a class, method, property or event

CClipWidget

Package system.web.widgets
Inheritance class CClipWidget » CWidget » CBaseController » CComponent
Since 1.0
Version $Id: CClipWidget.php 433 2008-12-30 22:59:17Z qiang.xue $
CClipWidget records its content and makes it available elsewhere.

Content rendered between its init() and run() calls are saved as a clip in the controller. The clip is named after the widget ID.

See CBaseController::beginClip and CBaseController::endClip for a shortcut usage of CClipWidget.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
actionPrefix string the prefix to the IDs of the actions. CWidget
controller CController the controller that this widget belongs to. CWidget
id string id of the widget. CWidget
owner CBaseController owner/creator of this widget. CWidget
renderClip boolean whether to render the clip content in place. CClipWidget
viewPath string Returns the directory containing the view files for this widget. CWidget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CWidget
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
actions() Returns a list of actions that are used by this widget. CWidget
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
beginCache() Begins fragment caching. CBaseController
beginClip() Begins recording a clip. CBaseController
beginContent() Begins the rendering of content that is to be decorated by the specified view. CBaseController
beginWidget() Creates a widget and executes it. CBaseController
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
createWidget() Creates a widget and initializes it. CBaseController
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
endCache() Ends fragment caching. CBaseController
endClip() Ends recording a clip. CBaseController
endContent() Ends the rendering of content. CBaseController
endWidget() Ends the execution of the named widget. CBaseController
getController() CWidget
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getId() CWidget
getOwner() CWidget
getViewFile() Looks for the view script file according to the view name. CWidget
getViewPath() Returns the directory containing the view files for this widget. CWidget
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
init() Starts recording a clip. CClipWidget
raiseEvent() Raises an event. CComponent
render() Renders a view. CWidget
renderFile() Renders a view file. CBaseController
renderInternal() Renders a view file. CBaseController
run() Ends recording a clip. CClipWidget
setId() CWidget
widget() Creates a widget and executes it. CBaseController

Property Details

renderClip property
public boolean $renderClip;

whether to render the clip content in place. Defaults to false, meaning the captured clip will not be displayed.

Method Details

init() method
public void init()

Starts recording a clip.

run() method
public void run()

Ends recording a clip. This method stops output buffering and saves the rendering result as a named clip in the controller.

Be the first person to leave a comment

Please to leave your comment.