loadSimplePrototype

Loads a TIBCO General Interface prototype into a location within Workspace.

Syntax

loadSimplePrototype(interfaceObject, source, location);

Parameters

  • interfaceObject - (Object) Object that launches the custom interface.
  • source - (string) A path to the TIBCO General Interface prototype. If null or an empty string, the source specified in customInterfaces.xml is used.
  • location - (string) (Optional) Either "areaA", "areaB", "areaC", "areaD", "dialog", or "browser". If null or an empty string, the location specified in the custom interface definition is used, however, if "script" is specified in the definition, this parameter must be supplied, and an exception is thrown if location is not provided.

    The method throws an exception if the specified location is not valid, given the location of the menu item or toolbar button (interfaceObject) that launches the interface (see Valid Custom Interface Locations).

Returns

Returns the parent container for the prototype that has been loaded, as follows:

  • jsx3.gui.Dialog (if 'dialog' location is specified)
  • jsx3.gui.Window (if 'browser' location is specified)
  • jsx3.gui.Block (if 'areaA', 'areaB', 'areaC' or 'areaD' location is specified)