EJqueryFlash
| Package | application.extensions.flash |
|---|---|
| Inheritance | class EJqueryFlash » CInputWidget » CWidget » CBaseController » CComponent |
| Since | 1.0.4 |
| Version | 0.1 beta |
EJqueryFlash is a widget which inserts Flash (swf) objects in a web page. It
relies on the jQuery Flash plugin. You should take a look into the plugin's
website, since there are many useful examples and advanced tips, which can't
be done with this widget as they're too complex and need custom javascript
coding.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| actionPrefix | string | the prefix to the IDs of the actions. | CWidget |
| attribute | string | the attribute associated with this widget. | CInputWidget |
| callbacks | array | Getter | EJqueryFlash |
| controller | CController | the controller that this widget belongs to. | CWidget |
| htmlOptions | array | Getter | EJqueryFlash |
| id | string | id of the widget. | CWidget |
| model | CModel | the data model associated with this widget. | CInputWidget |
| name | string | the input name. | CInputWidget |
| owner | CBaseController | owner/creator of this widget. | CWidget |
| pluginOptions | array | Getter | EJqueryFlash |
| skin | mixed | the name of the skin to be used by this widget. | CWidget |
| text | string | Getter | EJqueryFlash |
| value | string | the input value | CInputWidget |
| viewPath | string | Returns the directory containing the view files for this widget. | CWidget |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| validCallbacks | array | Valid callbacks. | EJqueryFlash |
| validHtmlOptions | array | Valid htmlOptions. | EJqueryFlash |
| validPluginOptions | array | Valid pluginOptions. | EJqueryFlash |
Public Methods
| Method | Description | Defined 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 |
| getCallbacks() | Getter | EJqueryFlash |
| getController() | CWidget | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getHtmlOptions() | Getter | EJqueryFlash |
| getId() | CWidget | |
| getOwner() | CWidget | |
| getPluginOptions() | Getter | EJqueryFlash |
| getText() | Getter | EJqueryFlash |
| 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() | Get the output buffer. | EJqueryFlash |
| raiseEvent() | Raises an event. | CComponent |
| render() | Renders a view. | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | Draw the widget | EJqueryFlash |
| setCallbacks() | Setter | EJqueryFlash |
| setHtmlOptions() | Setter | EJqueryFlash |
| setId() | CWidget | |
| setPluginOptions() | Setter | EJqueryFlash |
| setText() | Setter | EJqueryFlash |
| widget() | Creates a widget and executes it. | CBaseController |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| checkCallbacks() | Check callbacks against the valid ones | EJqueryFlash |
| checkOptions() | Check the options against the valid ones | EJqueryFlash |
| hasModel() | CInputWidget | |
| htmlCode() | Make the HTML code | EJqueryFlash |
| jsCode() | Generate the javascript code. | EJqueryFlash |
| makeOptions() | Make the options javascript string. | EJqueryFlash |
| publishAssets() | Publishes the assets | EJqueryFlash |
| registerClientScripts() | Registers the external javascript files | EJqueryFlash |
| resolveNameID() | CInputWidget |
Property Details
callbacks
property
Getter
htmlOptions
property
Getter
pluginOptions
property
Getter
text
property
Getter
validCallbacks
property
protected array $validCallbacks;
Valid callbacks.
validHtmlOptions
property
protected array $validHtmlOptions;
Valid htmlOptions.
validPluginOptions
property
protected array $validPluginOptions;
Valid pluginOptions.
Method Details
checkCallbacks()
method
|
protected static void checkCallbacks(array $value, array $validCallbacks)
| ||
| $value | array | $value user's callbacks |
| $validCallbacks | array | $validCallbacks valid callbacks |
Check callbacks against the valid ones
checkOptions()
method
|
protected static void checkOptions(array $value, array $validOptions)
| ||
| $value | array | $value user's options |
| $validOptions | array | $validOptions valid options |
Check the options against the valid ones
getCallbacks()
method
|
public array getCallbacks()
| ||
| {return} | array | |
Getter
getHtmlOptions()
method
|
public array getHtmlOptions()
| ||
| {return} | array | |
Getter
getPluginOptions()
method
|
public array getPluginOptions()
| ||
| {return} | array | |
Getter
getText()
method
|
public string getText()
| ||
| {return} | string | |
Getter
htmlCode()
method
|
protected string htmlCode(string $id)
| ||
| $id | string | $id id |
| {return} | string | |
Make the HTML code
init()
method
|
public void init()
|
Get the output buffer.
jsCode()
method
|
protected string jsCode(string $id)
| ||
| $id | string | $id id |
| {return} | string | |
Generate the javascript code.
makeOptions()
method
|
protected string makeOptions($opt)
| ||
| $opt | ||
| {return} | string | |
Make the options javascript string.
publishAssets()
method
|
protected void publishAssets()
|
Publishes the assets
registerClientScripts()
method
|
protected void registerClientScripts()
|
Registers the external javascript files
run()
method
|
public void run()
|
Draw the widget
setCallbacks()
method
|
public void setCallbacks(array $value)
| ||
| $value | array | $value callbacks |
Setter
setHtmlOptions()
method
|
public void setHtmlOptions(array $value)
| ||
| $value | array | $value htmlOptions |
Setter
setPluginOptions()
method
|
public void setPluginOptions(array $value)
| ||
| $value | array | $value pluginOptions |
Setter
setText()
method
|
public void setText(string $value)
| ||
| $value | string | $value text |
Setter