eZ.FieldEditView Class
Field Edit View. This is an abstract class, so it's not supposed to be used directly.
Item Index
Methods
- _addAttrs
- _addLazyAttr
- _addOutOfOrder
- _afterActiveReRender
- _afterContainerChange
- _aggregateAttrs
- _attrCfgHash
- _baseDestroy
- _baseInit
- _checkValidityDescription
- _cloneDefaultValue
- _defAttrChangeFn
- _defDestroyFn
- _defInitFn
- _destroyContainer
- _destroyHierarchy
- _errorUI
- _filterAdHocAttrs
- _fireAttrChange
- _generateViewClassName
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getContainer
- _getFieldValue
- _getFullType
- _getInstanceAttrCfgs
- _getName
- _getStateVal
- _getType
- _hasPotentialSubscribers
- _hideDescription
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _isLazyAttr
- _isTouch
- _monitor
- _normAttrVals
- _parseType
- _preInitEventCfg
- _protectAttrs deprecated
- _publish
- _set
- _setAttr
- _setAttrs
- _setAttrVal
- _setErrorMessage
- _setStateVal
- _setTemplate
- _setTooltipPosition
- _showDescription
- _variables
- addAttr
- addAttrs
- addTarget
- after
- appendServerSideError
- attachEvents
- attrAdded
- before
- bubble
- create
- destroy
- detach
- detachAll
- detachEvents
- fire
- get
- getAttrs
- getEvent
- getField
- getFieldEditView static
- getTargets
- init
- initializer
- isValid
- modifyAttr
- on
- once
- onceAfter
- parseType
- publish
- registerFieldEditView static
- remove
- removeAttr
- removeTarget
- render
- reset
- set
- setAttrs
- subscribe deprecated
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
- validate
Properties
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
_afterActiveReRender
()
protected
Method called after the field edit view has been rendered while it's already active. This means the view is re-rendered and this allows to update the generated UI for instance when a UI widget is used and needs to be initialized as if the view becomes active.
_afterContainerChange
()
protected
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
Parameters:
-
allAttrs
ArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_attrCfgHash
()
private
_baseDestroy
()
private
_baseInit
()
private
_checkValidityDescription
()
protected
Check if the fieldValue is valid, and if it is, hide de description
_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.
_destroyContainer
()
protected
container
from the DOM and purges all its event listeners.
_destroyHierarchy
()
private
_errorUI
-
e
Reflects in the UI the errorStatus change
Parameters:
-
e
Objectthe event facade of the errorStatusChange event
_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.
_generateViewClassName
-
name
Parameters:
-
name
String
Returns:
String
_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:
_getContainer
-
value
container
attribute.
Parameters:
-
value
Node | NullCurrent attribute value.
Returns:
_getFieldValue
()
protected
Returns the value of the field from the current user input. This method should be implemented in each field edit view.
The default implementation returns undefined. Returning undefined means that the field should be ignored when saving the content.
Returns:
mixed
_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
.
_getName
()
protected
Returns:
String
_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:
_hideDescription
()
protected
Hide the field description or the tooltip
_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:
_isTouch
()
Boolean
private
Returns whether the current browser is a touch device or not
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:
true if the new attribute value was stored, false if not.
_setErrorMessage
-
msg
Sets the error message in UI
Parameters:
-
msg
Stringthe error message
_setStateVal
-
name
-
value
Parameters:
-
name
StringThe name of the attribute -
value
AnyThe value of the attribute
_setTemplate
()
protected
template
property of the view. The template is
searched in the template registry and then in the DOM. The id of the
template (both in the registry and in the DOM) is the name of the
view in lowercase with the suffix -ez-template
.
_setTooltipPosition
()
protected
Set the description tooltip position. The tooltip position is modified by it's height and is relative to the field input.
_showDescription
()
protected
Show the field description
_variables
()
protected
Returns an object containing the additional variables needed in the field edit view template. The default implementation returns an empty object
Returns:
Object
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:
A reference to the host object.
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:
appendServerSideError
-
serverSideError
Append the server side error messages to the error status.
Parameters:
-
serverSideError
Y.eZ.FieldErrorDetails
attachEvents
-
[events]
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 theevents
attribute for details on the format. If not specified, this view'sevents
property will be used.
attrAdded
-
name
Parameters:
-
name
StringThe name of the attribute to check.
Returns:
before
()
Returns:
bubble
-
evt
Parameters:
-
evt
CustomEventthe custom event to propagate
Returns:
create
-
[container]
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.Node
instance, or DOM element to use at the container node.
Returns:
destroy
-
[options]
remove
property to destroy the container as well.
Parameters:
-
[options]
Object optionalOptions.-
[remove=false]
Boolean optionalIf
true
, this View's container will be removed from the DOM and destroyed as well.
-
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
detachEvents
()
chainable
attachEvents()
.
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:
The value of the attribute
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:
getEvent
-
type
-
prefixed
Parameters:
-
type
Stringthe type, or name of the event -
prefixed
Stringif true, the type is prefixed already
Returns:
getField
()
Returns an updated version of the field containing a field value reflecting the current user input. Returns undefined when the field value should not be taken into account.
Returns:
Object or undefined
getFieldEditView
-
fieldTypeIdentifier
Returns the field edit view constructor for the given field type identifier. Throw a TypeError if no field edit view is registered for it
Parameters:
-
fieldTypeIdentifier
Stringthe field type identifier (ezstring, eztext, ...)
Returns:
getTargets
()
Returns:
init
-
cfg
Parameters:
-
cfg
ObjectObject with configuration property name/value pairs
Returns:
initializer
()
Custom initializer method, it sets the event handling on the errorStatusChange event
isValid
()
Returns whether the view is currently in a valid state
Returns:
boolean
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:
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:
registerFieldEditView
-
fieldTypeIdentifier
-
editView
Registers a field edit view for the given field type identifier
Parameters:
-
fieldTypeIdentifier
Stringthe field type identifier (ezstring, eztext, ...)
-
editView
Functionthe constructor function of the field edit view
remove
()
chainable
removeAttr
-
name
Parameters:
-
name
StringThe name of the attribute to be removed.
render
()
eZ.FieldEditView
Default implementation of the field edit view render. By default, it
injects the field definition, the field, the content and the content
type. If the view is already active, it calls _afterActiveReRender
after the rendering process so that the field edit view
implementation has a way to handle rerender for instance when
switching language in the UI.
Returns:
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:
A reference to the host object.
setAttrs
-
attrs
-
[opts]
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs.
-
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
A reference to the host object.
subscribe
()
deprecated
toString
()
String
Returns:
unsubscribe
()
deprecated
unsubscribeAll
-
type
Parameters:
-
type
StringThe type, or name of the event
validate
()
Checks whether the current user input is valid or not. This methood
should be implemented by each field edit view and is supposed to
set the errorStatus
attribute.
The default implementation does nothing.
Properties
Registry of all registered field edit views indexed by field type identifier
Default: {}
_allowAdHocAttrs
Boolean
protected
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
_errorClass
String
protected
Contains the class to add/remove on/from the container when an error is detected.
Default: 'is-error'
_errorDefaultContent
String
protected
Contains the default content of the error message placeholder. It is used to restore the error placeholder when the view switches from the error state to the normal state.
_handleFieldDescriptionVisibility
Boolean
protected
Set if the fieldDefinition description is active or not.
Default: true
_tooltipInitialPosition
Array
protected
Contains the initial X an Y position of a tooltip This will be used to restore its position when vanishing
_useStandardFieldDefinitionDescription
Boolean
protected
Set if the fieldDefinition description has the standard display. Standard means it will use the ez-standard-description CSS rule from fieldedit.css
Default: true
containerTemplate
String
Default: "<div/>"
events
Object
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'
}
}
});
name
String
deprecated
template
Mixed
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
<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)
destroyed
Boolean
readonly
Default: false
errorStatus
Mixed
The validation error status. A truthy value means there's an error. Setting this attribute to a non empty string will add this string as an error message (under the field name by default)
Default: false
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.