This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > %ZEN.Component.objectInspector

%ZEN.Component.objectInspector

class %ZEN.Component.objectInspector extends %ZEN.Component.dynaGrid

Displays contents of a given client component.
This is used by ZEN tools.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTGRIDCLASS = inspectorGrid;
Subclasses can set this to change default css class used for grids.
parameter DEFAULTGRIDLABEL = Property;
Inherited description: Default value for the gridLabel property.
parameter DEFAULTROWLABELWIDTH = 150;
Inherited description: Default value for the rowLabelWidth property in pixels.

Properties (Including Private)

property currMember as %ZEN.Datatype.string (XMLPROJECTION = "none");
Client property that holds name of current property.
Property methods: currMemberDisplayToLogical(), currMemberGet(), currMemberIsValid(), currMemberLogicalToDisplay(), currMemberLogicalToOdbc(), currMemberNormalize(), currMemberSet(), currMemberTypeDisplayToLogical(), currMemberTypeGet(), currMemberTypeIsValid(), currMemberTypeLogicalToDisplay(), currMemberTypeLogicalToOdbc(), currMemberTypeNormalize(), currMemberTypeSet()
property currMemberType as %ZEN.Datatype.string (XMLPROJECTION = "none");
Client property that holds type of current property.
Property methods: currMemberTypeDisplayToLogical(), currMemberTypeGet(), currMemberTypeIsValid(), currMemberTypeLogicalToDisplay(), currMemberTypeLogicalToOdbc(), currMemberTypeNormalize(), currMemberTypeSet()
property idEditable as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, then the id property can be edited.
Property methods: idEditableDisplayToLogical(), idEditableGet(), idEditableIsValid(), idEditableLogicalToDisplay(), idEditableLogicalToOdbc(), idEditableLogicalToXSD(), idEditableNormalize(), idEditableSet(), idEditableXSDToLogical()
property onedit as %ZEN.Datatype.eventHandler;
onedit event handler:
This event is fired when the user presses the edit property button in the inspector. If not present, then the default action of launching the %ZEN.Dialog.componentValueEditor popup window is carried out.
Property methods: oneditDisplayToLogical(), oneditGet(), oneditIsValid(), oneditLogicalToDisplay(), oneditLogicalToOdbc(), oneditNormalize(), oneditSet(), oneditcellDisplayToLogical(), oneditcellGet(), oneditcellIsValid(), oneditcellLogicalToDisplay(), oneditcellLogicalToOdbc(), oneditcellNormalize(), oneditcellSet(), oneditkeydownDisplayToLogical(), oneditkeydownGet(), oneditkeydownIsValid(), oneditkeydownLogicalToDisplay(), oneditkeydownLogicalToOdbc(), oneditkeydownNormalize(), oneditkeydownSet(), oneditkeyupDisplayToLogical(), oneditkeyupGet(), oneditkeyupIsValid(), oneditkeyupLogicalToDisplay(), oneditkeyupLogicalToOdbc(), oneditkeyupNormalize(), oneditkeyupSet()
property onselect as %ZEN.Datatype.eventHandler;
onselect event handler: This event is fired when the user selects a property in the inspector.
Property methods: onselectDisplayToLogical(), onselectGet(), onselectIsValid(), onselectLogicalToDisplay(), onselectLogicalToOdbc(), onselectNormalize(), onselectSet(), onselectcellDisplayToLogical(), onselectcellGet(), onselectcellIsValid(), onselectcellLogicalToDisplay(), onselectcellLogicalToOdbc(), onselectcellNormalize(), onselectcellSet()
property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, values in the inspector cannot be edited.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToOdbc(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()
property showAll as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true show all properties of component, else just show settable properties.
Property methods: showAllDisplayToLogical(), showAllGet(), showAllIsValid(), showAllLogicalToDisplay(), showAllLogicalToOdbc(), showAllLogicalToXSD(), showAllNormalize(), showAllSet(), showAllXSDToLogical()

Methods (Including Private)

clientmethod acquireData() [ Language = javascript ]
Get the properties and values from the target object.
clientmethod applyValue(property, value) [ Language = javascript ]
Apply a value to the target object.
clientmethod dblClickHandler() [ Language = javascript ]
User double click on a cell.
clientmethod editMember(name) [ Language = javascript ]
User click on edit member button within inspector.
clientmethod getCellContents(data, r, c) [ Language = javascript ]
Prepares data for display within a given cell. If there is an ondrawcell() callback, it is invoked. This callback has a chance to chance the contents that will be displayed within the cell.
clientmethod getColumnInfo(c) [ Language = javascript ]
Return an object containing display information for column c (0-based).
clientmethod getCurrMember() [ Language = javascript ]
Return name of selected object member.
clientmethod getCurrMemberType() [ Language = javascript ]
Return type of selected object member.
clientmethod getCurrObject() [ Language = javascript ]
Return current object.
clientmethod getData(d1, d2, d3) [ Language = javascript ]
Return the data contained in the specified location. Location is 0-based;
clientmethod getDataSet() [ Language = javascript ]
Return the dataSet object associated with this grid. The inspector will serve as its own dataSet.
clientmethod getDimSize(dim) [ Language = javascript ]
Return the number of items in the specified dimension (dim is 1,2, or 3).
clientmethod getDimensions() [ Language = javascript ]
Return the number of dimensions in the dataSet.
clientmethod getDisplayValue(val) [ Language = javascript ]
Get the string to display for a given value.
clientmethod getEditCellHTML(r As %Library.String, c As %Library.String, value As %Library.String, which As %Library.String) [ Language = javascript ]
Return the HTML that renders the cell editor for the given cell. r and c are 1-based. Override to provide custom-behavior.
clientmethod getLabel(n, dim) [ Language = javascript ]
Get the label at position n (0-based) in the given dimension (1,2, or 3).
clientmethod getRowInfo(r) [ Language = javascript ]
Return an object containing display information for row r (0-based).
clientmethod getRowMemberName(r) [ Language = javascript ]
Find the property name associated with row r (0-based).
clientmethod getRowType(r) [ Language = javascript ]
Find what type of data should be in row r (0-based).
clientmethod onCreate() [ Language = javascript ]
Initialize additional client-side variables
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when a popup page has specified this component as its parent and fires an action.
popupName is the name of the popup window sending the action.
action is the name of the action.
value is the value associated with the action.
clientmethod renderInspector() [ Language = javascript ]
Redraw contents of object inspector
clientmethod selectCellHandler(r, c) [ Language = javascript ]
Notification that user is about to move to a new cell.
clientmethod setCellValue(value, r, c) [ Language = javascript ]
Set the value of grid cell; Row and column are 1-based.
clientmethod setCurrMember(name) [ Language = javascript ]
Set selected object member (given its name).
clientmethod setCurrObject(obj) [ Language = javascript ]
Make given component the current inspector target.
clientmethod setData(value, d1, d2, d3) [ Language = javascript ]
Set the data contained in the specified location. Location is 0-based;
clientmethod showCellButton(r, c) [ Language = javascript ]
If this method is defined, and returns true, then a button is displayed within the selected cell.
clientmethod update() [ Language = javascript ]
Update the values displayed within the inspector.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window