PHP Class Prado\Web\UI\JuiControls\TJuiSortable

TJuiSortable is an extension to {@link TActivePanel} based on jQuery-UI's {@link http://jqueryui.com/sortable/ Sortable} interaction. The panel can be feed a {@link setDataSource DataSource} and will interally render a {@link TRepeater} that displays items in an unordered list. Items can be sortered dragging and dropping them. $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
OnStop ( object $params ) Raises the OnStop event
__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 renderSortables()} when page's IsCallback property is true.
getOptions ( ) : TJuiControlOptions Object containing defined javascript options
getSortables ( ) : TRepeater
getValidEvents ( ) : array() Array containing valid javascript events
getValidOptions ( ) : array() Array containing valid javascript options
getWidget ( ) : string
getWidgetID ( ) : string
onActivate ( object $params ) Raises the OnActivate event
onBeforeStop ( object $params ) Raises the OnBeforeStop event
onChange ( object $params ) Raises the OnChange event
onCreate ( object $params ) Raises the OnCreate event
onDeactivate ( object $params ) Raises the OnDeactivate event
onOut ( object $params ) Raises the OnOut event
onOver ( object $params ) Raises the OnOver event
onReceive ( object $params ) Raises the OnReceive event
onRemove ( object $params ) Raises the OnRemove event
onSort ( object $params ) Raises the OnSort event
onStart ( object $params ) Raises the OnStart event
onUpdate ( object $params ) Raises the OnUpdate 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

OnStop() public method

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

__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 Sortables.

dataBind() public method

Overrides parent implementation. Callback {@link renderSortables()} 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.

getSortables() public method

public getSortables ( ) : 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

onActivate() public method

Raises the OnActivate event
public onActivate ( object $params )
$params object event parameters

onBeforeStop() public method

Raises the OnBeforeStop event
public onBeforeStop ( object $params )
$params object event parameters

onChange() public method

Raises the OnChange event
public onChange ( object $params )
$params object event parameters

onCreate() public method

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

onDeactivate() public method

Raises the OnDeactivate event
public onDeactivate ( object $params )
$params object event parameters

onOut() public method

Raises the OnOut event
public onOut ( object $params )
$params object event parameters

onOver() public method

Raises the OnOver event
public onOver ( object $params )
$params object event parameters

onReceive() public method

Raises the OnReceive event
public onReceive ( object $params )
$params object event parameters

onRemove() public method

Raises the OnRemove event
public onRemove ( object $params )
$params object event parameters

onSort() public method

Raises the OnSort event
public onSort ( object $params )
$params object event parameters

onStart() public method

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

onUpdate() public method

Raises the OnUpdate event
public onUpdate ( 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