Members
(constant) EXPORT_FORMAT :Object
Type:
- Object
(constant) OPTIONS :Object
Maps server side field types to alpaca field types options
Type:
- Object
Methods
_getRowFilterColumns(settings, colNames) → {Array}
Returns columns that have row filter defined
Parameters:
| Name | Type | Description |
|---|---|---|
settings |
||
colNames |
Returns:
- Type
- Array
_hasParentRow($currentRow) → {*}
Returns parent row unique id if current has a parent row
Parameters:
| Name | Type | Description |
|---|---|---|
$currentRow |
Returns:
- Type
- *
aaplyGroupHeader()
Add Group Header
Returns:
void
applyTableColumWidth()
Apply user specific width customization on table each column
Returns:
void
copyValueToClipboard()
Utility module for performing clipboard related operations. Utility functions can be accessed using singleton class "App.clipboard"
createFormTemplateService() → {Object}
Factory method to create form template service.
Returns:
object containing API methods of this class
- Type
- Object
decorateConfig(searchForm)
Adds autocomplete settings to fields in the search form config
Parameters:
| Name | Type | Description |
|---|---|---|
searchForm |
getExportPayload(dataTable, type) → {Object}
Generates and returns JSON object having data for export
Parameters:
| Name | Type | Description |
|---|---|---|
dataTable |
instance of the table which is being exported |
|
type |
EXPORT_FORMAT | export format |
Returns:
export payload
- Type
- Object
getFormContent(dataTable, type) → {DocumentFragment}
Builds form content for POST submit.
Parameters:
| Name | Type | Description |
|---|---|---|
dataTable |
instance of the table which is being exported |
|
type |
EXPORT_FORMAT | export format |
Returns:
- Type
- DocumentFragment
getPath(section, field) → {string}
Parameters:
| Name | Type | Description |
|---|---|---|
section |
||
field |
Returns:
- Type
- string
getValue(value, visibleValue) → {Object}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
||
visibleValue |
Returns:
- Type
- Object
handleServiceWorkerUpdate(action, payload, error)
Handles messages received from Service Worker. These are usually delayed.
Parameters:
| Name | Type | Description |
|---|---|---|
action |
||
payload |
||
error |
hide(dataTableWidget)
Hides empty box in the widget. Generally invoked when a table has data
Parameters:
| Name | Type | Description |
|---|---|---|
dataTableWidget |
App.dataTable.DataTable | instance |
highlightContent($container, value, optionsopt, DataTable)
Highlights matched content based on value
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
$container |
jQuery | jquery element defining the scope for toggling highlight |
|
value |
string | value to be highlighted |
|
options |
object |
<optional> |
options to be passed to the API |
DataTable |
object |
highlightElement($element)
Highlights the passed in element with yellow blink
Parameters:
| Name | Type | Description |
|---|---|---|
$element |
jQuery | jquery element that will be highlighted |
highlightRow($element)
Highlights the passed in element with light green
Parameters:
| Name | Type | Description |
|---|---|---|
$element |
jQuery | jquery element that will be highlighted |
isAny(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isAutocomplete(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isCheckbox(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isConnectMultiple(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isGroupHeader() → {boolean}
Check whether a table column has group header or not.
Returns:
- Type
- boolean
isMultiValue(field) → {boolean}
Check whether a field e.i attribute is a multi value at the schema level
Parameters:
| Name | Type | Description |
|---|---|---|
field |
Returns:
- Type
- boolean
isRadioButton(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isRichtext(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isSelect(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isSingleConnect(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isTextArea(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
removeExistingPanel()
utils Function to remove existing panels if any before loading new panel from view collection's toolbar
show(dataTableWidget)
Shows an empty box in the widget with a message indicating there's no data
Parameters:
| Name | Type | Description |
|---|---|---|
dataTableWidget |
App.dataTable.DataTable | instance |
submitExport(dataTable, type)
Builds data based on data table and submits to server for export
Parameters:
| Name | Type | Description |
|---|---|---|
dataTable |
||
type |
toggleContentHighlight($container, value)
Removes highlighting of content from container and marks new content based on passed in value
Parameters:
| Name | Type | Description |
|---|---|---|
$container |
jQuery | jquery element defining the scope for toggling highlight |
value |
string | value to be highlighted |
unHighlightContent($container, optionsopt)
Remove highlighting of all content within the container
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
$container |
jQuery | jquery element defining the scope for toggling highlight |
|
options |
object |
<optional> |
options to be passed to the API |
validateOptions() → {boolean}
Validates if the options are correctly configured.
Returns:
True if options is correctly configured, otherwise false.
- Type
- boolean