new (require("nmodule/webEditors/rc/wb/mgr/model/columns/MixinPropMgrColumn"))(type, prop [, params])
API Status: Development
MgrColumn that allows you to edit a property on a baja:IMixIn
installed
on a component.
Extends:
Parameters:
Name | Type | Argument | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
type |
Type | the |
|||||||||
prop |
String | baja.Slot | the property you wish to edit |
|||||||||
params |
Object |
<optional> |
Properties
|
Throws:
-
if Type or prop are missing, or if prop is not a frozen
slot on the given Type - Type
- Error
Methods
-
buildCell(row, dom)
-
Creates the cell's contents by calling
toString
on the row's proposed value
or the current value if there is no proposal. HTML will be safely escaped.Parameters:
Name Type Description row
module:nmodule/webEditors/rc/wb/table/model/Row dom
JQuery - Inherited From:
Returns:
- Type
- Promise
-
coalesceRows(rows)
-
Given the set of rows to be edited, coalesce their values into one single
value to load into an editor.By default, this will simply read the proposed value from the first row.
This is appropriate for a use case where one value will be entered and
written back to all edited components.Parameters:
Name Type Description rows
Array.<module:nmodule/webEditors/rc/wb/table/model/Row> - Inherited From:
Throws:
-
if rows array not given, or values from rows are not all
of the same type - Type
- Error
Returns:
value coalesced from the given rows
- Type
- *
-
commit(value, row [, params])
-
Sets the value to the mixin instance on the row's component. If the
component does not have an instance of the mixin, a new one will be
created.Parameters:
Name Type Argument Description value
baja.Value row
module:nmodule/webEditors/rc/wb/table/model/Row params
Object <optional>
Returns:
- Type
- Promise
-
destroyCell(row, dom)
-
Called when the table is destroying the DOM element built for a cell in this column. This
gives aColumn
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 toPromise.resolve()
.Parameters:
Name Type Description row
module:nmodule/webEditors/rc/wb/table/model/Row dom
jQuery - Inherited From:
Returns:
- Type
- Promise | *
-
getColumnIcon()
-
Returns a URI for an icon representing this column. Returns
null
by
default; override as needed in subclasses.- Inherited From:
Returns:
a URI for an icon to be shown for this column.
- Type
- String
-
getConfigFor(rows)
-
When creating an editor for this column, use the value coalesced from the
given rows, and respect any slot Facets on the mixin Type.Parameters:
Name Type Description rows
Array.<module:nmodule/webEditors/rc/wb/table/model/Row> Returns:
config with value and facets
- Type
- Object
-
getFlags()
-
Get the flags set on this column.
- Inherited From:
Returns:
- Type
- Number
-
getName()
-
Get the column name or
null
if none was given.- Inherited From:
Returns:
- Type
- String
-
getProposedValueFor(row)
-
Get the currently proposed value for the given row. If no value proposed
yet, will return the actual column value (getValueFor
).Parameters:
Name Type Description row
module:nmodule/webEditors/rc/wb/table/model/Row Returns:
- Type
- *
-
getValueFor(row)
-
Get the property from the mixin instance on this row's component. If
the component does not have an instance of that mixin (e.g. it is an
unmounted component created browser-side), the default value from an
instance of that mixin will be returned.Parameters:
Name Type Description row
module:nmodule/webEditors/rc/wb/table/model/Row Returns:
- Type
- baja.Value
-
hasFlags(flags)
-
Return true if the column has all of the given flags.
Parameters:
Name Type Description flags
Number flags to check for
- Inherited From:
Returns:
- Type
- Boolean
-
isEditable()
-
Return true if the column is editable.
- Inherited From:
Returns:
- Type
- Boolean
-
isEditorSuitable(editor, rows)
-
If an editor has already been built, it may be possible to reuse it,
simply loading in a new coalesced value rather than destroying and
rebuilding the existing editor.This function should return true if the editor is suitable to be reused
for the given rows. By default, will always return true.Parameters:
Name Type Description editor
module:nmodule/webEditors/rc/fe/baja/BaseEditor rows
Array.<module:nmodule/webEditors/rc/wb/table/model/Row> Returns:
- Type
- Boolean
-
isHidable()
-
Return true if the column should available in the table's show/hide context menu.
Defaults to true.- Inherited From:
Returns:
- Type
- Boolean
-
isReadonly()
-
Return true if the column is readonly.
- Inherited From:
Returns:
- Type
- Boolean
-
isSortable()
-
Returns a boolean indicating whether the column should not be sortable via the table headings.
Defaults to true.- Inherited From:
Returns:
- Type
- Boolean
-
isUnseen()
-
Return true if the column is unseen.
- Inherited From:
Returns:
- Type
- Boolean
-
mgrValidate(model, data [, params])
-
Allows this column to validate proposed changes.
Parameters:
Name Type Argument 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 theMgrModel
. If a value in this array is null, no change has
been proposed for that row.params
Object <optional>
Properties
Name Type Argument 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.- Inherited From:
Returns:
promise that resolves by default
- Type
- Promise
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')); } } };
-
propose(value, row)
-
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.Parameters:
Name Type Description value
* row
module:nmodule/webEditors/rc/wb/table/model/Row - Inherited From:
Returns:
- Type
- Promise
-
setEditable(editable)
-
Set or unset the column's
EDITABLE
flag. Emits aflagsChanged
event.Parameters:
Name Type Description editable
boolean - Inherited From:
-
setFlags(flags)
-
Set the column's flags.
Parameters:
Name Type Description flags
Number - Inherited From:
Throws:
-
if a non-Number given
- Type
- Error
-
setHidable(hidable)
-
Set or unset whether the column should be allowed to be hidden or shown by the table's
show/hide context menu.Parameters:
Name Type Description hidable
boolean - Inherited From:
-
setReadonly(readonly)
-
Set or unset the column's
READONLY
flag. Emits aflagsChanged
event.Parameters:
Name Type Description readonly
boolean - Inherited From:
-
setSortable(sortable)
-
Set or unset whether the column should be allowed to be sorted by the table heading.
Parameters:
Name Type Description sortable
boolean - Inherited From:
-
setUnseen(unseen)
-
Set or unset the column's
UNSEEN
flag. Emits aflagsChanged
event.Parameters:
Name Type Description unseen
boolean - Inherited From:
-
toDisplayName()
-
Resolves a display name for this column.
- Inherited From:
Returns:
promise to be resolved when the element's display name
has been fully built. It's also acceptable for overrides of this function
to complete synchronously without returning a promise, so be sure to wrap
calls to this function inPromise.resolve()
when appropriate.- Type
- Promise | *