Docs For Class WFYAHOO

Description

A YAHOO base class for our framework.

This class provides some base features for all Yahoo! YUI classes such as core js/css includes, etc.

It's also useful as a stub if you're doing custom YUI coding; you can use a single {WFYAHOO} widget to make sure needed libs are loaded.

NOTE: Core js/css include capabilities have been moved to the WFView base class since YUI is now "bundled" with PHOCOA and other PHOCOA widgets rely on YUI.

todo: Also need to decide about phocoa.js and prototype.js; should these be included in the skin, or by the widgets that need them (I think this is tricky b/c then those widgets can't be added via AJAX since these base js files won't exist), or by modules that know they are using them?
abstract:

Located in /framework/widgets/yahoo/WFYAHOO.php (line 183)

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

Direct descendents

Class	Description
WFYAHOO_widget_AutoComplete	A YAHOO AutoComplete widget for our framework. This widget acts like a ComboBox: it is a text field with a pick-list and OPTIONAL custom entry.
WFYAHOO_widget_Calendar	A colorpicker widget. Works in conjunction with a text field.
WFYAHOO_widget_ColorPicker	A colorpicker widget. Works in conjunction with a text field.
WFYAHOO_widget_Logger	A YAHOO Logger widget for our framework.
WFYAHOO_widget_Menu	A YAHOO Menu widget for our framework. This widget allows you to easily create vertical or horizontal multi-level menus.
WFYAHOO_widget_Module	A YAHOO Module widget for our framework.
WFYAHOO_widget_Tab	A wrapper for the individual tab instances.
WFYAHOO_widget_TabView	A YAHOO TabView widget for our framework. This widget allows you to easily create tabbed content.
WFYAHOO_widget_TreeView	A tree widget for our framework. Uses Yahoo! YUI library.
WFYAHOO_widget_YahooScript	A special widget that makes it easy to include Javascript that relies on YAHOO stuff to run.

Variable Summary

mixed $initializeWaitsForID

Method Summary

WFYAHOO __construct ( $id, $page)

void canPushValueBinding ()

string initJS (string $blockContent)

void jsForSimplePropertyConfig ( $widgetVarName, $propertyName, $value)

void jsValueForValue ( $value)

void render ([ $blockContent = NULL])

void yuiloader ()

Variables

mixed $initializeWaitsForID (line 185)

access: protected

Inherited Variables

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::$page
WFView::$parent

Methods

Constructor __construct (line 190)

Constructor.

WFYAHOO __construct ( $id, $page)

$id
$page

Redefinition of:

WFWidget::__construct(): Constructor.

Redefined in descendants as:

WFYAHOO_widget_AutoComplete::__construct() : Constructor.
WFYAHOO_widget_Calendar::__construct() : Constructor.
WFYAHOO_widget_ColorPicker::__construct() : Constructor.
WFYAHOO_widget_Logger::__construct() : Constructor.
WFYAHOO_widget_Menu::__construct() : Constructor.
WFYAHOO_widget_Module::__construct() : Constructor.
WFYAHOO_widget_Overlay::__construct() : Constructor.
WFYAHOO_widget_Panel::__construct() : Constructor.
WFYAHOO_widget_Dialog::__construct() : Constructor.
WFYAHOO_widget_PhocoaDialog::__construct() : Constructor.
WFYAHOO_widget_Tab::__construct() : Constructor.
WFYAHOO_widget_TabView::__construct() : Constructor.
WFYAHOO_widget_TreeView::__construct() : Constructor.
WFYAHOO_widget_YahooScript::__construct() : Constructor.

canPushValueBinding (line 216)

void canPushValueBinding ()

Redefinition of:

WFWidget::canPushValueBinding(): Does this widget use the "value" binding to WRITE data back to the bindings?

Redefined in descendants as:

initJS (line 214)

The initJS function is where YUI widgets perform their bootstrap/initialization.

The YUI integration also includes some delegate methods for performing pre- and post- initialization tasks.

These are the delegate method for YUI widget instantiation:

PHOCOA.widgets.<widgetId>.yuiDelegate.widgetWillLoad()
PHOCOA.widgets.<widgetId>.yuiDelegate.widgetDidLoad(obj) // obj is the YUI widget instance, also available from PHOCOA.runtime.getObject('<widgetId>')

return: The JS code to run to instantiate the YUI widget. This could should define PHOCOA.widgets.<id>.init(), which will be executed to load the widget.
abstract:
access: public

string initJS (string $blockContent)

string $blockContent: The content of the YUI widget as a block, if needed. Some YUI widgets like the Container family need access to this in the bootstrap routines.

Redefined in descendants as:

jsForSimplePropertyConfig (line 244)

void jsForSimplePropertyConfig ( $widgetVarName, $propertyName, $value)

$widgetVarName
$propertyName
$value

jsValueForValue (line 218)

void jsValueForValue ( $value)

$value

render (line 280)

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

All subclasses need a DOM element of the ID of the widget so that the loading bootstrapping works correctly.

void render ([ $blockContent = NULL])

$blockContent

Redefinition of:

WFView::render(): Render the view into HTML.

Redefined in descendants as:

yuiloader (line 197)

access: public

void yuiloader ()

Inherited Methods

Inherited From WFWidget

WFWidget::__construct()
WFWidget::addError()
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::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::validateValueForKey()
WFObject::validateValueForKeyPath()
WFObject::valueForKey()
WFObject::valueForKeyPath()
WFObject::valueForUndefinedKey()
WFObject::__toString()