HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk.event

Class s7sdk.event.SearchEvent

This event is dispatched by SearchManager and SearchPanel components when new search is submitted by the user or search request is processed and search response is generated.

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.event.SearchEvent(type, searchRequest, searchResults, bubbles)
Field Summary
Field Attributes Field Name and Description
 
Specifies whether the event should bubble.
<static>  
s7sdk.event.SearchEvent.SEARCH_COMPLETED
This event is dispatched by the SearchManager component to notify that the new search data is available.
<static>  
s7sdk.event.SearchEvent.SEARCH_FAILED
This event is dispatched by the SearchManager component to notify when an error happens during search.
<static>  
s7sdk.event.SearchEvent.SEARCH_SUBMITTED
This event is dispatched by the SearchPanel component to notify that search data is submitted.
 
The search text.
 
Search results created by SearchManager component.
 
The type of the particular event object.
Class Detail
s7sdk.event.SearchEvent(type, searchRequest, searchResults, bubbles)
Parameters:
{String} type
Defines the value of the type property.
{String} searchRequest
The search text.
{s7sdk.search.SearchResultsDesc} searchResults
Search results.
{Boolean} bubbles
- Defines whether the event bubbles.
Field Detail
{Boolean} bubbles
Specifies whether the event should bubble.

<static> s7sdk.event.SearchEvent.SEARCH_COMPLETED
This event is dispatched by the SearchManager component to notify that the new search data is available.

<static> s7sdk.event.SearchEvent.SEARCH_FAILED
This event is dispatched by the SearchManager component to notify when an error happens during search.

<static> s7sdk.event.SearchEvent.SEARCH_SUBMITTED
This event is dispatched by the SearchPanel component to notify that search data is submitted.

{String} searchRequest
The search text.

{s7sdk.search.SearchResultsDesc} searchResults
Search results created by SearchManager component.

{String} type
The type of the particular event object.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Oct 15 2020 11:59:12 GMT-0000 (UTC)