Docs For Class WFMessageBox

Description

A Label widget for our framework.

PHOCOA Builder Setup:

Required:

value The message to display. Can use ValuePattern.

Optional:

mode Built-in types are Info, Warning, Error, and Confirm. You can supply any string, which will be used as the "class" of the div. This allows you to customize the icons for custom messages. Default is "Info".

Located in /framework/widgets/WFMessageBox.php (line 22)

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFMessageBox

Class Constant Summary

WFMESSAGEBOX_CONFIRM = 'Confirm'

WFMESSAGEBOX_ERROR = 'Error'

WFMESSAGEBOX_INFO = 'Info'

WFMESSAGEBOX_WARNING = 'Warning'

Variable Summary

string $mode

Method Summary

static void exposedProperties ()

WFMessageBox __construct ( $id, $page)

void canPushValueBinding ()

void render ([ $blockContent = NULL])

void setMode (string $m)

void setupExposedBindings ()

Variables

string $mode (line 32)

var: The "mode" of the MessageBox.
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::$originalOnEvent
WFView::$page
WFView::$parent

Methods

static method exposedProperties (line 55)

access: public

static void exposedProperties ()

Redefinition of:

WFWidget::exposedProperties()

Constructor __construct (line 37)

Constructor.

WFMessageBox __construct ( $id, $page)

$id
$page

Redefinition of:

WFWidget::__construct(): Constructor.

canPushValueBinding (line 106)

void canPushValueBinding ()

Redefinition of:

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

render (line 72)

void render ([ $blockContent = NULL])

$blockContent

Redefinition of:

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

setMode (line 50)

Set the mode of the message box.

Options are WFMESSAGEBOX_INFO, WFMESSAGEBOX_WARNING, WFMESSAGEBOX_ERROR, or WFMESSAGEBOX_CONFIRM.

void setMode (string $m)

string $m: The mode to use.

setupExposedBindings (line 62)

void setupExposedBindings ()

Redefinition of:

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

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

Class Constants

WFMESSAGEBOX_CONFIRM = 'Confirm' (line 27)

WFMESSAGEBOX_ERROR = 'Error' (line 26)

WFMESSAGEBOX_INFO = 'Info' (line 24)

WFMESSAGEBOX_WARNING = 'Warning' (line 25)