Carousel Class Reference

Composant Twitter Bootstrap Carousel. More...

Inheritance diagram for Carousel:

Public Member Functions
	__construct (JsUtils $js)
	attach ($identifier)
	setInterval ($value=5000)
	The amount of time to delay between automatically cycling an item.
	setPause ($event="hover")
	Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.
	setWrap ($value=true)
	Whether the carousel should cycle continuously or have hard stops.
	setKeyboard ($value=true)
	Whether the carousel should react to keyboard events.
	onSlide ($jsCode)
	This event fires immediately when the slide instance method is invoked.
	onSlid ($jsCode)
	This event is fired when the carousel has completed its slide transition.
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 Carousel.

Author

jc

Version

1.001

Definition at line 13 of file Carousel.php.

Constructor & Destructor Documentation

__construct()

__construct

(

JsUtils

$js

)

Reimplemented from SimpleComponent.

Definition at line 15 of file Carousel.php.

Member Function Documentation

attach()

attach

(

$identifier

)

Parameters

String

$identifier

identifiant CSS

Reimplemented from SimpleComponent.

Definition at line 21 of file Carousel.php.

onSlid()

onSlid

(

$jsCode

)

This event is fired when the carousel has completed its slide transition.

Parameters

string

$jsCode

Returns

$this

Definition at line 76 of file Carousel.php.

onSlide()

onSlide

(

$jsCode

)

This event fires immediately when the slide instance method is invoked.

Parameters

string

$jsCode

Returns

$this

Definition at line 67 of file Carousel.php.

setInterval()

setInterval

(

$value = 5000

)

The amount of time to delay between automatically cycling an item.

If false, carousel will not automatically cycle.

Parameters

int

$value

Returns

\Ajax\bootstrap\components\Carousel default : 5000

Definition at line 31 of file Carousel.php.

setKeyboard()

setKeyboard

(

$value = true

)

Whether the carousel should react to keyboard events.

Parameters

string

$value

Returns

\Ajax\bootstrap\components\Carousel default : true

Definition at line 58 of file Carousel.php.

setPause()

setPause

(

$event = "hover"

)

Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.

Parameters

string

$event

Returns

\Ajax\bootstrap\components\Carousel default : 'hover'

Definition at line 40 of file Carousel.php.

setWrap()

setWrap

(

$value = true

)

Whether the carousel should cycle continuously or have hard stops.

Parameters

string

$value

Returns

\Ajax\bootstrap\components\Carousel default : true

Definition at line 49 of file Carousel.php.

---

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

• Ajax/bootstrap/components/Carousel.php