settings.SettingsMainView Class
/var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/settings/settingsMainView.js:5
The primary view for the settings area. Refer to settings.settingsCollection to find the various individual views for each area. When creating a view, try to only extend the awa.mvc.ContentView. The router/controller simply passes an args object to this view which is dispersed to the proper tab and then evaluated to the correct contents view. This view currently supports 6 categories which correspond to the 6 tabs.
Constructor
settings.SettingsMainView
()
Item Index
Methods
Methods
allowedEvents
()
Undefined
This is a function, but what's important is the returned value. 'tabCreated', 'tabDisplayed', 'tabDestroyed', 'destroyed', 'rendered'
Returns:
bindToModel
-
[model]
Binds the view to a Model. will explain more later.
Parameters:
-
[model]awa.mvc.Model | Backbone.Model optionalModel to bind to
Returns:
createTab
-
params -
$container
Adds a new tab and view area to the tabbed container view
Parameters:
-
paramsObjectThis can be either the constructor method or an already constructed view. I'd suggest you construct your view first as it's easier to track any issues.
-
onTabSelectString | FunctionThis can be a string location or a function that carries out its own process. It is recommended that you also set a location per Tab.
-
[view]awa.mvc.View | Constructor optionalView instance that is displayed in tab panel
-
[viewArgs]Array optionalArguments applied to the view class
-
[title]String optionalTab title
-
[index]String optional???
-
[identifier]String optionalidentifying key, should be dom safe
-
[template]String | Function optionaltemplate to render into tab
-
[args]Object optionaldont use this
-
[locked]Boolean optionalPrevents user from closing tab
-
[icon]String optionalIcon for title
-
-
$containerObjectdont use this
Returns:
destroy
()
awa.mvc.View
clears out all widgets, grids, and events. Also removes and destroys children
Returns:
this
doChildrenLayouts
()
Undefined
Needed for height fixing and other positioning changes
Returns:
doLayout
()
Undefined
Needed for height fixing and other positioning changes
Returns:
getTabView
-
id
Parameters:
-
idStringTab identifier
Returns:
View in tab
getWidget
()
Array
get the view controlling a widget by it's selector
Returns:
widgets
insertTab
-
params
wrapper for old views that use the old methods
Parameters:
-
paramsObjectThis can be either the constructor method or an already constructed view. I'd suggest you construct your view first as it's easier to track any issues.
Returns:
on
-
event -
callback -
context
More Magic
Parameters:
-
eventStringEvent string
-
callbackFunctionCallback
-
contextObjectContext
Returns:
onDestroyed
-
callback -
context
More Magic
Parameters:
-
callbackFunctionCallback
-
contextObjectContext
Returns:
onNewTabID
-
args
sets current tab with args object. tabIdentifier is required to find the correct tab. The entire args object is passed through to the view in the tab.
Parameters:
-
argsObjectOptions object
-
tabIdentifierStringweb safe string identifier for tab
-
idStringweb safe string identifier for tab. either this or tabIdentifier is requires
-
Returns:
onRendered
-
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:
onSelectedTabClosed
-
tab
Stub function to allow child views to handle what to do when a selected tab is closed.
Returning true prevents the default action.
Parameters:
-
tabObjectTab config
Returns:
true if default action should be prevented
onTabCreated
-
callback -
[context]
The onTabCreated method binds to the tabcreated event. when calling this method, all existing tabs that have been created are passed to the function. This prevents you from having to check what tabs already exist. There is a onceTabCreated and an offTabCreated.
Parameters:
-
callbackFunctionEvent handler
-
[context]Object optionalobject to represent this
Returns:
onTabDestroyed
-
callback -
[context]
Parameters:
-
callbackFunctionEvent handler
-
[context]Object optionalobject to represent this
Returns:
onTabDisplayed
-
callback -
[context]
Parameters:
-
callbackFunctionEvent handler
-
[context]Object optionalobject to represent this
Returns:
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:
this
render
()
awa.mvc.TabContainerView
chainable
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:
this
requestChange
-
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:
requestClose
-
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:
setElement
-
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:
triggerDestroyed
()
Undefined
More Magic
Returns:
triggerRendered
-
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:
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:
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
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
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