Class ReportSimpleSearch

Object
   |
   +--ReportSimpleSearch

class ReportSimpleSearch

Defined in widgets/simplesearch.js

Field Detail

buttons

Array buttons

Set of action buttons: send, add, view, clear

changed

Boolean changed

Indicates if the class filters database has changed since last page load

display

Object display

Layer used to display current registered filters

displayVisible

Boolean displayVisible

Holds the current visibility state of the filters

fields

Object fields

Search fields select input

filters

Array filters

Registered filters

form

Object form

Form that contains the seach fields

masks

Array masks

Search masks

name

String name

Report instance name

onSearch

Function onSearch

onSearch handler. This can be defined inside the report's XML specification

operators

Object operators

Search operators select input

searchUrl

String searchUrl

Report target URL

term

Object term

Search term field

ReportSimpleSearch

ReportSimpleSearch(<String> instanceName, <Array> masks, <String> searchUrl)

The ReportSimpleSearch controls the simple search widget that can be included in PHP2Go HTML reports

Parameters:
instanceName - Report instance name
masks - Masks array
searchUrl - Search URL

addFilter

void addFilter(<Boolean> verbose)

Adds a new filter. This method reads the contents of the field, operator and term values and creates a new data filter. The added/removed filters are persisted in a browser cookie

Parameters:
verbose - Enable or disable verbose mode (added success message)

buildFilters

 <private> void buildFilters()

Build HTML code of the filters display DIV. Called just once, inside ReportSimpleSearch.setup()

clearFilters

void clearFilters()

Remove all registered filters and redirect to the original search URL

getCurrentMask

String getCurrentMask()

Retrieve the current active mask, based on the current selected field. If there is no selected field, this method returns null

isValidSearch

Boolean isValidSearch(<Boolean> focus)

Verify if the current search parameters are valid: non empty field, non empty operator and non empty and valid search term

Parameters:
focus - Whether to move focus to the first empty or invalid field

rebuildOperators

 <private> void rebuildOperators()

Called when a new filter field is selected, to rebuild the operators select input based on the mask associated with the selected field

removeFilter

void removeFilter(<Event> e)

Removes an existent filter

Parameters:
e - Event reference

sendSearch

void sendSearch(<Event> e)

Submit the search form

Parameters:
e - Event reference

setup

void setup()

Performs all initialization routines. Build filters display div, restoring persistent filters from cookies. Register all field and button event listeners

toggleFiltersDisplay

void toggleFiltersDisplay()

Toggles visibility of the filters display DIV

validateTerm

 <private> Boolean validateTerm(<String> val)

Validates the search term using Validator.isMask()

Parameters:
val - Search term