Namespace: util

Namespaces

clipboard

datetime

Event

url

xml

Methods

staticbcdui.util._sendFormRequest()

util/utilPackage.js, line 501

sends a HTTP request using HTML form submit {string} url the url to call {object} [args] optional arguments {string} [args.method=get] request method {string} [args.target=_blank] the target {string} [args.enctype=application/x-www-form-urlencoded] the enctype {object} [args.parameters] object map with parameters to send

staticbcdui.util.createCustomElement(elementName, createdCallback)

util/utilPackage.js, line 553

Custom element creation helper.

Name	Type	Description
elementName	string	The name of the custom element to create, must adhere to custom element standards.
createdCallback	function	The function which is called on the element once it is attached to the document, the context is set to the element.

staticbcdui.util.decodeURI(string){string}

util/utilPackage.js, line 247

Name	Type	Description
string	string	Value to be decoded

Returns:

Type	Description
string	dencoded string

staticbcdui.util.encodeURI(string){string}

util/utilPackage.js, line 237

Name	Type	Description
string	string	Value to be encoded

Returns:

Type	Description
string	encoded string

staticbcdui.util.escapeHtml(string){string}

util/utilPackage.js, line 226

Name	Type	Description
string	string	Value to be escaped

Returns:

Type	Description
string	Escaped string

staticbcdui.util.getBindingInfo(bindingSetId, bRefs, callback)

util/utilPackage.js, line 628

returns an object map holding information for a binding's items (id, description and type)

Name	Type	Description
bindingSetId	string	The id of the binding set
bRefs	string | array	requested binding items. Can be a comma-separated value list or an array
callback	function	The function which is called after a successful call of the BindingInfo servlet and returns the collected data

staticbcdui.util.getUuid(){string}

util/utilPackage.js, line 601

Generates a new UUID

Returns:

Type	Description
string	uuid

staticbcdui.util.interpolateXPath(xPath, fillParams){string}

util/utilPackage.js, line 672

transforms a xpath string with placeholders. A value with an apostrophe gets translated into a concat statement.

Name	Type	Description
xPath	string	xPath pointing to value (can include dot template placeholders which get filled with the given fillParams)
fillParams	Object	optional array or object holding the values for the dot placeholders in the xpath. Values with "'" get 'escaped' with a concat operation to avoid bad xpath expressions

Returns:

Type	Description
string	final xPath with filled in values for possibly existing placeholders

staticbcdui.util.setSubjectPreference(name, value, callback)

util/utilPackage.js, line 613

sets a subject preference

Name	Type	Description
name	string	The name of the subjectSetting
value	string	The value of for the subjectSetting specified by the name parameter. Can be a comma-separated value list
callback	function	The function which is called after a successful call of the subjectPreferences servlet

staticbcdui.util.toQueryParams(url, separator){string}

util/utilPackage.js, line 61

Logic derived from PrototypeJs library to "Parses a URI-like query string and returns an object composed of parameter/value pairs".

Name	Type	Description
url	string	URL with the parameters
separator

Returns:

Type	Description
string	An object with the parameters of the url as properties

staticbcdui.util.unescapeHtml(string){string}

util/utilPackage.js, line 214

Name	Type	Description
string	string	Value to be unescaped

Returns:

Type	Description
string	unescaped string