|
Class TScaffoldSearch
TScaffoldSearch provide a simple textbox and a button that is used to perform
search on a TScaffoldListView with ID given by setListViewID
ListViewID.
The getSearchText SearchText property is a TTextBox and the getSearchButton SearchButton property is a TButton with label value
"Search".
Searchable fields of the Active Record can be restricted by specifying a
comma delimited string of allowable fields in the setSearchableFields
SearchableFields property. The default is null, meaning that most text type
fields are searched (the default searchable fields are database dependent).
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TCompositeControl
implements
INamingContainer
-
TTemplateControl
-
TScaffoldBase
-
TScaffoldSearch
Methods summary
protected
TScaffoldListView
|
|
public
|
#
setListViewID( string $value )
Parameters
- $value
string ID of the TScaffoldListView this search control belongs to.
|
public
string
|
#
getListViewID( )
Returns
string ID of the TScaffoldListView this search control belongs to.
|
public
boolean
|
#
bubbleEvent( TControl $sender, TEventParameter $param )
Sets the SearchCondition of the TScaffoldListView as the search terms given
by the text of the search text box.
Sets the SearchCondition of the TScaffoldListView as the search terms given
by the text of the search text box.
Parameters
Returns
boolean true if the event bubbling is handled and no more bubbling.
Overrides
|
protected
string
|
#
createSearchCondition( )
Returns
string the search criteria for the search terms in the search text box.
|
protected
array
|
#
getFields( )
Returns
array list of fields to be searched.
|
public
string
|
#
getSearchableFields( )
Returns
string comma delimited list of fields that may be searched.
|
public
|
#
setSearchableFields( string $value )
Parameters
- $value
string comma delimited list of fields that may be searched.
|
public
TButton
|
#
getSearchButton( )
Returns
TButton
button with default label "Search".
|
public
TTextBox
|
|
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(),
onLoad(),
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
|
|