%ZEN.ComponentEx.finderPane

class %ZEN.ComponentEx.finderPane extends %ZEN.Component.component

This component implements a simple Finder-like component for browsing hierarchically organized data. It is similar to the original SmallTalk Finder (later adopted by Mac/OS).

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DOMAIN = %ZEN;
Localization domain

Properties

property animate as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true (default is true), then animate the appearance of the finder.
Property methods: animateDisplayToLogical(), animateGet(), animateIsValid(), animateLogicalToDisplay(), animateLogicalToOdbc(), animateLogicalToXSD(), animateNormalize(), animateScroll(), animateSet(), animateXSDToLogical()
property caption as %ZEN.Datatype.caption (ZENEXPRESSION = 1);
If provided, this text is displayed as a caption along the top of the finder. The text is *not* HTML escaped, so that it can contain markup.
Property methods: captionDisplayToLogical(), captionGet(), captionIsValid(), captionLogicalToDisplay(), captionLogicalToOdbc(), captionNormalize(), captionSet()
property columnWidth as %ZEN.Datatype.length;
Width of columns in the finder when in "columns" mode. The default is 200 pixels.
Property methods: columnWidthDisplayToLogical(), columnWidthGet(), columnWidthIsValid(), columnWidthLogicalToDisplay(), columnWidthLogicalToOdbc(), columnWidthNormalize(), columnWidthSet()
property folderIcon as %ZEN.Datatype.uri [ InitialExpression = "portal/folder_48.gif" ];
Default icon to display for folder items that do not supply an icon.
Property methods: folderIconDisplayToLogical(), folderIconGet(), folderIconIsValid(), folderIconLogicalToDisplay(), folderIconLogicalToOdbc(), folderIconNormalize(), folderIconSet()
property hilightTop as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true (default is false), then hilight the top-level rows in "list" mode.
Property methods: hilightTopDisplayToLogical(), hilightTopGet(), hilightTopIsValid(), hilightTopLogicalToDisplay(), hilightTopLogicalToOdbc(), hilightTopLogicalToXSD(), hilightTopNormalize(), hilightTopSet(), hilightTopXSDToLogical()
property itemIcon as %ZEN.Datatype.uri [ InitialExpression = "portal/document_48.gif" ];
Default icon to display for items that do not supply an icon.
Property methods: itemIconDisplayToLogical(), itemIconGet(), itemIconIsValid(), itemIconLogicalToDisplay(), itemIconLogicalToOdbc(), itemIconNormalize(), itemIconSet()
property listColumns as %ZEN.Datatype.csv;
If defined, this is a list of properties that supply the column values in 'list' mode.
Property methods: listColumnsDisplayToLogical(), listColumnsGet(), listColumnsIsValid(), listColumnsLogicalToDisplay(), listColumnsLogicalToOdbc(), listColumnsNormalize(), listColumnsSet()
property msgNoPriv as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("You do not have privilege to view this page.","%ZEN") ];
Property methods: msgNoPrivDisplayToLogical(), msgNoPrivGet(), msgNoPrivIsValid(), msgNoPrivLogicalToDisplay(), msgNoPrivLogicalToOdbc(), msgNoPrivNormalize(), msgNoPrivSet()
property oncancel as %ZEN.Datatype.eventHandler;
oncancel event handler: If defined, this event is fired when the user presses the escape key within the finder.
Property methods: oncancelDisplayToLogical(), oncancelGet(), oncancelIsValid(), oncancelLogicalToDisplay(), oncancelLogicalToOdbc(), oncancelNormalize(), oncancelSet()
property ondblclick as %ZEN.Datatype.eventHandler;
ondblclick event handler: If defined, this event is fired when the user double-clicks on an item within the finder.
Property methods: ondblclickDisplayToLogical(), ondblclickGet(), ondblclickIsValid(), ondblclickLogicalToDisplay(), ondblclickLogicalToOdbc(), ondblclickNormalize(), ondblclickSet()
property ondrawdetails as %ZEN.Datatype.eventHandler;
ondrawdetails event handler: If defined, this event is fired when an item with no children is selected. If this event handler returns a value, then it is used as DHTML to render the item details.
Property methods: ondrawdetailsDisplayToLogical(), ondrawdetailsGet(), ondrawdetailsIsValid(), ondrawdetailsLogicalToDisplay(), ondrawdetailsLogicalToOdbc(), ondrawdetailsNormalize(), ondrawdetailsSet()
property ondrawempty as %ZEN.Datatype.eventHandler;
ondrawempty event handler: If defined, this event is fired when there is no data available to display within the finder. If this event handler returns a value, then it is used as DHTML providing content for the empty finder.
Property methods: ondrawemptyDisplayToLogical(), ondrawemptyGet(), ondrawemptyIsValid(), ondrawemptyLogicalToDisplay(), ondrawemptyLogicalToOdbc(), ondrawemptyNormalize(), ondrawemptySet()
property ondrawitem as %ZEN.Datatype.eventHandler;
ondrawitem event handler: If defined, this event is fired when an item within the finder is about to be drawn. If this event handler returns a value, then it is used as DHTML to render the item contents.
Property methods: ondrawitemDisplayToLogical(), ondrawitemGet(), ondrawitemIsValid(), ondrawitemLogicalToDisplay(), ondrawitemLogicalToOdbc(), ondrawitemNormalize(), ondrawitemSet()
property ongetdata as %ZEN.Datatype.eventHandler;
ongetdata event handler: This defines the client-side code that returns an graph of javascript objects used to provide the contents of the finder.
Property methods: ongetdataDisplayToLogical(), ongetdataGet(), ongetdataIsValid(), ongetdataLogicalToDisplay(), ongetdataLogicalToOdbc(), ongetdataNormalize(), ongetdataSet()
property ongeticon as %ZEN.Datatype.eventHandler;
ongeticon event handler: If defined, this event is fired when the finder is in "icons" view and returns the url of the icon to use; if it returns "", then the default icon is used.
The current item is passed as item.
Property methods: ongeticonDisplayToLogical(), ongeticonGet(), ongeticonIsValid(), ongeticonLogicalToDisplay(), ongeticonLogicalToOdbc(), ongeticonNormalize(), ongeticonSet()
property onlazyload as %ZEN.Datatype.eventHandler;
onlazyload event handler: Used to partially load data into the finder. This defines the client-side code that returns an graph of javascript objects that are used as the children of the current node.
Property methods: onlazyloadDisplayToLogical(), onlazyloadGet(), onlazyloadIsValid(), onlazyloadLogicalToDisplay(), onlazyloadLogicalToOdbc(), onlazyloadNormalize(), onlazyloadSet()
property onselectitem as %ZEN.Datatype.eventHandler;
onselectitem event handler: If defined, this event is fired when the user clicks on an item within the finder.
Property methods: onselectitemDisplayToLogical(), onselectitemGet(), onselectitemIsValid(), onselectitemLogicalToDisplay(), onselectitemLogicalToOdbc(), onselectitemNormalize(), onselectitemSet()
property parameters as array of %ZEN.Auxiliary.parameter (XMLKEYNAME = "paramName", XMLNAME = "parameter", XMLPROJECTION = "ELEMENT");
User-defined set of parameters. These are currently not used by the finder.
Property methods: parametersBuildValueArray(), parametersCollectionToDisplay(), parametersCollectionToOdbc(), parametersDisplayToCollection(), parametersGet(), parametersGetObject(), parametersGetObjectId(), parametersGetSwizzled(), parametersIsValid(), parametersOdbcToCollection(), parametersSet(), parametersSetObject(), parametersSetObjectId()
property selectFirstOnIconDrillDown as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true (default is true), the first item is preselected on drilldown in icon mode.
Property methods: selectFirstOnIconDrillDownDisplayToLogical(), selectFirstOnIconDrillDownGet(), selectFirstOnIconDrillDownIsValid(), selectFirstOnIconDrillDownLogicalToDisplay(), selectFirstOnIconDrillDownLogicalToOdbc(), selectFirstOnIconDrillDownLogicalToXSD(), selectFirstOnIconDrillDownNormalize(), selectFirstOnIconDrillDownSet(), selectFirstOnIconDrillDownXSDToLogical()
property selectedList as %ZEN.Datatype.csv;
This is a list of numbers (0-based) indicating the current selected item(s). The first number is the index in the top-most list of items; the second is the index within the children of the top-most item and so on.
Property methods: selectedListDisplayToLogical(), selectedListGet(), selectedListIsValid(), selectedListLogicalToDisplay(), selectedListLogicalToOdbc(), selectedListNormalize(), selectedListSet()
property upIcon as %ZEN.Datatype.uri [ InitialExpression = "portal/up_48.gif" ];
Up icon to display in icons mode.
Property methods: upIconDisplayToLogical(), upIconGet(), upIconIsValid(), upIconLogicalToDisplay(), upIconLogicalToOdbc(), upIconNormalize(), upIconSet()
property viewType as %ZEN.Datatype.string (VALUELIST = ",icons,list,columns") [ InitialExpression = "columns" ];
How the contents of the finder component are displayed.
Property methods: viewTypeDisplayToLogical(), viewTypeGet(), viewTypeIsValid(), viewTypeLogicalToDisplay(), viewTypeLogicalToOdbc(), viewTypeNormalize(), viewTypeSet()

Methods

clientmethod cancelEvent(evt) [ Language = javascript ]
Swallow a mouse event.
clientmethod getColumnsViewContent(graph) [ Language = javascript ]
Return HTML for columns mode.
clientmethod getFinderColumnHTML(graph, column, selectedList) [ Language = javascript ]
Return the HTML to render one column of the finder.
graph is the object graph describing the contents of the finder.
column is the column number to render (0 based).
selectedList is an array containing of the selected item for each column.
clientmethod getIconsViewContent(graph) [ Language = javascript ]
Return HTML for icons mode.
clientmethod getItem(addr) [ Language = javascript ]
Find the item in the object graph with the given address. addr is a list of array offsets starting with the topmost array in the graph: '2,4,2'.
clientmethod getListRowsHTML(array, selectedList, level, parentIdx) [ Language = javascript ]
Return HTML for rows within list mode. array is the data model to display.
selectedList is an array containing the selected list.
level is how many levels we are nested.
parentIdx an array of indexs for all levels above this one.
clientmethod getListViewContent(graph) [ Language = javascript ]
Return HTML for list mode.
clientmethod getObjectGraph() [ Language = javascript ]
Get object graph for finder.
clientmethod iconClickHandler(evt, list) [ Language = javascript ]
Mouse down handler for items in finder (in "icon" mode).
clientmethod iconDblClickHandler(evt, list) [ Language = javascript ]
Mouse double-click handler for items in finder (in "icon" mode).
clientmethod iconGoUp(evt) [ Language = javascript ]
Go up one level in "icon" mode.
clientmethod iconKeyPressHandler(evt, list) [ Language = javascript ]
Key press handler for items in finder (in "icons" mode).
clientmethod itemClickHandler(evt, list) [ Language = javascript ]
Mouse down handler for items in finder (in "columns" mode).
clientmethod itemDblClickHandler(evt, list) [ Language = javascript ]
Mouse double-click handler for items in finder (in "columns" mode).
clientmethod itemKeyPressHandler(evt, list) [ Language = javascript ]
Key press handler for items in finder (in "columns" mode).
clientmethod renderContents() [ Language = javascript ]
Draw contents of finder.
clientmethod rowClickHandler(evt, idx) [ Language = javascript ]
Mouse click handler for items in finder (in "list" mode).
clientmethod rowDisclosureClick(evt, idx) [ Language = javascript ]
Mouse disclosure click handler for items in finder (in "list" mode).
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod setViewType(type) [ Language = javascript ]
Set the current view type.
clientmethod update(reset) [ Language = javascript ]
Refresh the contents of the finder. If reset is true, unhighlight and unscroll the contents.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

Feedback