Class Index | File Index

Classes


Function Namespace kocujILV12aCBackendSettingsFieldsImage

kocujILV12aCBackendSettingsFieldsImage
Defined in: image.js.

Function Namespace Summary
Constructor Attributes Constructor Name and Description
 
Image upload prototype constructor
Field Summary
Field Attributes Field Name and Description
<private>  
Object kocujILV12aHelper
<private>  
Projects list
<private>  
Current script filename
<private>  
Script settings - text for window button label
<private>  
Script settings - text for window title
<private>  
Script settings - throw errors (true) or not (false)
Method Summary
Method Attributes Method Name and Description
<private>  
_checkAddProject(projectId, projectName)
Check arguments for adding project
<private>  
_getHTMLNameImageContainer(projectId, fieldHtmlId, number)
Get HTML image container name
<private>  
_getHTMLNameImageId(projectId, fieldHtmlId, number)
Get HTML image identifier name
<private>  
_getHTMLNameUploadImageButton(projectId, fieldHtmlId, number)
Get HTML uploading image button name
<private>  
_parseProjectId(projectId)
Parse project identifier
<private>  
_throwError(codeString, param)
Throw an error if debugging is enabled
 
addProject(projectId, projectName)
Add project
 
addProjectIfNotExists(projectId, projectName)
Add project if not exists
 
getHTMLSelectorImageContainer(projectId, fieldHtmlId)
Get HTML selector for image container
 
getHTMLSelectorImageId(projectId, fieldHtmlId)
Get HTML selector for image identifier
 
getHTMLSelectorUploadImageButton(projectId, fieldHtmlId)
Get HTML selector for uploading image button
 
process(projectId, fieldHtmlId)
Process image uploading
Function Namespace Detail
kocujILV12aCBackendSettingsFieldsImage()
Image upload prototype constructor
Returns:
{void}
Field Detail
<private> _objHelper
Object kocujILV12aHelper

<private> _prj
Projects list

<private> _thisFilename
Current script filename

<private> _valsTextWindowButtonLabel
Script settings - text for window button label

<private> _valsTextWindowTitle
Script settings - text for window title

<private> _valsThrowErrors
Script settings - throw errors (true) or not (false)
Method Detail
<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> {string} _getHTMLNameImageContainer(projectId, fieldHtmlId, number)
Get HTML image container name
Parameters:
{string} projectId
Project identifier
{string} fieldHtmlId
HTML field identifier
{number} number
Number of element in array
Returns:
{string} HTML image container name

<private> {string} _getHTMLNameImageId(projectId, fieldHtmlId, number)
Get HTML image identifier name
Parameters:
{string} projectId
Project identifier
{string} fieldHtmlId
HTML field identifier
{number} number
Number of element in array
Returns:
{string} HTML image identifier name

<private> {string} _getHTMLNameUploadImageButton(projectId, fieldHtmlId, number)
Get HTML uploading image button name
Parameters:
{string} projectId
Project identifier
{string} fieldHtmlId
HTML field identifier
{number} number
Number of element in array
Returns:
{string} HTML uploading image button 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}

{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} getHTMLSelectorImageContainer(projectId, fieldHtmlId)
Get HTML selector for image container
Parameters:
{string} projectId
Project identifier
{string} fieldHtmlId
HTML field identifier
Returns:
{string} HTML selector for image container

{string} getHTMLSelectorImageId(projectId, fieldHtmlId)
Get HTML selector for image identifier
Parameters:
{string} projectId
Project identifier
{string} fieldHtmlId
HTML field identifier
Returns:
{string} HTML selector for image identifier

{string} getHTMLSelectorUploadImageButton(projectId, fieldHtmlId)
Get HTML selector for uploading image button
Parameters:
{string} projectId
Project identifier
{string} fieldHtmlId
HTML field identifier
Returns:
{string} HTML selector for uploading image button

{void} process(projectId, fieldHtmlId)
Process image uploading
Parameters:
{string} projectId
Project identifier
{string} fieldHtmlId
HTML field identifier
Returns:
{void}

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