class %ZEN.Portal.assistedText
extends %ZEN.Component.control
• parameter DEFAULTCONTROLCLASS = "assistedText";
The default css class used for the main element within this control. This
is overridden by subclasses.
• parameter INCLUDEFILES = "zenCSLM.js";
Comma-separated list of additional JS include files for the page.
• property OnUpdateDataServer
as %ZEN.Datatype.delegator(FORMALSPEC="pBase:%String",RETURNTYPE="%String");
When controlType is custom, this is the server method to call to get data to populate the selector control
The format of this attribute is just the name of the server method.
onUpdateDataClient takes precedence over OnUpdateDataServer.
The server method takes one argument that is the base text. The base text is either empty string or it ends with the trigger character.
The return value is a single-character delimited list with the delimiter character as the first character.
• property controlType
as %ZEN.Datatype.string [ InitialExpression = "custom" ];
Specify the type of the control, it accepts 3 formats:
classname - use build in assist for classname
property: - use build in assist for property names with the top level context class being
custom - this is default, the control calls onUpdateDataClient or OnUpdateDataServer to populate the selector control
• property controlWidth
as %ZEN.Datatype.string [ InitialExpression = "100px" ];
The width of the control, must end in the unit, i.e. 100px
• property hideGhost
as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
When hideGhost is true, it indicates a UI behavior where the grey suggested text (ghost text) is not shown.
This gives a different UI behavior that is desirable under some circumstances.
For example, when isSuggestedDataComplete is true, because the suggested text may not match the existing text in the
beginning portion of the string, without hideGhost=true, you will see ghost text under the existing text and being different.
• property isSuggestedDataComplete
as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
When isSuggestedDataComplete is false, it indicates the string list returned by update data callbacks are partial strings
and they are to be appended to the original base string to be used as suggested text.
When isSuggestedDataComplete is true, it indicates the string list returned by update data callbacks are complete strings
and they do not need to be appended to the original base string.
When isSuggestedDataComplete is true, it is suggested hideGhost=true to be used.
When controlType is either classname or property, isSuggestedDataComplete is ignored. It is assumed to be false.
• property listSize
as %ZEN.Datatype.integer(MINVAL=0) [ InitialExpression = 5 ];
The size (number of lines) of the drop-down area for this assistedText control.
• property onUpdateDataClient
as %ZEN.Datatype.eventHandler;
When controlType is custom, this is the client method to call to get data to populate the selector control
The format of this attribute is "zenPage.(base);"
onUpdateDataClient takes precedence over OnUpdateDataServer.
The client method takes one argument that is the base text. The base text is either empty string or it ends with the trigger character.
The return value is a single-character delimited list with the delimiter character as the first character.
• property triggerChars
as %ZEN.Datatype.string [ InitialExpression = "." ];
list of characters that triggers the calls to update data.
When controlType is either classname or property, triggerChars is ignored. It is assumed to be the dot character.
• method %DrawHTML()
Draw content of control.
• method ServerCallOnUpdateDataServer(pBase As %String)
as %String
[ ZenMethod ]
Invoke the OnUpdateDataServer callback.
• classmethod ServerGetClassPackageList(pBase As %String)
as %String
[ ZenMethod ]
• classmethod ServerGetPropertyList(pBase As %String, pClassname As %String)
as %String
[ ZenMethod ]
• method controlGotFocus()
[ Language = javascript ]
• method controlKeyPressed(event)
[ Language = javascript ]
• method controlOnBlur(event)
[ Language = javascript ]
• method deferredComboUpdate()
[ Language = javascript ]
• method deferredEscapeAction()
[ Language = javascript ]
• method deferredLostFocus()
[ Language = javascript ]
• method deferredSaveCurrentTextValue(keyCode)
[ Language = javascript ]
• method doAction()
[ Language = javascript ]
• method getSelection(ctrl)
[ Language = javascript ]
• method ghostGotFocus()
[ Language = javascript ]
• method onCreate()
[ Language = javascript ]
client-side initialization for this object.
• method selectorChanged()
[ Language = javascript ]
• method selectorDblClicked()
[ Language = javascript ]
• method selectorGotFocus()
[ Language = javascript ]
• method setComboOptions(combo, options, insertBlank)
[ Language = javascript ]
• method setProperty(property, value, value2)
[ Language = javascript ]
Set the value of a named property.
• method setSelection(ctrl, pos1, pos2)
[ Language = javascript ]
• method updateData(base)
[ Language = javascript ]
