Constructs Brick instance
Brick UID
Brick Name
Brick Path
Optional extend: BrickExtendObject to be extended, should have at least init() function
Readonly DEBUGEnables some internal debugging output to JS console eg. Config data Default is false for production environment and true for development
Private Readonly brickBrick Name
Private Readonly brickBrick Path relative to website root
Private Readonly brickUIDBrick Unique ID in current document
Private Optional Readonly domBrick HTML DOM Element of the main Brick container (wrapper)
Readonly editmodeIs TRUE if view is currently in editmode Works only for bricks using action.php extending Website\Tag\Area\ActionObject
Optional initCalled when Brick is created and associated with DOM element
Works only for bricks using action class extending Web4People\TemplateEngineBundle\AbstractTemplateAreabrick
Called when Brick is created and associated with DOM element
Works only for bricks using action class extending Web4People\TemplateEngineBundle\AbstractTemplateAreabrick
Optional brickId: stringProtected Optional initializedOptional onCalled when Brick is created and associated with DOM element
Called when Brick is created and associated with DOM element
Optional onCalled when ScrollMagic is available for this widget
Called when ScrollMagic is available for this widget
Private Readonly wrapperBrick HTML DOM Element of the main Brick container wrapped as JQuery Object
Returns a live HTMLCollection which contains every Brick descendant element which has the specified class name or names.
Optional names: stringis a string representing the list of class names to match; class names are separated by whitespace
Returns Brick Wrapper as JQuery Object
Before calling this function JQuery should be loaded using standard async load otherwise warn message is displayed and HTMLElement is returned instead
define(["jquery"], function ($) {
return function (brickId, brickName, brickPath, Brick) {
return new Brick(brickId, brickName, brickPath, {
// init function runs at the end of the constructor so "new Brick" above doesn't return usable value until init function is finished!
init: function () {
var wrapper = this.getWrapper();
}
});
};
});
or note "jquery" in require call
define([], function () {
return function (brickId, brickName, brickPath, Brick) {
return new Brick(brickId, brickName, brickPath, {
init: function () {
var me = this;
require(["jquery"], function($) {
var wrapper = me.getWrapper();
});
}
});
};
});
Add Event Listener to brick Dom Element
Private setGenerated using TypeDoc
Website Brick parent Class
Instance
Instance of Brick is available as DOM property with name "Brick" on brick container element