|
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
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TCheckBox
implements
IPostBackDataHandler,
IValidatable,
IDataRenderer,
ISurroundable
-
TActiveCheckBox
implements
ICallbackEventHandler,
IActiveControl
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
|
public
TBaseActiveCallbackControl
|
#
getActiveControl( )
Returns
Implementation of
|
public
TCallbackClientSide
|
|
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
Implementation of
|
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
|
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
|
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
|
protected
|
#
renderClientControlScript( mixed $writer )
|
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
|
protected
string
|
#
getClientClassName( )
Returns
string corresponding javascript class name for this TActiveCheckBox.
Overrides
|
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
|
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
|
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 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
|
|