API Docs for: 7.2
Show:

MQA.Base Class

Module: MQA

Generic object to be used as a base to create more complex objects. This object is not instantiated directly.

Constructor

MQA.Base

()

Properties

className

String MQA.base final

guid

String

A unique id for the object

parentCollections

Array

reservedProperties

String

A list (comma-separated string) of 'private' properties

Methods

_duco

() private

Stubbed for sub-objects. This function will return a calculated value for any specified key instead of returning the naked value. This function (_duco) is for internal use by the API. Users deriving their own objects would use the regular duco.

duco - from the Latin: to calculate

_facio

() private

Stubbed for sub-objects. Performs any actions or calculations needed when the specified key,value pair is set. This function (_facio) is for internal use by the API. Users deriving their own objects would use the regular facio. facio from the Latin: to make, do, act, perform

dispose

()

Destroys the object. You must provide an implementation of this when extending the object to clean up after yourself

draw

()

Stubbed for sub-objects

duco

() private

Stubbed for sub-objects. This function will return a calculated value for any specified key instead of returning the naked value. duco - from the Latin: to calculate

facio

() private

Stubbed for sub-objects. Performs any actions or calculations needed when the specified key,value pair is set.

facio - from the Latin: to make, do, act, perform

getValue

(
  • pcKey
)
Mixed | Undefined

Returns the value at the specified key if it exists, undefined otherwise.

Parameters:

  • pcKey String

    The property name of the value to get.

Returns <Mixed | Undefined>

The value of the specified property name. If the specified property does not exist, undefined is returned.

isFunction

(
  • fCheck
)
private

If fCheck is a function, return fCheck. Otherwise, return undefined.

Parameters:

lookupGetter

(
  • obj
  • name
)
private

Looks up a getter for an object and returns the function.

Parameters:

  • obj Object

    The object to find the accessor on

  • name Object

    Property name

lookupSetter

(
  • obj
  • name
  • restrict
)
private

Looks up a setter for an object and returns the function.

Parameters:

  • obj Object

    The object to find the accessor on

  • name Object

    Property name

  • restrict Object

    If true then only declared setters will be returned

override

(
  • key
)

Removes the default behavior for the specified property. Used when creating objects derived from MQA.Base where the default behavior is not preferable.

Parameters:

  • key String | Array

    Takes a string or an array of strings as a parameter.

setValue

(
  • pcKey
  • pcValue
)
Boolean

Sets the specified property to the specified value. Properties contained within reservedProperties will not be set and will return false.

Parameters:

  • pcKey String

    The property to set.

  • pcValue Mixed

    The value to set the property to.

Returns <Boolean>

true if the key exists and is set successfully, otherwise false.

setValues

(
  • pcValues
)
Number

Sets multiple properties for the object.

Parameters:

  • pcValues Object

    The key:value pairs to set where "key" is the property name and "value" is the value to set.

Returns <Number>

the number of objects set successfully