Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.Component.searchBox
Private  Storage   

%DeepSee.Component.searchBox


class %DeepSee.Component.searchBox extends
%ZEN.Component.abstractComboBox

Specialized searchBox control for DeepSee searches. This is designed for use within DeepSee components and not as a stand-alone control.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 31 42


Summary


Properties
%condition %import %includeFiles %page
%resource align autocomplete aux
buttonCaption buttonImage buttonImageDown buttonTitle
calendar clientType comboType composite
containerStyle controlClass controlStyle dataBinding
dataSourceName dateFormat delay descriptionProperty
disabled displayList displayMode dragEnabled
dropEnabled dropdownHeight dropdownWidth editable
enclosingClass enclosingStyle error filterName
firstDayOfWeek height hidden hint
hintClass hintStyle hzScroll iconApply
iconCancel iconSearch id index
inputtype invalid invalidMessage isDropdownVisible
label labelClass labelDisabledClass labelStyle
listOfText listOfValues loadingMessage maxRows
maxlength multiSelect name onafterdrag
onbeforedrag onblur onchange onclick
ondblclick ondrag ondrop onfocus
onhide onkeydown onkeypress onkeyup
onmousedown onmouseout onmouseover onmouseup
onrefresh onshow onshowdropdown onsubmit
ontouchend ontouchmove ontouchstart onupdate
onvalidate originalValue parent placeholder
previewMode priorText priorValues readOnly
relatedFilterKeys relatedFilterSpecs required requiredMessage
scrollIntoView selectMode selectType selectedIndex
showLabel size slice spellcheck
tabIndex text title tuple
unrestricted valign value valueList
valueRequired visible width window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetDisplayValue %GetEventHandlers %GetForm
%GetParameter %GetXMLName %IsA %IsModified
%MakeId %Name %New %NormalizeObject
%ObjectModified %OnAddToPageAfter %OnAddToPageBefore %OnDrawEnclosingDiv
%OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveFromSaveSet
%Self %SerializeObject %SetDefaultValues %SetModified
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType adjustDropdownPosition applyCalendar applyChange
applyMeasure cancelChanges cbNowClick comboboxButtonDown
comboboxButtonUp comboboxMouseOut comboboxMouseOver dateChange
dateFromHorolog dateRangeChange dateToHorolog doSearch
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler exposeComponent findDisplayValue
findElement findSelectedItem fireOnUpdateEvent focus
formatValue getCacheDiv getDisabled getDragData
getDropDownDiv getEnclosingDiv getForm getHidden
getHintElement getInvalidReason getItemEl getLabelElement
getOptionCount getOptionText getOptionValue getProperty
getReadOnly getSettings getType getValue
inputKeyHandler invokeSuper isAnyItemSelected isModified
isOfType isValid itemClick makeId
msrAllClick msrChange msrKeyPress normalizeValue
notClick offsetNowChange onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onStartModalHandler onchangeHandler onloadHandler
onresizeHandler onunloadHandler onupdateHandler rangeChange
rangeClick refreshContents rememberValues removeItem
render renderContents renderSVG resetItems
resolveNowOffset searchKeyPress select selectCustomItem
selectItem setDisabled setHidden setOverlayMode
setProperty setReadOnly setValue showDropdown
startProgressBar stopProgressBar sysName unformatValue
updateInput updateTooltip validationHandler


Parameters


• parameter DOMAIN = "%DeepSee";
Localization domain
• parameter ICONAPPLY = "deepsee/ds2_checkmark_16.png";
• parameter ICONCANCEL = "deepsee/ds2_circlex_22.png";
• parameter ICONSEARCH = "deepsee/ds2_magnify_18.png";
• parameter JSINCLUDES = "zenCSLM.js,zenESVG.js,DeepSee.js";
• parameter NAMESPACE = "http://www.intersystems.com/deepsee";
This is the XML namespace used for library components.

Properties


• property calendar as %ZEN.Datatype.string;
The calendar being used for a time level.
• property dataSourceName as %ZEN.Datatype.string;
Name of the DeepSee dataSource driving this dropdown.
• property dateFormat as %ZEN.Datatype.string [ InitialExpression = "mmm d, y" ];
Optional date format to apply (using DeepSee date format).
• property descriptionProperty as %ZEN.Datatype.string(XMLPROJECTION="none");
If defined, name of description property for a level.
• property displayList as %ZEN.Datatype.csv;
Optional csv-list of captions to use for dropdown
• property displayMode as %ZEN.Datatype.string(VALUELIST="list,calendar,custom,measure",XMLPROJECTION="none") [ InitialExpression = "list" ];
Display mode. Controls what is displayed in the drop down area.
• property filterName as %ZEN.Datatype.string;
Logical name of the filter supplying the values.
• property firstDayOfWeek as %ZEN.Datatype.integer;
Number indicating the first day of the week in the displayed calendar. 0 = Sunday, 6 = Saturday.
• property iconApply as %ZEN.Datatype.string [ InitialExpression = ..#ICONAPPLY ];
Apply icon.
• property iconCancel as %ZEN.Datatype.string [ InitialExpression = ..#ICONCANCEL ];
Cancel icon.
• property iconSearch as %ZEN.Datatype.string [ InitialExpression = ..#ICONSEARCH ];
Search icon.
• property listOfText as list of %ZEN.Datatype.string(XMLPROJECTION="none");
List of current selected item text values.
• property listOfValues as list of %ZEN.Datatype.string(XMLPROJECTION="none");
List of current selected item values.
• property loadingMessage as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Loading...","%ZEN") ];
Localized "loading" message displayed by control.
This message is temporarily displayed while a server-side query is running.
• property maxRows as %ZEN.Datatype.integer [ InitialExpression = 500 ];
Maximum number of items to show.
• property multiSelect as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, allow selection of multiple items.
• property onshowdropdown as %ZEN.Datatype.eventHandler;
onshowdropdown event handler: This event is fired just as the dropdown is about to be rendered.
• property previewMode as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, then render in preview mode.
• property priorText as list of %ZEN.Datatype.string(XMLPROJECTION="none");
List of item text values from prior searches.
• property priorValues as list of %ZEN.Datatype.string(XMLPROJECTION="none");
List of item values from prior searches.
• property relatedFilterKeys as list of %ZEN.Datatype.string(XMLPROJECTION="none");
List of filter key values from other filter controls. This is used to restrict the set of members displayed by this searchBox.
• property relatedFilterSpecs as list of %ZEN.Datatype.string(XMLPROJECTION="none");
List of filter specs from other filter controls. This is used to restrict the set of members displayed by this searchBox.
• property selectMode as %ZEN.Datatype.string(XMLPROJECTION="none");
Selection mode: "","not" or "range"
• property selectType as %ZEN.Datatype.string;
The type of level that provides data for this control.
• property valueList as %ZEN.Datatype.csv;
Optional csv-list of values to use for dropdown
• property valueRequired as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, require at least one selected item.

Methods


• method %DrawHTML()
Draw contents of search box.
• method %GetDisplayValue(pValue As %String, pType As %String = "") as %String
Lookup up the display value for the combobox given a logical value.
• method adjustDropdownPosition() [ Language = javascript ]
Adjust the placement and size of the dropdown box based on current screen geometry and scrolling conditions.
• method applyCalendar() [ Language = javascript ]
User click on ok icon in calendar mode.
• method applyChange() [ Language = javascript ]
User click on ok icon.
• method applyMeasure() [ Language = javascript ]
User click on ok icon in measure mode.
• method cancelChanges(close) [ Language = javascript ]
Cancel user changes.
• method cbNowClick(isCB, which) [ Language = javascript ]
User click on NOW checkbox.
• method dateChange(ctrl, clear) [ Language = javascript ]
User selected a new date in the calendar.
• method dateFromHorolog(val, nowInfo) [ Language = javascript ]
Convert a $H to yyyy-mm-dd date.
• method dateRangeChange(which) [ Language = javascript ]
User selected a new date range in the calendar(s).
• method dateToHorolog(val) [ Language = javascript ]
Convert a yyyy-mm-dd date to $h.
• method doSearch() [ Language = javascript ]
Perform search on drop down contents.
• method findDisplayValue(value) [ Language = javascript ]
Convert value to a display value.
• method inputKeyHandler(evt) [ Language = javascript ]
Intercept default behavior. Keydown within input control.
• method isAnyItemSelected() [ Language = javascript ]
Test if any checkbox is selected in the dropdown list.
• method itemClick(evt, idx, iscb) [ Language = javascript ]
User click on item within dropdown. iscb is true if this is a click from the checkbox.
• method msrAllClick(evt, iscb) [ Language = javascript ]
User click on all checkbox within measure dropdown. iscb is true if this is a click from the checkbox.
• method msrChange() [ Language = javascript ]
User change value within measure expression dropdown.
• method msrKeyPress(evt) [ Language = javascript ]
User key press in measure value control.
• method notClick(iscb) [ Language = javascript ]
User click on NOT (exclude members) option within dropdown.
• method offsetNowChange(which) [ Language = javascript ]
User change on NOW offset input
• method onEndModalHandler(zindex) [ Language = javascript ]
Notification that this component is about to stop being modal.
• method rangeChange(which) [ Language = javascript ]
Change of range combo.
• method rangeClick(iscb) [ Language = javascript ]
User click on Range option within dropdown.
• method rememberValues() [ Language = javascript ]
Remember current values.
• method removeItem(idx) [ Language = javascript ]
• method resetItems(skip) [ Language = javascript ]
Unselect all options in the dropdown list. If skip is provided, do not reset it.
• method resolveNowOffset(offset, type) [ Language = javascript ]
Convert NOW-offset to a readable date value given the type. If an unsupported type is entered, the function will return a localized 'NOW'+offset.
Supported types: day, month, year
• method searchKeyPress(evt) [ Language = javascript ]
Keypress in search box control.
• method selectCustomItem(text, val) [ Language = javascript ]
User selected a value in the custom drop down.
• method updateInput() [ Language = javascript ]
Display new values in input control.
• method updateTooltip() [ Language = javascript ]
Change the tooltip for the input control.