|
Class TScaffoldEditView
Template control for editing an Active Record instance. The
RecordClass determines the Active Record class to be edited. A particular
record can be edited by specifying the setRecordPk RecordPk value (may
be an array for composite keys).
The default editor input controls are created based on the column types. The
editor layout can be specified by a renderer by set the value of the setEditRenderer EditRenderer property to the class name of a class that
implements TScaffoldEditRenderer. A renderer is an external template control
that implements IScaffoldEditRenderer.
The Data of the IScaffoldEditRenderer will be set as the current
Active Record to be edited. The UpdateRecord() method of
IScaffoldEditRenderer is called when request to save the record is
requested.
Validators in the custom external editor template should have the TBaseValidator::setValidationGroup ValidationGroup property set to the value of
the TScaffoldEditView::getValidationGroup() of the TScaffoldEditView instance (the edit view
instance is the Parent of the IScaffoldEditRenderer in most cases.
Cosmetic changes to the default editor should be done using Cascading
Stylesheets. For example, a particular field/property can be hidden by
specifying "display:none" for the corresponding style (each field/property has
unique Css class name as "property_xxx", where xxx is the property name).
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TCompositeControl
implements
INamingContainer
-
TTemplateControl
-
TScaffoldBase
-
TScaffoldEditView
Methods summary
public
|
#
onLoad( TEventParameter $param )
Initialize the editor form if it is Visible.
Initialize the editor form if it is Visible.
Parameters
Overrides
|
public
string
|
#
getEditRenderer( )
Returns
string the class name for scaffold editor. Defaults to empty, meaning not set.
|
public
|
#
setEditRenderer( string $value )
Parameters
- $value
string the class name for scaffold editor. Defaults to empty, meaning not set.
|
public
|
#
setRecordPk( array $value )
Parameters
- $value
array Active Record primary key value to be edited.
|
public
array
|
#
getRecordPk( )
Returns
array Active Record primary key value.
|
protected
TActiveRecord
|
|
public
|
#
initializeEditForm( )
Initialize the editor form
Initialize the editor form
|
protected
|
#
createEditRenderer( TActiveRecord $record, string $classPath )
Instantiate the external edit renderer.
Instantiate the external edit renderer.
Parameters
- $record
TActiveRecord
record to be edited
- $classPath
string external edit renderer class name.
Throws
|
protected
|
#
createRepeaterEditItem( mixed $sender, mixed $param )
Initialize the default editor using the scaffold input builder.
Initialize the default editor using the scaffold input builder.
|
public
boolean
|
#
bubbleEvent( TControl $sender, TEventParameter $param )
Bubble the command name event. Stops bubbling when the page validator false.
Otherwise, the bubble event is continued.
Bubble the command name event. Stops bubbling when the page validator false.
Otherwise, the bubble event is continued.
Parameters
Returns
boolean true if the event bubbling is handled and no more bubbling.
Overrides
|
protected
boolean
|
#
doSave( )
Check the validators, then tries to save the record.
Check the validators, then tries to save the record.
Returns
boolean true if the validators are true, false otherwise.
|
protected
TRepeater
|
#
getInputRepeater( )
Returns
TRepeater
default editor input controls repeater
|
public
TButton
|
#
getSaveButton( )
Returns
TButton
Button triggered to save the Active Record.
|
public
TButton
|
#
getClearButton( )
Returns
TButton
Button to clear the editor inputs.
|
public
TButton
|
#
getCancelButton( )
Returns
TButton
Button to cancel the edit action (e.g. hide the edit view).
|
protected
TScaffoldInputBase
|
#
getScaffoldInputBuilder( TActiveRecord $record )
Create the default scaffold editor control factory.
Create the default scaffold editor control factory.
Parameters
Returns
|
public
string
|
#
getValidationGroup( )
Returns
string editor validation group name.
|
Methods inherited from TScaffoldBase
clearRecordObject(),
copyFrom(),
getDefaultStyle(),
getEnableDefaultStyle(),
getRecordClass(),
getRecordFinder(),
getRecordObject(),
getRecordPkValues(),
getRecordPropertyValues(),
getTableInfo(),
onPreRender(),
setDefaultStyle(),
setEnableDefaultStyle(),
setRecordClass(),
setRecordObject()
|
Methods inherited from TTemplateControl
createChildControls(),
getIsSourceTemplateControl(),
getMaster(),
getMasterClass(),
getTemplate(),
getTemplateDirectory(),
initRecursive(),
injectContent(),
loadTemplate(),
registerContent(),
registerContentPlaceHolder(),
setMasterClass(),
setTemplate()
|
Methods inherited from TControl
__construct(),
__get(),
addParsedObject(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
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(),
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 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
|
|