DataTable.TableView Class
View class responsible for rendering a <table> from provided data. Used as
the default view for Y.DataTable.Base and Y.DataTable classes.
Item Index
Methods
- addAttr
- addAttrs
- addTarget
- after
- attachEvents
- attrAdded
- before
- bubble
- create
- destroy
- detach
- detachAll
- detachEvents
- fire
- get
- getAttrs
- getCell
- getEvent
- getRecord
- getRow
- getTargets
- init
- modifyAttr
- on
- once
- onceAfter
- parseType
- publish
- remove
- removeAttr
- removeTarget
- render
- reset
- set
- setAttrs
- subscribe deprecated
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
Properties
Attributes
Methods
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:
-
nameStringThe name of the attribute.
-
configObjectAn 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.
-
lazyBoolean(optional) Whether or not to add this attribute lazily (on the first call to get/set).
Returns:
A reference to the host object.
addAttrs
-
cfgs -
values -
lazy
Configures a group of attributes, and sets initial values.
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:
-
cfgsObjectAn object with attribute name/configuration pairs.
-
valuesObjectAn 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.
-
lazyBooleanWhether 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:
A reference to the host object.
addTarget
-
o
Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.
Events can only bubble if emitFacade is true.
Included in the event-custom-complex submodule.
Parameters:
-
oEventTargetthe target to add
after
-
type -
fn -
[context] -
[arg*]
Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.
Parameters:
Returns:
A subscription handle capable of detaching the subscription
attachEvents
-
[events]
Attaches delegated event handlers to this view's container element. This
method is called internally to subscribe to events configured in the
events attribute when the view is initialized.
You may override this method to customize the event attaching logic.
Parameters:
-
[events]Object optionalHash of events to attach. See the docs for the
eventsattribute for details on the format. If not specified, this view'seventsproperty will be used.
attrAdded
-
name
Checks if the given attribute has been added to the host
Parameters:
-
nameStringThe name of the attribute to check.
Returns:
true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.
before
()
Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.
For DOM and custom events: type, callback, context, 0-n arguments
For methods: callback, object (method host), methodName, context, 0-n arguments
Returns:
detach handle
bubble
-
evt
Propagate an event. Requires the event-custom-complex module.
Parameters:
-
evtCustomEventthe custom event to propagate
Returns:
the aggregated return value from Event.Custom.fire
create
-
[container]
Creates and returns a container node for this view.
By default, the container is created from the HTML template specified in the
containerTemplate property, and is not added to the DOM automatically.
You may override this method to customize how the container node is created
(such as by rendering it from a custom template format). Your method must
return a Y.Node instance.
Parameters:
-
[container]HTMLElement | Node | String optionalSelector string,
Y.Nodeinstance, or DOM element to use at the container node.
Returns:
Node instance of the created container node.
destroy
-
[options]
Destroys this View, detaching any DOM events and optionally also destroying its container node.
By default, the container node will not be destroyed. Pass an options
object with a truthy remove property to destroy the container as well.
detach
-
type -
fn -
context
Detach one or more listeners the from the specified event
Parameters:
-
typeString | 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.
-
fnFunctionThe subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
-
contextObjectThe 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:
the host
detachAll
-
type
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
Parameters:
-
typeStringThe type, or name of the event
detachEvents
()
chainable
Detaches DOM events that have previously been attached to the container by
attachEvents().
fire
-
type -
arguments
Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.
The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.
If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.
Parameters:
-
typeString | ObjectThe type of the event, or an object that contains a 'type' property.
-
argumentsObject*an 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:
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
get
-
name
Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.
Parameters:
-
nameStringThe 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:
The value of the attribute
getAttrs
-
attrs
Gets multiple attribute values.
Parameters:
Returns:
An object with attribute name/value pairs.
getCell
-
seed -
[shift]
Returns the <td> Node from the given row and column index. Alternately,
the seed can be a Node. If so, the nearest ancestor cell is returned.
If the seed is a cell, it is returned. If there is no cell at the given
coordinates, null is returned.
Optionally, include an offset array or string to return a cell near the
cell identified by the seed. The offset can be an array containing the
number of rows to shift followed by the number of columns to shift, or one
of "above", "below", "next", or "previous".
// Previous cell in the previous row
var cell = table.getCell(e.target, [-1, -1]);
// Next cell
var cell = table.getCell(e.target, 'next');
var cell = table.getCell(e.taregt, [0, 1];
This is actually just a pass through to the bodyView instance's method
by the same name.
Parameters:
Returns:
getEvent
-
type -
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
Parameters:
Returns:
the custom event or null
getRow
-
id
Returns the <tr> Node from the given row index, Model, or Model's
clientId. If the rows haven't been rendered yet, or if the row can't be
found by the input, null is returned.
This is actually just a pass through to the bodyView instance's method
by the same name.
Returns:
getTargets
()
Returns an array of bubble targets for this object.
Returns:
EventTarget[]
init
-
cfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
Parameters:
-
cfgObjectObject with configuration property name/value pairs
Returns:
A reference to this object
modifyAttr
-
name -
config
Updates the configuration of an attribute which has already been added.
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 addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base).
on
-
type -
fn -
[context] -
[arg*]
Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.
this.on("change", this._onChange, this);Callback functions for events published with 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:
Returns:
A subscription handle capable of detaching that subscription
once
-
type -
fn -
[context] -
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to on except the
listener is immediatelly detached when it is executed.
Parameters:
Returns:
A subscription handle capable of detaching the subscription
onceAfter
-
type -
fn -
[context] -
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to after except the
listener is immediatelly detached when it is executed.
Parameters:
Returns:
A subscription handle capable of detaching that subscription
parseType
-
type -
[pre]
Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.
Parameters:
Returns:
an array containing:
- the detach category, if supplied,
- the prefixed event type,
- whether or not this is an after listener,
- the supplied event type
publish
-
type -
opts
Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.
Parameters:
-
typeStringthe type, or name of the event
-
optsObjectoptional 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
emitFacadeis 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
asyncistrue. -
[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:
the custom event
remove
()
chainable
Removes this view's container element from the DOM (if it's in the DOM), but doesn't destroy it or any event listeners attached to it.
removeAttr
-
name
Removes an attribute from the host object
Parameters:
-
nameStringThe name of the attribute to be removed.
render
()
chainable
Creates the UI in the configured container.
reset
-
name
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
Parameters:
-
nameStringOptional. The name of the attribute to reset. If omitted, all attributes are reset.
Returns:
A reference to the host object.
set
-
name -
value -
[opts]
Sets the value of an attribute.
Parameters:
-
nameStringThe 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)). -
valueAnyThe value to set the attribute to.
-
[opts]Object optionalOptional data providing the circumstances for the change.
Returns:
A reference to the host object.
setAttrs
-
attrs -
[opts]
Sets multiple attribute values.
Parameters:
Returns:
A reference to the host object.
subscribe
()
deprecated
subscribe to an event
toString
()
String
Default toString implementation. Provides the constructor NAME and the instance guid, if set.
Returns:
String representation for this object
unsubscribe
()
deprecated
detach a listener
unsubscribeAll
-
type
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
Parameters:
-
typeStringThe type, or name of the event
Properties
body
Object
The object or instance of the class assigned to bodyView that is
responsible for rendering and managing the table's <tbody>(s) and its
content.
Default: undefined (initially unset)
CAPTION_TEMPLATE
String
The HTML template used to create the caption Node if the caption
attribute is set.
Default: '<caption class="{className}"></caption>'
displayColumns
Object[]
Array of the columns that correspond to those with value cells in the
data rows. Excludes colspan header columns (configured with children).
events
Object
Hash of CSS selectors mapped to events to delegate to elements matching those selectors.
CSS selectors are relative to the container element. Events are attached
to the container, and delegation is used so that subscribers are only
notified of events that occur on elements inside the container that match
the specified selectors. This allows the container's contents to be re-
rendered as needed without losing event subscriptions.
Event handlers can be specified either as functions or as strings that map to function names on this view instance or its prototype.
The this object in event handlers will refer to this view instance. If
you'd prefer this to be something else, use Y.bind() to bind a custom
this object.
Default: {}
Example:
var view = new Y.View({
events: {
// Call this.toggle() whenever the element with the id
// "toggle-button" is clicked.
'#toggle-button': {click: 'toggle'},
// Call this.hoverOn() when the mouse moves over any element
// with the "hoverable" class, and this.hoverOff() when the
// mouse moves out of any element with the "hoverable" class.
'.hoverable': {
mouseover: 'hoverOn',
mouseout : 'hoverOff'
}
}
});foot
Object
The object or instance of the class assigned to footerView that is
responsible for rendering and managing the table's <tfoot> and its
content.
Default: undefined (initially unset)
head
Object
The object or instance of the class assigned to headerView that is
responsible for rendering and managing the table's <thead> and its
content.
Default: undefined (initially unset)
TABLE_TEMPLATE
String
The HTML template used to create the table Node.
Default: '<table cellspacing="0" class="{className}"></table>'
template
Mixed
Template for this view's contents.
This is a convenience property that has no default behavior of its own.
It's only provided as a convention to allow you to store whatever you
consider to be a template, whether that's an HTML string, a Y.Node
instance, a Mustache template, or anything else your little heart
desires.
How this template gets used is entirely up to you and your custom
render() method.
Default: ''
Attributes
bodyConfig
Object
Configuration overrides used when instantiating the bodyView
instance.
Fires event bodyConfigChange
Fires when the value for the configuration attribute bodyConfig is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
bodyView
Function | Object
An instance of this class is used to render the contents of the table's
<tbody>—the data cells in the table.
The instance of this View will be assigned to the instance's body
property.
It is not strictly necessary that the class function assigned here be
a View subclass. It must however have a render() method.
Default: Y.DataTable.BodyView
Fires event bodyViewChange
Fires when the value for the configuration attribute bodyView is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
caption
HTML
HTML content of an optional <caption> element to appear above the
table. Leave this config unset or set to a falsy value to remove the
caption.
Default: undefined (initially unset)
Fires event captionChange
Fires when the value for the configuration attribute caption is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
columns
Object[]
Columns to include in the rendered table.
This attribute takes an array of objects. Each object is considered a
data column or header cell to be rendered. How the objects are
translated into markup is delegated to the headerView, bodyView,
and footerView.
The raw value is passed to the headerView and footerView. The
bodyView receives the instance's displayColumns array, which is
parsed from the columns array. If there are no nested columns (columns
configured with a children array), the displayColumns is the same
as the raw value.
Fires event columnsChange
Fires when the value for the configuration attribute columns is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
container
HTMLElement | Node | String
Container node into which this view's content will be rendered.
The container node serves as the host for all DOM events attached by the view. Delegation is used to handle events on children of the container, allowing the container's contents to be re-rendered at any time without losing event subscriptions.
The default container is a <div> Node, but you can override this in
a subclass, or by passing in a custom container config value at
instantiation time. If you override the default container in a subclass
using ATTRS, you must use the valueFn property. The view's constructor
will ignore any assignments using value.
When container is overridden by a subclass or passed as a config
option at instantiation time, you can provide it as a selector string, a
DOM element, a Y.Node instance, or (if you are subclassing and modifying
the attribute), a valueFn function that returns a Y.Node instance.
The value will be converted into a Y.Node instance if it isn't one
already.
The container is not added to the page automatically. This allows you to have full control over how and when your view is actually rendered to the page.
Default: Y.Node.create(this.containerTemplate)
Fires event containerChange
Fires when the value for the configuration attribute container is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
destroyed
Boolean
readonly
Flag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
Fires event destroyedChange
Fires when the value for the configuration attribute destroyed is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
headerConfig
Object
Configuration overrides used when instantiating the headerView
instance.
Fires event headerConfigChange
Fires when the value for the configuration attribute headerConfig is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
headerView
Function | Object
An instance of this class is used to render the contents of the
<thead>—the column headers for the table.
The instance of this View will be assigned to the instance's head
property.
It is not strictly necessary that the class function assigned here be
a View subclass. It must however have a render() method.
Default: Y.DataTable.HeaderView
Fires event headerViewChange
Fires when the value for the configuration attribute headerView is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
initialized
Boolean
readonly
Flag indicating whether or not this object has been through the init lifecycle phase.
Default: false
Fires event initializedChange
Fires when the value for the configuration attribute initialized is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
summary
String
Content for the <table summary="ATTRIBUTE VALUE HERE">. Values
assigned to this attribute will be HTML escaped for security.
Default: '' (empty string)
Fires event summaryChange
Fires when the value for the configuration attribute summary is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
width
String
Width of the table including borders. This value requires units, so
200 is invalid, but '200px' is valid. Setting the empty string
(the default) will allow the browser to set the table width.
Default: ''
Fires event widthChange
Fires when the value for the configuration attribute width is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeEvent 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:
-
eEventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.