Class ZmId
Defined in: ZmId.js.
Method Detail
<static>
ZmId.create(params, description)
Returns a unique ID that can later be looked up. As many params as possible should be provided, in order to
make lookup easier. If one or more IDs is found to already have been created with the given set of params,
a sequence number is added as a parameter.
<static>
{String}
ZmId.getButtonId(context, op, tbType)
Generates the ID for a button. Intended for use with the top toolbar, nav toolbar,
and invite toolbar.
Examples:
<static>
{String}
ZmId.getComposeViewId(component)
Generates an ID for the compose view, or for a component within the compose view. Since
only one compose view is created, there is no need for a context to make the ID unique.
The component name is not joined with the "|" character for backward compatibility.
Examples:
<static>
{String}
ZmId.getMenuId(context, menuType)
Generates the ID for an action menu.
Examples:
<static>
{String}
ZmId.getMenuItemId(context, op, menuType)
Generates the ID for a menu item in an action menu.
Examples:
<static>
{String}
ZmId.getOverviewContainerId(overviewContainerId)
Generates the ID for an overview container.
<static>
{String}
ZmId.getOverviewId(overviewId)
Generates the ID for an overview.
Examples:
<static>
ZmId.getParams(id)
Returns the set of params used to create the given ID.
<static>
{String}
ZmId.getPrefPageId(tabKey)
Generates an ID for a pref page tab.
<static>
{String}
ZmId.getTabId(context, tabName)
Generates an ID for a tab (actually the tab button in the tab bar).
Tab contexts and names:
<static>
{String}
ZmId.getToolbarId(context, tbType)
Generates the ID for a toolbar.
Examples:
<static>
{String}
ZmId.getTreeId(overviewId, orgType)
Generates the ID for a tree within an overview.
Examples:
<static>
{String}
ZmId.getTreeItemId(overviewId, organizerId, type)
Generates a tree item ID based on the underlying organizer and the overview ID (since the same
organizer may be represented as tree items in more than one overview). Some sample IDs:
<static>
{String}
ZmId.getViewId(viewId, component, context)
Generates an ID for a view that fills the content area, or for a component of that
view. A context should be provided if the view is not a singleton (for example,
message view may appear within several double-pane views). The component name
is not joined with the "|" character in order to preserve backward compatibility.
Examples:
<static>
ZmId.lookup(params)
Returns the DOM ID that matches the given set of params. If more than one ID matches, a list is returned.
A partial set of params may be provided. The more params provided, the better the chance of finding just one ID.
The best approach is to provide the minimal set of params that will uniquely differentiate the element. If no
params are provided, returns all IDs.
Optionally, a list of values can be given. An attempt will be made to reverse-engineer the params by figuring
out the appropriate key for each value. This method will never be as reliable as providing a hash in the first place.
<static>
ZmId.showIds(params)
Displays a list of matching IDs in a popup, with the params used to create them and their descriptions.
Intended as a development tool.
|
||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:35 GMT-0400 (EDT)
|