Plugin.DataTableQuickEdit Class
The QuickEdit plugin provides a new mode for DataTable where all
values in the table can be edited simultaneously, controlled by the
column configuration. Each editable cell contains an input field. If
the user decides to save the changes, then you can extract the changed
values by calling dt.qe.getChanges()
.
For a column to be editable in QuickEdit mode, the column
configuration must include quickEdit
. The contents of
this object define the column's behavior in QuickEdit mode.
To move up or down within a column while in QuickEdit mode, hold down the Ctrl key and press the up or down arrow.
If a column should not be editable, but needs to be formatted
differently in QuickEdit mode, then you must define qeFormatter in
the column configuration. This is simply a normal cell formatter
function that will be used in QuickEdit mode. The static functions
readonly*Formatter
provide examples.
The following configuration can be provided as part of quickEdit:
- changed
- Optional. The function to call with the old and new value. Should return true if the values are different.
- formatter
- The cell formatter which will render an appropriate form field: <input type="text">, <textarea>, or <select>.
- validation
- Validation configuration for every field in the column.
- copyDown
- If true, the top cell in the column will have a button to copy the value down to the rest of the rows.
The following configuration can be provided as part of quickEdit.validation:
- css
- CSS classes encoding basic validation rules:
yiv-required
- Value must not be empty.
yiv-length:[x,y]
- String must be at least x characters and at most y characters. At least one of x and y must be specified.
yiv-integer:[x,y]
- The integer value must be at least x and at most y. x and y are both optional.
yiv-decimal:[x,y]
- The decimal value must be at least x and at most y. Exponents are not allowed. x and y are both optional.
- fn
- A function that will be called with the DataTable as its scope and the cell's form element as the argument. Return true if the value is valid. Otherwise, call this.qe.displayMessage(...) to display an error and return false.
- msg
- A map of types to messages that will be displayed when a basic or regex validation rule fails. The valid types are: required, min_length, max_length, integer, decimal, and regex. There is no default for type regex, so you must specify a message if you configure a regex validation.
- regex
- Regular expression that the value must satisfy in order to be considered valid.
Custom QuickEdit Formatters
To write a custom cell formatter for QuickEdit mode, you must structure the function as follows:
function myQuickEditFormatter(o) { var markup = '<input type="text" class="{yiv} quickedit-field quickedit-key:{key}" value="{value}"/>' + '{cd}' + Y.Plugin.DataTableQuickEdit.error_display_markup; var qe = o.column.quickEdit; return Y.Lang.sub(markup, { key: o.column.key, value: o.value.toString().replace(/"/g, '"'), yiv: qe.validation ? (qe.validation.css || '') : '', cd: QuickEdit.copyDownFormatter.call(this, o) }); };
You can use textarea or select instead of input, but you can only create a single field.
extractMyEditableValue
does not have to be a separate
function. The work should normally be done inline in the formatter
function, but the name of the sample function makes the point clear.
Constructor
Plugin.DataTableQuickEdit
-
config
Parameters:
-
config
ObjectObject literal to set component configuration.
Item Index
Methods
- _addAttrs
- _addLazyAttr
- _addOutOfOrder
- _aggregateAttrs
- _attrCfgHash
- _baseDestroy
- _baseInit
- _cloneDefaultValue
- _defAttrChangeFn
- _defDestroyFn
- _defInitFn
- _destroyHierarchy
- _filterAdHocAttrs
- _fireAttrChange
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getColumnKey
- _getElementStatus
- _getFullType
- _getInstanceAttrCfgs
- _getStateVal
- _getType
- _hasPotentialSubscribers
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _isLazyAttr
- _monitor
- _normAttrVals
- _parseType
- _preInitEventCfg
- _protectAttrs deprecated
- _publish
- _set
- _setAttr
- _setAttrs
- _setAttrVal
- _setStateVal
- addAttr
- addAttrs
- addTarget
- after
- afterHostEvent
- afterHostMethod
- attrAdded
- before
- beforeHostMethod
- bubble
- cancel
- clearMessages
- copyDownFormatter static
- destroy
- destructor
- detach
- detachAll
- displayMessage
- doAfter
- doBefore
- fire
- get
- getAttrs
- getChanges
- getEvent
- getTargets
- init
- initializer
- modifyAttr
- on
- once
- onceAfter
- onceAfterHostEvent
- onceHostEvent
- onHostEvent
- parseType
- publish
- readonlyEmailFormatter static
- readonlyLinkFormatter static
- removeAttr
- removeTarget
- reset
- set
- setAttrs
- start
- subscribe deprecated
- textareaFormatter static
- textFormatter static
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
- validate
Properties
- _allowAdHocAttrs
- _handles
- copy_down_button_class static
- error_display_markup static
- error_text_class static
- name deprecated
Attributes
Methods
_addAttrs
-
cfgs
-
values
-
lazy
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs. -
values
ObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only. -
lazy
BooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
_addLazyAttr
-
name
-
[lazyCfg]
Parameters:
-
name
ObjectThe name of the attribute -
[lazyCfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.
_addOutOfOrder
-
name
-
cfg
Parameters:
-
name
Stringattribute name -
cfg
Objectattribute configuration
_aggregateAttrs
-
allAttrs
Parameters:
-
allAttrs
ArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_attrCfgHash
()
private
_baseDestroy
()
private
_baseInit
()
private
_cloneDefaultValue
-
cfg
Parameters:
-
cfg
Object
_defAttrChangeFn
-
e
-
eventFastPath
Parameters:
-
e
EventFacadeThe event object for attribute change events. -
eventFastPath
BooleanWhether or not we're using this as a fast path in the case of no listeners or not
_defInitFn
-
e
Parameters:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyHierarchy
()
private
_filterAdHocAttrs
-
allAttrs
-
userVals
Parameters:
-
allAttrs
ObjectThe set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty. -
userVals
ObjectThe config object passed in by the user, from which adhoc attrs are to be filtered.
Returns:
_fireAttrChange
-
attrName
-
subAttrName
-
currVal
-
newVal
-
opts
-
[cfg]
Parameters:
-
attrName
StringThe name of the attribute -
subAttrName
StringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null. -
currVal
AnyThe current value of the attribute -
newVal
AnyThe new value of the attribute -
opts
ObjectAny additional event data to mix into the attribute change event's event facade. -
[cfg]
Object optionalThe attribute config stored in State, if already available.
_getAttr
-
name
Parameters:
-
name
StringThe name of the attribute.
Returns:
_getAttrCfg
-
name
Parameters:
-
name
StringOptional. The attribute name. If not provided, the method will return the configuration for all attributes.
Returns:
_getAttrCfgs
()
Object
protected
Returns:
_getAttrInitVal
-
attr
-
cfg
-
initValues
Parameters:
-
attr
StringThe name of the attribute -
cfg
ObjectThe attribute configuration object -
initValues
ObjectThe object with simple and complex attribute name/value pairs returned from _normAttrVals
Returns:
_getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
_getClasses
()
Function
protected
Returns:
_getColumnKey
-
e
Return the column key for the specified field.
Parameters:
-
e
Nodeform field
Returns:
_getElementStatus
-
e
-
r
Return the status of the field.
Parameters:
-
e
Nodeform field
-
r
RegExpregex to match against className
Returns:
_getFullType
-
type
Parameters:
-
type
StringThe short type to prefix
Returns:
_getInstanceAttrCfgs
-
allCfgs
addAttrs
,
from the static cached ATTRS for the class.
Parameters:
-
allCfgs
ObjectThe set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.
Returns:
addAttrs
.
_getStateVal
-
name
-
[cfg]
Parameters:
-
name
StringThe name of the attribute -
[cfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.
Returns:
_getType
()
private
_hasPotentialSubscribers
-
fullType
Parameters:
-
fullType
StringThe fully prefixed type name
Returns:
_initAttrHost
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor. -
values
ObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required. -
lazy
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initAttribute
()
private
_initAttrs
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor. -
values
ObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required. -
lazy
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initBase
-
config
Parameters:
-
config
ObjectThe constructor configuration object
_initHierarchy
-
userVals
Parameters:
-
userVals
ObjectObject with configuration property name/value pairs
_initHierarchyData
()
private
_isLazyAttr
-
name
Parameters:
-
name
StringThe name of the attribute
Returns:
_monitor
-
what
-
eventType
-
o
Parameters:
-
what
String'attach', 'detach', 'fire', or 'publish' -
eventType
String | CustomEventThe prefixed name of the event being monitored, or the CustomEvent object. -
o
ObjectInformation about the event interaction, such as fire() args, subscription category, publish config
_normAttrVals
-
valueHash
Parameters:
-
valueHash
ObjectAn object with attribute name/value pairs
Returns:
_parseType
()
private
_preInitEventCfg
-
config
Parameters:
-
config
ObjectThe user configuration object
_protectAttrs
-
attrs
Parameters:
-
attrs
ObjectA hash of attribute to configuration object pairs.
Returns:
_publish
-
fullType
-
etOpts
-
ceOpts
type
to fullType
conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
Parameters:
-
fullType
StringThe prefixed type of the event to publish. -
etOpts
ObjectThe EventTarget specific configuration to mix into the published event. -
ceOpts
ObjectThe publish specific configuration to mix into the published event.
Returns:
etOpts
or ceOpts
, this will
be the default CustomEvent
instance, and can be configured independently.
_set
-
name
-
val
-
[opts]
Parameters:
-
name
StringThe name of the attribute. -
val
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
_setAttr
-
name
-
value
-
[opts]
-
force
Parameters:
-
name
StringThe name of the attribute. -
value
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change. -
force
BooleanIf true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.
Returns:
_setAttrs
-
attrs
-
[opts]
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs. -
[opts]
Object optionalOptional data providing the circumstances for the change
Returns:
_setAttrVal
-
attrName
-
subAttrName
-
prevVal
-
newVal
-
[opts]
-
[attrCfg]
Parameters:
-
attrName
StringThe attribute name. -
subAttrName
StringThe sub-attribute name, if setting a sub-attribute property ("x.y.z"). -
prevVal
AnyThe currently stored value of the attribute. -
newVal
AnyThe value which is going to be stored. -
[opts]
Object optionalOptional data providing the circumstances for the change. -
[attrCfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.
Returns:
_setStateVal
-
name
-
value
Parameters:
-
name
StringThe name of the attribute -
value
AnyThe value of the attribute
addAttr
-
name
-
config
-
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
- value <Any>
- The initial value to set on the attribute
- valueFn <Function | String>
-
A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.
valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
- readOnly <boolean>
- Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
- writeOnce <boolean> or <string>
-
Whether or not the attribute is "write once". Attributes having writeOnce set to true,
can only have their values set once, be it through the default configuration,
constructor configuration arguments, or by invoking set.
The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)
- setter <Function | String>
-
The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.
setter can also be set to a string, representing the name of the instance method to be used as the setter function.
- getter <Function | String>
-
The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.
getter can also be set to a string, representing the name of the instance method to be used as the getter function.
- validator <Function | String>
-
The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.
validator can also be set to a string, representing the name of the instance method to be used as the validator function.
- lazyAdd <boolean>
- Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
Parameters:
-
name
StringThe name of the attribute. -
config
ObjectAn object with attribute configuration property/value pairs, specifying the configuration for the attribute.NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
-
lazy
Boolean(optional) Whether or not to add this attribute lazily (on the first call to get/set).
Returns:
addAttrs
-
cfgs
-
values
-
lazy
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs. -
values
ObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only. -
lazy
BooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
Returns:
addTarget
-
o
Parameters:
-
o
EventTargetthe target to add
after
-
type
-
fn
-
[context]
-
[arg*]
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
afterHostEvent
-
type
-
fn
-
context
Parameters:
-
type
String | ObjectThe event type. -
fn
FunctionThe listener. -
context
ObjectThe execution context. Defaults to the plugin instance.
Returns:
afterHostMethod
-
method
-
fn
-
context
Parameters:
-
method
StringThe name of the method to inject the function after. -
fn
FunctionThe function to inject. -
context
ObjectThe execution context. Defaults to the plugin instance.
Returns:
attrAdded
-
name
Parameters:
-
name
StringThe name of the attribute to check.
Returns:
before
()
Returns:
beforeHostMethod
-
method
-
fn
-
context
Parameters:
-
method
StringThe name of the method to inject the function before. -
fn
FunctionThe function to inject. -
context
ObjectThe execution context. Defaults to the plugin instance.
Returns:
bubble
-
evt
Parameters:
-
evt
CustomEventthe custom event to propagate
Returns:
cancel
()
Stop QuickEdit mode. THIS DISCARDS ALL DATA! If you want to save the data, call getChanges() BEFORE calling this function. If the table has paginators, you must show them.
clearMessages
()
Clear all validation messages in QuickEdit mode.
copyDownFormatter
-
o
-
td
Inserts a "Copy down" button if the cell is in the first row of the DataTable. Call this at the end of your QuickEdit formatter.
Parameters:
-
o
Objectcell formatter object
-
td
Nodecell
destroy
()
BaseCore
chainable
Returns:
A reference to this object
destructor
()
detach
-
type
-
fn
-
context
Parameters:
-
type
String | ObjectEither the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events. -
fn
FunctionThe subscribed function to unsubscribe, if not supplied, all subscribers will be removed. -
context
ObjectThe custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)
Returns:
detachAll
-
type
Parameters:
-
type
StringThe type, or name of the event
displayMessage
-
e
-
msg
-
type
-
scroll
Display a message for a QuickEdit field. If an existing message with a higher precedence is already visible, it will not be replaced.
Parameters:
-
e
Elementform field
-
msg
Stringmessage to display
-
type
Stringmessage type: error, warn, success, info
-
scroll
BooleanIf false, does not scroll, even if this is the first message to display.
doAfter
-
strMethod
-
fn
-
context
Parameters:
-
strMethod
StringThe event to listen for, or method to inject logic after. -
fn
FunctionThe handler function. For events, the "after" moment listener. For methods, the function to execute after the given method is executed. -
context
ObjectAn optional context to call the handler with. The default context is the plugin instance.
Returns:
doBefore
-
strMethod
-
fn
-
context
Parameters:
-
strMethod
StringThe event to listen for, or method to inject logic before. -
fn
FunctionThe handler function. For events, the "on" moment listener. For methods, the function to execute before the given method is executed. -
context
ObjectAn optional context to call the handler with. The default context is the plugin instance.
Returns:
fire
-
type
-
arguments
Parameters:
-
type
String | ObjectThe type of the event, or an object that contains a 'type' property. -
arguments
Objectan arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.
Returns:
get
-
name
Parameters:
-
name
StringThe name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g.get("x.y.z")
)
Returns:
getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
getChanges
()
Mixed
Return the changed values. For each row, an object is created with
only the changed values. The object keys are the column keys. If
you need values from particular columns to be included always, even
if the value did not change, include the key changesAlwaysInclude
in the plugin configuration and pass an array of column keys.
If you need the row indexes, configure includeRowIndexInChanges
.
If you only want the records with changes, configure
includeAllRowsInChanges
to be false. For this to be useful, you
will need to configure either changesAlwaysInclude
or
includeRowIndexInChanges
.
Returns:
array of objects if all validations pass, false otherwise
getEvent
-
type
-
prefixed
Parameters:
-
type
Stringthe type, or name of the event -
prefixed
Stringif true, the type is prefixed already
Returns:
getTargets
()
Returns:
init
-
cfg
Parameters:
-
cfg
ObjectObject with configuration property name/value pairs
Returns:
initializer
-
config
Parameters:
-
config
ObjectConfiguration object with property name/value pairs.
modifyAttr
-
name
-
config
The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute:
- readOnly;
- writeOnce;
- broadcast; and
- getter.
Note: New attributes cannot be added using this interface. New attributes must be added using {{#crossLink "AttributeCore/addAttr:method"}}addAttr{{/crossLink}}, or an appropriate manner for a class which utilises Attributes (e.g. the {{#crossLink "Base/ATTRS:property"}}ATTRS{{/crossLink}} property in {{#crossLink "Base"}}Base{{/crossLink}}).
Parameters:
-
name
StringThe name of the attribute whose configuration is to be updated. -
config
ObjectAn object with configuration property/value pairs, specifying the configuration properties to modify.
on
-
type
-
fn
-
[context]
-
[arg*]
emitFacade = true
will
receive an EventFacade
as the first argument (typically named "e").
These callbacks can then call e.preventDefault()
to disable the
behavior published to that event's defaultFn
. See the EventFacade
API for all available properties and methods. Subscribers to
non-emitFacade
events will receive the arguments passed to fire()
after the event name.
To subscribe to multiple events at once, pass an object as the first
argument, where the key:value pairs correspond to the eventName:callback.
this.on({
"attrChange" : this._onAttrChange,
"change" : this._onChange
});
You can also pass an array of event names as the first argument to
subscribe to all listed events with the same callback.
this.on([ "change", "attrChange" ], this._onChange);
Returning false
from a callback is supported as an alternative to
calling e.preventDefault(); e.stopPropagation();
. However, it is
recommended to use the event methods whenever possible.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
once
-
type
-
fn
-
[context]
-
[arg*]
on
except the
listener is immediatelly detached when it is executed.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
onceAfter
-
type
-
fn
-
[context]
-
[arg*]
after
except the
listener is immediatelly detached when it is executed.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
onceAfterHostEvent
-
type
-
fn
-
context
Parameters:
-
type
String | ObjectThe event type. -
fn
FunctionThe listener. -
context
ObjectThe execution context. Defaults to the plugin instance.
Returns:
onceHostEvent
-
type
-
fn
-
context
Parameters:
-
type
String | ObjectThe event type. -
fn
FunctionThe listener. -
context
ObjectThe execution context. Defaults to the plugin instance.
Returns:
onHostEvent
-
type
-
fn
-
context
Parameters:
-
type
String | ObjectThe event type. -
fn
FunctionThe listener. -
context
ObjectThe execution context. Defaults to the plugin instance.
Returns:
parseType
-
type
-
[pre]
Parameters:
-
type
Stringthe type -
[pre]
String optionalThe prefix. Defaults to this._yuievt.config.prefix
Returns:
publish
-
type
-
opts
Parameters:
-
type
Stringthe type, or name of the event -
opts
Objectoptional config params. Valid properties are:-
[broadcast=false]
Boolean optionalwhether or not the YUI instance and YUI global are notified when the event is fired.
-
[bubbles=true]
Boolean optionalWhether or not this event bubbles. Events can only bubble if
emitFacade
is true. -
[context=this]
Object optionalthe default execution context for the listeners.
-
[defaultFn]
Function optionalthe default function to execute when this event fires if preventDefault was not called.
-
[emitFacade=false]
Boolean optionalwhether or not this event emits a facade.
-
[prefix]
String optionalthe prefix for this targets events, e.g., 'menu' in 'menu:click'.
-
[fireOnce=false]
Boolean optionalif an event is configured to fire once, new subscribers after the fire will be notified immediately.
-
[async=false]
Boolean optionalfireOnce event listeners will fire synchronously if the event has already fired unless
async
istrue
. -
[preventable=true]
Boolean optionalwhether or not
preventDefault()
has an effect. -
[preventedFn]
Function optionala function that is executed when
preventDefault()
is called. -
[queuable=false]
Boolean optionalwhether or not this event can be queued during bubbling.
-
[silent]
Boolean optionalif silent is true, debug messages are not provided for this event.
-
[stoppedFn]
Function optionala function that is executed when stopPropagation is called.
-
[monitored]
Boolean optionalspecifies whether or not this event should send notifications about when the event has been attached, detached, or published.
-
[type]
String optionalthe event type (valid option if not provided as the first parameter to publish).
-
Returns:
readonlyEmailFormatter
-
o
Called with exactly the same arguments as any other cell formatter, this function displays an email address without the anchor tag. Use this as the column's qeFormatter if the column should not be editable in QuickEdit mode.
Parameters:
-
o
Objectstandard DataTable formatter data
readonlyLinkFormatter
-
o
Called with exactly the same arguments as any other cell formatter, this function displays a link without the anchor tag. Use this as the column's qeFormatter if the column should not be editable in QuickEdit mode.
Parameters:
-
o
Objectstandard DataTable formatter data
removeAttr
-
name
Parameters:
-
name
StringThe name of the attribute to be removed.
reset
-
name
Parameters:
-
name
StringOptional. The name of the attribute to reset. If omitted, all attributes are reset.
Returns:
A reference to the host object.
set
-
name
-
value
-
[opts]
Parameters:
-
name
StringThe name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g.set("x.y.z", 5)
). -
value
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
setAttrs
-
attrs
-
[opts]
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
start
()
Switch to QuickEdit mode. Columns that have quickEdit defined will be editable. If the table has paginators, you must hide them.
subscribe
()
deprecated
textareaFormatter
-
o
Called with exactly the same arguments as any other cell formatter, this function displays a textarea field.
Parameters:
-
o
Objectstandard DataTable formatter data
textFormatter
-
o
Called with exactly the same arguments as any other cell formatter, this function displays an input field.
Parameters:
-
o
Objectstandard DataTable formatter data
toString
()
String
Returns:
String representation for this object
unsubscribe
()
deprecated
unsubscribeAll
-
type
Parameters:
-
type
StringThe type, or name of the event
validate
()
Boolean
Validate the QuickEdit data.
Returns:
true if all validation checks pass
Properties
_allowAdHocAttrs
Boolean
protected
Default: undefined (false)
_handles
Array
private
error_display_markup
String
static
The markup for the container for the error message inside a cell.
error_text_class
String
static
The CSS class that marks the container for the error message inside a cell.
name
String
deprecated
Attributes
destroyed
Boolean
readonly
Default: false
includeAllRowsInChanges
Boolean
If true, getChanges() returns a record for every row, even if the record is empty. Set to false if you want getChanges() to only return records that contain data.
Default: true
Events
destroy
Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.
Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).
Event Payload:
-
e
EventFacadeEvent object
init
Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.
Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).
Event Payload:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.