pui.widgets.add( config )

Owned by Alex Roytman
Last updated: May 03, 2024 by Emily Seage
4 min read

This function creates a new base widget from scratch.  The implementation of the widget will require advanced JavaScript coding.

Parameter:

  • config object - JavaScript object containing configuration properties

Configuration Options:

  • name - the new base widget name; also referred to as the "field type"

  • newId - the default id prefix - used to assign id's when the element is first created; for example if the newId is "Map", new elements created will have id's of Map1, Map2, Map3, etc.

  • menuName - pull-down menu name for the widget

  • defaults - an object with name/value pairs for default property settings for this base widget; these values can overridden by the pui.toolbox.add() function

  • propertySetters - an object representing a set of functions that are triggered when a particular widget property is changed; the "field type" function can be used as the main function to construct the widget; each function will receive a configuration parameter with the following properties:

    • originalValue - original value before the property was changed

    • newValue - new value (before scripting evaluation)

    • value - new value (after scripting evaluation)

    • properties - object representing the current property names and values for the widget

    • dom - reference to the main DOM element for the widget

    • oldDom - reference to the old DOM element (this will only be different from dom if the change to the widget property required the dom element to be changed or recreated)

    • propertyName - the name of the widget property being changed

    • design - flag that specifies whether the widget property is being changed at design time or at run time 

    • designItem - reference to the design item object for this widget

    • resizer - reference to the resizer object for this widget

    • evalProperty - function that can be used to evaluate scripted properties

  • globalPropertySetter - a global function that is triggered every time any widget property is changed. globalPropertySetter is discarded when a widget is defined as a pui.BasicWidget–it uses either the options "constr" or render and getValue.

  • tag - the tag of the main DOM element; if omitted, "div" tag is assummed

  • inputType - if the "input" tag is specified, this option specifies the input type, such as "text", "checkbox", "radio", "password", etc.

  • resizable - if false is specified, the widget cannot be resized in the designer

  • canBelongToGrid - if false is specified, the widget cannot be dragged into a subfile grid

  • dependencies - Array of strings and/or objects with URLs pointing to JavaScript or CSS files. At run time, these will be loaded into your session (if not there already) only if your widget is used on the current format.  At design time, all dependencies are loaded when the Visual Designer is loaded or Genie is switched into Design Mode. (Available starting with Profound UI Version 5, Fix Pack 8.0). 

    • Strings: when the string contains a URL the CSS or JavaScript file will always be loaded before a screen renders or Designer loads.

    • Objects: A script can be conditionally loaded, according to the return value of a custom function. Supply an object with a "script" property containing a string, the URL of a conditionally loaded JavaScript file. Also supply a function to a "condition" property. The condition function should return true for when the script should be loaded prior to rendering. If the function returns false, then the script does not load. The function accepts these parameters:

      • properties - an Object with the current properties and values of the widget.

      • boundData - an Object with fields and values loaded from the server-side program.

      • designer - a boolean value. True means the page is Visual Designer or Node Designer; false means the page is not in a Designer.

  • render - A function that makes the custom widget use bidirectional custom properties if "getValue" is also supplied. The widget becomes a subclass of pui.BasicWidget, and the "render" function gets assigned to that instance of pui.BasicWidget. Profound UI calls "render" on bidirectional widgets after setting all properties. Render should be used to draw content instead of using property-setters. If the "constr" option is set, then "render" is ignored. Within render(), the special word, "this", points to the instance of pui.BasicWidget. (Available starting with Profound UI Version 6, Fix Pack 12.0)

  • getValue - A function that makes the custom widget use bidirectional custom properties if "render" is also supplied. The widget becomes a subclass of pui.BasicWidget, and the "getValue" function gets assigned to that instance of pui.BasicWidget. Profound UI calls "getValue" when building a screen response to send to the server-side program. Get value should fetch input values from custom elements and return a String. If the "constr" option is set, then "getValue" is ignored. Within render(), the special word, "this", points to the instance of pui.BasicWidget. (Available starting with Profound UI Version 6, Fix Pack 12.0)

  • constr - A reference to a class constructor of a subclass of pui.BasicWidget, which handles rendering and routing data to the server-side program. (See the pui.BasicWidget section below) (Available starting with Profound UI Version 6, Fix Pack 12.0)

Examples

There are examples of using the pui.widgets.add() API in the https://profoundlogicsupport.atlassian.net/l/cp/RujEA62n section of our documentation. We’ve listed some specific pages/examples below:

  1. https://profoundlogicsupport.atlassian.net/l/cp/ifJ1aRbb

  2. https://profoundlogicsupport.atlassian.net/l/cp/7u79Dv4S