Class WFDieselNav

Description

The Dieselpoint Faceted Navigation UI placeholder.

This widget coordinates all WFDieselFacet widgets (which are its children). It provides the "cookie trail" of the search and the overall search form.

IMPORTANT: Any module/page using a DieselNav needs to have as its last 4 parameters:

'dpQueryState', 'paginatorState', 'doPopup', 'treeViewPath'

You can have additional parameters, at the beginning, used with setBaseParams().

PHOCOA Builder Setup:

Required:

Optional:

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

WFObject
   |
   --WFView
      |
      --WFWidget
         |
         --WFDieselNav
Variable Summary
Method Summary
static void exposedProperties ()
WFDieselNav __construct ( $id,  $page)
void baseURL ()
void facetFilterNav ( $facet)
void facetNavHeight ()
void render ([ $blockContent = NULL])
void setDieselSearch ( $ds)
void setFacetNavOrder ( $orderedList)
Variables
mixed $baseURL (line 38)
  • access: protected
object WFDieselSearchHelper $dieselSearchHelper (line 35)
  • var: The WFDieselSearchHelper object that this facet is linked to.
  • access: protected
mixed $dpQueryStateParamName (line 39)
  • access: protected
mixed $facetNavHeight (line 40)
  • access: protected
mixed $facetNavOrder (line 36)
  • access: protected
mixed $maxFacetsToShow (line 37)
  • access: protected
mixed $searchAction (line 41)
  • access: protected
mixed $showLoadingMessage (line 42)
  • 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 61)
  • access: public
static void exposedProperties ()

Redefinition of:
WFWidget::exposedProperties()
Constructor __construct (line 47)

Constructor.

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

Redefinition of:
WFWidget::__construct()
Constructor.
baseURL (line 98)
void baseURL ()
canPushValueBinding (line 367)
void canPushValueBinding ()

Redefinition of:
WFWidget::canPushValueBinding()
Does this widget use the "value" binding to WRITE data back to the bindings?
facetFilterNav (line 345)
void facetFilterNav ( $facet)
  • $facet
facetNavHeight (line 74)
void facetNavHeight ()
render (line 121)
void render ([ $blockContent = NULL])
  • $blockContent

Redefinition of:
WFView::render()
Render the view into HTML.
setDieselSearch (line 88)
void setDieselSearch ( $ds)
  • $ds
setFacetNavOrder (line 79)
void setFacetNavOrder ( $orderedList)
  • $orderedList
showLoadingMessage (line 93)
void showLoadingMessage ()

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

Documentation generated on Sun, 28 Sep 2008 18:24:36 -0400 by phpDocumentor 1.4.1