ControlsView Class
Extends awa.mvc.View
Defined in:
Module: awa.mvc
/var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/awa/mvc/ControlsView.js:5
This is a basic part of the new gui structure for awa. It extends the View class and should be used as a control/menu bar for contents views
inputs: [
{
type: 'button', //button is default, also takes select, date, sectionButton, more, etc.
id:
align:,
content: 'Save', //used for button
tip:,
color:,
callback:,
collection:
collectionID:
collectionValue:
contents: "Cancel", callback: "onCancel", tip: "Update Demographics"},
{contents: "Save Changes", callback: "save", tip: "Save Changes", color: "red"},
{contents: "Save & Close", callback: "onSaveAndClose", tip: "Save & Close", color: "red"},
// {icon: "print16", contents: "Print", callback: "onPrint", tip: "Update Demographics"},
{icon: "expand16", align: "right", callback: "expandAllSections"},
{icon: "collapse16", align: "right", callback: "collapseAllSections"}
]Constructor
ControlsView
()
Item Index
Methods
Methods
addButton
(
Null
-
config
Parameters:
-
configObjectconfiguration object with various properties
-
[contents]Object optionalhtml contents of the button (icons, text, etc.)
-
[icon]Object optionalhtml contents of the button (icons, text, etc.)
-
[type]Object optionalbutton widget type, decides the color
-
[callback]Function optionaldefined callback
-
Returns:
Null:
not available
addFilter
(
Null
-
config -
callback
Parameters:
-
configObjectconfiguration object with various properties
-
keyStringhtml contents of the button (icons, text, etc.)
-
defaultKeyStringhtml contents of the button (icons, text, etc.)
-
defaultValueStringhtml contents of the button (icons, text, etc.)
-
collectionObjecthtml contents of the button (icons, text, etc.)
-
collectionKeyStringhtml contents of the button (icons, text, etc.)
-
collectionValueStringhtml contents of the button (icons, text, etc.)
-
collectionTemplateStringhtml contents of the button (icons, text, etc.)
-
-
callbackFunctionfunction to add to config
Returns:
Null:
not available
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:
generateControlsConfigFromModelFilter
(
object
-
filter -
args
Generates controls from filters
Parameters:
-
filterobject[object that should contain the filter type]
-
argsobject[merges in to the generated configs. Good for passing the desired callback]
Returns:
object:
[return controls config]
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:
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:
setup
(
Null
-
config
For deprecation, do not use.
Parameters:
-
configObjectconfiguration object with various properties
-
targetViewObjectContents view that this view controls
-
titleObjectContents view that this view controls
-
[template]Object optionalTemplate to render. Can either be a string locator for the old templates or a compiled underscore template
-
[templateArgs]Object optionalarguments to pass through to the template when rendering
-
[targetElementId]String optionalMostly for testing, id of element this view controls
-
Returns:
Null:
nothing, do not use
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
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