Show:

A base class for Freemarker plugin.

Constructor

A.AceEditor.AutoCompleteFreemarker

(
  • config
)

Parameters:

  • config Object

    Object literal specifying configuration properties.

Methods

_addAttrs

(
  • cfgs
  • values
  • lazy
)
private

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:

  • cfgs Object

    An object with attribute name/configuration pairs.

  • values Object

    An 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 Boolean

    Whether 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 <a href="#method_addAttr">addAttr</a>.

_addLazyAttr

(
  • name
  • [lazyCfg]
)
private

Finishes initializing an attribute which has been lazily added.

Parameters:

  • name Object

    The name of the attribute

  • [lazyCfg] Object optional

    Optional 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
)
private

Utility method used by get/set to add attributes encountered out of order when calling addAttrs().

For example, if:

this.addAttrs({
                                                     foo: {
                                                         setter: function() {
                                                            // make sure this bar is available when foo is added
                                                            this.get("bar");
                                                         }
                                                     },
                                                     bar: {
                                                         value: ...
                                                     }
                                                });

Parameters:

  • name String

    attribute name

  • cfg Object

    attribute configuration

_aggregateAttrs

(
  • allAttrs
)
Object private

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:

  • allAttrs Array

    An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object:

The aggregate set of ATTRS definitions for the instance

_attrCfgHash

() private

Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.

_baseDestroy

() private

Internal destroy implementation for BaseCore

_baseInit

() private

Internal initialization implementation for BaseCore

_cloneDefaultValue

(
  • cfg
)
private

This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.

Parameters:

  • cfg Object

_defAttrChangeFn

(
  • e
  • eventFastPath
)
private

Default function for attribute change events.

Parameters:

  • e EventFacade

    The event object for attribute change events.

  • eventFastPath Boolean

    Whether or not we're using this as a fast path in the case of no listeners or not

_defDestroyFn

(
  • e
)
protected

Default destroy event handler

Parameters:

_defInitFn

(
  • e
)
protected

Default init event handler

Parameters:

  • e EventFacade

    Event object, with a cfg property which refers to the configuration object passed to the constructor.

_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
)
Object private

Parameters:

  • allAttrs Object

    The 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 Object

    The config object passed in by the user, from which adhoc attrs are to be filtered.

Returns:

Object:

The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

_fireAttrChange

(
  • attrName
  • subAttrName
  • currVal
  • newVal
  • opts
  • [cfg]
)
private

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

  • attrName String

    The name of the attribute

  • subAttrName String

    The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.

  • currVal Any

    The current value of the attribute

  • newVal Any

    The new value of the attribute

  • opts Object

    Any additional event data to mix into the attribute change event's event facade.

  • [cfg] Object optional

    The attribute config stored in State, if already available.

_getAttr

(
  • name
)
Any protected chainable

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.

See <a href="#method_get">get</a> for argument details.

Parameters:

  • name String

    The name of the attribute.

Returns:

Any:

The value of the attribute.

_getAttrCfg

(
  • name
)
Object protected

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:

  • name String

    Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

Returns:

Object:

The configuration properties for the given attribute, or all attributes.

_getAttrCfgs

() Object protected

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object:

The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.

_getAttrInitVal

(
  • attr
  • cfg
  • initValues
)
Any private

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:

  • attr String

    The name of the attribute

  • cfg Object

    The attribute configuration object

  • initValues Object

    The object with simple and complex attribute name/value pairs returned from _normAttrVals

Returns:

Any:

The initial value of the attribute.

_getAttrs

(
  • attrs
)
Object protected

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

  • attrs String | Boolean

    Optional. 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:

Object:

An object with attribute name/value pairs.

_getClasses

() Function protected

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function:

An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.

_getFullType

(
  • type
)
String private

Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.

NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.

Parameters:

  • type String

    The short type to prefix

Returns:

String:

The prefixed type, if a prefix is set, otherwise the type passed in

_getInstanceAttrCfgs

(
  • allCfgs
)
Object private

A helper method used to isolate the attrs config for this instance to pass to addAttrs, from the static cached ATTRS for the class.

Parameters:

  • allCfgs Object

    The 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:

Object:

The set of attributes to be added for this instance, suitable for passing through to addAttrs.

_getStateVal

(
  • name
  • [cfg]
)
Any private

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

  • name String

    The name of the attribute

  • [cfg] Object optional

    Optional 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:

Any:

The stored value of the attribute

_getTokenType

(
  • token
)
Number protected

Retrieves the type of a token. It can be one of these: TOKEN_PUNCTUATOR_DOT = 1 TOKEN_UNRECOGNIZED = -1 TOKEN_VARIABLE = 0

Parameters:

  • token Number

    The type of the token

Returns:

Number:

The token type

_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.

_getVariableMatches

(
  • content
)
Array protected

Scans the content and extracts variables.

Parameters:

  • content String

    The content from which variable matches will be extracted

Returns:

Array:

List with variable matches

_hasPotentialSubscribers

(
  • fullType
)
Boolean private

Parameters:

  • fullType String

    The fully prefixed type name

Returns:

Boolean:

Whether the event has potential subscribers or not

_initAttrHost

(
  • attrs
  • values
  • lazy
)
private

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

  • attrs Object

    The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

  • values Object

    The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.

  • lazy Boolean

    Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).

_initAttribute

() private

Inherited from BaseObservable but overwritten in yui3/src/base/js/BaseCore.js:309

Initializes AttributeCore

_initAttrs

(
  • attrs
  • values
  • lazy
)
protected

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

Parameters:

  • attrs Object

    The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.

  • values Object

    The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.

  • lazy Boolean

    Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).

_initBase

(
  • config
)
private

Internal construction logic for BaseCore.

Parameters:

  • config Object

    The constructor configuration object

_initHierarchy

(
  • userVals
)
private

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and invoking the initializer method on the prototype of each class in the hierarchy.

Parameters:

  • userVals Object

    Object 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.

_isLastToken

(
  • index
  • tokens
)
Boolean protected

Checks if the the provided index is the last token in the list of tokens.

Parameters:

  • index Number

    The index which should be checked

  • tokens Array

    The array with tokens

Returns:

Boolean:

True if the provided index is the last token in the list

_isLazyAttr

(
  • name
)
Boolean private

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

  • name String

    The name of the attribute

Returns:

Boolean:

true if it's a lazily added attribute, false otherwise.

_monitor

(
  • what
  • eventType
  • o
)
private

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 -> click_attach, click_detach, 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:

  • what String

    'attach', 'detach', 'fire', or 'publish'

  • eventType String | CustomEvent

    The prefixed name of the event being monitored, or the CustomEvent object.

  • o Object

    Information about the event interaction, such as fire() args, subscription category, publish config

_normAttrVals

(
  • valueHash
)
Object private

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

Parameters:

  • valueHash Object

    An object with attribute name/value pairs

Returns:

Object:

An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.

_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
)
private

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:

  • config Object

    The user configuration object

_protectAttrs

(
  • attrs
)
Object deprecated protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:924

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

  • attrs Object

    A hash of attribute to configuration object pairs.

Returns:

Object:

A protected version of the attrs argument.

_publish

(
  • fullType
  • etOpts
  • ceOpts
)
CustomEvent private

The low level event publish implementation. It expects all the massaging to have been done outside of this method. e.g. the 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 String

    The prefixed type of the event to publish.

  • etOpts Object

    The EventTarget specific configuration to mix into the published event.

  • ceOpts Object

    The publish specific configuration to mix into the published event.

Returns:

CustomEvent:

The published event. If called without etOpts or ceOpts, this will be the default CustomEvent instance, and can be configured independently.

_set

(
  • name
  • val
  • [opts]
)
Object protected chainable

Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.

Parameters:

  • name String

    The name of the attribute.

  • val Any

    The value to set the attribute to.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

_setAttr

(
  • name
  • value
  • [opts]
  • force
)
Object protected chainable

Provides the common implementation for the public set and protected _set methods.

See <a href="#method_set">set</a> for argument details.

Parameters:

  • name String

    The name of the attribute.

  • value Any

    The value to set the attribute to.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

  • force Boolean

    If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object:

A reference to the host object.

_setAttrs

(
  • attrs
  • [opts]
)
Object protected chainable

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

  • attrs Object

    An object with attributes name/value pairs.

  • [opts] Object optional

    Optional data providing the circumstances for the change

Returns:

Object:

A reference to the host object.

_setAttrVal

(
  • attrName
  • subAttrName
  • prevVal
  • newVal
  • [opts]
  • [attrCfg]
)
Boolean private

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

  • attrName String

    The attribute name.

  • subAttrName String

    The sub-attribute name, if setting a sub-attribute property ("x.y.z").

  • prevVal Any

    The currently stored value of the attribute.

  • newVal Any

    The value which is going to be stored.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

  • [attrCfg] Object optional

    Optional 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:

Boolean:

true if the new attribute value was stored, false if not.

_setRegexValue

(
  • value
)
RegExp protected

Normalizes a regualr expression value. If the value is String, it will be converted to an RegExp.

Parameters:

  • value String | RegExp

    The provided regualr expression value

Returns:

RegExp:

The final instance of RegExp object

_setStateVal

(
  • name
  • value
)
private

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

  • name String

    The name of the attribute

  • value Any

    The value of the attribute

addAttr

(
  • name
  • config
  • lazy
)
Object chainable

<p> Adds an attribute with the provided configuration to the host object. </p> <p> The config argument object supports the following properties: </p>

<dl> <dt>value <Any></dt> <dd>The initial value to set on the attribute</dd>

<dt>valueFn <Function | String></dt> <dd> <p>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.</p>

<p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p> </dd>

<dt>readOnly <boolean></dt> <dd>Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.</dd>

<dt>writeOnce <boolean> or <string></dt> <dd> 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. <p>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)</p> </dd>

<dt>setter <Function | String></dt> <dd> <p>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 <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent the value from being stored. </p>

<p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p> </dd>

<dt>getter <Function | String></dt> <dd> <p> 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. </p>

<p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p> </dd>

<dt>validator <Function | String></dt> <dd> <p> The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored. </p>

<p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p> </dd>

<dt>lazyAdd <boolean></dt> <dd>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 <a href="#method_addAttrs">addAttrs</a> method.</dd>

</dl>

<p>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.</p>

<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.</p>

Parameters:

  • name String

    The name of the attribute.

  • config Object

    An object with attribute configuration property/value pairs, specifying the configuration for the attribute.

    <p> <strong>NOTE:</strong> 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. </p>

  • lazy Boolean

    (optional) Whether or not to add this attribute lazily (on the first call to get/set).

Returns:

Object:

A reference to the host object.

addAttrs

(
  • cfgs
  • values
  • lazy
)
Object chainable

Configures a group of attributes, and sets initial values.

<p> <strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required. </p>

Parameters:

  • cfgs Object

    An object with attribute name/configuration pairs.

  • values Object

    An 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 Boolean

    Whether 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 <a href="#method_addAttr">addAttr</a>.

Returns:

Object:

A reference to the host object.

addTarget

(
  • o
)
chainable

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:

after

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

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:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching the subscription

attrAdded

(
  • name
)
Boolean

Checks if the given attribute has been added to the host

Parameters:

  • name String

    The name of the attribute to check.

Returns:

Boolean:

true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.

before

()

Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.

For DOM and custom events: type, callback, context, 0-n arguments

For methods: callback, object (method host), methodName, context, 0-n arguments

Returns:

detach handle

bubble

(
  • evt
)
Boolean

Propagate an event. Requires the event-custom-complex module.

Parameters:

Returns:

Boolean:

the aggregated return value from Event.Custom.fire

destroy

() BaseCore chainable

Inherited from BaseObservable but overwritten in yui3/src/base/js/BaseCore.js:352

Destroy lifecycle method. Invokes destructors for the class hierarchy.

Returns:

BaseCore:

A reference to this object

detach

(
  • type
  • fn
  • context
)
EventTarget

Detach one or more listeners the from the specified event

Parameters:

  • type String | Object

    Either 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 Function

    The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.

  • context Object

    The 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:

EventTarget:

the host

detachAll

(
  • type
)

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String

    The type, or name of the event

fire

(
  • type
  • arguments
)
Boolean

Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.

The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.

If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.

Parameters:

  • type String | Object

    The type of the event, or an object that contains a 'type' property.

  • arguments Object

    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:

Boolean:

True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.

get

(
  • name
)
Any

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:

  • name String

    The 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. <code>get("x.y.z")</code>)

Returns:

Any:

The value of the attribute

getAttrs

(
  • attrs
)
Object

Gets multiple attribute values.

Parameters:

  • attrs String | Boolean

    Optional. 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:

Object:

An object with attribute name/value pairs.

getEvent

(
  • type
  • prefixed
)
CustomEvent

Returns the custom event of the provided type has been created, a falsy value otherwise

Parameters:

  • type String

    the type, or name of the event

  • prefixed String

    if true, the type is prefixed already

Returns:

CustomEvent:

the custom event or null

getMatch

(
  • content
)
Object

Checks if the provided content contains directive or variable.

Parameters:

  • content String

    The content which should be traversed for matches

Returns:

Object:

An Object which contains the following properties: content - the found content start - the start index of the match type - match type, could be 0 (DIRECTIVES) or 1 (VARIABLES)

getResults

(
  • match
  • callbackSuccess
  • callbackError
)

Accepts match and depending on its type processes directives or variables. In case of success, calls the provided success callback, or the error callback otherwise.

Parameters:

  • match Object

    The provided match. It should contain at least type and content properties

  • callbackSuccess Function

    The function to be called in case of success

  • callbackError Function

    The function to be called in case of error

getSuggestion

(
  • match
  • selectedSuggestion
)
String

Formats the selected suggestion depending on the match type and currently selected editor mode. The match type can be one of: MATCH_DIRECTOVES or MATCH_VARIABLES. The selected editor mode can be one of the following: INSERT or OVERWRITE. See AceEditor.AutoCompleteBase/fillMode:attribute

Parameters:

  • match Object

    The provided match. It should contain at least type and content properties

  • selectedSuggestion String

    The selected suggestion from the list with suggestions

Returns:

String:

The final suggestion which should be inserted to the editor

getTargets

()

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

init

(
  • cfg
)
BaseCore chainable

Inherited from BaseObservable but overwritten in yui3/src/base/js/BaseCore.js:319

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

Parameters:

  • cfg Object

    Object with configuration property name/value pairs

Returns:

BaseCore:

A reference to this object

modifyAttr

(
  • name
  • config
)

Updates the configuration of an attribute which has already been added. <p> 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: </p> <dl> <dt>readOnly;</dt> <dt>writeOnce;</dt> <dt>broadcast; and</dt> <dt>getter.</dt> </dl> <p> Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base). </p>

Parameters:

  • name String

    The name of the attribute whose configuration is to be updated.

  • config Object

    An object with configuration property/value pairs, specifying the configuration properties to modify.

on

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.

 this.on("change", this._onChange, this);
                                                

Callback functions for events published with emitFacade = true will receive an EventFacade as the first argument (typically named "e"). These callbacks can then call e.preventDefault() to disable the behavior published to that event's defaultFn. See the EventFacade API for all available properties and methods. Subscribers to non-emitFacade events will receive the arguments passed to fire() after the event name.

To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback.

 this.on({
                                                     "attrChange" : this._onAttrChange,
                                                     "change"     : this._onChange
                                                 });
                                                

You can also pass an array of event names as the first argument to subscribe to all listed events with the same callback.

 this.on([ "change", "attrChange" ], this._onChange);
                                                

Returning false from a callback is supported as an alternative to calling e.preventDefault(); e.stopPropagation();. However, it is recommended to use the event methods whenever possible.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching that subscription

once

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Listen to a custom event hosted by this object one time. This is the equivalent to <code>on</code> except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching the subscription

onceAfter

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Listen to a custom event hosted by this object one time. This is the equivalent to <code>after</code> except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching that subscription

parseType

(
  • type
  • [pre]
)
Array

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:168

Available since 3.3.0

Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.

Parameters:

  • type String

    the type

  • [pre] String optional

    The prefix. Defaults to this._yuievt.config.prefix

Returns:

Array:

an array containing:

  • the detach category, if supplied,
  • the prefixed event type,
  • whether or not this is an after listener,
  • the supplied event type

publish

(
  • type
  • opts
)
CustomEvent

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:

  • type String

    the type, or name of the event

  • opts Object

    optional config params. Valid properties are:

    • [broadcast=false] Boolean optional

      whether or not the YUI instance and YUI global are notified when the event is fired.

    • [bubbles=true] Boolean optional

      Whether or not this event bubbles. Events can only bubble if emitFacade is true.

    • [context=this] Object optional

      the default execution context for the listeners.

    • [defaultFn] Function optional

      the default function to execute when this event fires if preventDefault was not called.

    • [emitFacade=false] Boolean optional

      whether or not this event emits a facade.

    • [prefix] String optional

      the prefix for this targets events, e.g., 'menu' in 'menu:click'.

    • [fireOnce=false] Boolean optional

      if an event is configured to fire once, new subscribers after the fire will be notified immediately.

    • [async=false] Boolean optional

      fireOnce event listeners will fire synchronously if the event has already fired unless async is true.

    • [preventable=true] Boolean optional

      whether or not preventDefault() has an effect.

    • [preventedFn] Function optional

      a function that is executed when preventDefault() is called.

    • [queuable=false] Boolean optional

      whether or not this event can be queued during bubbling.

    • [silent] Boolean optional

      if silent is true, debug messages are not provided for this event.

    • [stoppedFn] Function optional

      a function that is executed when stopPropagation is called.

    • [monitored] Boolean optional

      specifies whether or not this event should send notifications about when the event has been attached, detached, or published.

    • [type] String optional

      the event type (valid option if not provided as the first parameter to publish).

Returns:

CustomEvent:

the custom event

removeAttr

(
  • name
)

Removes an attribute from the host object

Parameters:

  • name String

    The name of the attribute to be removed.

removeTarget

(
  • o
)
chainable

Removes a bubble target

Parameters:

reset

(
  • name
)
Object chainable

Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.

Parameters:

  • name String

    Optional. The name of the attribute to reset. If omitted, all attributes are reset.

Returns:

Object:

A reference to the host object.

set

(
  • name
  • value
  • [opts]
)
Object chainable

Sets the value of an attribute.

Parameters:

  • name String

    The 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. <code>set("x.y.z", 5)</code>).

  • value Any

    The value to set the attribute to.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

setAttrs

(
  • attrs
  • [opts]
)
Object chainable

Sets multiple attribute values.

Parameters:

  • attrs Object

    An object with attributes name/value pairs.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

subscribe

() deprecated

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:346

Deprecated: use on

subscribe to an event

toString

() String

Default toString implementation. Provides the constructor NAME and the instance guid, if set.

Returns:

String:

String representation for this object

unsubscribe

() deprecated

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:469

Deprecated: use detach

detach a listener

unsubscribeAll

(
  • type
)
deprecated

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:490

Deprecated: use detachAll

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:

  • type String

    The type, or name of the event

Properties

_allowAdHocAttrs

Boolean protected

This property controls whether or not instances of this class should allow users to add ad-hoc attributes through the constructor configuration hash.

AdHoc attributes are attributes which are not defined by the class, and are not handled by the MyClass._NON_ATTRS_CFG

Default: undefined (false)

ATTRS

Object static

Static property used to define the default attribute configuration for the Freemarker.

NAME

String static

Static property which provides a string to identify the class.

name

String deprecated

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:297

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

NS

String static

Static property provides a string to identify the namespace.

Attributes

destroyed

Boolean readonly

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

directives

Array

Contains the list of supported directives according to Freemarker specification.

Default: value: [ 'assign', 'attempt', 'break', 'case', 'compress', 'default', 'else', 'elseif', 'escape', 'fallback', 'flush', 'ftl', 'function', 'global', 'if', 'import', 'include', 'list', 'local', 'lt', 'macro', 'nested', 'noescape', 'nt', 'recover', 'recurse', 'return', 'rt', 'setting', 'stop', 'switch', 't', 'visit' ]

directivesMatcher

Contains the regular expression which checks for directive presence.

Default: /<#[\w]*[^<#]*$/

host

Object

The Editor in which the current instance is plugged.

initialized

Boolean readonly

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

variables

Object

Contains the supported variables.

variablesMatcher

Contains the regular expression which will check for variable match.

Default: /\${[\w., ()"]*(?:[^$]|\\\$)*$/

Events

destroy

<p> 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. </p> <p> Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction). </p>

Event Payload:

init

<p> 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. </p> <p> Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization). </p>

Event Payload:

  • e EventFacade

    Event object, with a cfg property which refers to the configuration object passed to the constructor.