|
Class TInPlaceTextBox
TInPlaceTextBox Class * TInPlaceTextBox is a component rendered as a label
and allows its contents to be edited by changing the label to a textbox when the
label is clicked or when another control or html element with ID given by setEditTriggerControlID EditTriggerControlID is clicked.
If the OnLoadingText event is handled, a callback request is made
when the label is clicked, while the request is being made the textbox is
disabled from editing. The OnLoadingText event allows you to update the
content of the textbox before the client is allowed to edit the content. After
the callback request returns successfully, the textbox is enabled and the
contents is then allowed to be edited.
Once the textbox loses focus, if setAutoPostBack AutoPostBack is true
and the textbox content has changed, a callback request is made and the OnTextChanged event is raised like that of the TActiveTextBox. During the
request, the textbox is disabled.
After the callback request returns sucessfully, the textbox is enabled. If
the setAutoHideTextBox AutoHideTextBox property is true, then the
textbox will be hidden and the label is then shown.
Since 3.1.2, you can set the setReadOnly ReadOnly property to make
the control not editable. This property can be also changed on callback
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TTextBox
implements
IPostBackDataHandler,
IValidatable,
IDataRenderer
-
TActiveTextBox
implements
ICallbackEventHandler,
IActiveControl
-
TInPlaceTextBox
Methods summary
public
|
#
__construct( )
Sets the auto post back to true by default.
Sets the auto post back to true by default.
Overrides
|
public
|
#
setAutoHideTextBox( boolean $value )
Parameters
- $value
boolean true to hide the textbox after losing focus.
|
public
boolean
|
#
getAutoHideTextBox( )
Returns
boolean true will hide the textbox after losing focus.
|
public
|
#
setDisplayTextBox( boolean $value )
Parameters
- $value
boolean true to display the edit textbox
|
public
boolean
|
#
getDisplayTextBox( )
Returns
boolean true to display the edit textbox
|
protected
|
#
callClientFunction( string $func, mixed $value )
Calls the client-side static method for this control class.
Calls the client-side static method for this control class.
Parameters
- $func
string static method name
- $value
mixed method parmaeter
|
public
|
#
setEditTriggerControlID( string $value )
Parameters
- $value
string ID of the control that can trigger to edit the textbox
|
public
string
|
#
getEditTriggerControlID( )
Returns
string ID of the control that can trigger to edit the textbox
|
protected
string
|
#
getExternalControlID( )
Returns
string edit trigger control client ID.
|
public
|
#
setText( string $value )
On callback response, the inner HTMl of the label and the value of the
textbox is updated
On callback response, the inner HTMl of the label and the value of the
textbox is updated
Parameters
- $value
string the text value of the label
Overrides
|
public
|
#
setReadOnly( boolean $value )
Update ClientSide Readonly property
Update ClientSide Readonly property
Parameters
Since
3.1.2
Overrides
|
protected
string
|
#
getTagName( )
Returns
string tag name of the label.
Overrides
|
public
|
#
renderContents( THtmlWriter $writer )
Renders the body content of the label.
Renders the body content of the label.
Parameters
Overrides
|
protected
string
|
#
getLabelClientID( )
Returns
string label client ID
|
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
Overrides
|
protected
array
|
#
getPostBackOptions( )
Returns
array callback options.
Overrides
|
public
|
#
onLoadingText( TCallbackEventParameter $param )
Raised when editing the content is requsted to be loaded from the server
side.
Raised when editing the content is requsted to be loaded from the server
side.
Parameters
|
protected
string
|
#
getClientClassName( )
Returns
string corresponding javascript class name for this TInPlaceTextBox
Overrides
|
protected
|
#
addAttributesToRender( THtmlWriter $writer )
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.
Parameters
- $writer
THtmlWriter
the writer used for the rendering purpose
Overrides
|
public
|
#
onPreRender( mixed $param )
Registers CSS and JS. This method is invoked right before the control
rendering, if the control is visible.
Registers CSS and JS. This method is invoked right before the control
rendering, if the control is visible.
Parameters
- $param
mixed event parameter
Overrides
|
protected
|
#
registerClientScript( )
Registers the relevant JavaScript.
Registers the relevant JavaScript.
|
Methods inherited from TTextBox
getAutoCompleteType(),
getAutoPostBack(),
getAutoTrim(),
getCausesValidation(),
getColumns(),
getData(),
getDataChanged(),
getEnableClientScript(),
getIsValid(),
getMaxLength(),
getPersistPassword(),
getReadOnly(),
getRows(),
getSafeText(),
getSafeTextParser(),
getText(),
getTextMode(),
getValidationGroup(),
getValidationPropertyValue(),
getWrap(),
loadPostData(),
onTextChanged(),
raisePostDataChangedEvent(),
renderBeginTag(),
setAutoCompleteType(),
setAutoPostBack(),
setAutoTrim(),
setCausesValidation(),
setColumns(),
setData(),
setEnableClientScript(),
setIsValid(),
setMaxLength(),
setPersistPassword(),
setRows(),
setTextMode(),
setValidationGroup(),
setWrap()
|
Methods inherited from TWebControl
clearStyle(),
copyBaseAttributes(),
createStyle(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getDisplay(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getToolTip(),
getWidth(),
render(),
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
|
|