Plumtree Portal UI  
 

SearchFormFactory Methods

The methods of the SearchFormFactory class are listed below. For a complete list of SearchFormFactory class members, see the SearchFormFactory Members topic.

Public Static Methods

GetSearchButton Static convenience method to return the standard portal search button
MakeSearchFormJavascript This is public so it can be used for the "search again" form on the results page; most users of this class should NOT call this method.

Public Instance Methods

AddFilterStatement Add an advanced search-style filter to the search form. For example: factory.AddFilterStatement(PT_INTRINSICS.PT_PROPERTY_PROVIDERCLSID, PT_FILTEROPS.PT_FILTEROP_CONTAINS, "61266621"); This will add a filter for things with a provider classid that contains "61266621". Note that you can make multiple calls to this method to produce a set of filter statements. The default is for these to be 'and-ed' together, but you can change that by calling SetFilterClauseOperator. You should call this before calling GetForm.
AddOptionalSettingOverloaded. Add an optional setting that will be set only if the indicated optionName is selected
AddRequiredSettingOverloaded. Add a required setting (constraint) that will be added to all searches generated by this form.
AddRequiredSettings Add a group of required settings (constraint) that will be added to all searches generated by this form.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ForceBannerSearchDefaults Special flag that forces this search box to have all the user's banner search defaults applied to it. Should only be used by the banner search box itself and the "search again" box on the search results page, otherwise you can't be sure what you get.
ForceSubmitOfEnclosingForm Yet another hack special flag. If called, and we're embedded within another form, then force the form to be submitted through javascript when the user hits Enter in the search box. THIS IS DANGEROUS*; some browsers also submit the form automatically; make sure you don't get double searches!!
ForceTopBestBet Special flag for designating the form to be a top best bet search, which requires a special control (the activity space was alterable through other methods, but this was added for setting the control).
GetAnchorOnClick Returns the onclick javascript for the HTMLAnchor used as a "submit" button or link
GetForm Convenience method. Same as GetResult(), but simply casts the result to type HTMLForm. Do not call if buildCompleteForm=false was passed to the constructor.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetInputBoxName Returns the name callers must use for the input box
GetInputBoxOnKeyDown Returns the javascript callers should use as the "onKeyDown" attribute of the input box
GetNextSelectName Get a new name for a pull-down HTMLSelect.
GetResult Returns the search form (if building a complete form) or inputs to be inserted into another form (otherwise).
GetSingleClassFilterJavascript 
GetType (inherited from Object)Gets the Type of the current instance.
OverrideEnclosingFormAndSubmitToSearchResultPage Special flag (== "hack"), buildCompleteForm (passed to the constructor) must be false. Before submitting the search form, override the parent form's in_hi_space and associated arguments to force the user to go to the search results page.
SetFilterClauseOperator Set the operator for the set of statements in the filter.
SetPageMode A special "mode" argument thta is passed along to the results page. Different results page implementations may interpret this flag in different ways.
SetTarget Sets the target for this form.
SetValidateAlert 
SetValidationFunction Sets the javascript validation function for this form. This javascript function must be declared elsewhere on the page and must not include the final '();'.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

AddInputs Helper method to actually add the setting hidden inputs, called by AddRequiredSetting and AddOptionalSetting
CreateFilterElements Create the hidden inputs for the search form to encode the filter.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

SearchFormFactory Class | com.plumtree.portaluiinfrastructure.search Namespace