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 TActiveCheckBox

TActiveCheckBox class.

The active control counter part to checkbox. The setAutoPostBack AutoPostBack property is set to true by default. Thus, when the checkbox is clicked a onCallback OnCallback event is raise after OnCheckedChanged event.

The setText Text and setChecked Checked properties can be changed during a callback.

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TCheckBox implements IPostBackDataHandler, IValidatable, IDataRenderer, ISurroundable
Extended by TActiveCheckBox implements ICallbackEventHandler, IActiveControl
Package: System\Web\UI\ActiveControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Since: 3.1
Located at Web/UI/ActiveControls/TActiveCheckBox.php
Methods summary
public
# __construct( )

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.

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.
public
# raiseCallbackEvent( TCallbackEventParameter $param )

Raises the callback event. This method is required by ICallbackEventHandler interface. This method is mainly used by framework and control developers.

Raises the callback event. This method is required by ICallbackEventHandler interface. This method is mainly used by framework and control developers.

Parameters

$param
TCallbackEventParameter
the event parameter

Implementation of

ICallbackEventHandler::raiseCallbackEvent()
public
# onCallback( TCallbackEventParameter $param )

This method is invoked when a callback is requested. The method raises 'OnCallback' 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 'OnCallback' 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
TCallbackEventParameter
event parameter to be passed to the event handlers
public
# setText( string $value )

Updates the button text on the client-side if the setEnableUpdate EnableUpdate property is set to true.

Updates the button text on the client-side if the setEnableUpdate EnableUpdate property is set to true.

Parameters

$value
string
caption of the button

Overrides

TCheckBox::setText()
public
# setChecked( boolean $value )

Sets a value indicating whether the checkbox is to be checked or not. Updates checkbox checked state on the client-side if the setEnableUpdate EnableUpdate property is set to true.

Sets a value indicating whether the checkbox is to be checked or not. Updates checkbox checked state on the client-side if the setEnableUpdate EnableUpdate property is set to true.

Parameters

$value
boolean
whether the checkbox is to be checked or not.

Overrides

TCheckBox::setChecked()
protected
# renderClientControlScript( mixed $writer )

Override parent implementation, no javascript is rendered here instead the javascript required for active control is registered in TWebControl::addAttributesToRender().

Override parent implementation, no javascript is rendered here instead the javascript required for active control is registered in TWebControl::addAttributesToRender().

Overrides

TCheckBox::renderClientControlScript()
protected
# renderInputTag( THtmlWriter $writer, string $clientID, string $onclick )

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.

Since 3.1.4, the javascript code is not rendered if setAutoPostBack AutoPostBack is false

Parameters

$writer
THtmlWriter
the writer for the rendering purpose
$clientID
string
checkbox id
$onclick
string
onclick js

Overrides

TCheckBox::renderInputTag()
protected string
# getClientClassName( )

Returns

string
corresponding javascript class name for this TActiveCheckBox.

Overrides

TCheckBox::getClientClassName()
public TMap
# getLabelAttributes( )

Overrides parent implementation to ensure label has ID.

Overrides parent implementation to ensure label has ID.

Returns

TMap
list of attributes to be rendered for label beside the checkbox

Overrides

TCheckBox::getLabelAttributes()
protected
# renderLabel( THtmlWriter $writer, string $clientID, string $text )

Renders a label beside the checkbox.

Renders a label beside the checkbox.

Parameters

$writer
THtmlWriter
the writer for the rendering purpose
$clientID
string
checkbox id
$text
string
label text

Overrides

TCheckBox::renderLabel()
protected string
# getDefaultLabelID( )

Returns

string
checkbox label ID;
Methods inherited from TCheckBox
getAutoPostBack(), getCausesValidation(), getChecked(), getData(), getDataChanged(), getEnableClientScript(), getInputAttributes(), getIsValid(), getPostBackOptions(), getSpanNeeded(), getSurroundingTagID(), getTagName(), getText(), getTextAlign(), getValidationGroup(), getValidationPropertyValue(), getValue(), getValueAttribute(), loadPostData(), onCheckedChanged(), onPreRender(), raisePostDataChangedEvent(), render(), setAutoPostBack(), setCausesValidation(), setData(), setEnableClientScript(), setIsValid(), setTextAlign(), setValidationGroup(), setValue()
Methods inherited from TWebControl
addAttributesToRender(), clearStyle(), copyBaseAttributes(), createStyle(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), renderBeginTag(), renderContents(), 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