awa.mvc.ContentsView Class
Extends awa.mvc.View
Defined in:
Module: awa.mvc
/var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/ContentsView.js:5
The ContentsView is the main view inside of a TabView. Please use the set methods to set the elements of the other sections in the tab view easier refactoring and a structured way to handle different platforms (varying screen size, mobile, touchscreens, etc.) Provided below is some boilerplate code for creating a new ContentsView.
events:
hide - Triggered on minimize, element hidden, etc.
show - Triggered on maximize, element show, etc
define(
['awa', '[package_name]/tpl'],
function(awa, tpl){
var NewView = awa.mvc.ContentsView.extend({
initialize: function() {
self.model = new awa.mvc.Model();
},
render: function() {
var self = this;
NewView.__super__.render.call(this);
//control panel
self.controls = self.addChild("controls", new awa.mvc.ControlsView({
tpl: //controls template
}));
self.controls.render();
self.setControls(self.controls.$el);
self.widgets();
//this is how to setup the ModelForm if needed
self.form = new awa.mvc.ModelForm({
model: self.model,
el: self.$el
});
//lets the scrollable widget know the view is done rendering
self.trigger("rendered");
}
});
return NewView;
});Constructor
awa.mvc.ContentsView
(
-
[options.title] -
[options.viewDescription]
Parameters:
-
[options.title]String optionaltitle for this view
-
[options.viewDescription]String optionaldescription for use of view. May also explain a concept. Intended for the user
Item Index
Methods
Methods
bindToModel
(
Undefined
-
[model]
Binds the view to a Model. will explain more later.
Parameters:
-
[model]awa.mvc.Model | Backbone.Model optionalModel to bind to
Returns:
Undefined:
destroy
()
awa.mvc.View
clears out all widgets, grids, and events. Also removes and destroys children
Returns:
awa.mvc.View:
this
doChildrenLayouts
()
Undefined
Needed for height fixing and other positioning changes
Returns:
Undefined:
doLayout
()
Undefined
Needed for height fixing and other positioning changes
Returns:
Undefined:
getWidget
()
Array
get the view controlling a widget by it's selector
Returns:
Array:
widgets
onRendered
(
Undefined
-
callback -
context
This is called only once in the lifetime of a view, if you bind to it before the view is rendered, the function
will be called after triggerRendered is called.
Parameters:
-
callbackFunctionCallback -
contextObjectDefines scope of callback
Returns:
Undefined:
popup
(
Object
-
[createArgs]
Parameters:
-
[createArgs]Object optionalarguments used on creation of popup
-
[controlsOnTop]Boolean optionaldefaults to false
-
[x]Integer optionaldefaults to false
-
[y]Integer optionaldefaults to false
-
[onRender]Function optionaldefaults to false
-
Returns:
Object:
popup
refresh
()
awa.mvc.View
There is a habit of re-rendering entire views when it may not be necessary.
Parent views can check the rendered flag and call refresh instead if the child view has already been rendered.
Returns:
awa.mvc.View:
this
render
()
Undefined
overrides backbone.view's render method.
Sets the rendered property to rendered and renders any provided templates.
This also binds any buttons in the view to it's action *IF* it has an actions attribute.
The action attribute value should match the name of the function in the view class.
Returns:
Undefined:
requestChange
(
Undefined
-
callback
Parent views should check this before changing/swapping a view.
Useful for views that are in edit mode that you want to do confirmation before leaving.
Parameters:
-
callbackFunctionfunction to call when you have determined if the view can close or not. If it can close, return an object with property 'success' set to 1.
Returns:
Undefined:
requestClose
(
Undefined
-
callback
Parent views should check this before closing a view.
Useful for views that are in edit mode that you want to do confirmation before closing.
Parameters:
-
callbackFunctionfunction to call when you have determined if the view can close or not. If it can close, return an object with property 'success' set to 1.
Returns:
Undefined:
setElement
(
Undefined
-
element -
[delegate]
Overidden setElement method applies the className to the new element the view is applied to.
Also, if multiple views are passed in (what is returned from a jquery selector) it will be the top of the list.
Parameters:
-
elementJquery.SelectorJquery selector -
[delegate]? optional?
Returns:
Undefined:
triggerRendered
(
Undefined
-
args
The view should only call this once its completely rendered. This does not include refreshing views
(i.e. grids changing pages). This also sets the view's rendered property to true.
Parameters:
-
argsObjectparameter to emit
Returns:
Undefined:
viewOptions
()
Array
the constructor uses this function to determine which properties to pull out of the passed in options to directly attach to the view.
All other options can be referenced from the view's options property
Returns:
Array:
Acceptable view options
Properties
__parent__
View
Parent view object
Default: undefined
className
Boolean | Function
when this view is rendered, it will create a new element with this class added.
If the setElement method is used, this will append itself to the class attribute
Default: "awa-mvc-View"
closeOnReplace
Boolean
Mostly for views that contain multiple views.
This allows a parent view to know that the view should be closed and destroyed when another view is swapped in.
Default: false
controlsView
awa.mvc.ControlsView
reference to this contentsView's main controls view. Subsequent controls view will have to be managed another way.
Default: undefined
globalKeys
Object
used for the keymaster plugin. These will be scoped to the entire app.
Default: undefined
keys
Object
used for the keymaster plugin. These will be scoped to this view in the future.
Default: undefined
ModelClass
Constructor
provide model class to derive information from and to fill data
Default: undefined
refreshOnReplace
Boolean
Mostly for views that contain multiple views.
This allows a parent view to know that the view should be refreshed when this view is swapped back in.
Default: true
rendered
Boolean
Lets you know if this view object has been rendered or not.
If you override the render method without doing a supercall, be sure to set it to true when you are done rendering.
Default: false
title
Strin
Can be used by parent views to put on tabs, control bars, popup headers, etc.
Use accessor methods.
Default: "View"
tpl
Function
default template to use with this view, the render method will use this and inject the resulting html into it's $el.
Default: undefined
tplArgs
Object
arguments that are passed to the template
Default: undefined
viewDescription
String
Description for use of view. May also explain a concept. Intended for the user. If set, the content view rendering process will decide where to place his content if needed.
Default: undefined