Class Index | File Index

Classes


Function Namespace kocujILV12aCBackendSettingsFormArray

kocujILV12aCBackendSettingsFormArray
Defined in: array.js.

Function Namespace Summary
Constructor Attributes Constructor Name and Description
 
Array prototype constructor
Field Summary
Field Attributes Field Name and Description
<private>  
Object kocujILV12aDataHelper
<private>  
Object kocujILV12aHelper
<private>  
Projects list
<private>  
Current script filename
<private>  
Script settings - div for element controls
<private>  
Script settings - div for element container
<private>  
Script settings - div for element field
<private>  
Script settings - HTML identifier format for array container
<private>  
Script settings - image with down arrow
<private>  
Script settings - image with up arrow
<private>  
Script settings - image with delete button
<private>  
Script settings - empty image
<private>  
Script settings - text for button for adding new element
<private>  
Script settings - throw errors (true) or not (false)
Method Summary
Method Attributes Method Name and Description
<private>  
_addNewEmptyField(projectId, formId, fieldId)
Add empty field
<private>  
_changeFields(projectId, formId, fieldId, numberAbove, numberBelow)
Change fields in array
<private>  
_checkAddProject(projectId, projectName)
Check arguments for adding project
<private>  
_deleteField(projectId, formId, fieldId, number)
Delete field in array
<private>  
_getHTMLNameArrayContainer(projectId, formId, fieldId, number)
Get HTML array container name
<private>  
_parseProjectId(projectId)
Parse project identifier
<private>  
_throwError(codeString, param)
Throw an error if debugging is enabled
<private>  
_updateControls(projectId, arrayId, number, changePrevNumber, prevNumber, changeNextNumber, nextNumber)
Update controls
 
addProject(projectId, projectName)
Add project
 
addProjectIfNotExists(projectId, projectName)
Add project if not exists
 
getHTMLSelectorArrayContainer(projectId, formId, fieldId)
Get HTML selector for array container
 
getHTMLSelectorArrayElementArrowDown(projectId, formId, fieldId, number)
Get HTML selector for array element down arrow
 
getHTMLSelectorArrayElementArrowUp(projectId, formId, fieldId, number)
Get HTML selector for array element up arrow
 
getHTMLSelectorArrayElementContainer(projectId, formId, fieldId, number)
Get HTML selector for array element container
 
getHTMLSelectorArrayElementContainerControlsDiv(projectId, formId, fieldId, number)
Get HTML selector for array element container controls div
 
getHTMLSelectorArrayElementContainerFieldDiv(projectId, formId, fieldId, number)
Get HTML selector for array element container field div
 
getHTMLSelectorArrayElementContainerFieldValue(projectId, formId, fieldId, number)
Get HTML selector for array element container field value
 
getHTMLSelectorArrayElementDelete(projectId, formId, fieldId, number)
Get HTML selector for array element delete
 
getHTMLSelectorArrayEmptyElementContainer(projectId, formId, fieldId)
Get HTML selector for array empty element container
 
process(projectId, formId, fieldId, emptyField, elementsCount, arraySettings)
Process array elements
Function Namespace Detail
kocujILV12aCBackendSettingsFormArray()
Array prototype constructor
Returns:
{void}
Field Detail
<private> _objDataHelper
Object kocujILV12aDataHelper

<private> _objHelper
Object kocujILV12aHelper

<private> _prj
Projects list

<private> _thisFilename
Current script filename

<private> _valsDivControls
Script settings - div for element controls

<private> _valsDivElementContainer
Script settings - div for element container

<private> _valsDivField
Script settings - div for element field

<private> _valsHtmlIdFormatArrayContainer
Script settings - HTML identifier format for array container

<private> _valsImageArrowDown
Script settings - image with down arrow

<private> _valsImageArrowUp
Script settings - image with up arrow

<private> _valsImageDelete
Script settings - image with delete button

<private> _valsImageEmpty
Script settings - empty image

<private> _valsTextButtonAddNewElement
Script settings - text for button for adding new element

<private> _valsThrowErrors
Script settings - throw errors (true) or not (false)
Method Detail
<private> {void} _addNewEmptyField(projectId, formId, fieldId)
Add empty field
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
Returns:
{void}

<private> {void} _changeFields(projectId, formId, fieldId, numberAbove, numberBelow)
Change fields in array
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} numberAbove
First number of element in array
{number} numberBelow
Second number of element in array
Returns:
{void}

<private> {Object} _checkAddProject(projectId, projectName)
Check arguments for adding project
Parameters:
{string} projectId
Project identifier
{string} projectName Optional
Project name
Throws:
{kocujILV12aCException}
kocujILV12aExceptionCode.EMPTY_PROJECT_ID if project identifier entered in projectId is empty
Returns:
{Object} Parsed arguments for adding project

<private> {void} _deleteField(projectId, formId, fieldId, number)
Delete field in array
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} number
Number of element in array
Returns:
{void}

<private> {string} _getHTMLNameArrayContainer(projectId, formId, fieldId, number)
Get HTML array container name
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} number
Number of element in array
Returns:
{string} HTML array container name

<private> {string} _parseProjectId(projectId)
Parse project identifier
Parameters:
{string} projectId
Project identifier
Throws:
{kocujILV12aCException}
kocujILV12aExceptionCode.EMPTY_PROJECT_ID if project identifier entered in projectId is empty
{kocujILV12aCException}
kocujILV12aExceptionCode.PROJECT_DOES_NOT_EXIST if project identifier entered in projectId does not exist
Returns:
{string} Parsed project identifier

<private> {void} _throwError(codeString, param)
Throw an error if debugging is enabled
Parameters:
{string} codeString
Error code in string format
{string} param Optional
Parameter for error information
Returns:
{void}

<private> {void} _updateControls(projectId, arrayId, number, changePrevNumber, prevNumber, changeNextNumber, nextNumber)
Update controls
Parameters:
{string} projectId
Project identifier
{number} arrayId
Identifier of array of fields
{number} number
Number of element in array
{boolean} changePrevNumber
Change previous number (true) or leave it as it is (false)
{number|string} prevNumber
Previous number or empty string if there is none
{boolean} changeNextNumber
Change next number (true) or leave it as it is (false)
{number|string} nextNumber
Next number or empty string if there is none
Returns:
{void}

{void} addProject(projectId, projectName)
Add project
Parameters:
{string} projectId
Project identifier
{string} projectName Optional
Project name
Throws:
{kocujILV12aCException}
kocujILV12aExceptionCode.PROJECT_ALREADY_EXISTS if project identifier entered in projectId already exists
Returns:
{void}

{void} addProjectIfNotExists(projectId, projectName)
Add project if not exists
Parameters:
{string} projectId
Project identifier
{string} projectName Optional
Project name
Returns:
{void}

{string} getHTMLSelectorArrayContainer(projectId, formId, fieldId)
Get HTML selector for array container
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
Returns:
{string} HTML selector for array container

{string} getHTMLSelectorArrayElementArrowDown(projectId, formId, fieldId, number)
Get HTML selector for array element down arrow
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} number
Number of element in array
Returns:
{string} HTML selector for array element down arrow

{string} getHTMLSelectorArrayElementArrowUp(projectId, formId, fieldId, number)
Get HTML selector for array element up arrow
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} number
Number of element in array
Returns:
{string} HTML selector for array element up arrow

{string} getHTMLSelectorArrayElementContainer(projectId, formId, fieldId, number)
Get HTML selector for array element container
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} number
Number of element in array
Returns:
{string} HTML selector for array element container

{string} getHTMLSelectorArrayElementContainerControlsDiv(projectId, formId, fieldId, number)
Get HTML selector for array element container controls div
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} number
Number of element in array
Returns:
{string} HTML selector for array element container controls div

{string} getHTMLSelectorArrayElementContainerFieldDiv(projectId, formId, fieldId, number)
Get HTML selector for array element container field div
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} number
Number of element in array
Returns:
{string} HTML selector for array element container field div

{string} getHTMLSelectorArrayElementContainerFieldValue(projectId, formId, fieldId, number)
Get HTML selector for array element container field value
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} number
Number of element in array
Returns:
{string} HTML selector for array element container field value

{string} getHTMLSelectorArrayElementDelete(projectId, formId, fieldId, number)
Get HTML selector for array element delete
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{number} number
Number of element in array
Returns:
{string} HTML selector for array element delete

{string} getHTMLSelectorArrayEmptyElementContainer(projectId, formId, fieldId)
Get HTML selector for array empty element container
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
Returns:
{string} HTML selector for array empty element container

{void} process(projectId, formId, fieldId, emptyField, elementsCount, arraySettings)
Process array elements
Parameters:
{string} projectId
Project identifier
{string} formId
Form identifier
{string} fieldId
Field identifier
{string} emptyField
Empty field
{number} elementsCount
Array elements count
{Object} arraySettings
Array settings
Returns:
{void}

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Mar 08 2018 21:48:57 GMT+0100 (CET)