This widget allows a tree navigation within a P4A_DB_Source.

• author: Fabrizio Balliano <fabrizio.balliano@crealabs.it>

Located in /p4a/objects/widgets/db_navigator.php (line 44)

P4A_Object
   |
   --P4A_Widget
      |
      --P4A_DB_Navigator

boolean $allow_movement_to_root = false (line 100)

Allows user to create new root element (with parent_id = null)

• access: private

boolean $allow_roots_movement = false (line 93)

Allows user to move also the root elements

• access: private

string $description = "" (line 65)

The description field name

• access: private

boolean $enable_selected_element = false (line 107)

Is selected element clickable?

• access: private

boolean $expand_all = true (line 72)

Expand whole tree or collapse?

• access: private

string $field_to_update_on_movement = null (line 86)

When moving a record, this field is updated

• access: private

string $recursor = "__recursor" (line 58)

The recursion field name

• access: private

P4A_DB_Source $source = null (line 51)

The P4A_DB_Source used for navigation

• access: private

integer $trim = 0 (line 79)

Trim after this number of characters

• access: private

Inherited Variables

Inherited from P4A_Widget

P4A_Widget::$actions
P4A_Widget::$enabled
P4A_Widget::$label
P4A_Widget::$map_actions
P4A_Widget::$properties
P4A_Widget::$style
P4A_Widget::$template_name
P4A_Widget::$use_template
P4A_Widget::$value
P4A_Widget::$visible
P4A_Widget::$_temp_vars
P4A_Widget::$_tpl_vars

Inherited from P4A_Object

P4A_Object::$_helpers
P4A_Object::$_id
P4A_Object::$_map_actions
P4A_Object::$_name
P4A_Object::$_objects
P4A_Object::$_parent_id

Constructor P4A_DB_Navigator (line 114)

The constructor

• access: public

P4A_DB_Navigator P4A_DB_Navigator (string $name)

• string $name: The name of the widget

allowMovement (line 186)

Enable/disable movement of setions (only if AJAX is enabled)

• access: public

void allowMovement (mixed &$field)

• mixed &$field: (false|parent_id field on your mask)

allowMovementToRoot (line 207)

Enable/disable movement of sections to root (parent_id = null)

• access: public

void allowMovementToRoot ([boolean $allow = true])

• boolean $allow

allowRootsMovement (line 197)

Enable/disable movement of root sections (parent_id = null)

• access: public

void allowRootsMovement ([boolean $allow = true])

• boolean $allow

collapse (line 176)

Sets if the tree is collapsed or not.

• access: public

void collapse ([boolean $value = true])

• boolean $value: The value

enableSelectedElement (line 217)

Is selected element clickable?

• access: public

void enableSelectedElement ([boolean $enable = true])

• boolean $enable

expandAll (line 166)

Sets if the tree is expanded or not.

• access: public

void expandAll ([boolean $value = true])

• boolean $value: The value

getAsString (line 222)

void getAsString ([ $id = null])

• $id

---

Redefinition of:

P4A_Widget::getAsString()

Returns the HTML rendered widget.

getPath (line 343)

void getPath ( $id,  $table,  $pk)

• $id
• $table
• $pk

onClick (line 363)

OnClick event interceptor.

• access: private

void onClick (array $params)

• array $params: All the parameters passed by the HTML form

---

Redefinition of:

P4A_Widget::onClick()

Wrapper used to add the handling of OnClick action.

onMovement (line 392)

Event interceptor when user moves an element to another subtree

• access: private

void onMovement ()

setDescription (line 146)

Sets the field name used to print out the description in the tree.

• access: public

void setDescription (string $field_name)

• string $field_name: The field name

setRecursor (line 136)

Sets the field name used to recursively navigate the P4A_DB_Source.

• access: public

void setRecursor ( $field_name)

• $field_name

setSource (line 126)

Sets the source of the tree, it must be a P4A_DB_Source.

• access: public

void setSource (P4A_DB_Source &$source)

• P4A_DB_Source &$source: The DB source to navigate.

setTrim (line 156)

Trims description after x chars (0 = disabled).

• access: public

void setTrim (integer $chars)

• integer $chars: Num of chars

_getAsString (line 280)

void _getAsString ( $id,  &$all,  $obj_id,  $table,  $pk,  $order,  $current, [ $recurse = true])

• $id
• &$all
• $obj_id
• $table
• $pk
• $order
• $current
• $recurse

_trim (line 376)

Trims a text after a fixed number of characters.

• access: private

void _trim (string $text)

• string $text: The text to be trimmed

Inherited Methods

Inherited From P4A_Widget

P4A_Widget::addAction()
P4A_Widget::addAjaxAction()
P4A_Widget::addTempVar()
P4A_Widget::changeEvent()
P4A_Widget::clearTemplateVars()
P4A_Widget::clearTempVars()
P4A_Widget::composeStringActions()
P4A_Widget::composeStringClassStyle()
P4A_Widget::composeStringProperties()
P4A_Widget::composeStringStyle()
P4A_Widget::disable()
P4A_Widget::display()
P4A_Widget::dropAction()
P4A_Widget::dropTempVar()
P4A_Widget::enable()
P4A_Widget::fetchTemplate()
P4A_Widget::getAccessKey()
P4A_Widget::getAsString()
P4A_Widget::getHeight()
P4A_Widget::getLabel()
P4A_Widget::getProperty()
P4A_Widget::getStyleProperty()
P4A_Widget::getValue()
P4A_Widget::getWidth()
P4A_Widget::isEnabled()
P4A_Widget::isVisible()
P4A_Widget::onBlur()
P4A_Widget::onChange()
P4A_Widget::onClick()
P4A_Widget::onDblClick()
P4A_Widget::onFocus()
P4A_Widget::onKeyDown()
P4A_Widget::onKeyPress()
P4A_Widget::onKeyUp()
P4A_Widget::onMouseDown()
P4A_Widget::onMouseMove()
P4A_Widget::onMouseOver()
P4A_Widget::onMouseUp()
P4A_Widget::onReturnPress()
P4A_Widget::onSelect()
P4A_Widget::p4a_widget()
P4A_Widget::raise()
P4A_Widget::redesign()
P4A_Widget::requireConfirmation()
P4A_Widget::setAccessKey()
P4A_Widget::setBgcolor()
P4A_Widget::setBgimage()
P4A_Widget::setDefaultLabel()
P4A_Widget::setFontColor()
P4A_Widget::setFontWeight()
P4A_Widget::setHeight()
P4A_Widget::setInvisible()
P4A_Widget::setLabel()
P4A_Widget::setProperty()
P4A_Widget::setStyleProperty()
P4A_Widget::setValue()
P4A_Widget::setVisible()
P4A_Widget::setWidth()
P4A_Widget::unrequireConfirmation()
P4A_Widget::unsetProperty()
P4A_Widget::unsetStyleProperty()
P4A_Widget::useTemplate()

Inherited From P4A_Object

P4A_Object::actionHandler()
P4A_Object::build()
P4A_Object::destroy()
P4A_Object::dropIntercept()
P4A_Object::errorHandler()
P4A_Object::getId()
P4A_Object::getName()
P4A_Object::getObjectType()
P4A_Object::getParentID()
P4A_Object::implementMethod()
P4A_Object::intercept()
P4A_Object::isActionTriggered()
P4A_Object::p4a_object()
P4A_Object::setName()
P4A_Object::setParentID()
P4A_Object::void()
P4A_Object::_loadHelper()
P4A_Object::__call()