reports.PMRecordsView Class
/var/www/azaleahealth.com/branches/docs/source_repo/awa/resources/apps/js/reports/PMRecordsView.js:8
StructuredView for a centralized area for all items in a client app
Constructor
reports.PMRecordsView
-
[options.model]
Parameters:
-
[options.model]PatientModel optionalsets patient for this view
Item Index
Methods
- addSection deprecated
- addSections
- getContents
- getContext
- getCurrentContentsView
- getCurrentControlsView
- getSection
- getViewFromSection
- hideContext
- hideControls
- hideSidebar
- popup
- render
- setContents
- setContextText
- setControls
- setCurrentControlsView
- setHeader
- setHeaderText
- setSidebar
- showControls
- showSidebar
- toggleSidebar
Methods
addSection
-
section
For multi section structured views (i.e. patients record or settings area)
Parameters:
-
sectionObjectSection config
-
nameObjectDisplayable name
-
groupObjectUsed for grouping on sidebars
-
iconObjectrecommended icon
-
sectionObjectKey/id for section
-
callbackFunctionCalled when view is requested
-
Returns:
addSections
-
sections
For multi section structured views (i.e. patients record or settings area)
Parameters:
-
sectionsArrayarray of section args
Returns:
getContents
()
jQuery.Element
returns the contents element
Returns:
View Jquery selector element for contents
getContext
()
jQuery.Element
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 actione attribute value should match the name of the function in the view class.
Returns:
View Jquery selector element for contents
getCurrentContentsView
()
awa.mvc.View
Returns:
returns the current active contents view
getCurrentControlsView
()
awa.mvc.ControlsView
Returns:
The current controls view
getSection
()
Object
override this method to return views based on the parameters provided.
Returns:
Configuration object
getViewFromSection
-
sectionConfig
override this method to return views based on the parameters provided.
Parameters:
-
sectionConfigObjectSection config to match against
-
sectionObjectkey/id for section
-
Returns:
varies depending on if config provides a callback If the section has no classpath, but has a callback, the result from that callback will be returned with sectionConfig passed as the argument If the section has a classpath, but no callback, an attempt is made to require and instantiate the view at the classpath. If this succeeds, the new instance is returned. If the section has a classpath and a callback, an attempt is made to require and instantiate the view at the classpath. If this succeeds, that view is passed as the arg to the callback. Otherwise undefined is returned.
hideContext
()
awa.mvc.StructuredView
chainable
Hides context Menu/Title
Returns:
this
hideControls
-
$el
Adds a child View. Added children automatically get cleaned up after (destroy is called, events are unbound). Be sure to always add child view AND large ui element (like autoselect)
Parameters:
-
$elString | jQuery.ElementThis 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:
hideSidebar
()
awa.mvc.StructuredView
chainable
Adds a child View. Added children automatically get cleaned up after (destroy is called, events are unbound). Be sure to always add child view AND large ui element (like autoselect)
Returns:
this
popup
-
[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:
popup
render
()
awa.mvc.StructuredView
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 actione attribute value should match the name of the function in the view class.
Returns:
this
setContents
-
$el
Adds a child View. Added children automatically get cleaned up after (destroy is called, events are unbound). Be sure to always add child view AND large ui element (like autoselect)
Parameters:
-
$elString | jQuery.ElementThis 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:
setContextText
-
text
Sets a subtitle for the structured view
Parameters:
-
textStringContext text
Returns:
setControls
-
$el
Adds a child View. Added children automatically get cleaned up after (destroy is called, events are unbound). Be sure to always add child view AND large ui element (like autoselect)
Parameters:
-
$elString | jQuery.ElementThis 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:
setCurrentControlsView
-
view
Sets an internal pointer for the current controls view. Also replaces the existing controls view on the dom but keeps the current element alive.
Parameters:
-
viewawa.mvc.ControlsViewControlsView object to set for structured view
Returns:
this
setHeader
-
$el
Adds a child View. Added children automatically get cleaned up after (destroy is called, events are unbound). Be sure to always add child view AND large ui element (like autoselect)
Parameters:
-
$elString | jQuery.ElementThis 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:
setHeaderText
-
text
Sets a title in the very top bar of the structured view
Parameters:
-
textStringHeader text I'd suggest you construct your view first as it's easier to track any issues.
Returns:
setSidebar
-
$el
Adds a child View. Added children automatically get cleaned up after (destroy is called, events are unbound). Be sure to always add child view AND large ui element (like autoselect)
Parameters:
-
$elString | jQuery.ElementThis 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:
showControls
-
$el
Adds a child View. Added children automatically get cleaned up after (destroy is called, events are unbound). Be sure to always add child view AND large ui element (like autoselect)
Parameters:
-
$elString | jQuery.ElementThis 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:
showSidebar
-
show
Parameters:
-
showBooleanif undefined, defaults to true
Returns:
this
toggleSidebar
()
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 actione attribute value should match the name of the function in the view class.