Modal Class Reference

Composant Twitter Bootstrap Modal. More...

Inheritance diagram for Modal:

Public Member Functions
	__construct (JsUtils $js)
	attach ($identifier)
	setShow ($value)
	Shows the modal when initialized.
	setBackdrop ($value)
	Includes a modal-backdrop element.
	setKeyboard ($value)
	Closes the modal when escape key is pressed.
	setDraggable ($value)
	onShow ($jsCode)
	This event fires immediately when the show instance method is called.
	onShown ($jsCode)
	This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete).
	onHide ($jsCode)
	This event is fired immediately when the hide instance method has been called.
	onHidden ($jsCode)
	This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
	onLoaded ($jsCode)
	This event is fired when the modal has loaded content using the remote option.
Public Member Functions inherited from SimpleExtComponent
	addEvent ($event, $jsCode)
	getScript ()
	addCode ($jsCode)
Public Member Functions inherited from SimpleComponent
	on ($event, $jsCode)
	getAttachTo ()
	getItemSelector ()
	setItemSelector ($itemSelector)
Public Member Functions inherited from BaseComponent
	setParam ($key, $value)
	getParam ($key)
	getParams ()
	compile (JsUtils $js=NULL)
	setParams ($params)
	addParams ($params)
	setDebug ($value)
	setVerbose ($value)

Additional Inherited Members
Data Fields inherited from BaseComponent
	$jquery_code_for_compile =array ()
Protected Member Functions inherited from SimpleExtComponent
	compileJsCodes ()
Protected Member Functions inherited from SimpleComponent
	compileEvents ()
	_createSelector ($itemSelector, $selector)
	compileJQueryCode ()
	setParamCtrl ($key, $value, $typeCtrl)
Protected Member Functions inherited from BaseComponent
	getParamsAsJSON ($params)
Protected Attributes inherited from SimpleExtComponent
	$events =array ()
	$jsCodes =array ()
Protected Attributes inherited from SimpleComponent
	$attachTo
	$itemSelector
	$uiName
	$events
Protected Attributes inherited from BaseComponent
	$params =array ()
	$js

Detailed Description

Composant Twitter Bootstrap Modal.

Author

jc

Version

1.001

Definition at line 14 of file Modal.php.

Constructor & Destructor Documentation

__construct()

__construct

(

JsUtils

$js

)

Reimplemented from SimpleComponent.

Definition at line 16 of file Modal.php.

Member Function Documentation

attach()

attach

(

$identifier

)

Parameters

String

$identifier

identifiant CSS

Reimplemented from SimpleComponent.

Definition at line 21 of file Modal.php.

onHidden()

onHidden

(

$jsCode

)

This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).

Parameters

string

$jsCode

Returns

$this

Definition at line 101 of file Modal.php.

onHide()

onHide

(

$jsCode

)

This event is fired immediately when the hide instance method has been called.

Parameters

string

$jsCode

Returns

$this

Definition at line 92 of file Modal.php.

onLoaded()

onLoaded

(

$jsCode

)

This event is fired when the modal has loaded content using the remote option.

Parameters

string

$jsCode

Returns

$this

Definition at line 110 of file Modal.php.

onShow()

onShow

(

$jsCode

)

This event fires immediately when the show instance method is called.

If caused by a click, the clicked element is available as the relatedTarget property of the event.

Parameters

string

$jsCode

Returns

$this

Definition at line 73 of file Modal.php.

onShown()

onShown

(

$jsCode

)

This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete).

If caused by a click, the clicked element is available as the relatedTarget property of the event.

Parameters

string

$jsCode

Returns

$this

Definition at line 83 of file Modal.php.

setBackdrop()

setBackdrop

(

$value

)

Includes a modal-backdrop element.

Alternatively, specify static for a backdrop which doesn't close the modal on click.

Parameters

Boolean

$value

default : true

Returns

$this

Definition at line 44 of file Modal.php.

setDraggable()

setDraggable

(

$value

)

Definition at line 57 of file Modal.php.

setKeyboard()

setKeyboard

(

$value

)

Closes the modal when escape key is pressed.

Parameters

Boolean

$value

default : false

Returns

$this

Definition at line 53 of file Modal.php.

setShow()

setShow

(

$value

)

Shows the modal when initialized.

Parameters

Boolean

$value

default : true

Returns

$this

Definition at line 34 of file Modal.php.

---

The documentation for this class was generated from the following file:

• Ajax/bootstrap/components/Modal.php