Class RaxanUIWidget

Description
Description | Vars (details) | Methods (details)

Raxan User Interface Widget Class

This class stores a reference to a single DOM element that is used to render the widget

  • property: string $elmId: Element id
  • property: string $elmMarkup: Default UI html markup
  • property: DOMElement $contentElement: Used as a proxy element to display text and html content
  • property: array $properties: An array or ui Element properties
  • property: string $preserveState: Default state mode. set to local or session to preserve state within a component
  • property: string $background: Sets background color or image
  • property: string $foregound: Sets forground color
  • property: string $bordercolor: Sets border color
  • property: int $borderwidth: Sets border width value
  • property: int $borderradius: Sets border radius value
  • property: int $height: Sets the height of the widget
  • property: int $width: Sets the width of the widget
  • property: boolean $enableDefaultUIProperties: Enables default UI properties such as borderradius, bordercolor, borderwidth, etc
  • abstract:

Located in /raxan.ui.php (line 27) 

RaxanBase
   |
   --RaxanElement
      |
      --RaxanUIWidget
Variable Summary
Description | Vars (details) | Methods (details)
mixed $contentElement
mixed $element
mixed $elmId
mixed $elmMarkup
mixed $enableDefaultUIProperties
mixed $isRendered
mixed $isUIWidget
mixed $preserveState
mixed $properties
Method Summary
Description | Vars (details) | Methods (details)
RaxanUIWidget __construct ( $id, [ $properties = null])
void __destruct ()
mixed getProperty (mixed $name)
mixed handleEventBinding ( &$type,  &$options,  &$local, string $type, array $options, boolean $local)
boolean handleStateData (string $mode,  &$data, [boolean $save = false], array $data)
RaxanUIWidget loadInterface ()
RaxanUIWidget renderInterface ()
RaxanUIWidget selectable ([array $opt = null])
RaxanUIWidget setProperty (string $name, mixed $value)
RaxanUIWidget sortable ([array $opt = null])
boolean _bind ( &$type,  &$options,  &$local, string $type, array $options, boolean $local)
boolean _bindData ( &$data,  &$opt, mixed $data, array $opt)
void _config ()
void _destroy ()
void _init ()
void _load ()
void _prerender ()
mixed _property (string $name, [mixed $value = null], [boolean $writeMode = false])
void _restore ( $mode,  &$data)
void _save ( $mode,  &$data)
void __get ( $name)
void __set ( $name,  $value)
Variables
Description | Vars (details) | Methods (details)
mixed $contentElement (line 33)
  • access: protected
mixed $element (line 32)
  • access: protected
mixed $elmId (line 31)
  • access: protected
mixed $elmMarkup = '<div />' (line 36)
  • access: protected
mixed $enableDefaultUIProperties = true (line 38)
  • access: protected
mixed $isRendered = false (line 35)
  • access: protected
mixed $isUIWidget = true (line 29)
  • access: public
mixed $preserveState (line 34)
  • access: protected
mixed $properties = array() (line 37)
  • access: protected

Inherited Variables

Inherited from RaxanElement

RaxanElement::$callMethods
 RaxanElement::$doc
 RaxanElement::$elms
 RaxanElement::$_context
 RaxanElement::$_customValidity
 RaxanElement::$_invalidInp
 RaxanElement::$_length
 RaxanElement::$_modifiedStack
 RaxanElement::$_rootElm
 RaxanElement::$_selector
 RaxanElement::$_stack
 RaxanElement::$_storeName
 RaxanElement::$_validInp

Inherited from RaxanBase

RaxanBase::$events
 RaxanBase::$mObjId
 RaxanBase::$objId
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 41)
  • access: public
RaxanUIWidget __construct ( $id, [ $properties = null])
  • $id
  • $properties
Redefinition of:
RaxanElement::__construct()
RaxanElement(css,context)
Destructor __destruct (line 97)
  • access: public
void __destruct ()
getProperty (line 155)

Get UI Property value

  • access: public
mixed getProperty (mixed $name)
  • mixed $name: Option name
handleEventBinding (line 191)

Handle event binding. Used to interecept UI event bindings

  • access: public
mixed handleEventBinding ( &$type,  &$options,  &$local, string $type, array $options, boolean $local)
  • string $type
  • array $options
  • boolean $local
  • &$type
  • &$options
  • &$local
handleStateData (line 177)

Returns true if state data was handled by the UI. Used by RaxanWebPage::saveElement

  • access: public
boolean handleStateData (string $mode,  &$data, [boolean $save = false], array $data)
  • string $mode
  • array $data
  • boolean $save
  • &$data
loadInterface (line 199)

Triggers the _load event handler to load addition data

  • access: public
RaxanUIWidget loadInterface ()
renderInterface (line 208)

Triggers the _prerender event handler to render the UI widget.

  • access: public
RaxanUIWidget renderInterface ()
selectable (line 239)

Make child elements selectable

  • access: public
RaxanUIWidget selectable ([array $opt = null])
  • array $opt: Optional. See jQuery Selectable plugin
setProperty (line 165)

Set UI Property value

  • access: public
RaxanUIWidget setProperty (string $name, mixed $value)
  • string $name: Option name
  • mixed $value
sortable (line 250)

Make child elements sortable

  • access: public
RaxanUIWidget sortable ([array $opt = null])
  • array $opt: Optional. See jQuery Sortable plugin
_bind (line 126)

Used to setup/intercept UI events. This handler is invoked when an event is attached.

  • return: Returns true if event binding was handled locally
  • access: protected
boolean _bind ( &$type,  &$options,  &$local, string $type, array $options, boolean $local)
  • string $type: Event name or type. Example: click or #click
  • array $options: Event options
  • boolean $local: True for local events
  • &$type
  • &$options
  • &$local
_bindData (line 134)

Used to setup/intercept data binding. This handler is invoked when binding data.

  • return: Returns true if data binding was handled locally
  • access: protected
boolean _bindData ( &$data,  &$opt, mixed $data, array $opt)
  • mixed $data: Dataset
  • array $opt: Optional
  • &$data
  • &$opt
_config (line 111)
  • access: protected
void _config ()
_destroy (line 117)
  • access: protected
void _destroy ()
_init (line 112)
  • access: protected
void _init ()
_load (line 114)
  • access: protected
void _load ()
_prerender (line 115)
  • access: protected
void _prerender ()
_property (line 143)

Used to read or write UI property values

  • access: protected
mixed _property (string $name, [mixed $value = null], [boolean $writeMode = false])
  • string $name: Property name
  • mixed $value: Property value
  • boolean $writeMode
_restore (line 113)
  • access: protected
void _restore ( $mode,  &$data)
  • $mode
  • &$data
_save (line 116)
  • access: protected
void _save ( $mode,  &$data)
  • $mode
  • &$data
__get (line 101)
  • access: public
void __get ( $name)
  • $name
Redefinition of:
RaxanElement::__get()
__set (line 106)
  • access: public
void __set ( $name,  $value)
  • $name
  • $value

Inherited Methods

Inherited From RaxanElement

RaxanElement::__construct()
RaxanElement::add()
RaxanElement::addClass()
RaxanElement::addMethod()
RaxanElement::after()
RaxanElement::alphanumericVal()
RaxanElement::andSelf()
RaxanElement::append()
RaxanElement::appendTo()
RaxanElement::appendToClient()
RaxanElement::appendView()
RaxanElement::attr()
RaxanElement::autoId()
RaxanElement::before()
RaxanElement::bind()
RaxanElement::checkValidity()
RaxanElement::children()
RaxanElement::clearNode()
RaxanElement::click()
RaxanElement::cloneNodes()
RaxanElement::css()
RaxanElement::data()
RaxanElement::dateVal()
RaxanElement::delegate()
RaxanElement::disable()
RaxanElement::draggable()
RaxanElement::droppable()
RaxanElement::emailVal()
RaxanElement::enable()
RaxanElement::end()
RaxanElement::eq()
RaxanElement::expose()
RaxanElement::fadeIn()
RaxanElement::fadeOut()
RaxanElement::filter()
RaxanElement::find()
RaxanElement::findByXPath()
RaxanElement::floatVal()
RaxanElement::get()
RaxanElement::hasClass()
RaxanElement::height()
RaxanElement::hide()
RaxanElement::hideFromClient()
RaxanElement::html()
RaxanElement::inputValues()
RaxanElement::insert()
RaxanElement::insertAfter()
RaxanElement::insertBefore()
RaxanElement::intVal()
RaxanElement::invalidInputs()
RaxanElement::is()
RaxanElement::isHTML()
RaxanElement::localize()
RaxanElement::map()
RaxanElement::matchSelector()
RaxanElement::matchVal()
RaxanElement::modifyClass()
RaxanElement::next()
RaxanElement::nextAll()
RaxanElement::node()
RaxanElement::not()
RaxanElement::outerHtml()
RaxanElement::overlay()
RaxanElement::parent()
RaxanElement::parents()
RaxanElement::position()
RaxanElement::prepend()
RaxanElement::prependTo()
RaxanElement::prependToClient()
RaxanElement::preserveState()
RaxanElement::prev()
RaxanElement::prevAll()
RaxanElement::remove()
RaxanElement::removeAttr()
RaxanElement::removeChildren()
RaxanElement::removeClass()
RaxanElement::removeData()
RaxanElement::removeState()
RaxanElement::replaceAll()
RaxanElement::replaceClient()
RaxanElement::replaceWith()
RaxanElement::resizable()
RaxanElement::selectInnerChild()
RaxanElement::setCustomValidity()
RaxanElement::show()
RaxanElement::showInClient()
RaxanElement::siblings()
RaxanElement::slice()
RaxanElement::slideDown()
RaxanElement::slideUp()
RaxanElement::stack()
RaxanElement::storeName()
RaxanElement::submit()
RaxanElement::text()
RaxanElement::textVal()
RaxanElement::timeout()
RaxanElement::toggleClass()
RaxanElement::traverse()
RaxanElement::trigger()
RaxanElement::unbind()
RaxanElement::unique()
RaxanElement::unstack()
RaxanElement::updateClient()
RaxanElement::val()
RaxanElement::validInputs()
RaxanElement::value()
RaxanElement::width()
RaxanElement::wrap()
RaxanElement::wrapAll()
RaxanElement::__call()
RaxanElement::__get()

Inherited From RaxanBase

RaxanBase::__construct()
RaxanBase::bind()
RaxanBase::log()
RaxanBase::objectId()
RaxanBase::trigger()
RaxanBase::unbind()