Zimlet JavaScript API Reference - DwtId

Class DwtId


This class is responsible for providing unique, predictable IDs for HTML elements. That way, code outside the client can locate particular elements.

Not every element that has an associated JS object will have a known ID. Those are allocated only for elements it would be useful to locate: major components of the UI, toolbars, buttons, views, menus, some menu items, and some selects.

There is a simple naming scheme for the IDs themselves. Each ID starts with a "z" followed by one to a few letters that indicate the type of object (widget) represented by the element.

Defined in: DwtId.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
DwtId()
Field Summary
Field Attributes Field Name and Description
<static>  
Defines the list view "headers" modifier.
<static>  
Defines the list view "rows" modifier.
<static>  
DwtId.WIDGET_HDR
Defines the widget "list view header".
<static>  
Defines the widget "list view header dropdown arrow".
<static>  
Defines the widget "list view header icon image".
<static>  
Defines the widget "list view header text".
<static>  
Defines the widget "sash between list view headers".
<static>  
Defines the widget "list view header table".
<static>  
DwtId.WIDGET_ITEM
Defines the widget "list view item".
<static>  
Defines the widget "list view item cell".
<static>  
Defines the widget "list view item field".
<static>  
Defines the widget "list view item row".
<static>  
Defines the widget "list view".
Method Summary
Method Attributes Method Name and Description
<static>  
DwtId.getIframeId(context)
Gets an ID for an IFRAME.
<static>  
DwtId.getListViewHdrId(type, context, hdr)
Gets an ID for an element within a list view header.
<static>  
DwtId.getListViewId(context, modifier)
Gets an ID for a list view.
<static>  
DwtId.getListViewItemId(type, context, itemId, field)
Gets an ID for an element associated with the display of an item in a list view.
Class Detail
DwtId()

Author: Conrad Damon.
Field Detail
<static> DwtId.LIST_VIEW_HEADERS
Defines the list view "headers" modifier.

<static> DwtId.LIST_VIEW_ROWS
Defines the list view "rows" modifier.

<static> DwtId.WIDGET_HDR
Defines the widget "list view header".

<static> DwtId.WIDGET_HDR_ARROW
Defines the widget "list view header dropdown arrow".

<static> DwtId.WIDGET_HDR_ICON
Defines the widget "list view header icon image".

<static> DwtId.WIDGET_HDR_LABEL
Defines the widget "list view header text".

<static> DwtId.WIDGET_HDR_SASH
Defines the widget "sash between list view headers".

<static> DwtId.WIDGET_HDR_TABLE
Defines the widget "list view header table".

<static> DwtId.WIDGET_ITEM
Defines the widget "list view item".

<static> DwtId.WIDGET_ITEM_CELL
Defines the widget "list view item cell".

<static> DwtId.WIDGET_ITEM_FIELD
Defines the widget "list view item field".

<static> DwtId.WIDGET_ITEM_ROW
Defines the widget "list view item row".

<static> DwtId.WIDGET_LIST_VIEW
Defines the widget "list view".
Method Detail
<static> {string} DwtId.getIframeId(context)
Gets an ID for an IFRAME.
Parameters:
{constant} context
the ID of owning DwtIframe
Returns:
{string} the ID

<static> {string} DwtId.getListViewHdrId(type, context, hdr)
Gets an ID for an element within a list view header.
Parameters:
{constant} type
the type of hdr element (see DwtId.WIDGET_HDR* constants)
{constant} context
the the ID of owning view
{constant} hdr
the header ID
Returns:
{string} the ID

<static> {string} DwtId.getListViewId(context, modifier)
Gets an ID for a list view.
Parameters:
{constant} context
the owning view identifier
{DwtId.LIST_VIEW_HEADERS|DwtId.LIST_VIEW_ROWS} modifier
indicates element within list view (see DwtId.LIST_VIEW* constants)
Returns:
{string} the ID

<static> {string} DwtId.getListViewItemId(type, context, itemId, field)
Gets an ID for an element associated with the display of an item in a list view.
Parameters:
{constant} type
the type of item element (see DwtId.WIDGET_ITEM* constants)
{constant} context
the ID of owning view
{string} itemId
the item ID (typically numeric)
{constant} field
the field identifier (for example, "su" for subject)
Returns:
{string} the ID

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:25 GMT-0400 (EDT)