|
Class TTemplateControl
TTemplateControl class. TTemplateControl is the base class for all controls
that use templates. By default, a control template is assumed to be in a file
under the same directory with the control class file. They have the same file
name and different extension name. For template file, the extension name is
".tpl".
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TCompositeControl
implements
INamingContainer
-
TTemplateControl
Indirect known subclasses
TDataGridItemRenderer,
TDataListItemRenderer,
TWsatLogin,
TWsatScaffolding,
TItemDataRenderer,
TRepeaterItemRenderer,
TScaffoldEditView,
TScaffoldListView,
TScaffoldSearch,
TScaffoldView,
TWsatGenerateAR,
TWsatHome
Methods summary
public
ITemplate |null
|
#
getTemplate( )
Returns the template object associated with this control object.
Returns the template object associated with this control object.
Returns
ITemplate |null
the parsed template, null if none
|
public
|
#
setTemplate( ITemplate $value )
Sets the parsed template. Note, the template will be applied to the whole
control class. This method should only be used by framework and control
developers.
Sets the parsed template. Note, the template will be applied to the whole
control class. This method should only be used by framework and control
developers.
Parameters
|
public
boolean
|
#
getIsSourceTemplateControl( )
Returns
boolean whether this control is a source template control. A source template control
loads its template from external storage, such as file, db, rather than from
within another template.
|
public
string
|
#
getTemplateDirectory( )
Returns
string the directory containing the template. Empty if no template available.
|
protected
ITemplate
|
#
loadTemplate( )
Loads the template associated with this control class.
Loads the template associated with this control class.
Returns
|
public
|
#
createChildControls( )
Creates child controls. This method is overridden to load and instantiate
control template. This method should only be used by framework and control
developers.
Creates child controls. This method is overridden to load and instantiate
control template. This method should only be used by framework and control
developers.
Overrides
|
public
|
#
registerContent( string $id, TContent $object )
Registers a content control.
Registers a content control.
Parameters
- $id
string ID of the content
- $object
TContent
|
public
|
#
registerContentPlaceHolder( string $id, TContentPlaceHolder $object )
Registers a content placeholder to this template control. This method should
only be used by framework and control developers.
Registers a content placeholder to this template control. This method should
only be used by framework and control developers.
Parameters
|
public
string
|
#
getMasterClass( )
Returns
string master class name (in namespace form)
|
public
|
#
setMasterClass( string $value )
Parameters
- $value
string master control class name (in namespace form)
|
public
TTemplateControl |null
|
|
public
|
#
injectContent( string $id, TContent $content )
Injects all content controls (and their children) to the corresponding
content placeholders. This method should only be used by framework and control
developers.
Injects all content controls (and their children) to the corresponding
content placeholders. This method should only be used by framework and control
developers.
Parameters
- $id
string ID of the content control
- $content
TContent
the content to be injected
|
protected
|
#
initRecursive( TControl $namingContainer = null )
Performs the OnInit step for the control and all its child controls. This
method overrides the parent implementation by ensuring child controls are
created first, and if master class is set, master will be applied. Only
framework developers should use this method.
Performs the OnInit step for the control and all its child controls. This
method overrides the parent implementation by ensuring child controls are
created first, and if master class is set, master will be applied. Only
framework developers should use this method.
Parameters
- $namingContainer
TControl
the naming container control
Overrides
|
Methods inherited from TControl
__construct(),
__get(),
addParsedObject(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
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(),
isDescendentOf(),
isObjectRegistered(),
loadRecursive(),
loadState(),
loadStateRecursive(),
onDataBinding(),
onInit(),
onLoad(),
onPreRender(),
onUnload(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
render(),
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 summary
string |
EXT_TEMPLATE |
'.tpl' |
|
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
|
|