View Class
Represents a logical piece of an application's user interface, and provides a lightweight, overridable API for rendering content and handling delegated DOM events on a container element.
The View class imposes little structure and provides only minimal functionality of its own: it's basically just an overridable API interface that helps you implement custom views.
As of YUI 3.5.0, View allows ad-hoc attributes to be specified at instantiation
time, so you don't need to subclass Y.View to add custom attributes. Just pass
them to the constructor:
var view = new Y.View({foo: 'bar'});
view.get('foo'); // => "bar"
Constructor
View
()
Item Index
Methods
- _addAttrs
- _addLazyAttr
- _afterContainerChange
- _aggregateAttrs
- _attrCfgHash
- _baseDestroy
- _baseInit
- _defAttrChangeFn
- _defDestroyFn
- _defInitFn
- _destroyContainer
- _destroyHierarchy
- _filterAdHocAttrs
- _filterAttrCfs
- _fireAttrChange
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getContainer
- _getStateVal
- _getType
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _isLazyAttr
- _monitor
- _normAttrVals
- _parseType
- _preInitEventCfg
- _protectAttrs deprecated
- _set
- _setAttr
- _setAttrs
- _setAttrVal
- _setStateVal
- addAttr
- addAttrs
- addTarget
- after
- attachEvents
- attrAdded
- before
- bubble
- create
- destroy
- detach
- detachAll
- detachEvents
- fire
- get
- getAttrs
- getEvent
- getTargets
- init
- modifyAttr
- on
- once
- onceAfter
- parseType
- publish
- remove
- removeAttr
- removeTarget
- render
- reset
- set
- setAttrs
- subscribe deprecated
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
Properties
- _allowAdHocAttrs
- _NON_ATTRS_CFG static
- containerTemplate
- events
- name deprecated
- template
Attributes
Methods
_addAttrs
-
cfgs -
values -
lazy
Implementation behind the public addAttrs method.
This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).
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.
_addLazyAttr
-
name
Finishes initializing an attribute which has been lazily added.
Parameters:
-
nameObjectThe name of the attribute
_afterContainerChange
()
protected
Handles containerChange events. Detaches event handlers from the old
container (if any) and attaches them to the new container.
Right now the container attr is initOnly so this event should only ever
fire the first time the container is created, but in the future (once Y.App
can handle it) we may allow runtime container changes.
_aggregateAttrs
-
allAttrs
A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.
The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).
Parameters:
-
allAttrsArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_attrCfgHash
()
private
Utility method to define the attribute hash used to filter/whitelist property mixes for this class.
_baseDestroy
()
private
Internal destroy implementation for BaseCore
_baseInit
()
private
Internal initialization implementation for BaseCore
_defAttrChangeFn
-
e
Default function for attribute change events.
Parameters:
-
eEventFacadeThe event object for attribute change events.
_defInitFn
-
e
Default init event handler
Parameters:
-
eEventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyContainer
()
protected
Removes the container from the DOM and purges all its event listeners.
_destroyHierarchy
()
private
Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_filterAdHocAttrs
-
allAttrs -
userVals
Parameters:
-
allAttrsObjectThe 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.
-
userValsObjectThe config object passed in by the user, from which adhoc attrs are to be filtered.
Returns:
_filterAttrCfs
-
clazz -
allCfgs
A helper method used when processing ATTRS across the class hierarchy during initialization. Returns a disposable object with the attributes defined for the provided class, extracted from the set of all attributes passed in.
Parameters:
Returns:
_fireAttrChange
-
attrName -
subAttrName -
currVal -
newVal -
opts
Utility method to help setup the event payload and fire the attribute change event.
Parameters:
-
attrNameStringThe name of the attribute
-
subAttrNameStringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
-
currValAnyThe current value of the attribute
-
newValAnyThe new value of the attribute
-
optsObjectAny additional event data to mix into the attribute change event's event facade.
_getAttr
-
name
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
Parameters:
-
nameStringThe name of the attribute.
Returns:
_getAttrCfg
-
name
Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.
Parameters:
-
nameStringOptional. The attribute name. If not provided, the method will return the configuration for all attributes.
Returns:
_getAttrCfgs
()
Object
protected
Returns an aggregated set of attribute configurations, by traversing the class hierarchy.
Returns:
_getAttrInitVal
-
attr -
cfg -
initValues
Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.
Parameters:
Returns:
_getAttrs
-
attrs
Implementation behind the public getAttrs method, to get multiple attribute values.
Parameters:
-
attrsArray | 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 the class hierarchy for this object, with BaseCore being the last class in the array.
Returns:
_getContainer
-
value
Getter for the container attribute.
Parameters:
-
valueNode | NullCurrent attribute value.
Returns:
_getStateVal
-
name
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
Parameters:
-
nameStringThe name of the attribute
Returns:
_getType
()
private
If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_initAttrHost
-
attrs -
values -
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
Parameters:
-
attrsObjectThe 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.
-
valuesObjectThe 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.
-
lazyBooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initAttribute
()
private
Initializes AttributeCore
_initAttrs
-
attrs -
values -
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
Parameters:
-
attrsObjectThe 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.
-
valuesObjectThe 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.
-
lazyBooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initBase
-
config
Internal construction logic for BaseCore.
Parameters:
-
configObjectThe constructor configuration object
_initHierarchy
-
userVals
Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.
Parameters:
-
userValsObjectObject with configuration property name/value pairs
_initHierarchyData
()
private
A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.
_isLazyAttr
-
name
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
Parameters:
-
nameStringThe name of the attribute
Returns:
_monitor
-
what -
eventType -
o
This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> clickattach, clickdetach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.
Parameters:
-
whatString'attach', 'detach', 'fire', or 'publish'
-
eventTypeString | CustomEventThe prefixed name of the event being monitored, or the CustomEvent object.
-
oObjectInformation about the event interaction, such as fire() args, subscription category, publish config
_normAttrVals
-
valueHash
Utility method to split out simple attribute name/value pairs ("x") from complex attribute name/value pairs ("x.y.z"), so that complex attributes can be keyed by the top level attribute name.
Parameters:
-
valueHashObjectAn object with attribute name/value pairs
Returns:
_parseType
()
private
Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_preInitEventCfg
-
config
Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.
Parameters:
-
configObjectThe user configuration object
_protectAttrs
-
attrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
Parameters:
-
attrsObjectA hash of attribute to configuration object pairs.
Returns:
_set
-
name -
val
Allows setting of readOnly/writeOnce attributes. See set for argument details.
Parameters:
-
nameStringThe name of the attribute.
-
valAnyThe value to set the attribute to.
Returns:
_setAttr
-
name -
value -
opts -
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
Parameters:
-
nameStringThe name of the attribute.
-
valueAnyThe value to set the attribute to.
-
optsObject(Optional) Optional event data to be mixed into the event facade passed to subscribers of the attribute's change event. This is currently a hack. There's no real need for the AttributeCore implementation to support this parameter, but breaking it out into AttributeObservable, results in additional function hops for the critical path.
-
forceBooleanIf true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.
Returns:
_setAttrs
-
attrs
Implementation behind the public setAttrs method, to set multiple attribute values.
Parameters:
-
attrsObjectAn object with attributes name/value pairs.
Returns:
_setAttrVal
-
attrName -
subAttrName -
prevVal -
newVal
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
Parameters:
Returns:
_setStateVal
-
name -
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
Parameters:
-
nameStringThe name of the attribute
-
valueAnyThe 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:
-
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:
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:
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:
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:
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:
bubble
-
evt
Propagate an event. Requires the event-custom-complex module.
Parameters:
-
evtCustomEventthe custom event to propagate
Returns:
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:
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:
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.
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.
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.
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:
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:
getAttrs
-
attrs
Gets multiple attribute values.
Parameters:
-
attrsArray | 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:
getEvent
-
type -
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
Parameters:
Returns:
getTargets
()
Returns an array of bubble targets for this object.
Returns:
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:
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.
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.
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, or pass an array of event names as the first argument to subscribe to all listed events with the same callback.
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:
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:
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:
parseType
-
type -
[pre=this._yuievt.config.prefix]
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.
Returns:
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': whether or not the YUI instance and YUI global are notified when the event is fired (false)
- 'bubbles': whether or not this event bubbles (true) Events can only bubble if emitFacade is true.
- 'context': the default execution context for the listeners (this)
- 'defaultFn': the default function to execute when this event fires if preventDefault was not called
- 'emitFacade': whether or not this event emits a facade (false)
- 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
- 'fireOnce': if an event is configured to fire once, new subscribers after the fire will be notified immediately.
- 'async': fireOnce event listeners will fire synchronously if the event has already fired unless async is true.
- 'preventable': whether or not preventDefault() has an effect (true)
- 'preventedFn': a function that is executed when preventDefault is called
- 'queuable': whether or not this event can be queued during bubbling (false)
- 'silent': if silent is true, debug messages are not provided for this event.
- 'stoppedFn': a function that is executed when stopPropagation is called
- 'monitored': specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
- 'type': the event type (valid option if not provided as the first parameter to publish)
Returns:
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
Renders this view.
This method is a noop by default. Override it to provide a custom
implementation that renders this view's content and appends it to the
container element. Ideally your render method should also return this as
the end to allow chaining, but that's up to you.
Since there's no default renderer, you're free to render your view however
you see fit, whether that means manipulating the DOM directly, dumping
strings into innerHTML, or using a template language of some kind.
For basic templating needs, Y.Node.create() and Y.Lang.sub() may
suffice, but there are no restrictions on what tools or techniques you can
use to render your view. All you need to do is append something to the
container element at some point, and optionally append the container
to the DOM if it's not there already.
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:
set
-
name -
value
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.
Returns:
setAttrs
-
attrs
Sets multiple attribute values.
Parameters:
-
attrsObjectAn object with attributes name/value pairs.
Returns:
subscribe
()
deprecated
subscribe to an event
toString
()
String
Default toString implementation. Provides the constructor NAME and the instance guid, if set.
Returns:
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
_allowAdHocAttrs
Boolean
protected
This tells Y.Base that it should create ad-hoc attributes for config
properties passed to View's constructor. This makes it possible to
instantiate a view and set a bunch of attributes without having to subclass
Y.View and declare all those attributes first.
Default: true
_NON_ATTRS_CFG
Array
protected
static
Properties that shouldn't be turned into ad-hoc attributes when passed to View's constructor.
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'
}
}
});
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
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:
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:
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.