Class TActiveTableRow

Description

Implements interfaces:

TActiveTableRow class.

TActiveTableRow is the active counterpart to the original TTableRow control and displays a table row. The table cells in the row can be accessed via Cells. The horizontal and vertical alignments of the row are specified via HorizontalAlign and VerticalAlign properties, respectively.

TActiveTableRow allows the contents of the table row to be changed during callback. When RowSelected property is set, selecting (clicking on) the row will perform a callback request causing OnRowSelected event to be fired.

It will also respond to a bubbled onCellSelected event of a TActiveTableCell child control and fire a OnRowSelected event.

TActiveTableRow allows the client-side row contents to be updated during a callback response by getting a new writer, invoking the render method and flushing the output, similar to a TActivePanel control.

  1.  function callback_request($sender$param)
  2.  {
  3.      $this->active_row->render($param->getNewWriter());
  4.  }

Please refer to the original documentation of the regular counterpart for usage.

Located in /Web/UI/ActiveControls/TActiveTableRow.php (line 53)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TTableRow
               |
               --TActiveTableRow
Method Summary
Variables

Inherited Variables

Inherited from TWebControl

TWebControl::$_decorator
Methods
Constructor __construct (line 64)

Creates a new callback control, sets the adapter to TActiveControlAdapter.

  • access: public
TActiveTableRow __construct ()

Redefinition of:
TControl::__construct()
Constructor.
addAttributesToRender (line 144)

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control if the event handler for the onRowSelected event is set.

  • access: protected
void addAttributesToRender (THtmlWriter $writer)
  • THtmlWriter $writer: the writer responsible for rendering

Redefinition of:
TWebControl::addAttributesToRender()
Adds attribute name-value pairs to renderer.
bubbleEvent (line 116)

This method overrides parent's implementation and raises the control's callback event. This will fire the onRowSelected event if an appropriate event handler is implemented.

  • return: whether the event bubbling should stop here.
  • access: public
boolean bubbleEvent (TControl $sender, TEventParameter $param)

Redefinition of:
TControl::bubbleEvent()
This method responds to a bubbled event.
getActiveControl (line 73)
  • return: standard callback control options.
  • access: public
TBaseActiveCallbackControl getActiveControl ()
getClientClassName (line 89)
  • return: corresponding javascript class name for this TActiveTableRow.
  • access: protected
string getClientClassName ()
getClientSide (line 81)
  • return: client side request options.
  • access: public
TCallbackClientSide getClientSide ()
getPostBackOptions (line 185)

Returns postback specifications for the table row.

This method is used by framework and control developers.

  • return: parameters about how the row defines its postback behavior.
  • access: protected
array getPostBackOptions ()
getRowIndex (line 198)

Returns the zero-based index of the TActiveTableRow within the TTableRowCollection of the parent TTable control. Raises a TConfigurationException if the row is no member of the row collection.

  • return: the zero-based index of the row
  • access: public
integer getRowIndex ()
getTable (line 210)

Returns the parent TTable control by looping through all parents until a TTable is found. Raises a TConfigurationException if no table control is found.

  • return: the parent table control
  • access: public
TTable getTable ()
onRowSelected (line 133)

This method is invoked when a callback is requested. The method raises 'OnRowSelected' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.

  • access: public
void onRowSelected (TActiveTableRowEventParameter $param)
raiseCallbackEvent (line 102)

Raises the callback event. This method is required by ICallbackEventHandler interface. It will raise onRowSelected event with a TActiveTableRowEventParameter containing the zero-based index of the TActiveTableRow.

This method is mainly used by framework and control developers.

  • access: public
void raiseCallbackEvent (TCallbackEventParameter $param)
render (line 159)

Renders and replaces the row's content on the client-side. When render() is called before the OnPreRender event, such as when render() is called during a callback event handler, the rendering is defered until OnPreRender event is raised.

  • access: public
void render (THtmlWriter $writer)

Redefinition of:
TWebControl::render()
Renders the control.

Inherited Methods

Inherited From TTableRow

TTableRow::addParsedObject()
TTableRow::createControlCollection()
TTableRow::createStyle()
TTableRow::getCells()
TTableRow::getHorizontalAlign()
TTableRow::getTableSection()
TTableRow::getTagName()
TTableRow::getVerticalAlign()
TTableRow::renderContents()
TTableRow::setHorizontalAlign()
TTableRow::setTableSection()
TTableRow::setVerticalAlign()

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::clearStyle()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getDecorator()
TWebControl::getDisplay()
TWebControl::getEnsureId()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::onPreRender()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setEnsureId()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
TControl::getID()
TControl::getIsSkinApplied()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()
Class Constants

Documentation generated on Mon, 25 Jun 2012 14:37:16 +0200 by phpDocumentor 1.4.3