Import file to use in MicroFocus IDMAPPS module's forms.

Current capabilities are to add a tabbed control inside an HTML control that emits events and callbacks per tab, as well as some functions to work with stand-alone picklists.

Main files:

• IAtools.js: Import file source code
• IAtools.min.js: Minified version of the code
• IAtools.js: Source map file for the minified version
• IAtools-test.xml: example IDMAPPS (User Application/RBPM) workflow using this import.

Kind: global namespace

• IAtools : object
  • .tabCtrlFactory : object
    • ~addTab(id, name, order, fieldlist, cb) ⇒ boolean
    • ~removeTab(id) ⇒ boolean
    • ~setCSSClassName(type, name) ⇒ boolean
    • ~setFieldEventName(fieldname, eventname) ⇒ boolean
    • ~getSampleCSS() ⇒ text/html
    • ~getTabHTML(uniqueID) ⇒ text/html
  • .picklistFnFactory : object
    • ~PlFactory(selections, srcFieldName, destFieldName) ⇒ boolean
  • .version() ⇒ string
  • .init(field, form, IDVault)
  • .fieldVisibility(event, field) ⇒ undefined
  • .readAllPicklistOptions(fldName) ⇒ Object

IDMAPPS tab control sub-module.

Kind: static namespace of IAtools
Example

var tabname = IAtools.tabCtrlFactory();

• .tabCtrlFactory : object
  • ~addTab(id, name, order, fieldlist, cb) ⇒ boolean
  • ~removeTab(id) ⇒ boolean
  • ~setCSSClassName(type, name) ⇒ boolean
  • ~setFieldEventName(fieldname, eventname) ⇒ boolean
  • ~getSampleCSS() ⇒ text/html
  • ~getTabHTML(uniqueID) ⇒ text/html

Add tab to the internal storage. Underscore characters are NOT allowed as part of the ids since underscore will be used as a delimiter later. For order it is recommended to use large numbers to make it easier to insert new tabs in between any of the original ones without too much code changes/refactoring.

Kind: inner method of tabCtrlFactory
Returns: boolean - true if successful, false if invalid parameters are received or tab already exists

Removes tab from the internal storage.

Kind: inner method of tabCtrlFactory
Returns: boolean - true if successful, false if invalid parameters are received or tab doesn't exist

Allows to set the name of the CSS classes to be used when building the HTML code for the tabbed control

Kind: inner method of tabCtrlFactory
Returns: boolean - true if successful, false if any issues occurred.

Set the name of the visibility events per field name so that the tabbed control can show/hide the appropriated fields

Kind: inner method of tabCtrlFactory
Returns: boolean - true if successful, false if any issues occurred.

Sample CSS style for the tabbed control to demonstrate its usage.

Kind: inner method of tabCtrlFactory
Returns: text/html - Style HTML tag with working basic style for the HTML tabbed control

Builds and returns the HTML code to be set on an IDMAPPS string/HTML form field.

Kind: inner method of tabCtrlFactory
Returns: text/html - Style HTML tag with working HTML tabs

Builds functions to manage items on picklist control. Allows developer to define functions that copy or move items between picklists, as well as ones that remove items from picklists. Allows to specify sorting and pass in a custom sorting function to be used by the picklist management function generated.

Kind: static namespace of IAtools

Example

var addToPicklist = IAtools.picklistFnFactory( "add" );

Example

var moveToPicklistWithSort = IAtools.picklistFnFactory( "move", true );

Example

var removeCustomSort = IAtools.picklistFnFactory( "remove", true, function(a, b) { return a - b; } );

Returned Function that performs picklist management as per parameters passed to picklistFnFactory.

Kind: inner method of picklistFnFactory
Returns: boolean - false if validation of parameters or task failed, true otherwise.

Module version and requirements

Kind: static method of IAtools
Returns: string - Module's version

Initializes references to the IDMAPPs framework objects and save the same in the internal storage

Kind: static method of IAtools

When added in the event section of a form field, allow us to show and hide that field by using field.fireEvent( event-name, action ); Where event-name is the event's name and action is either 'show' or 'hide'

Since the field visibility functions only exist inside the field context we need to pass both objects from where the function is being called to use them inside that scope/context. Inside the event we just need to add the line: IAtools.fieldVisibility( event, field ); to properly use this function. No need to change anything on the line above, it is already passing the event and field objects as seen in the scope of that particular form field.

Kind: static method of IAtools
Returns: undefined - Changes the field visibility, no return value provided.

Reads a picklist field in RBPM and retrieves all its values/options. This is necessary since the RBPM standard API only lets us retrieve selected values, not the whole list of available ones.

Kind: static method of IAtools
Returns: Object - Returns an object with the format { 'data':[ picklist data ], 'display':[ picklist display values ] }