deprecatedclass %ZEN.Component.lookup
extends %ZEN.Component.control
This is a specialized lookup control that provides a way to select
a value from a list of options.
• property context
as %ZEN.Datatype.uri;
Context string used to determine the selection list for this component.
A context string take the form of a URL:
SearchClass/SearchName?parm1=value&parm2=value
SearchClass is the name of a %ZEN.Portal.ContextSearch
search class that contains the search to perform.
SearchName is the name of the search method to invoke within
the search class.
You can omit the search class and name and use the context to pick up value from
other controls on the current page. In this case the context string should start take the form:
?parm1=value
At this time, search class and name are not supported by this control.
• property displayBinding
as %ZEN.Datatype.string;
Optional. If this control belongs to a form that is associated with
a dataController, this specifies the name of the property within the dataController
that will provide the display value for this control.
• property idProperty
as %ZEN.Datatype.string;
Name of property within data element that supplies the id value.
• property imageProperty
as %ZEN.Datatype.string;
Name of property within data element that supplies an image src value.
If defined, and the property exists, show the image in the popup instead of the text value.
• property lookupIcon
as %ZEN.Datatype.uri [ InitialExpression = "deepsee/zoom_16.png" ];
Image to use to invoke lookup popup.
• property multiSelect
as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
This flag is not implemented at this time.
• property noResultsMessage
as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Nothing to show!","%Utility") ];
Message to show when no results are present.
• property ongetdata
as %ZEN.Datatype.eventHandler;
ongetdata event handler:
Return a javascript array of data to display in the popup.
This can be any array of object or literal values.
• property onshowPopup
as %ZEN.Datatype.eventHandler;
onshowPopup event handler:
This event is fired just before the popup is displayed.
• property popupLabel
as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Search","%Utility") ];
Title to display within popup.
• property propertyList
as %ZEN.Datatype.csv;
List of property values to display in the popup list.
This is a csv-list of property names.
• property separator
as %ZEN.Datatype.string [ InitialExpression = "," ];
This property is not used at this time.
• property showFilter
as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Specify if there should be a filter text box within the pop up.
• property size
as %ZEN.Datatype.integer;
Size (width * 10 pixels) of the base (non popup) portion of this control.
• property styleList
as %ZEN.Datatype.csv;
List of CSS styles to apply to cells within the popup list.
This is a csv-list of CSS styles.
• property text
as %ZEN.Datatype.string;
Display value for this control.
value contains the logical value.
• property textProperty
as %ZEN.Datatype.string;
Name of property within data element that supplies the text value.
• method adjustSize()
[ Language = javascript ]
Adjust the size of the control.
• method applyValue(value, text)
[ Language = javascript ]
Value applied from popup.
• method focus()
[ Language = javascript ]
Client-side method to give input focus to this control.
• method getPopupContent(group)
[ Language = javascript ]
Return the content for the popup/dropdown.
• method getProperty(property, key)
as %String
[ Language = javascript ]
Override to get current value of control.
• method renderContents()
[ Language = javascript ]
Client-side method to render control.
• method selectPopupItem(index)
[ Language = javascript ]
Select an item within the popup (used by keyboard handling).
• method selectorClick()
[ Language = javascript ]
User has pressed the selector button.
• method setProperty(property, value, value2)
[ Language = javascript ]
Set the value of a named property.
• method showGroupHandler()
[ Language = javascript ]
Notification that the popup group is displayed.
• method showPopup(spec)
[ Language = javascript ]
Display the dropdown popup window.
spec is an object with any of the following properties:
top - top edge of popup.
left - left edge of popup.
parentDiv - if supplied, use this to place the popup.
value - current logical value.
data - array of data elements to display; can be an array of objects or literal values.
propertyList - if data contains objects, this is a csv-list of properties to display.
styleList - this is a csv-list of styles to apply to the columns in the popup.
idProperty - if data contains objects, this the name of the property supplying the id value.
textProperty - if data contains objects, this the name of the property supplying the display value.
title - title to display in popup.
applyValue - function to call a value is selected within the popup.
