PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

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
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TCompositeControl implements INamingContainer
Extended by TTemplateControl
Extended by TScaffoldBase
Extended by TScaffoldSearch
Package: System\Data\ActiveRecord\Scaffold
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Version: $Id$
Since: 3.1
Located at Data/ActiveRecord/Scaffold/TScaffoldSearch.php
Methods summary
protected TScaffoldListView
# getListView( )

Returns

TScaffoldListView
the scaffold list view this search box belongs to.
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

$sender
TControl
sender of the event
$param
TEventParameter
event parameters

Returns

boolean
true if the event bubbling is handled and no more bubbling.

Overrides

TControl::bubbleEvent()
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
# getSearchText( )

Returns

TTextBox
search text box.
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 TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
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 TTemplateControl
EXT_TEMPLATE
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
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO