module:nmodule/webEditors/rc/wb/mgr/model/columns/NameMgrColumn

module:nmodule/webEditors/rc/wb/mgr/model/columns/NameMgrColumn

new (require("nmodule/webEditors/rc/wb/mgr/model/columns/NameMgrColumn"))(params)

Description:

  • API Status: Development

    MgrColumn subclass that allows components in a MgrModel to be renamed.

Source:
Extends:
Parameters:
Name Type Description
params Object

Extends

Methods

buildCell(row, dom) → {Promise}

Description:

  • Creates the cell's contents by calling getDisplayName on the row's proposed value
    or the current value if there is no proposal.
    If the row's subject does not have a displayName function, buildCell defers to the superclass.

Source:
Overrides:
Parameters:
Name Type Description
row module:nmodule/webEditors/rc/wb/table/model/Row
dom JQuery
Returns:
Type
Promise

coalesceRows(rows) → {string}

Source:
Overrides:
Parameters:
Name Type Description
rows Array.<module:nmodule/webEditors/rc/wb/table/model/Row>
Throws:

if more than one row is selected

Type
Error
Returns:

the component name when a single row is selected

Type
string

commit(value, row, paramsopt) → {Promise}

Description:

  • Renames the row's Component subject.

Source:
Overrides:
Parameters:
Name Type Attributes Description
value String

the new name
row module:nmodule/webEditors/rc/wb/table/model/Row
params Object <optional>
Properties
Name Type Attributes Description
batch baja.comm.Batch <optional>
Returns:

promise to be resolved when the component has
been renamed.

Type
Promise

destroyCell(row, dom) → {Promise|*}

Description:

  • Called when the table is destroying the DOM element built for a cell in this column. This
    gives a Column implementation the chance to clean up any resources that might have been
    created during the earlier call to #buildCell, perhaps destroying a widget in the cell,
    for example. As with #buildCell, if this completes synchronously and doesn't return a
    Promise, the caller must wrap this in a call to Promise.resolve().

Source:
Inherited From:
Parameters:
Name Type Description
row module:nmodule/webEditors/rc/wb/table/model/Row
dom JQuery
Returns:
Type
Promise | *

getColumnIcon() → {String}

Description:

  • Return object.png.

Source:
Overrides:
Returns:
Type
String

getConfigFor(rows) → {Object}

Description:

  • After coalescing the selected rows into a single value, calculate a
    config object to be given to fe.makeFor that will determine how the
    editor will be built to edit that value.

    This function will typically not be called directly but serves as an
    override point. By default, it will simply get the coalesced value from
    those rows and have fe.makeFor build the default editor for that value.
    Note that this means if the coalesced value is a non-Baja value, like an
    array, this function must be overridden.

Source:
Inherited From:
Parameters:
Name Type Description
rows Array.<module:nmodule/webEditors/rc/wb/table/model/Row>
Returns:

configuration object to be given to fe.makeFor

Type
Object

getFlags() → {Number}

Description:

  • Get the flags set on this column.

Source:
Inherited From:
Returns:
Type
Number

getName() → {String}

Description:

  • Get the column name or null if none was given.

Source:
Inherited From:
Returns:
Type
String

getProposedValueFor(row) → {*}

Description:

  • Get the currently proposed value for the given row. If no value proposed
    yet, will return the actual column value (getValueFor).

Source:
Inherited From:
Parameters:
Name Type Description
row module:nmodule/webEditors/rc/wb/table/model/Row
Returns:
Type
*

getValueFor(row) → {String}

Description:

  • Returns the row's Component subject's slot name.

Source:
Overrides:
Parameters:
Name Type Description
row module:nmodule/webEditors/rc/wb/table/model/Row
Returns:
Type
String

hasFlags(flags) → {Boolean}

Description:

  • Return true if the column has all of the given flags.

Source:
Inherited From:
Parameters:
Name Type Description
flags Number

flags to check for
Returns:
Type
Boolean

isEditable() → {Boolean}

Description:

  • Return true if the column is editable.

Source:
Inherited From:
Returns:
Type
Boolean

isEditorSuitable(editor, rows) → {boolean}

Description:

  • We can't set multiple components to the same name. So if editing more than
    one row, we need the editor to be a DisplayOnlyEditor.

Source:
Overrides:
Parameters:
Name Type Description
editor module:nmodule/webEditors/rc/fe/baja/BaseEditor
rows Array.<module:nmodule/webEditors/rc/wb/table/model/Row>
Returns:

true when:
there's more than one row and it's a DisplayOnlyEditor,
it's a frozen slot and it's a DisplayOnlyEditor, or
it's only one row and it's editable

Type
boolean

isExportable() → {Boolean}

Description:

  • Return true if the column should show up in export operations, e.g. to CSV.

Source:
Since:
  • Niagara 4.8
Inherited From:
Returns:
Type
Boolean

isHidable() → {Boolean}

Description:

  • Return true if the column should available in the table's show/hide context menu.
    Defaults to true.

Source:
Inherited From:
Returns:
Type
Boolean

isReadonly() → {Boolean}

Description:

  • Return true if the column is readonly.

Source:
Inherited From:
Returns:
Type
Boolean

isSortable() → {Boolean}

Description:

  • Returns a boolean indicating whether the column should not be sortable via the table headings.
    Defaults to true.

Source:
Inherited From:
Returns:
Type
Boolean

isUnseen() → {Boolean}

Description:

  • Return true if the column is unseen.

Source:
Inherited From:
Returns:
Type
Boolean

mgrValidate(model, data, paramsopt) → {Promise}

Description:

  • Allows this column to validate proposed changes.

Source:
Inherited From:
Example

Validating this column may require that I examine the changes I'm about to make to other columns as well.

MyMgrColumn.prototype.mgrValidate = function (model, data, params) {
  var that = this,
      rows = model.getRows(),
      otherColumn = model.getColumn('otherColumn');

  //search through all MgrModel rows, and check to see that my proposed
  //change is compatible with the proposed change to another column.
  //say, i'm a "password" column, and the other column is a "password
  //scheme" column - i need to make sure that the proposed password is
  //considered valid by the proposed password scheme.

  for (var i = 0; i < rows.length; i++) {
    var row = rows[i],
        myValue = data[i],
        otherValue = otherColumn.getProposedValueFor(row);

    if (myValue === null) {
      //no changes proposed for this row, so nothing to validate.
    }

    if (!isCompatible(myValue, otherValue)) {
      return Promise.reject(new Error('incompatible values'));
    }
  }
};
Parameters:
Name Type Attributes Description
model module:nmodule/webEditors/rc/wb/mgr/model/MgrModel

the model to which we're about to apply changes.
data Array

an array of proposed changes to this column, one per
row in the MgrModel. If a value in this array is null, no change has
been proposed for that row.
params Object <optional>
Properties
Name Type Attributes Description
editor module:nmodule/webEditors/rc/fe/baja/BaseEditor <optional>

the editor from which the proposed values were read. Note that the editor
may have been used to edit other rows, so the editor's current value may
not match the proposed new values.
Returns:

promise that resolves by default

Type
Promise

propose(value, row) → {Promise}

Description:

  • Should read the value and "tentatively" apply it to the
    selected row. In most cases this will be setting some temporary data
    for display-only purposes.

    By default, will set some temporary data on the row using the column's
    name as a key.

Source:
Inherited From:
Parameters:
Name Type Description
value *
row module:nmodule/webEditors/rc/wb/table/model/Row
Returns:
Type
Promise

setEditable(editable)

Description:

  • Set or unset the column's EDITABLE flag. Emits a flagsChanged event.

Source:
Inherited From:
Parameters:
Name Type Description
editable boolean

setExportable(exportable)

Description:

  • Set or unset whether the column should show up in export operations.

Source:
Since:
  • Niagara 4.8
Inherited From:
Parameters:
Name Type Description
exportable boolean

setFlags(flags)

Description:

  • Set the column's flags.

Source:
Inherited From:
Parameters:
Name Type Description
flags Number
Throws:

if a non-Number given

Type
Error

setHidable(hidable)

Description:

  • Set or unset whether the column should be allowed to be hidden or shown by the table's
    show/hide context menu.

Source:
Inherited From:
Parameters:
Name Type Description
hidable boolean

setReadonly(readonly)

Description:

  • Set or unset the column's READONLY flag. Emits a flagsChanged event.

Source:
Inherited From:
Parameters:
Name Type Description
readonly boolean

setSortable(sortable)

Description:

  • Set or unset whether the column should be allowed to be sorted by the table heading.

Source:
Inherited From:
Parameters:
Name Type Description
sortable boolean

setUnseen(unseen)

Description:

  • Set or unset the column's UNSEEN flag. Emits a flagsChanged event.

Source:
Inherited From:
Parameters:
Name Type Description
unseen boolean

toDisplayName() → {String}

Description:

  • Returns name from webEditors lexicon.

Source:
Overrides:
Returns:
Type
String