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 TActiveTableRow

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 getCells Cells. The horizontal and vertical alignments of the row are specified via setHorizontalAlign HorizontalAlign and setVerticalAlign VerticalAlign properties, respectively.

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

It will also respond to a bubbled onCellSelected OnCellSelected event of a TActiveTableCell child control and fire a onRowSelected 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.

function callback_request($sender, $param)
{
    $this->active_row->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 TTableRow
Extended by TActiveTableRow 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/TActiveTableRow.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 TActiveTableRow.
public
# raiseCallbackEvent( TCallbackEventParameter $param )

Raises the callback event. This method is required by ICallbackEventHandler interface. It will raise onRowSelected OnRowSelected event with a TActiveTableRowEventParameter containing the zero-based index of the TActiveTableRow. This method is mainly used by framework and control developers.

Raises the callback event. This method is required by ICallbackEventHandler interface. It will raise onRowSelected OnRowSelected event with a TActiveTableRowEventParameter containing the zero-based index of the TActiveTableRow. This method is mainly used by framework and control developers.

Parameters

$param
TCallbackEventParameter
the event parameter

Implementation of

ICallbackEventHandler::raiseCallbackEvent()
public boolean
# bubbleEvent( TControl $sender, TEventParameter $param )

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

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

Parameters

$sender
TControl
the sender of the event
$param
TEventParameter
event parameter

Returns

boolean
whether the event bubbling should stop here.

Overrides

TControl::bubbleEvent()
public
# onRowSelected( TActiveTableRowEventParameter $param )

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.

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.

Parameters

$param
TActiveTableRowEventParameter
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 onRowSelected OnRowSelected 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 onRowSelected OnRowSelected event is set.

Parameters

$writer
THtmlWriter
the writer responsible for rendering

Overrides

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

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.

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.

Parameters

$writer
THtmlWriter
html writer

Overrides

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

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

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

Returns

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

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.

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.

Returns

integer
the zero-based index of the row
public TTable
# getTable( )

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

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

Returns

TTable
the parent table control
Methods inherited from TTableRow
addParsedObject(), createControlCollection(), createStyle(), getCells(), getHorizontalAlign(), getTableSection(), getTagName(), getVerticalAlign(), renderContents(), setHorizontalAlign(), setTableSection(), setVerticalAlign()
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(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), 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