Docs For Class WFYAHOO_widget

Description

A YAHOO Overlay widget for our framework.

PHOCOA Builder Setup:

Required:

Optional:

Located in /framework/widgets/yahoo/WFYAHOO_widget_Overlay.php (line 20)

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFYAHOO
            |
            --WFYAHOO_widget_Module
               |
               --WFYAHOO_widget_Overlay

Direct descendents

Class	Description
WFYAHOO_widget_Panel	A YAHOO Panel widget for our framework.

Variable Summary

boolean $constraintoviewport

boolean $fixedcenter

string $height

boolean $iframe

string $width

integer $x

integer $y

integer $zIndex

Method Summary

static void exposedProperties ()

WFYAHOO_widget_Overlay __construct ( $id, $page)

void canPushValueBinding ()

void initJS ( $blockContent)

void render ([ $blockContent = NULL])

void setContext (string $id, [string $elementCorner = 'tl'], [string $contextCorner = 'tl'])

void setFixedCenter ( $b)

void setHeight (string $w)

void setIFrame ( $b)

void setWidth (string $w)

void setX ( $x)

void setXY ( $x, $y)

void setY ( $y)

void setZIndex ( $i)

Variables

boolean $constraintoviewport (line 54)

var: TRUE to try to constrain the overal inside the viewport. DEFAULT: false
access: protected

boolean $fixedcenter (line 38)

var: TRUE to make the overlay stay "fixed" in the center of the viewport. For this to work properly, be sure to set an explicit width/height. DEFAULT: false
access: protected

string $height (line 46)

var: CSS height for the overlay. DEFAULT: NULL
access: protected

boolean $iframe (line 58)

var: TRUE to use an IFRAME for rendering. To fix z-index/select issue. Automatic for IE. DEFAULT: false; true for IE6 and below.
access: protected

string $width (line 42)

var: CSS width for the overlay. DEFAULT: 300px. Although no default is "required", the panel doesn't look right on IE if there is no width specified.
access: protected

integer $x (line 25)

var: The X coordinate of the overlay.
access: protected

integer $y (line 29)

var: The Y coordinate of the overlay.
access: protected

integer $zIndex (line 50)

var: The z-index value of the overlay.
access: protected

Inherited Variables

Inherited from WFYAHOO_widget_Module

WFYAHOO_widget_Module::$body
WFYAHOO_widget_Module::$buildModuleProgrammatically
WFYAHOO_widget_Module::$containerClass
WFYAHOO_widget_Module::$effects
WFYAHOO_widget_Module::$footer
WFYAHOO_widget_Module::$header
WFYAHOO_widget_Module::$monitorresize
WFYAHOO_widget_Module::$renderTo
WFYAHOO_widget_Module::$visible

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

access: public

static void exposedProperties ()

Redefinition of:

WFYAHOO_widget_Module::exposedProperties()

Redefined in descendants as:

Constructor __construct (line 63)

Constructor.

WFYAHOO_widget_Overlay __construct ( $id, $page)

$id
$page

Redefinition of:

WFYAHOO_widget_Module::__construct(): Constructor.

Redefined in descendants as:

WFYAHOO_widget_Panel::__construct() : Constructor.
WFYAHOO_widget_Dialog::__construct() : Constructor.
WFYAHOO_widget_PhocoaDialog::__construct() : Constructor.

canPushValueBinding (line 232)

void canPushValueBinding ()

Redefinition of:

WFYAHOO_widget_Module::canPushValueBinding()

Redefined in descendants as:

initJS (line 173)

void initJS ( $blockContent)

$blockContent

Redefinition of:

WFYAHOO_widget_Module::initJS()

Redefined in descendants as:

render (line 159)

void render ([ $blockContent = NULL])

$blockContent

Redefinition of:

WFYAHOO_widget_Module::render()

Redefined in descendants as:

setContext (line 151)

Set the context for the content.

void setContext (string $id, [string $elementCorner = 'tl'], [string $contextCorner = 'tl'])

string $id: The element id to anchor near.
string $elementCorner: Which corner of the element to anchor to. One of "tr", "tl", "br", "bl".
string $contextCorner: Which corner of this content to anchor to the element's anchor corner. One of "tr", "tl", "br", "bl".

setFixedCenter (line 93)

void setFixedCenter ( $b)

$b

setHeight (line 113)

Set the height of the module.

void setHeight (string $w)

string $w: Height in CSS terms: 240px, 5in, etc.

setIFrame (line 123)

void setIFrame ( $b)

$b

setWidth (line 103)

Set the width of the module.

void setWidth (string $w)

string $w: Width in CSS terms: 240px, 5in, etc.

setX (line 128)

void setX ( $x)

$x

setXY (line 138)

void setXY ( $x, $y)

$x
$y

setY (line 133)

void setY ( $y)

$y

setZIndex (line 118)

void setZIndex ( $i)

$i

Inherited Methods

Inherited From WFYAHOO_widget_Module

WFYAHOO_widget_Module::__construct()
WFYAHOO_widget_Module::addEffect()
WFYAHOO_widget_Module::canPushValueBinding()
WFYAHOO_widget_Module::exposedProperties()
WFYAHOO_widget_Module::initJS()
WFYAHOO_widget_Module::render()
WFYAHOO_widget_Module::setBody()
WFYAHOO_widget_Module::setBuildModuleProgrammatically()
WFYAHOO_widget_Module::setFooter()
WFYAHOO_widget_Module::setHeader()
WFYAHOO_widget_Module::setupExposedBindings()
WFYAHOO_widget_Module::setVisible()

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_Overlay

Inherited Variables

Inherited Methods