Class TActiveTableCell

Description

Implements interfaces:

TActiveTableCell class.

TActiveTableCell is the active counterpart to the original TTableCell control and displays a table cell. The horizontal and vertical alignments of the cell are specified via HorizontalAlign and VerticalAlign properties, respectively.

TActiveTableCell allows the contents of the table cell to be changed during callback. When CellSelected property is set, selecting (clicking on) the cell will perform a callback request causing OnCellSelected event to be fired.

It will also bubble the OnCellSelected event up to it's parent TActiveTableRow control which will fire up the event handlers if implemented.

TActiveTableCell allows the client-side cell 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_cell->render($param->getNewWriter());
  4.  }

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

Located in /Web/UI/ActiveControls/TActiveTableCell.php (line 52)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TTableCell
               |
               --TActiveTableCell
Method Summary
Variables

Inherited Variables

Inherited from TWebControl

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

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

  • access: public
TActiveTableCell __construct ()

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

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

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

Redefinition of:
TTableCell::addAttributesToRender()
Adds attributes to renderer.
getActiveControl (line 72)
  • return: standard callback control options.
  • access: public
TBaseActiveCallbackControl getActiveControl ()
getCellIndex (line 179)

Returns the zero-based index of the TActiveTableCell within the TTableCellCollection of the parent TTableRow control. Raises a TConfigurationException if the cell is no member of the cell collection.

  • return: the zero-based index of the cell
  • access: public
integer getCellIndex ()
getClientClassName (line 88)
  • return: corresponding javascript class name for this TActiveTableCell.
  • access: protected
string getClientClassName ()
getClientSide (line 80)
  • return: client side request options.
  • access: public
TCallbackClientSide getClientSide ()
getPostBackOptions (line 166)

Returns postback specifications for the table cell.

This method is used by framework and control developers.

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

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

  • return: the parent row control
  • access: public
TTableRow getRow ()
onCellSelected (line 115)

This method is invoked when a callback is requested. The method raises 'OnCellSelected' 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 onCellSelected (TActiveTableCellEventParameter $param)
raiseCallbackEvent (line 101)

Raises the callback event. This method is required by ICallbackEventHandler interface. It will raise onCellSelected event with a TActiveTableCellEventParameter containing the zero-based index of the TActiveTableCell.

This method is mainly used by framework and control developers.

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

Renders and replaces the cell'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 TTableCell

TTableCell::addAttributesToRender()
TTableCell::createStyle()
TTableCell::getColumnSpan()
TTableCell::getData()
TTableCell::getHorizontalAlign()
TTableCell::getRowSpan()
TTableCell::getTagName()
TTableCell::getText()
TTableCell::getVerticalAlign()
TTableCell::getWrap()
TTableCell::renderContents()
TTableCell::setColumnSpan()
TTableCell::setData()
TTableCell::setHorizontalAlign()
TTableCell::setRowSpan()
TTableCell::setText()
TTableCell::setVerticalAlign()
TTableCell::setWrap()

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:15 +0200 by phpDocumentor 1.4.3