Doc.Search
class Doc.Search extends %ZEN.Component.page
A Zen-based search page for DocBook that uses SQL text searching.Property Inventory
Method Inventory
- %OnAfterCreatePage()
- %OnDrawHTMLMeta()
- %OnPreHTTP()
- GetHeadInfo()
- GetHitHTMLNEW()
- GetLocatorHTMLForTopic()
- GetPagination()
- Nope()
- SearchKeyGet()
- SetBookFilter()
- UpdateBadSearchGlobal()
- UpdateGoodSearchGlobal()
- UpdateSelect()
Parameters
parameter APPLICATION;
Class name of application this page belongs to.
parameter CSSINCLUDES;
Inherited description: Comma-separated list of additional CSS include files for the page.
If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).
parameter DOMAIN = DOCBOOK;
Domain used for localization.
parameter PAGENAME = Search documentation;
Displayed name of this page (supposedly)
parameter TOPICSPERPAGE = 20;
Properties
property BookId as %String (ZENURL = "Book");
Book Id for limited search
Property methods: BookIdDisplayToLogical(), BookIdGet(), BookIdIsValid(), BookIdLogicalToDisplay(), BookIdLogicalToOdbc(), BookIdNormalize(), BookIdSet()
property KeyWord as %String (ZENURL = "KeyWord");
Initial search string.
Property methods: KeyWordDisplayToLogical(), KeyWordGet(), KeyWordIsValid(), KeyWordLogicalToDisplay(), KeyWordLogicalToOdbc(), KeyWordNormalize(), KeyWordSet()
property Op as %String (ZENURL = "Op") [ InitialExpression = "AND" ];
Property methods: OpDisplayToLogical(), OpGet(), OpIsValid(), OpLogicalToDisplay(), OpLogicalToOdbc(), OpNormalize(), OpSet()
property Page as %Integer (ZENURL = "Page");
Page number to display
Property methods: Page(), PageDisplayToLogical(), PageGet(), PageIsValid(), PageLogicalToDisplay(), PageNormalize(), PageSet(), PageXSDToLogical()
property ProductId as %String (ZENURL = "Product");
Product Id for limited search
Property methods: ProductIdDisplayToLogical(), ProductIdGet(), ProductIdIsValid(), ProductIdLogicalToDisplay(), ProductIdLogicalToOdbc(), ProductIdNormalize(), ProductIdSet()
property SearchKey as %String [ Calculated ];
Search key made up of Product:Book:KeyWord:Tags:SearchType
Property methods: SearchKeyDisplayToLogical(), SearchKeyIsValid(), SearchKeyLogicalToDisplay(), SearchKeyLogicalToOdbc(), SearchKeyNormalize()
property SearchType as %Integer (ZENURL = "SearchType") [ InitialExpression = 2 ];
Property methods: SearchTypeDisplayToLogical(), SearchTypeGet(), SearchTypeIsValid(), SearchTypeLogicalToDisplay(), SearchTypeNormalize(), SearchTypeSet(), SearchTypeXSDToLogical()
property Tags as %String (ZENURL = "Tags");
extra tags for limited search
Property methods: TagsDisplayToLogical(), TagsGet(), TagsIsValid(), TagsLogicalToDisplay(), TagsLogicalToOdbc(), TagsNormalize(), TagsSet()
property Which as %String (ZENURL = "Which");
Property methods: WhichDisplayToLogical(), WhichGet(), WhichIsValid(), WhichLogicalToDisplay(), WhichLogicalToOdbc(), WhichNormalize(), WhichSet()
property msgSearching as %ZEN.Datatype.caption [ InitialExpression = "Searching..." ];
Localized searching message.
Property methods: msgSearchingDisplayToLogical(), msgSearchingGet(), msgSearchingIsValid(), msgSearchingLogicalToDisplay(), msgSearchingLogicalToOdbc(), msgSearchingNormalize(), msgSearchingSet()
Methods
method %OnAfterCreatePage() as %Status
Implementation of callback.
Display ProductFilter dropdown list only if we have more than one product.
Called after the server-side page
object and all of its children are created.
method %OnDrawHTMLMeta() as %Status
Add meta tags within head tag
classmethod %OnPreHTTP() as %Boolean
This is called before the standard Zen pre-HTTP processing occurs.
classmethod GetHeadInfo()
classmethod GetHitHTMLNEW(hit As %DynamicObject, showType As %Boolean = 0, itemNumber As %Integer = "", searchWord As %String) as %String
classmethod GetLocatorHTMLForTopic(locator As %DynamicArray = "", displayClass As %String = "locatorclass") as %String
Given a locator array (see DocAPI.v1.Content),
return the inline HTML we can use to display it as a set of links.
This HTML does not include <div> and </div>
classmethod Nope(tPhrase, sessionid)
method SearchKeyGet() as %String
method SetBookFilter() [ ZenMethod ]
clientmethod UpdateSelect() [ Language = javascript ]
Inherited Members
Inherited Properties
- %condition
- %import
- %includeFiles
- %page
- %resource
- align
- aux
- backgroundTimerInterval
- cellAlign
- cellSize
- cellStyle
- cellVAlign
- children
- composite
- containerStyle
- cssLevel
- disabled
- dragAndDrop
- dragEnabled
- dropEnabled
- enclosingClass
- enclosingStyle
- error
- groupClass
- groupStyle
- height
- hidden
- hint
- hintClass
- hintStyle
- id
- index
- label
- labelClass
- labelDisabledClass
- labelPosition
- labelStyle
- layout
- name
- onafterdrag
- onbeforedrag
- onclick
- ondrag
- ondrop
- onhide
- onrefresh
- onshow
- onupdate
- parent
- showLabel
- slice
- title
- tuple
- useSVG
- useSoftModals
- valign
- visible
- width
- window
- zenPersistentPopup
Inherited Methods
- %AddChild()
- %AddChildAfter()
- %AddChildBefore()
- %AddComponent()
- %AddImportedComponents()
- %AddToSaveSet()
- %ApplyURLParms()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawAutoLogout()
- %DrawClassDefinitions()
- %DrawComponentHTML()
- %DrawHTML()
- %DrawHTMLPage()
- %DrawJSStrings()
- %DrawObjectDefinitions()
- %EnclosingDivId()
- %EndBackgroundMethod()
- %EndScript()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %GetChildIndex()
- %GetComponent()
- %GetComponentById()
- %GetComponentByName()
- %GetEventHandlers()
- %GetLinks()
- %GetPageName()
- %GetParameter()
- %GetValueById()
- %GetValueByName()
- %GetXMLName()
- %IsA()
- %IsModified()
- %Link()
- %LinkCSS()
- %LinkScript()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnBeforeCreatePage()
- %OnCreateApplication()
- %OnCreatePage()
- %OnDetermineCSSLevel()
- %OnDrawEnclosingDiv()
- %OnDrawHTMLBody()
- %OnDrawHTMLHead()
- %OnDrawObjectProperties()
- %OnFinishBackgroundTask()
- %OnMonitorBackgroundTask()
- %OnMutateChildren()
- %OnObjectSynch()
- %OnUseSoftModals()
- %OnZENDeserialize()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %RemoveChild()
- %RemoveChildren()
- %RemoveComponent()
- %RemoveFromSaveSet()
- %RunBackgroundMethod()
- %Self()
- %SerializeObject()
- %SetBackgroundMethodStatus()
- %SetErrorById()
- %SetErrorByName()
- %SetModified()
- %SetValueById()
- %SetValueByName()
- %SetValuesByName()
- %StartScript()
- %ValidateObject()
- %ZENVersion()
- ConvertParameter()
- Decrypt()
- Encrypt()
- EscapeHTML()
- EscapeURL()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- OnHTTPHeader()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- Page()
- QuoteJS()
- RewriteURL()
- ShowError()
- StartTimer()
- StopTimer()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- addChild()
- addChildAfter()
- addChildBefore()
- cancelPopup()
- childrenMutated()
- correctIELayering()
- createComponent()
- createComponentNS()
- deleteComponent()
- dragFinishHandler()
- dragHandler()
- dragNotifyHandler()
- dragStartHandler()
- dropHandler()
- dropStartHandler()
- endModal()
- exposeComponent()
- findElement()
- fireOnResizeEvent()
- fireOnUnloadEvent()
- fireOnUpdateEvent()
- firePopupAction()
- getChildIndex()
- getComponent()
- getComponentById()
- getEnclosingDiv()
- getHidden()
- getHintElement()
- getLabelElement()
- getOpener()
- getProperty()
- getSettings()
- getType()
- gotoPage()
- invokeSuper()
- isOfType()
- launchPopupWindow()
- makeId()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onPopupAction()
- onRefreshContents()
- onSerialize()
- onServerMethodCall()
- onServerMethodError()
- onServerMethodReturn()
- onStartModalHandler()
- ondisabledHandler()
- onkeydownHandler()
- onkeyupHandler()
- onlayoutHandler()
- onlogoutHandler()
- onoverlayHandler()
- onresizeHandler()
- onunloadHandler()
- onupdateHandler()
- popupActionHandler()
- refreshContents()
- removeChild()
- render()
- renderContents()
- renderSVG()
- setComponentId()
- setHidden()
- setOverlayMode()
- setProperty()
- setPropertyAll()
- setTraceOption()
- startModal()
- startProgressBar()
- stopProgressBar()