Class WFYAHOO_widget_Module

Description

A YAHOO Module widget for our framework.

NOTE: You can include YAHOO containers with WFView or WFViewBlock. If you use WFViewBlock, the block content will be used as the container body.

PHOCOA Builder Setup:

Required:

Optional:

NOTE: Effects don't work on Modules, but do on all subclasses. Bugfix coming from YUI.

  • todo: buildModuleProgrammatically needs a way to specify a parent element to add the module to.

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

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFYAHOO
            |
            --WFYAHOO_widget_Module
Direct descendents
Class Description
WFYAHOO_widget_Overlay A YAHOO Overlay widget for our framework.
Variable Summary
Method Summary
static void exposedProperties ()
WFYAHOO_widget_Module __construct ( $id,  $page)
void addEffect ( $effectName, [ $duration = 0.5])
void initJS ( $blockContent)
void render ([ $blockContent = NULL])
void setBody ( $html)
void setFooter ( $html)
void setHeader ( $html)
void setVisible ( $show)
Variables
mixed $body (line 28)
  • access: protected
mixed $buildModuleProgrammatically (line 51)
  • access: protected
string $containerClass (line 50)
  • var: The name of the YAHOO Container class to instantiate. Subclasses should set this method to the proper name.
  • access: protected
array $effects (line 45)
  • var: An array of ContainerEffects to use for show/hide.
  • todo: Move these to Overlay (which is the first class that can have effects)
  • access: protected
mixed $footer (line 29)
  • access: protected
mixed $header (line 27)
  • access: protected
mixed $monitorresize (line 40)
  • access: protected
Raw $renderTo (line 34)
  • var: javascript string of argument passed to container.render(). Defaults to NULL.
  • access: protected
boolean $visible (line 39)
  • var: Whether or not the module is visible. DEFAULT: false
  • 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 77)
  • access: public
static void exposedProperties ()

Redefinition of:
WFWidget::exposedProperties()

Redefined in descendants as:
Constructor __construct (line 56)

Constructor.

WFYAHOO_widget_Module __construct ( $id,  $page)
  • $id
  • $page

Redefinition of:
WFYAHOO::__construct()
Constructor.

Redefined in descendants as:
addEffect (line 93)
void addEffect ( $effectName, [ $duration = 0.5])
  • $effectName
  • $duration
initJS (line 187)
void initJS ( $blockContent)
  • $blockContent

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

Redefined in descendants as:
render (line 140)
void render ([ $blockContent = NULL])
  • $blockContent

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

Redefined in descendants as:
setBody (line 130)
void setBody ( $html)
  • $html
setBuildModuleProgrammatically (line 84)
  • access: public
void setBuildModuleProgrammatically ( $b)
  • $b
setFooter (line 135)
void setFooter ( $html)
  • $html
setHeader (line 125)
void setHeader ( $html)
  • $html
setupExposedBindings (line 99)
void setupExposedBindings ()

Redefinition of:
WFWidget::setupExposedBindings()
Set up all exposed bindings for this widget.
setVisible (line 120)
void setVisible ( $show)
  • $show

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()

Documentation generated on Thu, 14 May 2009 16:20:50 -0400 by phpDocumentor 1.4.2