Class SeedSearchForm

Description

The SeedSearchForm control class.

This control can be used for to search for all kinds of seeds. It can base the search operation on all class properties of the seed class as well as a custom search filter.

The control can be added to the page with the PHP and JavaScript add functions and can then be retrieved with Wigbi.getControl(id). It requires the seeds that it is to search for.

JAVASCRIPT ********************************

MailForm : BaseControl

Properties:

  • public string searchFilter()
  • public void setSearchFilter(string newVal)
  • public array searchProperties()
  • public void setSearchProperties(array newVal)
  • public string seedClass()
  • public void setSeedClass(string newVal)

Functions:

  • [ASYNC] public static void add(string controlId, string seedClass, array searchProperties, string searchFilter, string targetElementId, function onAdd())
  • public void reset()
  • [ASYNC] public void submit()

Events:

  • public bool onPreSubmit()
  • public void onSubmit(array searchResult)

Override onPreSubmit to set what to do before the form is being submitted. If it returns false, the submit operation will abort.

Override onSubmit to set what to do when the submit operation has finished. By default, it alerts that the mail has been sent.

LANGUAGE HANDLING *************************

The following language parameters are used by the control:

  • [controlId] SeedSearchForm submit
  • [controlId] SeedSearchForm submitted
  • [controlId] SeedSearchForm submitting

Located in /wigbi_controls/SeedSearchForm.php (line 85)

BaseControl
   |
   --SeedSearchForm
Method Summary
 static void add (string $controlId, string $seedClass, array $searchProperties, [string $searchFilter = ""])
 SeedSearchForm __construct ()
Methods
static add (line 240)

Add a SeedSearchForm control to the page.

  • access: public
static void add (string $controlId, string $seedClass, array $searchProperties, [string $searchFilter = ""])
  • string $controlId: The unique control ID.
  • string $seedClass: The seed class that is to be handled by the control.
  • array $searchProperties: The search properties that the search text is to match.
  • string $searchFilter: The search filter that is to complete the free text search; default blank.
Constructor __construct (line 96)

Create an instance of the control.

This constructor is only intended to be used by Wigbi at startup.

  • access: public
SeedSearchForm __construct ()

Redefinition of:
BaseControl::__construct()
Create an instance of the class.

Inherited Methods

Inherited From BaseControl

 BaseControl::__construct()
 BaseControl::closeForm()
 BaseControl::controlId()
 BaseControl::isPostBackSource()
 BaseControl::javaScript()
 BaseControl::openForm()
 BaseControl::registerJavaScript()
 BaseControl::submit()

Documentation generated on Sun, 27 Dec 2009 20:12:06 +0100 by phpDocumentor 1.4.1