HTML_CustomItemView Class

This class provides an abstract item view API to access any supported item view, that is, any DHTML/AJAX/JS item view widget with dedicated support. This class inherits the HTML_FormElement Class which inherits the HTML_Object Class. (See How to set up Support for Complex Widgets for how this API can be used to support those custom item view widgets which Squish doesn't support as standard.)

The API for the items in the item view is provided by the HTML_CustomItem Class.

The itemText used in many of the methods listed below identifies the relevant item. In the example shipped with Squish, the itemText is always the item's text as a string.

Here are some quick links to the HTML_CustomItemView class's methods and properties:

HTML_CustomItem HTML_CustomItemView.childItem()

HTML_CustomItem HTML_CustomItemView.childItem(column)

Returns a reference to the view's first item (of type HTML_CustomItem Class); or returns 0 if the view is empty.

The column is optional (and not all view's support it), but if it is specified (and supported), then the view's first child item in the given column is returned if there is one; otherwise 0 is returned.

HTML_CustomItemView.clickHandle(itemName)

Clicks the expand/collapse handle of the item called itemName.

HTML_CustomItemView.clickItem(itemName)

HTML_CustomItemView.clickItem(row, column)

This function clicks the item with the given itemName text or the item at the given row and column. If the item isn't found or if the extension doesn't support this function (some only support the itemName version), the function does nothing.

String HTML_CustomItemView.columnCaption(column)

Returns the view's caption for the given column.

HTML_CustomItemView.doubleClickItem(itemName)

HTML_CustomItemView.doubleClickItem(itemName, modifierState)

Double-clicks the item called itemName. See Web Object API Function Parameters for which values are valid for the optional modifierState.

HTML_CustomItem HTML_CustomItemView.findItem(itemName)

HTML_CustomItem HTML_CustomItemView.findItem(row, column)

This function returns a reference to the item (of type HTML_CustomItem Class) with the given itemName or at the given row and column. If the item isn't found or if the extension doesn't support this function (some only support the itemName version), the function returns 0.

Boolean HTML_CustomItemView.hasItem(itemName)

This function returns true if the view has an item called itemName; otherwise it returns false.

Boolean HTML_CustomItemView.isOpen(itemName)

This function returns true if the view has an item called itemName, and the item is open (i.e., any child items it has are visible); otherwise it returns false.

Boolean HTML_CustomItemView.isSelected(itemName)

This function returns true if the view has an item called itemName, and the item is seleced; otherwise it returns false.

int HTML_CustomItemView.numColumns

This read-only property holds the number of columns displayed in the view.

This is a synthetic property, see Synthetic Properties in Web Objects for more information.

int HTML_CustomItemView.numRows

This read-only property holds the number of rows displayed in the view. For tree views this is the number of top-level children. Not all extensions support this property, in which case its value is -1.

This is a synthetic property, see Synthetic Properties in Web Objects for more information.

String HTML_CustomItemView.realType

This read-only property holds the type name of the actual (i.e., real) type wrapped by this API as a string.

The type name might be, for example, "gwttree", or "itmilltree", or "dojotree", and so on.