driver

Module: nmodule/driver/rc/wb/mgr/DriverMgr

new (require("nmodule/driver/rc/wb/mgr/DriverMgr"))()

API Status: Development

DriverMgr constructor. Contains functionality for working with components
within a driver network.

There is usually no reason to extend this directly; extend DeviceMgr or
PointMgr instead.

Extends:
  • module:nmodule/webEditors/rc/wb/mgr/Manager
Parameters:
Name Type Argument Description
params.keyName String <optional>

the key name used for lexicon entries for this view.
params.moduleName String <optional>

the module name used for lexicon entries for this view.
params.subscriptionDepth Number <optional>

the depth to subscribe the component tree.
params.folderType String | Type <optional>

optional parameter indicating the folder type
used for the manager view. This will be used by the NewFolder command.
See:

Methods

buildMainTableCell(column, row, dom)

Override of the base manager's build cell function.

Parameters:
Name Type Description
column module:nmodule/webEditors/rc/wb/table/model/Column

The column for the cell
row module:nmodule/webEditors/rc/wb/table/model/Row

The row for the cell
dom JQuery
Returns:
Type
Promise

componentAdded(parent, child)

Function called when a new component is added. If the
component is a folder and the all descendants command is selected,
we want to subscribe to that folder to the correct depth.

Parameters:
Name Type Description
parent baja.Component
child baja.Component

componentChanged(comp)

Function called when a property of one of the row's subjects or descendants
changes. This is used to update the table when, for example, a property
on a point's proxy extension is changed.

Parameters:
Name Type Description
comp baja.Component

The component notifying the changed property.

componentRemoved(value)

Function called when a subscribed component is removed. If the
component was a folder and the all descendants command is selected,
we want to unsubscribe to that folder.

Parameters:
Name Type Description
value baja.Component

componentRenamed(comp)

Function called when the depth subscriber notifies a renamed component. This will
try to emit a 'changed' event on the component source.

Parameters:
Name Type Description
comp

doDestroy()

Destroy the widget. This will clean up the event handler we have attached
for listening to descendant changes.

Returns:
Type
*

doInitialize(dom)

Manager initialization. In addition to the base manager initialization, this will configure
double click handling on the table rows and ensure that the basic commands are in the
appropriate default state.

Parameters:
Name Type Description
dom JQuery
Returns:
Type
*

doLoad(comp)

Load the widget from the component. This will hook up the event handlers to the
depth subscriber used by this type.

Parameters:
Name Type Description
comp baja.Component
Returns:
Type
Promise

finishMainTableRow(row, dom)

Overrides the basic manager #finishMainTableRow function with some extra css information
specified on the dom for the table row.

Parameters:
Name Type Description
row module:nmodule/webEditors/rc/wb/table/model/Row

a table row instance
dom JQuery

getSubject(elem)

Get the subject via the manager's main table.

Parameters:
Name Type Description
elem
Returns:
Type
*

getSubscriptionDepth()

Get the configured component subscription depth for the driver manager.
This value is specified by the 'subscriptionDepth' parameter property
in the constructor.

Returns:
Type
Number

makeCommands()

Return the default set of Command instances for a device manager. The
basic set are commands for creating a new folder (if a folder type was
specified in the constructor's parameters), creating a new point type
and editing an existing point type.

Concrete point manager types may override this function to append extra
commands and/or remove the default ones.

Returns:
Type
Array.<module:bajaux/commands/Command>