A class handling everything associated with the search panel.
| name | The name of the global variable that will be storing this instance. Is needed to be able to set timeouts. |
| mode | The mode the search is going to work in. Pass <NaturalDocs::Builder::Base->CommandLineOption()>, so the value will be something like “HTML” or “FramedHTML”. |
| SearchPanel | A class handling everything associated with the search panel. |
| Variables | |
| name | The name of the global variable that will be storing this instance of the class. |
| mode | The mode the search is going to work in, such as “HTML” or “FramedHTML”. |
| resultsPath | The relative path from the current HTML page to the results page directory. |
| keyTimeout | The timeout used between a keystroke and when a search is performed. |
| keyTimeoutLength | The length of keyTimeout in thousandths of a second. |
| lastSearchValue | The last search string executed, or an empty string if none. |
| lastResultsPage | The last results page. |
| deactivateTimeout | The timeout used between when a control is deactivated and when the entire panel is deactivated. |
| deactivateTimeoutLength | The length of deactivateTimeout in thousandths of a second. |
| DOM Elements | |
| DOMSearchField | |
| DOMSearchType | |
| DOMPopupSearchResults | |
| DOMPopupSearchResultsWindow | |
| DOMSearchPanel | |
| Event Handlers | |
| OnSearchFieldFocus | Called when focus is added or removed from the search field. |
| OnSearchFieldChange | Called when the content of the search field is changed. |
| OnSearchTypeFocus | Called when focus is added or removed from the search type. |
| OnSearchTypeChange | Called when the search type is changed. |
| Action Functions | |
| CloseResultsWindow | Closes the results window. |
| Search | Performs a search. |
| Activation Functions | Functions that handle whether the entire panel is active or not. |
| Activate | Activates or deactivates the search panel, resetting things to their default values if necessary. |
| InactivateAfterTimeout | Called by <inactivateTimeout>, which is set by Activate(). |
| SearchResults | The class that handles everything on the search results page. |
| Variables | |
| mode | The mode the search is going to work in, such as “HTML” or “FramedHTML”. |
| lastMatchCount | The number of matches from the last run of Search(). |
| Functions | |
| Toggle | Toggles the visibility of the passed element ID. |
| Search | Searches for the passed string. |
this.keyTimeoutLength
The length of keyTimeout in thousandths of a second.
this.lastResultsPage
The last results page. The value is only relevant if lastSearchValue is set.
this.deactivateTimeoutLength
The length of deactivateTimeout in thousandths of a second.
this.Activate = function( isActive, ignoreDeactivateDelay )
Activates or deactivates the search panel, resetting things to their default values if necessary. You can call this on every control’s OnBlur() and it will handle not deactivating the entire panel when focus is just switching between them transparently.
| isActive | Whether you’re activating or deactivating the panel. |
| ignoreDeactivateDelay | Set if you’re positive the action will deactivate the panel and thus want to skip the delay. |
this.InactivateAfterTimeout = function()
Called by <inactivateTimeout>, which is set by Activate(). Inactivation occurs on a timeout because a control may receive OnBlur() when focus is really transferring to another control in the search panel. In this case we don’t want to actually deactivate the panel because not only would that cause a visible flicker but it could also reset the search value. So by doing it on a timeout instead, there’s a short period where the second control’s OnFocus() can cancel the deactivation.
this.lastMatchCount
The number of matches from the last run of Search().
The name of the global variable that will be storing this instance of the class.
this.name
The mode the search is going to work in, such as “HTML” or “FramedHTML”.
this.mode
The relative path from the current HTML page to the results page directory.
this.resultsPath
The timeout used between a keystroke and when a search is performed.
this.keyTimeout
The length of keyTimeout in thousandths of a second.
this.keyTimeoutLength
The last search string executed, or an empty string if none.
this.lastSearchValue
The last results page.
this.lastResultsPage
The length of deactivateTimeout in thousandths of a second.
this.deactivateTimeoutLength
this.DOMSearchField = function()
this.DOMSearchType = function()
this.DOMPopupSearchResults = function()
this.DOMPopupSearchResultsWindow = function()
this.DOMSearchPanel = function()
Called when focus is added or removed from the search field.
this.OnSearchFieldFocus = function( isActive )
Called when the content of the search field is changed.
this.OnSearchFieldChange = function()
Called when focus is added or removed from the search type.
this.OnSearchTypeFocus = function( isActive )
Called when the search type is changed.
this.OnSearchTypeChange = function()
Closes the results window.
this.CloseResultsWindow = function()
Performs a search.
this.Search = function()
Activates or deactivates the search panel, resetting things to their default values if necessary.
this.Activate = function( isActive, ignoreDeactivateDelay )
Called by inactivateTimeout, which is set by Activate().
this.InactivateAfterTimeout = function()
The mode the search is going to work in, such as “HTML” or “FramedHTML”.
this.mode
The number of matches from the last run of Search().
this.lastMatchCount
Searches for the passed string.
this.Search = function( search )
Toggles the visibility of the passed element ID.
this.Toggle = function( id )