Home > Class Reference > ENSLIB namespace > %ZEN.Component.buttonView
Private  Storage   

%ZEN.Component.buttonView


class %ZEN.Component.buttonView extends %ZEN.Component.component

This Zen component displays a set of text buttons displayed within a table. The number of columns is determined by the columns property.
The contents of the buttonView are provided via the user-defined OnGetButtonInfo callback.
This component is typically used to display progressive filter buttons that allow a user to narrow down a search.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 4


Summary


Properties
%condition %import %includeFiles %page
%resource OnGetButtonInfo align aux
columns composite containerStyle dragEnabled
dropEnabled enclosingClass enclosingStyle error
height hidden hint hintClass
hintStyle id index label
labelClass labelDisabledClass labelStyle name
onafterdrag onbeforedrag ondrag ondrop
onhide onrefresh onselect onshow
onupdate parent seed showLabel
slice title tuple valign
value 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 %GetButtonInfo %GetEventHandlers %GetParameter
%GetXMLName %IsA %IsModified %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %RemoveFromSaveSet %Self %SerializeObject
%SetModified %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
exposeComponent findElement fireOnUpdateEvent getEnclosingDiv
getHidden getHintElement getLabelElement getProperty
getSettings getType invokeSuper isOfType
itemClicked makeId onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onStartModalHandler onloadHandler onunloadHandler
onupdateHandler refreshContents render renderContents
renderSVG resetItems setHidden setOverlayMode
setProperty startProgressBar stopProgressBar


Properties


• property OnGetButtonInfo as %ZEN.Datatype.delegator(FORMALSPEC="seed:%ZEN.Datatype.string,&pInfo",RETURNTYPE="%Status");
Optional. Name of Server-side callback method that provides the list of items to display for this component.
This method should return an array, indexed by button number, that defines the category, caption, value, and (optional) tooltip for each button. You can also provide an optional, disabled flag, which, it true will make the button disabled in all cases. The array takes the form:
	Set pInfo(n) = $LB(category,caption,value,tooltip,disabled)
When the user selects a button, all other buttons of the same category are disabled (unless category is ""). Pressing the Reset button restores clears all the selections.
This must be the name of a server-only method in the page class that contains this view component.
• property columns as %ZEN.Datatype.integer(MINVAL=1) [ InitialExpression = 4 ];
Number of columns of buttons to display.
• property onselect as %ZEN.Datatype.eventHandler;
onselect event handler: If defined, this event is fired when the user selects a new button. The variable, value is passed to the event handler and contains the current value of this component (same as the value property).
• property seed as %ZEN.Datatype.string(ZENEXPRESSION=1);
Optional. User-defined seed value. This is an optional parameter that is passed on to the OnGetButtonInfo callback method.
• property value as %ZEN.Datatype.string;
A string containing the current selected values. This takes the form: "category:value;"

Methods


• method %DrawHTML()
The %DrawHTML method draws the initial HTML for this component.
• method %GetButtonInfo(ByRef pInfo) as %Status
Invoke user method to get list of options to display.
• method itemClicked(idx) [ Language = javascript ]
User clicked on item.
• method resetItems() [ Language = javascript ]
Reset state of buttons.