PHP Class Prado\Web\UI\JuiControls\TJuiSelectable

TJuiSelectable is an extension to {@link TActivePanel} based on jQuery-UI's {@link http://jqueryui.com/selectable/ Selectable} interaction. TJuiSelectable can be feed a {@link setDataSource DataSource} and will interally render a {@link TRepeater} that displays items in an unordered list. Items can be selected by clicking on them, individually or in a group. $this->repeater1->DataSource=array('home', 'office', 'car', 'boat', 'plane'); $this->repeater1->dataBind();
Since: 3.3
Inheritance: extends Prado\Web\UI\ActiveControls\TActivePanel, implements Prado\Web\UI\JuiControls\IJuiOptions, implements Prado\Web\UI\ActiveControls\ICallbackEventHandler
显示文件 Open project: pradosoft/prado

Protected Properties

Property Type Description
$_options

Public Methods

Method Description
__construct ( ) Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.
dataBind ( ) Overrides parent implementation. Callback {@link renderSelectables()} when page's IsCallback property is true.
getOptions ( ) : TJuiControlOptions Object containing defined javascript options
getSelectables ( ) : TRepeater
getValidEvents ( ) : array() Array containing valid javascript events
getValidOptions ( ) : array() Array containing valid javascript options
getWidget ( ) : string
getWidgetID ( ) : string
onCreate ( object $params ) Raises the OnCreate event
onSelected ( object $params ) Raises the OnSelected event
onSelecting ( object $params ) Raises the OnSelecting event
onStart ( object $params ) Raises the OnStart event
onStop ( object $params ) Raises the OnStop event
onUnselected ( object $params ) Raises the OnUnselected event
onUnselecting ( object $params ) Raises the OnUnselecting event
raiseCallbackEvent ( $param ) Raises callback event. This method is required by the {@link ICallbackEventHandler} interface.
setDataSource ( $data )

Protected Methods

Method Description
addAttributesToRender ( $writer ) Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.
createRepeater ( ) : TRepeater
getPostBackOptions ( ) : array

Method Details

__construct() public method

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.
public __construct ( )

addAttributesToRender() protected method

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.
protected addAttributesToRender ( $writer )

createRepeater() protected method

protected createRepeater ( ) : TRepeater
return Prado\Web\UI\WebControls\TRepeater new instance of TRepater to render the list of Selectables.

dataBind() public method

Overrides parent implementation. Callback {@link renderSelectables()} when page's IsCallback property is true.
public dataBind ( )

getOptions() public method

Object containing defined javascript options
public getOptions ( ) : TJuiControlOptions
return TJuiControlOptions

getPostBackOptions() protected method

protected getPostBackOptions ( ) : array
return array list of callback options.

getSelectables() public method

public getSelectables ( ) : TRepeater
return Prado\Web\UI\WebControls\TRepeater suggestion list repeater

getValidEvents() public method

Array containing valid javascript events
public getValidEvents ( ) : array()
return array()

getValidOptions() public method

Array containing valid javascript options
public getValidOptions ( ) : array()
return array()

getWidget() public method

public getWidget ( ) : string
return string the name of the jQueryUI widget method

getWidgetID() public method

public getWidgetID ( ) : string
return string the clientid of the jQueryUI widget element

onCreate() public method

Raises the OnCreate event
public onCreate ( object $params )
$params object event parameters

onSelected() public method

Raises the OnSelected event
public onSelected ( object $params )
$params object event parameters

onSelecting() public method

Raises the OnSelecting event
public onSelecting ( object $params )
$params object event parameters

onStart() public method

Raises the OnStart event
public onStart ( object $params )
$params object event parameters

onStop() public method

Raises the OnStop event
public onStop ( object $params )
$params object event parameters

onUnselected() public method

Raises the OnUnselected event
public onUnselected ( object $params )
$params object event parameters

onUnselecting() public method

Raises the OnUnselecting event
public onUnselecting ( object $params )
$params object event parameters

raiseCallbackEvent() public method

Raises callback event. This method is required by the {@link ICallbackEventHandler} interface.
public raiseCallbackEvent ( $param )

setDataSource() public method

public setDataSource ( $data )

Property Details

$_options protected_oe property

protected $_options