QCObjects - Vaadin Add-on Directory
Cross Browser Javascript Framework for MVC Patterns
QCObjects
=============
Cross Browser Javascript Framework for MVC Patterns
---------------------------------------------------
QCObjects is a javascript framework designed to make easier everything about the MVC patterns implementation into the pure javascript scope. You don't need to use typescript nor any transpiler to run QCObjects. It runs directly on the browser and it uses pure javascript with no extra dependencies of code. You can make your own components expressed in real native javascript objects or extend a native DOM object to use in your own way. You can also use QCObjects in conjunction with CSS3 frameworks like [Foundation] (https://foundation.zurb.com), [Bootstrap] (http://getbootstrap.com) and mobile javascript frameworks like [PhoneGap] (https://phonegap.com) and OnsenUI (https://onsen.io)
_________________________
Table of Contents
--------------------
- [Demo Using Foundation](#demo-using-foundation)
- [Demo Using Materializecss](#demo-using-materializecss)
- [Demo Using Raw CSS](#demo-using-raw-css)
- [Another Basic Demo example: The simpliest demo example:](#another-basic-demo-example-the-simpliest-demo-example)
- [Using QCObjects with Atom:](#using-qcobjects-with-atom)
- [Using QCObjects in Visual Studio Code:](#using-qcobjects-in-visual-studio-code)
- [Installing with NPM:](#installing-with-npm)
- [Using the code in the straight way into HTML5:](#using-the-code-in-the-straight-way-into-html5)
- [Quick Start](#quick-start)
- [Step 1: Start creating a main import file and name it like: cl.quickcorp.js. Put it into packages/js/ file directory](#step-1-start-creating-a-main-import-file-and-name-it-like-clquickcorpjs-put-it-into-packagesjs-file-directory)
- [Step 2: Then create some services inhereting classes into the file js/packages/cl.quickcorp.services.js :](#step-2-then-create-some-services-inhereting-classes-into-the-file-jspackagesclquickcorpservicesjs-)
- [Step 3: Now it's time to create the components (cl.quickcorp.components.js)](#step-3-now-its-time-to-create-the-components-clquickcorpcomponentsjs)
- [Step 4: Once you have done the above components declaration, you will now want to code your controllers (cl.quickcorp.controller.js)](#step-4-once-you-have-done-the-above-components-declaration-you-will-now-want-to-code-your-controllers-clquickcorpcontrollerjs)
Copyright
--------------
Copyright (c) Jean Machuca and QuickCorp
Demo
--------------
# Demo Using Foundation
Check out a demo using Foundation components here:
[Demo Using Foundation](https://github.com/QuickCorp/quickobjects_sample1foundation)
# Demo Using Materializecss
Check out a demo using MaterializeCSS here:
[Demo Using Materializecss](https://qln.link)
# Demo Using Raw CSS
Check out a demo using raw CSS:
[Demo Using Raw CSS](https://github.com/QuickCorp/qcobjects_profile_browser)
# Another Basic Demo example: The simpliest demo example:
```html
Demo
*
* Everyone is permitted to copy and distribute verbatim copies of this
* license document, but changing it is not allowed.
*/
Import ('external/libs');
Import ('cl.quickcorp.model');
Import ('cl.quickcorp.components');
Import ('cl.quickcorp.controller');
Import ('cl.quickcorp.view');
Package('cl.quickcorp',[
Class('FormValidator',Object,{
}),
]);
```
## Step 2: Then create some services inhereting classes into the file js/packages/cl.quickcorp.services.js :
```javascript
"use strict";
/*
* QuickCorp/QCObjects is licensed under the
* GNU Lesser General Public License v3.0
* [LICENSE] (https://github.com/QuickCorp/QCObjects/blob/master/LICENSE.txt)
*
* Permissions of this copyleft license are conditioned on making available
* complete source code of licensed works and modifications under the same
* license or the GNU GPLv3. Copyright and license notices must be preserved.
* Contributors provide an express grant of patent rights. However, a larger
* work using the licensed work through interfaces provided by the licensed
* work may be distributed under different terms and without source code for
* the larger work.
*
* Copyright (C) 2015 Jean Machuca,
*
* Everyone is permitted to copy and distribute verbatim copies of this
* license document, but changing it is not allowed.
*/
Package('cl.quickcorp.service',[
Class('JsonService',{
method:"GET",
cached:false,
headers: {
"Content-Type":"application/json",
"charset":"utf-8"
},
JSONresponse: null,
done:function(result){
console.log("***** RECEIVED RESPONSE:");
console.log(result.service.template);
this.JSONresponse = JSON.parse(result.service.template);
alert(this.template);
}
}),
Class('FormSubmitService',{
method:"POST",
cached:false,
headers: {
"Content-Type":"application/json"
},
JSONresponse: null,
done: function(result) {
console.log("***** CALLED FormSubmitService");
this.JSONresponse = JSON.parse(result.service.template);
//TODO success case
console.log("***** SUCCESS!")
console.log(this.JSONresponse);
},
fail: function(result) {
//TODO negative case
console.log("***** ERROR");
}
})
])
```
## Step 3: Now it's time to create the components (cl.quickcorp.components.js)
```javascript
"use strict";
/*
* QuickCorp/QCObjects is licensed under the
* GNU Lesser General Public License v3.0
* [LICENSE] (https://github.com/QuickCorp/QCObjects/blob/master/LICENSE.txt)
*
* Permissions of this copyleft license are conditioned on making available
* complete source code of licensed works and modifications under the same
* license or the GNU GPLv3. Copyright and license notices must be preserved.
* Contributors provide an express grant of patent rights. However, a larger
* work using the licensed work through interfaces provided by the licensed
* work may be distributed under different terms and without source code for
* the larger work.
*
* Copyright (C) 2015 Jean Machuca,
*
* Everyone is permitted to copy and distribute verbatim copies of this
* license document, but changing it is not allowed.
*/
Package('cl.quickcorp.components',[
Class('FormField',Component,{
cached:false,
reload:true,
createBindingEvents:function (){
var _executeBinding = this.executeBinding;
var thisobj = this;
var _objList = this.body.querySelectorAll(this.fieldType);
for (var _datak=0;_datak<_objList.length;_datak++){
var _obj = _objList[_datak];
_obj.addEventListener('change',function(e){
logger.debug('Executing change event binding');
thisobj.executeBindings();
});
_obj.addEventListener('keydown',function(e){
logger.debug('Executing keydown event binding');
thisobj.executeBindings();
});
}
},
executeBinding:function (_obj){
var _datamodel = _obj.getAttribute('data-field');
logger.debug('Binding '+_datamodel+' for '+this.name);
this.data[_datamodel]=_obj.value;
},
executeBindings:function (){
var _objList = this.body.querySelectorAll(this.fieldType);
for (var _datak=0;_datak<_objList.length;_datak++){
var _obj = _objList[_datak];
var _datamodel = _obj.getAttribute('data-field');
logger.debug('Binding '+_datamodel+' for '+this.name);
this.data[_datamodel]=_obj.value;
}
},
done:function (){
var thisobj = this;
thisobj.executeBindings();
thisobj.createBindingEvents();
logger.debug('Field loaded: '+thisobj.fieldType+'[name='+thisobj.name+']');
}
}),
Class('ButtonField',FormField,{
fieldType:'button'
}),
Class('InputField',FormField,{
fieldType:'input'
}),
Class('TextField',FormField,{
fieldType:'textarea'
}),
Class('EmailField',FormField,{
fieldType:'input'
})
]);
```
## Step 4: Once you have done the above components declaration, you will now want to code your controllers (cl.quickcorp.controller.js)
```javascript
"use strict";
/*
* QuickCorp/QCObjects is licensed under the
* GNU Lesser General Public License v3.0
* [LICENSE] (https://github.com/QuickCorp/QCObjects/blob/master/LICENSE.txt)
*
* Permissions of this copyleft license are conditioned on making available
* complete source code of licensed works and modifications under the same
* license or the GNU GPLv3. Copyright and license notices must be preserved.
* Contributors provide an express grant of patent rights. However, a larger
* work using the licensed work through interfaces provided by the licensed
* work may be distributed under different terms and without source code for
* the larger work.
*
* Copyright (C) 2015 Jean Machuca,
*
* Everyone is permitted to copy and distribute verbatim copies of this
* license document, but changing it is not allowed.
*/
"use strict";
Package('cl.quickcorp.controller',[
Class('MainController',Object,{
_new_:function (){
//TODO: Implement
logger.debug('MainController Element Initialized');
}
}),
Class('MyAccountController',Object,{
component: null,
done:function (){
var controller = this;
logger.debug('MyAccountController Element Initialized');
this.component.body.setAttribute('loaded',true);
},
_new_:function (o){
//TODO: Implement
this.component = o.component;
}
}),
]);
```
## Step 5: To use into the HTML5 code you only need to do some settings between
```