Docs For Class WFRadioGroup

Description

The WFRadioGroup is the "interface" object used to interact with a set of WFRadio widgets.

The WFRadioGroup provides a single object that you can interface with to manage a set of Radio buttons. To bind an object to a set of radio buttons, bind them to the WFRadioGroup's value, and then specify WFRadio's as choices. If you want to use WFDynamic to create the list of WFRadio choices, create a WFRadioGroup and a WFDynamic. Provide the ID of the WFRadioGroup as the parentFormID of the WFDynamic.

If you want to use WFRadio's in your page, they must be contained by a WFRadioGroup. That is, all of the WFRadio's that are a part of the WFRadioGroup should be set up as children of the WFRadioGroup.

PHOCOA Builder Setup:

Required:

value The value of the WFRadio that should be selected.

todo: WFDynamic may need a little refactoring to avoid inserting itself into the view hierarchy. If we refactor, take out WFDynamic stuff.

Located in /framework/widgets/WFRadioGroup.php (line 27)

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFRadioGroup

Method Summary

static void exposedProperties ()

WFRadioGroup __construct ( $id, $page)

void addChild ( $newChild)

void canPushValueBinding ()

void checkRadioForDefault (object WFRadio $radio)

void render ([ $blockContent = NULL])

void restoreState ()

void selectedRadio ()

void setSelectedRadio ( $radio)

void setupExposedBindings ()

void setValue ( $val)

Variables

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

Methods

static method exposedProperties (line 49)

access: public

static void exposedProperties ()

Redefinition of:

WFWidget::exposedProperties()

Constructor __construct (line 41)

Constructor.

WFRadioGroup __construct ( $id, $page)

$id
$page

Redefinition of:

WFWidget::__construct(): Constructor.

addChild (line 130)

void addChild ( $newChild)

$newChild

Redefinition of:

WFView::addChild(): Add a child view to this view.

canPushValueBinding (line 156)

void canPushValueBinding ()

Redefinition of:

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

checkRadioForDefault (line 71)

Check the passed radio to see if it should be selected.

The WFRadios call this from allConfigFinishedLoading so that the WFRadioGroup can make sure that the correct WFRadio is selected by default. We have to do this to support WFDynamic, since sometimes the radios don't exist when WFRadioGroup's allConfigFinishedLoading() would be called.

void checkRadioForDefault (object WFRadio $radio)

object WFRadio $radio: The calling WFRadio instance.

render (line 151)

void render ([ $blockContent = NULL])

$blockContent

Redefinition of:

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

restoreState (line 140)

void restoreState ()

Redefinition of:

WFWidget::restoreState(): Restore the UI state of this widget from the $_REQUEST data.

selectedRadio (line 125)

void selectedRadio ()

setSelectedRadio (line 113)

void setSelectedRadio ( $radio)

$radio

setupExposedBindings (line 56)

void setupExposedBindings ()

Redefinition of:

WFWidget::setupExposedBindings(): Set up all exposed bindings for this widget.

setValue (line 80)

void setValue ( $val)

$val

Redefinition of:

WFWidget::setValue(): Set the value used by the widget.

Inherited Methods

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