emptySelectionNode

Properties:

emptySelectionTemplate

Properties:

Name

Type

Description

Template

Simplate

used on lookups to have empty Selection option.
This template is not directly rendered but included in #viewTemplate.
The default template uses the following properties:
name description
----------------------------------------------------------------
emptySelectionText The text to display on the empty Selection button.
The default template exposes the following actions:
* emptySelection

itemTemplate

listActionItemTemplate

Properties:

Name

Type

Description

The

Simplate

template used to render a list action item.
The default template uses the following properties:
name description
----------------------------------------------------------------
actionIndex The correlating index number of the action collection
title Text used for ARIA-labeling
icon Relative path to the icon to use
cls CSS class to use instead of an icon
id Unique name of action, also used for alt image text
label Text added below the icon

listLoading

Properties:

loadingTemplate

Properties:

Name

Type

Description

The

Simplate

template used to render the loading message when the view is requesting more data.
The default template uses the following properties:
name description
----------------------------------------------------------------
loadingText The text to display while loading.

moreNode

Properties:

moreTemplate

Properties:

Name

Type

Description

The

Simplate

template used to render the pager at the bottom of the view. This template is not directly rendered, but is
included in #viewTemplate.
The default template uses the following properties:
name description
----------------------------------------------------------------
moreText The text to display on the more button.
The default template exposes the following actions:
* more

newTooltipText

Properties:

noDataTemplate

Properties:

Name

Type

Description

The

Simplate

template used to render a message if there is no data available.
The default template uses the following properties:
name description
----------------------------------------------------------------
noDataText The text to display if there is no data.

visibleActions

widgetTemplate

Properties:

Name

Type

Description

The

Simplate

template used to render the view's main DOM element when the view is initialized.
This template includes emptySelectionTemplate, moreTemplate and listActionTemplate.
The default template uses the following properties:
name description
----------------------------------------------------------------
id main container div id
title main container div title attr
cls additional class string added to the main container div
resourceKind set to data-resource-kind

Methods

_applyStateToActions(selection)

Called from checkActionState method and sets the state of the actions from what was selected from the selected row, it sets the disabled state for each action
item using the currently selected row as context by passing the action instance the selected row to the
action items `enabled` property.

Parameters:

activateEntry(params)

Handler for each row.
If a selection model is defined and navigation is disabled then toggle the entry/row
in the model and if singleSelectionAction is true invoke the singleSelectAction.
Else navigate to the detail view for the extracted data-key.

Returns:

Type

String

checkActionState()

Called when showing the action bar for a newly selected row, it sets the disabled state for each action
item using the currently selected row as context by passing the action instance the selected row to the
action items `enabled` property.

clear(all)

Clears the view by:
* clearing the selection model, but without it invoking the event handlers;
* clears the views data such as `this.entries` and `this.entries`;
* clears the search width if passed true; and
* applies the default template.

Returns:

this.acttions

Type

Object

createActions(actions)

Creates the action bar and adds it to the DOM. Note that it replaces `this.actions` with the passed
param as the passed param should be the result of the customization mixin and `this.actions` needs to be the
final actions state.

initModel()

invokeActionItem(parameters, evt, node)

This is the data-action handler for list-actions, it will locate the action instance viw the data-id attribute
and invoke either the `fn` with `scope` or the named `action` on the current view.
The resulting function being called will be passed not only the action item definition but also
the first (only) selection from the lists selection model.

navigateToEditView(action, selection, additionalOptions)

Helper method for list-actions. Navigates to the defined `this.editView` passing the given selections `idProperty`
property in the navigation options (which is then requested and result used as default data).

Helper method for list actions. Takes a view id, data point and where format string, sets the nav options
`where` to the formatted expression using the data point and shows the given view id with that option.

Parameters:

Name

Type

Description

action

Object

Action instance, not used.

selection

Object

Data entry for the selection.

viewId

String

View id to be shown

whereQueryFmt

String

Where expression format string to be passed. `${0}` will be the `idProperty`

additionalOptions

Object

Additional options to be passed into the next view
property of the passed selection data.

onTransitionTo(self)

Parameters:

open()

Available Options:
horizontal: True if the transition is horizontal, False otherwise.
reverse: True if the transition is a reverse transition (right/down), False otherwise.
track: False if the transition should not be tracked in history, True otherwise.
update: False if the transition should not update title and back button, True otherwise.
scroll: False if the transition should not scroll to the top, True otherwise.

routeShow(ctx, next)

Parameters:

selectEntry(params, evt, node)

Handler for the select or action node data-action. Finds the nearest node with the data-key attribute and
toggles it in the views selection model.
If singleSelectAction is defined, invoke the singleSelectionAction.

setSearchTerm()

setSource(source)

Sets the `this.options.source` to passed param after adding the views resourceKind. This function is used so
that when the next view queries the navigation context we can include the passed param as a data point.

showActionPanel(rowNode)

Handler for showing the list-action panel/bar - it needs to do several things:
1. Check each item for context-enabledment
1. Move the action panel to the current row and show it
1. Adjust the scrolling if needed (if selected row is at bottom of screen, the action-bar shows off screen
which is bad)