Docs For Class WFJumpSelect

Description

A Select widget for our framework that will "jump" to a new URL when the user selects an item.

This is implemented via JavaScript. You should account for non-JS browsers by having a button and appropriate action handler.

PHOCOA Builder Setup:

Required:

value or values, depending on multiple.

Optional:

Located in /framework/widgets/WFJumpSelect.php (line 30)

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFSelect
            |
            --WFJumpSelect

Variable Summary

string $baseURL

Method Summary

static void exposedProperties ()

WFJumpSelect __construct ( $id, $page)

string baseURL ()

void canPushValueBinding ()

void doJump ()

void render ([ $blockContent = NULL])

void setBaseURL (string $url)

void setupExposedBindings ()

Variables

string $baseURL (line 35)

var: The base URL that should be used before appending the "value" for the redirect. If this is left blank, supply the ENTIRE URL as the value.
access: protected

Inherited Variables

Inherited from WFSelect

WFSelect::$contentLabels
WFSelect::$contentValues
WFSelect::$labelFormatter
WFSelect::$labelFormatterSkipFirst
WFSelect::$multiple
WFSelect::$options
WFSelect::$values
WFSelect::$visibleItems
WFSelect::$width

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

static method exposedProperties (line 46)

access: public

static void exposedProperties ()

Redefinition of:

WFSelect::exposedProperties()

Constructor __construct (line 40)

Constructor.

WFJumpSelect __construct ( $id, $page)

$id
$page

Redefinition of:

WFSelect::__construct(): Constructor.

baseURL (line 84)

Get the base URL for the WFJumpSelect.

return: The base URL for the WFJumpSelect.

string baseURL ()

canPushValueBinding (line 65)

void canPushValueBinding ()

Redefinition of:

WFSelect::canPushValueBinding()

doJump (line 96)

Do an HTTP 302 redirect to the selected item. This is a helper function for the Action handler for non-JS clients.

$page->outlet('myWFJumpSelect')->doJump();

void doJump ()

render (line 102)

void render ([ $blockContent = NULL])

$blockContent

Redefinition of:

WFSelect::render()

setBaseURL (line 74)

Set the base URL for the WFJumpSelect.

void setBaseURL (string $url)

string $url: The base URL for the WFJumpSelect. If NULL, use the "value". If not NULL, append the "value" to baseURL.

setupExposedBindings (line 53)

void setupExposedBindings ()

Redefinition of:

WFSelect::setupExposedBindings()

Inherited Methods

Inherited From WFSelect

WFSelect::__construct()
WFSelect::addValue()
WFSelect::assertMultiple()
WFSelect::canPushValueBinding()
WFSelect::contentLabels()
WFSelect::contentValues()
WFSelect::exposedProperties()
WFSelect::labelFormatter()
WFSelect::multiple()
WFSelect::processBindingOptions()
WFSelect::pushBindings()
WFSelect::render()
WFSelect::restoreState()
WFSelect::setContentLabels()
WFSelect::setContentValues()
WFSelect::setFormatter()
WFSelect::setJSonChange()
WFSelect::setLabelFormatter()
WFSelect::setMultiple()
WFSelect::setOptions()
WFSelect::setupExposedBindings()
WFSelect::setValue()
WFSelect::setValues()
WFSelect::setVisibleItems()
WFSelect::value()
WFSelect::valueIsSelected()
WFSelect::valueLabel()
WFSelect::values()
WFSelect::valuesLabels()
WFSelect::visibleItems()

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