Docs For Class WFYAHOO_widget

Description

A YAHOO Carousel widget for our framework.

WFYAHOO_widget_Carousel is a BLOCK widget that takes in a <ul> and turns it into a carousel.

PHOCOA Builder Setup:

Required:
none

Optional:
isCircular autoPlay

Located in /framework/widgets/yahoo/WFYAHOO_widget_Carousel.php (line 25)

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFYAHOO
            |
            --WFYAHOO_widget_Carousel

Variable Summary

string $animation

boolean $autoPlay

integer $firstVisible

boolean $isCircular

boolean $isVertical

string $loadItemsHandler

string $navigation

integer $numItems

integer $numVisible

integer $revealAmount

integer $scrollIncrement

integer $selectedItem

Method Summary

static void exposedProperties ()

WFYAHOO_widget_Carousel __construct ( $id, $page)

void canPushValueBinding ()

void initJS ( $blockContent)

void render ([ $blockContent = NULL])

Variables

string $animation (line 62)

var: JSON of the navigation controls to use. DEFAULT: SAM skin setup.
access: protected

boolean $autoPlay (line 66)

var: Number of milliseconds before automatically moving to next item. DEFAULT: 0 (autoplay off).
access: protected

integer $firstVisible (line 30)

var: First visible item. 0-based. DEFAULT: 0.
access: protected

boolean $isCircular (line 50)

var: Is the carousel circular? DEFAULT: false.
access: protected

boolean $isVertical (line 54)

var: Is the carousel vertical? DEFAULT: false.
access: protected

string $loadItemsHandler (line 74)

var: The name of a javascript function which will be called to load additional items.
access: protected

string $navigation (line 58)

var: JSON of the animation to use. DEFAULT: { speed: 0, effect: null }
access: protected

integer $numItems (line 70)

var: Number of items in the carousel. If the passed number is less than then # of elements, truncates carousel. If more, will call WFYAHOO_widget_Carousel::loadItemsHandler javascript function.
access: protected

integer $numVisible (line 34)

var: Number of items visible at once. DEFAULT: 3.
access: protected

integer $revealAmount (line 46)

var: Percentage of the item to be revealed on either side of the main item. DEFAULT: 0.
access: protected

integer $scrollIncrement (line 38)

var: Number of items to scroll at a time. DEFAULT: 1.
access: protected

integer $selectedItem (line 42)

var: Index of the selected item. DEFAULT: 0.
access: protected

Inherited Variables

Inherited from WFYAHOO

WFYAHOO::$initializeWaitsForID

Inherited from WFWidget

WFWidget::$bindings
WFWidget::$class
WFWidget::$errors
WFWidget::$formatter
WFWidget::$hasRestoredState
WFWidget::$hidden
WFWidget::$name
WFWidget::$value
WFWidget::$widgetLabel

Inherited from WFView

WFView::$children
WFView::$cssImports
WFView::$enabled
WFView::$id
WFView::$importInHead
WFView::$jsActions
WFView::$jsEvents
WFView::$jsImports
WFView::$originalOnEvent
WFView::$page
WFView::$parent

Methods

static method exposedProperties (line 99)

access: public

static void exposedProperties ()

Redefinition of:

WFWidget::exposedProperties()

Constructor __construct (line 79)

Constructor.

WFYAHOO_widget_Carousel __construct ( $id, $page)

$id
$page

Redefinition of:

WFYAHOO::__construct(): Constructor.

canPushValueBinding (line 160)

void canPushValueBinding ()

Redefinition of:

WFYAHOO::canPushValueBinding()

initJS (line 124)

void initJS ( $blockContent)

$blockContent

Redefinition of:

WFYAHOO::initJS(): The initJS function is where YUI widgets perform their bootstrap/initialization.

render (line 106)

void render ([ $blockContent = NULL])

$blockContent

Redefinition of:

WFYAHOO::render(): IMPORTANT: The subclasses should get the base class's html, then add the needed code.

Inherited Methods

Inherited From WFYAHOO

WFYAHOO::__construct()
WFYAHOO::canPushValueBinding()
WFYAHOO::initJS()
WFYAHOO::jsForSimplePropertyConfig()
WFYAHOO::jsValueForValue()
WFYAHOO::render()
WFYAHOO::yuiloader()

Inherited From WFWidget

WFWidget::__construct()
WFWidget::addError()
WFWidget::addErrors()
WFWidget::bind()
WFWidget::bindingByName()
WFWidget::bindings()
WFWidget::canPushValueBinding()
WFWidget::errors()
WFWidget::exposedBindings()
WFWidget::exposedProperties()
WFWidget::formattedValue()
WFWidget::formatter()
WFWidget::hasRestoredState()
WFWidget::hidden()
WFWidget::name()
WFWidget::processBindingOptions()
WFWidget::propagateValueToBinding()
WFWidget::pullBindings()
WFWidget::pushBindings()
WFWidget::restoreState()
WFWidget::setFormatter()
WFWidget::setHidden()
WFWidget::setName()
WFWidget::setupExposedBindings()
WFWidget::setValue()
WFWidget::setWidgetLabel()
WFWidget::unbind()
WFWidget::value()
WFWidget::valueForBinding()
WFWidget::widgetLabel()

Inherited From WFView

WFView::__construct()
WFView::addChild()
WFView::allConfigFinishedLoading()
WFView::children()
WFView::cloneWithID()
WFView::enabled()
WFView::exposedProperties()
WFView::getForm()
WFView::getJSActions()
WFView::getListenerJS()
WFView::getListenerJSInScriptTag()
WFView::getOnEvent()
WFView::getWidgetDir()
WFView::getWidgetWWWDir()
WFView::id()
WFView::importCSS()
WFView::importJS()
WFView::jsEndHTML()
WFView::jsStartHTML()
WFView::page()
WFView::parent()
WFView::removeChild()
WFView::render()
WFView::setEnabled()
WFView::setId()
WFView::setJSonBlur()
WFView::setJSonClick()
WFView::setListener()
WFView::setOnEvent()
WFView::setParent()
WFView::yuiPath()

Inherited From WFObject

WFObject::__construct()
WFObject::exposedProperties()
WFObject::getClass()
WFObject::keyPathToTargetAndKey()
WFObject::setValueForKey()
WFObject::setValueForKeyPath()
WFObject::setValuesForKeys()
WFObject::validatedSetValueForKey()
WFObject::validatedSetValueForKeyPath()
WFObject::validateObject()
WFObject::validateValueForKey()
WFObject::validateValueForKeyPath()
WFObject::valueForKey()
WFObject::valueForKeyPath()
WFObject::valueForStaticKey()
WFObject::valueForStaticKeyPath()
WFObject::valueForTargetAndKeyPath()
WFObject::valueForUndefinedKey()
WFObject::valueForUndefinedStaticKey()
WFObject::valuesForKeyPaths()
WFObject::valuesForKeys()
WFObject::_valueForStaticKey()
WFObject::__toString()

Class WFYAHOO_widget_Carousel

Inherited Variables

Inherited Methods