Class P4A_Table_Col

Description

Keeps the data for a single table column

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

P4A_Object
   |
   --P4A_Widget
      |
      --P4A_Table_Col
Variable Summary
Method Summary
 P4A_Table_Col __construct (string $name)
 string getDescription (string $value)
 void getHeader ()
 string getType ()
 boolean|P4A_Table_Col isFormatted ([boolean $formatted = null])
 P4A_Table_Col isSortable ([boolean $sortable = null])
 unknown onClick (array $aParams)
 void order ()
 P4A_Table_Col setHeader (string $header)
 P4A_Table_Col setType (string $type)
 P4A_Table_Col setVisible ([boolean $visible = true])
Variables
P4A_Data_Source $data = null (line 471)

Data source for the field

  • access: public
string $data_description_field = null (line 483)

The data source member that contains the descriptions for this field

  • access: protected
string $data_value_field = null (line 477)

The data source member that contains the values for this field

  • access: protected
boolean $formatted = true (line 489)

Tells if the fields content is formatted or not

  • access: protected
string $header = null (line 465)

Keeps the header string

  • access: protected
boolean $sortable = true (line 495)

Tells if the table can order by this col

  • access: protected
string $_type = "text" (line 501)

Type of the column

  • 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 506)
  • access: public
P4A_Table_Col __construct (string $name)
  • string $name: Mnemonic identifier for the object

Redefinition of:
P4A_Widget::__construct()
getDescription (line 637)

Translate the value with the description

  • access: public
string getDescription (string $value)
  • string $value: The value to translate
getHeader (line 551)

Returns the header for the column.

void getHeader ()
getSourceDescriptionField (line 627)

Returns the name of the data source member that keeps the field's description

  • access: public
string getSourceDescriptionField ()
getSourceValueField (line 618)

Returns the name of the data source member that keeps the field's value.

  • access: public
string getSourceValueField ()
getType (line 695)

Gets the type of the column (text|image|action)

  • access: public
string getType ()
isFormatted (line 661)

Sets/returns if the column should be formatted

  • access: public
boolean|P4A_Table_Col isFormatted ([boolean $formatted = null])
  • boolean $formatted
isSortable (line 673)

Tell if the column is sortable or not

  • access: public
P4A_Table_Col isSortable ([boolean $sortable = null])
  • boolean $sortable
onClick (line 704)
  • access: public
unknown onClick (array $aParams)
  • array $aParams

Redefinition of:
P4A_Widget::onClick()
Wrapper used to add the handling of onClick action
order (line 728)
  • access: public
void order ()
setHeader (line 540)

Sets the header for the column

  • deprecated:
  • access: public
P4A_Table_Col setHeader (string $header)
  • string $header
setSource (line 563)

If we use fields like combo box we have to set a data source.

By default we'll take the data source primary key as value field and the first fiels (not pk) as description.

  • access: public
P4A_Table_Col setSource (P4A_Data_Source $data_source)
setSourceDescriptionField (line 608)

Sets what data source member is the keeper of the field's description

  • access: public
P4A_Table_Col setSourceDescriptionField (string $name)
  • string $name: The name of the data source member
setSourceValueField (line 597)

Sets what data source member is the keeper of the field's value

  • access: public
P4A_Table_Col setSourceValueField (string $name)
  • string $name: The name of the data source member
setType (line 685)

Sets the type of the column (text|image|action)

  • access: public
P4A_Table_Col setType (string $type)
  • string $type
setVisible (line 518)

Sets the column visible (and add it as the last in the coloumn display order)

  • access: public
P4A_Table_Col setVisible ([boolean $visible = true])
  • boolean $visible

Redefinition of:
P4A_Widget::setVisible()

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