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 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. - function callback_request($sender, $param)
- {
- $this->active_cell->render($param->getNewWriter());
- }
Please refer to the original documentation of the regular counterpart for usage.
| 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,
|
| Constructor Summary |
| public |
Creates a new callback control, sets the adapter to TActiveControlAdapter.
|
| Method Summary |
|
protected
void
|
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.
|
|
TBaseActiveCallbackControl
|
|
|
integer
|
|
|
protected
string
|
|
|
protected
array
|
Returns postback specifications for the table cell.
|
|
TTableRow
|
|
|
void
|
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.
|
|
void
|
|
|
void
|
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.
|
| 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()
|
| Methods Inherited From TWebControl |
|
TWebControl::addAttributesToRender(), TWebControl::clearStyle(), TWebControl::copyBaseAttributes(), TWebControl::createStyle(), TWebControl::getAccessKey(), TWebControl::getBackColor(), TWebControl::getBorderColor(), TWebControl::getBorderStyle(), TWebControl::getBorderWidth(), TWebControl::getCssClass(), TWebControl::getDisplay(), TWebControl::getFont(), TWebControl::getForeColor(), TWebControl::getHasStyle(), TWebControl::getHeight(), TWebControl::getStyle(), TWebControl::getTabIndex(), TWebControl::getTagName(), TWebControl::getToolTip(), TWebControl::getWidth(), TWebControl::render(), TWebControl::renderBeginTag(), TWebControl::renderContents(), TWebControl::renderEndTag(), TWebControl::setAccessKey(), TWebControl::setBackColor(), TWebControl::setBorderColor(), TWebControl::setBorderStyle(), TWebControl::setBorderWidth(), TWebControl::setCssClass(), TWebControl::setDisplay(), TWebControl::setForeColor(), TWebControl::setHeight(), TWebControl::setStyle(), TWebControl::setTabIndex(), TWebControl::setToolTip(), TWebControl::setWidth()
|
| Methods Inherited From TControl |
|
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::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()
|
| Methods 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::__get(), TComponent::__set()
|
| Constructor Details |
__construct
Creates a new callback control, sets the adapter to TActiveControlAdapter.
|
| Method Details |
addAttributesToRender
| protected void 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 event is set.
| Input |
| THtmlWriter | $writer | the writer responsible for rendering |
| Output |
| Exception |
|
getActiveControl
|
getCellIndex
| 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.
| Output |
|
integer
| the zero-based index of the cell |
| Exception |
|
getClientClassName
| protected string getClientClassName |
() |
| Output |
|
string
| corresponding javascript class name for this TActiveTableCell. |
| Exception |
|
getPostBackOptions
| protected array getPostBackOptions |
() |
Returns postback specifications for the table cell.
This method is used by framework and control developers.
| Output |
|
array
| parameters about how the row defines its postback behavior. |
| Exception |
|
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.
| Output |
|
TTableRow
| the parent row control |
| Exception |
|
onCellSelected
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.
|
raiseCallbackEvent
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.
|
render
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.
|
|