Singleton manager of header/list/footer style Control
Members
-
(static) resultControlPanel :Object
-
The result panel element
Type:
- Object
-
(static) resultControlPanelAnimationTime :Number
-
Milliseconds to animate the result panel animation over (default=300)
Type:
- Number
-
(static) resultControlPanelInitialHeight :Number
-
Internal use
Type:
- Number
-
(static) resultControlPanelInitialWidth :Number
-
Internal use
Type:
- Number
-
(static) resultFooterPanel :Object
-
The result footer panel element
Type:
- Object
-
(static) resultFooterTransform :Object
-
The footer transform
Type:
- Object
-
(static) resultHeaderPanel :Object
-
The result header panel element
Type:
- Object
-
(static) resultHeaderTransform :Object
-
The header transform
Type:
- Object
-
(static) resultItemTransform :Object
-
The result item transform
Type:
- Object
-
(static) resultListPanel :Object
-
The results list panel element
Type:
- Object
-
(static) resultObject :Object
-
The results from the server
Type:
- Object
-
(static) resultsPanelIsOpen :Boolean
-
Whether the results panel is open
Type:
- Boolean
-
(static) resultViewPanel :Object
-
The result view panel element
Type:
- Object
-
(static) showResultsLoadingAnimPause :Number
-
Milliseconds to wait before showing the loading animation (default=10)
Type:
- Number
-
(static) showResultsLoadingAnimTimeout :Object
-
The timeout reference for the loading animation
Type:
- Object
Methods
-
(static) clearLoadingAnimTimeout()
-
Clears the loading animation timeout, usually because the results have been loaded
-
(static) closeResultsControlPanel(instantly)
-
Closes the results panel so that it is invisible
Parameters:
Name Type Description instantly
Whether to close the panel immediately or animate it -
(static) ensureChildControls()
-
Creates child controls if necessary
-
(static) expandResultControlPanel(extraHeight)
-
Expands the result panel to fit the result content inside of it
Parameters:
Name Type Description extraHeight
Any additional height to add to the content height -
(static) getResultControlPanel()
-
Returns the id=sew_searchResultControl element - which holds the entire search result control
-
(static) getResultFooterPanel()
-
Returns the footer panel element
-
(static) getResultHeaderPanel()
-
Returns the header panel element
-
(static) getResultListPanel()
-
Returns the element holding the 'result list' section of the control (ie between the header or footer)
-
(static) getResultViewPanel()
-
Returns the element holding the results section of the control, this is separate to the error and loading DIVs, and contains the sew_resultList element
-
(static) hideResultsLoadingAnim()
-
Hides the loading animation
-
(static) hideSearchResults()
-
Closes the results panel so that it is invisible and empties the child control content
-
(static) hideServerError()
-
Hides the server error message
-
(static) init()
-
Initialize
-
(static) onError()
-
Called when a server error occurs, and shows the error
-
(static) onErrorOKButton_Click()
-
Handles the error OK button click
-
(static) openResultsControlPanel(instantly)
-
Opens the results panel so that it is visible
Parameters:
Name Type Description instantly
Whether to open the panel immediately or animate it -
(static) scrollTop()
-
Scroll to the the top of the page if topOfPage is true, otherwise to the result header location
-
(static) showResultsLoadingAnim()
-
Shows the result loading animation after 'wait' millisconds, unless the results load first
-
(static) showSearchResults()
-
Show the search results, opening the result panel if necessary
-
(static) showServerError(exception)
-
Displays error information to the user
Parameters:
Name Type Description exception
Object with Message and StackTrace properties -
(static) shrinkResultControlPanel(extraHeight)
-
Shrinks the result panel by extraHeight
Parameters:
Name Type Description extraHeight
The amount of height to remove