QueryBuilder Class
The default package provides two data types: String (which can also
be used for numbers) and Select (which provides a menu of options). The
plugin API allows defining additional data types, e.g., date range or
multi-select. Every plugin must be registered in
Y.QueryBuilder.plugin_mapping
. Plugins must implement the following
functions:
constructor(qb, config)
- The arguments passed to the constructor are the QueryBuilder instance
and the
pluginConfig
set on the QueryBuilder instance. At the minimum, this function should initalize form field name patterns usingconfig.field_prefix
. create(query_index, var_config, op_list, value)
- This function must create the additional cells for the query row and
populate these cells appropriately. (The QueryBuilder widget will
insert the cells into the table.)
var_config
is the item from the QueryBuilder'svar_list
that the user selected.op_list
is the item from the QueryBuilder'soperators
which matches the variable selected by the user.value
is optional. If specified, it is the initial value(s) to be displayed by the plugin. postCreate(query_index, var_config, op_list, value)
- Optional. If it exists, it will be called after the cells returned by
create()
have been inserted into the table. The arguments are the same ascreate()
. destroy()
- Destroy the plugin. (The QueryBuilder widget will remove the cells and purge all events.)
updateName(new_index)
- Update the names of the form fields managed by the plugin.
toDatabaseQuery()
- Return an array of arrays. Each inner array contains an operation and a value. The default String and Select plugins each return a single inner array. A date range plugin would return two inner arrays, one for the start date and one for the end date.
validate()
- Optional. If additional validations are required beyond the basic
validations encoded in CSS, this function should check them. If
the input is not valid, call
displayFieldMessage()
on the QueryBuilder object and return false. Otherwise, return true.
Constructor
QueryBuilder
-
var_list
-
operators
-
config
Parameters:
-
var_list
ArrayList of variables that be included in the query.
-
name
StringThe name of the variable. Set as the
value
for the select option. -
type
StringThe variable type. Used to determine which plugin to instantiate. Must match a key in
Y.QueryBuilder.plugin_mapping
. (You can add new plugins to this global mapping.) -
text
StringThe text displayed when the variable is selected.
-
*
Mixedplugin-specific configuration
-
-
operators
ObjectMap of variable types to list of operators. Each operator is an object defining
value
andtext
. -
config
ObjectWidget configuration
Item Index
Methods
- _addAttrs
- _addLazyAttr
- _addOutOfOrder
- _afterChildSelectedChange
- _aggregateAttrs
- _applyParsedConfig
- _applyParser
- _attrCfgHash
- _baseDestroy
- _baseInit
- _bindAttrUI
- _bindDOM
- _bindUI
- _bindUIChild
- _cloneDefaultValue
- _createContainer
- _createUIEvent
- _defAttrChangeFn
- _defaultBB
- _defaultCB
- _defDestroyFn
- _defInitFn
- _defRenderFn
- _destroyBox
- _destroyHierarchy
- _destroyUIEvents
- _filterAdHocAttrs
- _filterUIEvent
- _fireAttrChange
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getFullType
- _getHtmlParser
- _getInstanceAttrCfgs
- _getNodeToParse
- _getSrcNode
- _getStateVal
- _getType
- _getUIEventNode
- _guid
- _hasPotentialSubscribers
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _initUIEvent
- _isLazyAttr
- _isUIEvent
- _mapInstance
- _monitor
- _normAttrVals
- _notifyChanged
- _onDocFocus
- _onDocMouseDown
- _parseType
- _preAddAttrs
- _preInitEventCfg
- _protectAttrs deprecated
- _publish
- _removeLoadingClassNames
- _renderBox
- _renderBoxClassNames
- _renderUI
- _renumberRows
- _rowControls
- _set
- _setAttr
- _setAttrs
- _setAttrUI
- _setAttrVal
- _setBB
- _setBox
- _setCB
- _setStateVal
- _strSetter
- _syncAttrUI
- _syncUI
- _syncUIChild
- _uiSetChildSelected
- _uiSetDim
- _uiSetDisabled
- _uiSetFocused
- _uiSetHeight
- _uiSetTabIndex
- _uiSetVisible
- _uiSetWidth
- _uiSizeCB
- _unbindDOM
- _unbindUI
- _validTabIndex
- _variablesMenu
- addAttr
- addAttrs
- addTarget
- after
- ancestor
- appendNew
- attrAdded
- before
- bindUI
- blur
- bubble
- clearFieldMessages
- destroy
- destructor
- detach
- detachAll
- disable
- displayFieldMessage
- enable
- fire
- focus
- get
- getAttrs
- getClassName
- getEvent
- getPlugin
- getSkinName
- getString deprecated
- getStrings deprecated
- getTargets
- hide
- init
- initializer
- isRoot
- modifyAttr
- next
- on
- once
- onceAfter
- parseType
- previous
- publish
- remove
- removeAttr
- removeTarget
- render
- renderer
- renderUI
- reset
- rowsReordered
- set
- setAttrs
- show
- subscribe deprecated
- syncUI
- toDatabaseQuery
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
- update
- validateFields
- variableName
Properties
- _allowAdHocAttrs
- _UI_ATTRS
- BOUNDING_TEMPLATE
- CONTENT_TEMPLATE
- DEF_PARENT_NODE
- DEF_UNIT
- Env static
- name deprecated
- plugin_mapping static
- UI_EVENTS
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
_afterChildSelectedChange
-
event
selected
attribute, responsible for updating the UI, in response to
attribute changes.
Parameters:
-
event
EventFacadeThe event facade for the attribute change.
_aggregateAttrs
-
allAttrs
Parameters:
-
allAttrs
ArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_applyParsedConfig
()
Object
protected
Returns:
_applyParser
-
config
HTML_PARSER
configuration for the
instance, to retrieve config data values.
Parameters:
-
config
ObjectUser configuration object (will be populated with values from Node)
_attrCfgHash
()
private
_baseDestroy
()
private
_baseInit
()
private
_bindAttrUI
-
attrs
Parameters:
-
attrs
Array
_bindDOM
()
protected
_bindUI
()
protected
_bindUIChild
()
protected
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_cloneDefaultValue
-
cfg
Parameters:
-
cfg
Object
_createContainer
()
DOM element
protected
Returns:
container for one piece of a query row
_createUIEvent
-
type
Parameters:
-
type
StringString representing the name of the event
_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
_defaultBB
()
protected
_defaultCB
()
protected
_defInitFn
-
e
Parameters:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_defRenderFn
-
e
-
parentNode
Parameters:
-
e
EventFacadeThe Event object -
parentNode
NodeThe parent node to render to, if passed in to therender
method
_destroyBox
()
protected
_destroyHierarchy
()
private
_destroyUIEvents
()
private
_filterAdHocAttrs
-
allAttrs
-
userVals
Parameters:
-
allAttrs
ObjectThe set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty. -
userVals
ObjectThe config object passed in by the user, from which adhoc attrs are to be filtered.
Returns:
_filterUIEvent
-
evt
For example, without the additional filter, if you have nested widgets, each widget will have a delegate listener. If you click on the inner widget, the inner delegate listener's filter will match once, but the outer will match twice (based on delegate's design) - once for the inner widget, and once for the outer.
Parameters:
-
evt
DOMEventFacade
Returns:
_fireAttrChange
-
attrName
-
subAttrName
-
currVal
-
newVal
-
opts
-
[cfg]
Parameters:
-
attrName
StringThe name of the attribute -
subAttrName
StringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null. -
currVal
AnyThe current value of the attribute -
newVal
AnyThe new value of the attribute -
opts
ObjectAny additional event data to mix into the attribute change event's event facade. -
[cfg]
Object optionalThe attribute config stored in State, if already available.
_getAttr
-
name
Parameters:
-
name
StringThe name of the attribute.
Returns:
_getAttrCfg
-
name
Parameters:
-
name
StringOptional. The attribute name. If not provided, the method will return the configuration for all attributes.
Returns:
_getAttrCfgs
()
Object
protected
Returns:
_getAttrInitVal
-
attr
-
cfg
-
initValues
Parameters:
-
attr
StringThe name of the attribute -
cfg
ObjectThe attribute configuration object -
initValues
ObjectThe object with simple and complex attribute name/value pairs returned from _normAttrVals
Returns:
_getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
_getClasses
()
Function
protected
Returns:
_getFullType
-
type
Parameters:
-
type
StringThe short type to prefix
Returns:
_getHtmlParser
()
Object
private
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
.
_getNodeToParse
()
Node
private
Returns:
_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
_getUIEventNode
()
protected
_guid
()
protected
_hasPotentialSubscribers
-
fullType
Parameters:
-
fullType
StringThe fully prefixed type name
Returns:
_initAttrHost
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor. -
values
ObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required. -
lazy
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initAttribute
()
private
_initAttrs
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor. -
values
ObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required. -
lazy
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initBase
-
config
Parameters:
-
config
ObjectThe constructor configuration object
_initHierarchy
-
userVals
Parameters:
-
userVals
ObjectObject with configuration property name/value pairs
_initHierarchyData
()
private
_initUIEvent
-
type
Parameters:
-
type
StringString representing the name of the event
Returns:
_isLazyAttr
-
name
Parameters:
-
name
StringThe name of the attribute
Returns:
_isUIEvent
-
type
Parameters:
-
type
StringString representing the name of the event
Returns:
_mapInstance
-
The
Parameters:
-
The
StringboundingBox id
_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:
_notifyChanged
()
protected
Fires the queryChanged event.
_onDocFocus
-
evt
Parameters:
-
evt
EventFacadeThe event facade for the DOM focus event
_onDocMouseDown
-
evt
Parameters:
-
evt
EventFacadeThe event facade for the DOM focus event
_parseType
()
private
_preAddAttrs
-
attrs
-
userVals
-
lazy
this.get("srcNode")
) can merge in it's
results before the rest of the attributes are added.
Parameters:
-
attrs
ObjectThe full hash of statically defined ATTRS attributes being added for this instance -
userVals
ObjectThe hash of user values passed to the constructor -
lazy
BooleanWhether or not to add the attributes lazily
_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.
_removeLoadingClassNames
()
protected
_renderBox
-
parentNode
Parameters:
-
parentNode
NodeThe parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.
_renderBoxClassNames
()
protected
_renderUI
()
protected
_renumberRows
()
private
_rowControls
()
String
protected
Returns:
markup for the row controls (insert and remove)
_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:
_setBB
-
node
Parameters:
-
node
Node | String
Returns:
_setBox
-
id
-
node
-
template
-
isBounding
Parameters:
-
id
StringThe node's id attribute -
node
Node | StringThe node reference -
template
StringHTML string template for the node -
isBounding
Booleantrue if this is the boundingBox, false if it's the contentBox
Returns:
_setCB
-
node
Parameters:
-
node
Node | String
Returns:
_setStateVal
-
name
-
value
Parameters:
-
name
StringThe name of the attribute -
value
AnyThe value of the attribute
_strSetter
-
strings
Parameters:
-
strings
Object
Returns:
_syncAttrUI
-
attrs
Parameters:
-
attrs
Array
_syncUI
()
protected
_syncUIChild
()
protected
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_uiSetChildSelected
-
selected
selected
attribute value.
Parameters:
-
selected
NumberThe selected value to be reflected in the UI.
_uiSetDim
-
dim
-
val
Parameters:
-
dim
StringThe dimension - "width" or "height" -
val
Number | StringThe value to set
_uiSetDisabled
-
val
Parameters:
-
val
Boolean
_uiSetFocused
-
val
-
src
Parameters:
-
val
Boolean -
src
StringString representing the source that triggered an update to the UI.
_uiSetHeight
-
val
Parameters:
-
val
String | Number
_uiSetTabIndex
-
Number
Parameters:
-
Number
Object
_uiSetVisible
-
val
Parameters:
-
val
Boolean
_uiSetWidth
-
val
Parameters:
-
val
String | Number
_uiSizeCB
-
expand
Parameters:
-
expand
Boolean
_unbindDOM
()
protected
_unbindUI
()
protected
_variablesMenu
-
menu_name
Parameters:
-
menu_name
Stringname for the select form element
Returns:
markup for the query variable menu
addAttr
-
name
-
config
-
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
- value <Any>
- The initial value to set on the attribute
- valueFn <Function | String>
-
A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.
valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
- readOnly <boolean>
- Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
- writeOnce <boolean> or <string>
-
Whether or not the attribute is "write once". Attributes having writeOnce set to true,
can only have their values set once, be it through the default configuration,
constructor configuration arguments, or by invoking set.
The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)
- setter <Function | String>
-
The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.
setter can also be set to a string, representing the name of the instance method to be used as the setter function.
- getter <Function | String>
-
The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.
getter can also be set to a string, representing the name of the instance method to be used as the getter function.
- validator <Function | String>
-
The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.
validator can also be set to a string, representing the name of the instance method to be used as the validator function.
- lazyAdd <boolean>
- Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
Parameters:
-
name
StringThe name of the attribute. -
config
ObjectAn object with attribute configuration property/value pairs, specifying the configuration for the attribute.NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
-
lazy
Boolean(optional) Whether or not to add this attribute lazily (on the first call to get/set).
Returns:
addAttrs
-
cfgs
-
values
-
lazy
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs. -
values
ObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only. -
lazy
BooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
Returns:
addTarget
-
o
Parameters:
-
o
EventTargetthe target to add
after
-
type
-
fn
-
[context]
-
[arg*]
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
ancestor
-
depth
Parameters:
-
depth
NumberNumber representing the depth of the ancestor.
Returns:
appendNew
-
name
-
value
Append a new query condition to the table.
Parameters:
-
name
StringIf specified, this variable is selected.
-
value
MixedIf specified, this value is selected. Refer to the appropriate plugin documentation to figure out what data to pass.
Returns:
plugin that was created for the row, if any
attrAdded
-
name
Parameters:
-
name
StringThe name of the attribute to check.
Returns:
before
()
Returns:
bindUI
()
protected
blur
()
chainable
bubble
-
evt
Parameters:
-
evt
CustomEventthe custom event to propagate
Returns:
clearFieldMessages
()
destroy
-
destroyAllNodes
Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy. Overrides Base's implementation, to support arguments to destroy
Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.
Parameters:
-
destroyAllNodes
BooleanIf true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.
Returns:
destructor
()
protected
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
disable
()
chainable
displayFieldMessage
-
e
-
msg
-
type
-
[scroll]
Display a message for the specified field.
Parameters:
-
e
String | ObjectThe selector for the element or the element itself
-
msg
StringThe message
-
type
StringThe message type (see Y.FormManager.status_order)
-
[scroll]
Boolean optionaltrue
if the form row should be scrolled into view
Returns:
true if the message was displayed, false if a higher precedence message was already there
enable
()
chainable
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:
focus
()
chainable
get
-
name
Parameters:
-
name
StringThe name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g.get("x.y.z")
)
Returns:
getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
getClassName
-
args
Y.config.classNamePrefix
attribute used by ClassNameManager
and
Widget.NAME.toLowerCase()
(e.g. "yui-widget-xxxxx-yyyyy", based on default values for
the prefix and widget class name).
The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances.
Parameters:
-
args
String multiple0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name
getEvent
-
type
-
prefixed
Parameters:
-
type
Stringthe type, or name of the event -
prefixed
Stringif true, the type is prefixed already
Returns:
getPlugin
-
row_index
Returns plugin used for the specified row, if any.
Parameters:
-
row_index
IntThe index of the row
Returns:
the plugin for the row, if any
getSkinName
-
[skinPrefix]
Parameters:
-
[skinPrefix]
String optionalThe prefix which the implementation uses for the skin ("yui3-skin-" is the default). NOTE: skinPrefix will be used as part of a regular expression: new RegExp('\\b' + skinPrefix + '(\\S+)') Although an unlikely use case, literal characters which may result in an invalid regular expression should be escaped.
Returns:
getString
-
key
Parameters:
-
key
String
Returns:
getStrings
-
key
Parameters:
-
key
String
Returns:
getTargets
()
Returns:
hide
()
chainable
init
-
cfg
Parameters:
-
cfg
ObjectObject with configuration property name/value pairs
Returns:
initializer
-
config
Parameters:
-
config
ObjectConfiguration object literal for the widget
isRoot
()
Boolean
Returns:
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.
next
-
circular
Parameters:
-
circular
BooleanBoolean indicating if the parent's first child should be returned if the child has no next sibling.
Returns:
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:
previous
-
circular
Parameters:
-
circular
BooleanBoolean indicating if the parent's last child should be returned if the child has no previous sibling.
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:
remove
-
row_index
Removes the specified row.
Parameters:
-
row_index
IntThe index of the row
Returns:
true
if successful
removeAttr
-
name
Parameters:
-
name
StringThe name of the attribute to be removed.
render
-
parentNode
This method should only be invoked once for an initialized widget.
It delegates to the widget specific renderer method to do the actual work.
Parameters:
-
parentNode
Object | StringOptional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string.If the selector string returns more than one Node, the first node will be used as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox are not currently in the document. If it's not provided, the Widget will be rendered to the body of the current document in this case.
renderer
()
protected
renderUI
()
protected
reset
-
var_list
-
operators
Reset the query.
Parameters:
-
var_list
ArrayIf specified, the list of available variables is replaced.
-
operators
ObjectIf specified, the operators for all variable types will be replaced.
rowsReordered
()
Updates internal data to match ordering of rows. Useful after Drag-and-Drop operation is finished.
set
-
name
-
value
-
[opts]
Parameters:
-
name
StringThe name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g.set("x.y.z", 5)
). -
value
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
setAttrs
-
attrs
-
[opts]
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
show
()
chainable
subscribe
()
deprecated
syncUI
()
protected
toDatabaseQuery
()
Array
Returns:
list of [var, op, value] tuples suitable for a database query
toString
()
String
Returns:
unsubscribe
()
deprecated
unsubscribeAll
-
type
Parameters:
-
type
StringThe type, or name of the event
update
-
row_index
-
value
Set the value of the specified row.
Parameters:
-
row_index
IntThe index of the row
-
value
MixedIf specified, the value to set (Refer to the appropriate plugin documentation to figure out what data to pass.)
validateFields
()
Boolean
Validate the fields in each row.
Returns:
true
if all values are valid
variableName
-
i
Parameters:
-
i
Intquery row index
Returns:
name for the select form element listing the available query variables
Properties
_allowAdHocAttrs
Boolean
protected
Default: undefined (false)
_UI_ATTRS
Object
private
BOUNDING_TEMPLATE
String
CONTENT_TEMPLATE
String
DEF_PARENT_NODE
String | Node
DEF_UNIT
String
Env
Object
static
Environment information.
- has_bubble_problem
- True if change events from select elements do not bubble.
name
String
deprecated
plugin_mapping
Object
static
Mapping of variable types to plugin classes. (Always introduce new variable types rather than changing the existing mappings.)
- string
- Generic string.
- number
- Generic number. You must specify appropriate validations, e.g., yiv-integer or yiv-decimal.
- select
- Generic list of values.
UI_EVENTS
Object
Attributes
boundingBox
String | Node
chooseVarPrompt
String
The prompt displayed when a new item is added to the query.
Default: "Choose a variable"
contentBox
String | Node
destroyed
Boolean
readonly
Default: false
disabled
Boolean
Default: false
fieldPrefix
String
All generated form field names start with this prefix. This avoids conflicts if you have more than one QueryBuilder on a page.
Default: ""
focused
Boolean
readonly
Default: false
height
String | Number
Default: EMPTY_STR
initialized
Boolean
readonly
Default: false
render
Boolean | Node
rendered
Boolean
readonly
Default: false
srcNode
String | Node
tabIndex
Number
Default: null
width
String | Number
Default: EMPTY_STR
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.
queryChanged
Fires when the query is modified.
Event Payload:
-
info
Objectremove
istrue
if a row was removed
render
Subscribers to the "on" moment of this event, will be notified before the widget is rendered.
Subscribers to the "after" moment of this event, will be notified after rendering is complete.
Event Payload:
-
e
EventFacadeThe Event Facade
widget:contentUpdate
Event Payload:
-
e
EventFacadeThe Event Facade