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

%ZEN.Component.locatorBar


class %ZEN.Component.locatorBar extends component

This component displays a locator bar; a set of links displayed along the top of a page to indicate where the page is located within the application.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 4


Summary


Properties
%condition %import %includeFiles %page
%resource OnDrawBar OnGetQuickLinks align
aux composite containerStyle dragEnabled
dropEnabled enclosingClass enclosingStyle error
height hidden hint hintClass
hintStyle id index label
labelClass labelDisabledClass labelStyle links
name onafterdrag onbeforedrag ondrag
ondrop onhide onrefresh onshow
onupdate parent seed showLabel
slice title tuple valign
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 %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 makeId
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onStartModalHandler
onloadHandler onunloadHandler onupdateHandler refreshContents
render renderContents renderSVG setHidden
setOverlayMode setProperty startProgressBar stopProgressBar


Properties


• property OnDrawBar as %ZEN.Datatype.delegator(FORMALSPEC="seed:%ZEN.Datatype.string",RETURNTYPE="%Status");
Optional. Name of Server-side callback method that will inject additional content into the center of the locator bar.
If defined, this callback is invoked on the server when this component is drawn. It provides HTML content by using &html or by using the WRITE command.
This must be the name of a server-only method in the page class that contains this component.
• property OnGetQuickLinks as %ZEN.Datatype.delegator(FORMALSPEC="*links:%ZEN.Datatype.string",RETURNTYPE="%Status");
Optional. Name of Server-side callback method that returns an array of quick links. The array is of the form:
pLink("caption")=url
If provided, these are displayed in a dropdown list at the edge of the locator bar.
This must be the name of a server-only method in the page class that contains this view component.
• property links as list of %ZEN.Auxiliary.locatorLink(XMLPROJECTION="ELEMENT",XMLREF=1,XMLTYPECONSTRAINT="CHOICE");
List of link objects.
Each object specifies a link displayed in the locator bar.
• property seed as %ZEN.Datatype.string(ZENEXPRESSION=1);
Optional. User-defined seed value. This is an optional parameter that is passed on to the OnDrawBar callback method.

Methods


• method %DrawHTML()
Static HTML display method
• method onupdateHandler() [ Language = javascript ]
This client method, if present, is fired when the object is updated from the server.