Class P4A_Table

Description

Tabular rapresentation of a data source.

This is a complex widget that's used to allow users to navigate data sources and than (for example) edit a record or view details etc...

Located in /p4a/objects/widgets/table.php (line 43)

P4A_Object
   |
   --P4A_Widget
      |
      --P4A_Table
Variable Summary
Method Summary
Variables
array $cols = array() (line 79)

Stores the table's structure (table_cols)

  • access: public
P4A_Data_Source $data = null (line 49)

Data source associated with the table

  • access: public
P4A_Table_Navigation_Bar $navigation_bar = null (line 55)

The gui widgets to allow table navigation

  • access: public
P4A_Table_Rows $rows = null (line 67)

All the table's rows

  • access: public
P4A_Toolbar $toolbar = null (line 61)

The table toolbar

  • access: public
boolean $_auto_navigation_bar = true (line 91)

Automatically add the navigation bar?

  • access: protected
array $_cols_order = array() (line 85)

Displaying order of columns

  • access: protected
integer $_current_page_number = 1 (line 97)

Wich page is shown?

  • access: protected
boolean $_show_headers = true (line 73)

Decides if the table will show the "field's header" row

  • access: protected

Inherited Variables

Inherited from P4A_Widget

P4A_Widget::$actions
P4A_Widget::$enabled
P4A_Widget::$label
P4A_Widget::$properties
P4A_Widget::$style
P4A_Widget::$template_name
P4A_Widget::$use_template
P4A_Widget::$visible
P4A_Widget::$_css_classes
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
Methods
Constructor __construct (line 102)
  • access: public
P4A_Table __construct (string $name)
  • string $name: Mnemonic identifier for the object

Redefinition of:
P4A_Widget::__construct()
addActionCol (line 155)

Adds a special clickable column

  • access: public
P4A_Table addActionCol (string $column_name)
  • string $column_name
addCol (line 141)

Adds a column to the data structure

  • access: protected
P4A_Table addCol (string $column_name)
  • string $column_name
getAsString (line 167)

Returns the HTML rendered object

  • access: public
string getAsString ()

Redefinition of:
P4A_Widget::getAsString()
Returns the HTML rendered widget.
getCols (line 326)

Return all column names

  • access: public
array getCols ()
getCurrentPageNumber (line 425)

Returns the current page number

  • access: public
integer getCurrentPageNumber ()
getInvisibleCols (line 360)

Return an array with all names of invisible columns

  • access: public
array getInvisibleCols ()
getVisibleCols (line 335)

Return an array with all names of visible columns

  • access: public
array getVisibleCols ()
hideHeaders (line 316)

Hides the bar with column names

  • access: public
P4A_Table hideHeaders ()
hideNavigationBar (line 295)
  • access: public
P4A_Table hideNavigationBar ()
hideToolbar (line 276)
  • access: public
P4A_Table hideToolbar ()
setCurrentPageNumber (line 435)

Sets the current page number

  • access: public
P4A_Table setCurrentPageNumber ( $page)
  • $page
setDataStructure (line 127)

Sets the table's structure (fields)

  • access: public
P4A_Table setDataStructure ( $array_fields)
  • array $array_fields
setInvisibleCols (line 404)

Sets all passed columns invisible.

If no array is given, than sets all columns invisible.

  • access: public
P4A_Table setInvisibleCols ([ $cols = array()])
  • array $cols: Columns names in indexed array
setSource (line 115)

Sets the data source that the table will navigate

  • access: public
P4A_Table setSource (P4A_Data_Source $data_source)
setVisibleCols (line 379)

Sets all passed columns visible.

If no array is given, than sets all columns visible.

  • access: public
P4A_Table setVisibleCols ([ $cols = array()])
  • array $cols
showHeaders (line 306)

Shows the bar with column names

  • access: public
P4A_Table showHeaders ()
showNavigationBar (line 285)
  • access: public
P4A_Table showNavigationBar ()
showToolbar (line 267)
  • access: public
P4A_Table showToolbar ()
syncPageWithSource (line 445)

Sets the page number reading it from the data source

  • access: public
P4A_Table syncPageWithSource ()

Inherited Methods

Inherited From P4A_Widget

 P4A_Widget::__construct()
 P4A_Widget::addAction()
 P4A_Widget::addAjaxAction()
 P4A_Widget::addCSSClass()
 P4A_Widget::addTempVar()
 P4A_Widget::changeEvent()
 P4A_Widget::clearTemplateVars()
 P4A_Widget::clearTempVars()
 P4A_Widget::composeStringActions()
 P4A_Widget::composeStringClass()
 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::getCSSClasses()
 P4A_Widget::getHeight()
 P4A_Widget::getLabel()
 P4A_Widget::getProperty()
 P4A_Widget::getStyleProperty()
 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::redesign()
 P4A_Widget::removeCSSClass()
 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::setVisible()
 P4A_Widget::setWidth()
 P4A_Widget::unrequireConfirmation()
 P4A_Widget::unsetProperty()
 P4A_Widget::unsetStyleProperty()
 P4A_Widget::useTemplate()

Inherited From P4A_Object

 P4A_Object::__construct()
 P4A_Object::actionHandler()
 P4A_Object::build()
 P4A_Object::destroy()
 P4A_Object::dropImplement()
 P4A_Object::dropMethod()
 P4A_Object::errorHandler()
 P4A_Object::getId()
 P4A_Object::getName()
 P4A_Object::getObjectType()
 P4A_Object::getParentID()
 P4A_Object::implement()
 P4A_Object::intercept()
 P4A_Object::isActionTriggered()
 P4A_Object::setName()
 P4A_Object::setParentID()
 P4A_Object::void()
 P4A_Object::_loadHelper()
 P4A_Object::__call()

Documentation generated on Tue, 02 Sep 2008 10:04:06 +0200 by phpDocumentor 1.4.2