PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TActiveTableCell

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 setHorizontalAlign HorizontalAlign and setVerticalAlign VerticalAlign properties, respectively.

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

It will also bubble the onCellSelected 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.

function callback_request($sender, $param)
{
    $this->active_cell->render($param->getNewWriter());
}

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

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TTableCell implements IDataRenderer
Extended by TActiveTableCell implements ICallbackEventHandler, IActiveControl
Package: System\Web\UI\ActiveControls
Copyright: Copyright © 2009 LANDWEHR Computer und Software GmbH
License: http://www.pradosoft.com/license/
Author: LANDWEHR Computer und Software GmbH <programmierung@landwehr-software.de>
Version: $Id$
Since: 3.1.9
Located at Web/UI/ActiveControls/TActiveTableCell.php
Methods summary
public
# __construct( )

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

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

Overrides

TControl::__construct()
public TBaseActiveCallbackControl
# getActiveControl( )

Returns

TBaseActiveCallbackControl
standard callback control options.

Implementation of

IActiveControl::getActiveControl()
public TCallbackClientSide
# getClientSide( )

Returns

TCallbackClientSide
client side request options.
protected string
# getClientClassName( )

Returns

string
corresponding javascript class name for this TActiveTableCell.
public
# raiseCallbackEvent( TCallbackEventParameter $param )

Raises the callback event. This method is required by ICallbackEventHandler interface. It will raise onCellSelected OnCellSelected event with a TActiveTableCellEventParameter containing the zero-based index of the TActiveTableCell. This method is mainly used by framework and control developers.

Raises the callback event. This method is required by ICallbackEventHandler interface. It will raise onCellSelected OnCellSelected event with a TActiveTableCellEventParameter containing the zero-based index of the TActiveTableCell. This method is mainly used by framework and control developers.

Parameters

$param
TCallbackEventParameter
the event parameter

Implementation of

ICallbackEventHandler::raiseCallbackEvent()
public
# onCellSelected( TActiveTableCellEventParameter $param )

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.

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.

Parameters

$param
TActiveTableCellEventParameter
event parameter to be passed to the event handlers
protected
# addAttributesToRender( THtmlWriter $writer )

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

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

Parameters

$writer
THtmlWriter
the writer responsible for rendering

Overrides

TTableCell::addAttributesToRender()
public
# render( THtmlWriter $writer )

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.

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.

Parameters

$writer
THtmlWriter
html writer

Overrides

TWebControl::render()
protected array
# getPostBackOptions( )

Returns postback specifications for the table cell. This method is used by framework and control developers.

Returns postback specifications for the table cell. This method is used by framework and control developers.

Returns

array
parameters about how the row defines its postback behavior.
public integer
# getCellIndex( )

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.

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.

Returns

integer
the zero-based index of the cell
public TTableRow
# getRow( )

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

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

Returns

TTableRow
the parent row control
Methods inherited from TTableCell
createStyle(), getColumnSpan(), getData(), getHorizontalAlign(), getRowSpan(), getTagName(), getText(), getVerticalAlign(), getWrap(), renderContents(), setColumnSpan(), setData(), setHorizontalAlign(), setRowSpan(), setText(), setVerticalAlign(), setWrap()
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), onPreRender(), renderBeginTag(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setDisplay(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__get(), addParsedObject(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBind(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadState(), loadStateRecursive(), onDataBinding(), onInit(), onLoad(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveState(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setEnabled(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Properties inherited from TWebControl
$_decorator
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO