Class M.DashboardView
Extends
M.View.
A dashboard view displays images and a corresponding text in a grid-like view
and serves as the homescreen of an application. By tapping on of the icons, a
user can access certain features of an app. By default, there are three icons
in a row and three rows per page possible. But you can easily adjust this to
your custom needs.
Defined in: dashboard.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
This property can be used to specify whether or not the dashboard can be re-arranged
by a user.
|
|
This property can be used to customize the number of items a dashboard
shows per line.
|
|
This property defines the dashboard's name.
|
|
This property specifies the recommended events for this type of view.
|
|
The type of this object.
|
- Fields borrowed from class M.View:
- childViews, computedValue, contentBinding, contentBindingReverse, cssClass, cssClassOnError, cssClassOnInit, cssStyle, events, hasFocus, html, id, isInline, isView, modelId, parentView, triggerActionOnChange, triggerActionOnEnter, triggerActionOnKeyUp, value
Method Attributes | Method Name and Description |
---|---|
addItems(item)
This method adds a given html string, contain the dasboard's items, to the DOM.
|
|
editDashboard(id, event, nextEvent)
This method is automatically called when a taphold event is triggered for one
of the dashboard's
|
|
editMouseDown(id, event)
|
|
editMouseMove(id, event)
|
|
editMouseUp(id, event)
|
|
editTouchEnd(id, event)
|
|
editTouchMove(id, event)
|
|
editTouchStart(id, event)
|
|
This method removes all of the dashboard view's items by removing all of its content in the DOM.
|
|
renderDashboardItemView(item, itemIndex)
|
|
setValue(items)
|
|
sortItemsByValues(items, values)
|
|
- Methods borrowed from class M.View:
- addCssClass, attachToObservable, clearHtml, clearValue, clearValues, computeValue, contentDidChange, delegateValueUpdate, design, getChildViewsAsArray, getIds, getValue, getValues, gotFocus, lostFocus, nl2br, registerEvents, removeCssClass, removeCssProperty, secure, setCssProperty, setValueFromDOM, style, tab2space, theme, themeChildViews
- Methods borrowed from class M.Object:
- bindToCaller, create, destroy, extend, get, include, set
Field Detail
{Boolean}
isEditable
This property can be used to specify whether or not the dashboard can be re-arranged
by a user.
{Number}
itemsPerLine
This property can be used to customize the number of items a dashboard
shows per line. By default this is set to three.
{String}
name
This property defines the dashboard's name. This is used internally to identify
the dashboard inside the DOM.
Note: If you are using more than one dashboard inside your application, make sure
you provide different names.
{Array}
recommendedEvents
This property specifies the recommended events for this type of view.
{String}
type
The type of this object.
Method Detail
addItems(item)
This method adds a given html string, contain the dasboard's items, to the DOM.
- Parameters:
- {String} item
- The html representation of the dashboard items to be added.
editDashboard(id, event, nextEvent)
This method is automatically called when a taphold event is triggered for one
of the dashboard's
- Parameters:
- id
- event
- nextEvent
editMouseDown(id, event)
- Parameters:
- id
- event
editMouseMove(id, event)
- Parameters:
- id
- event
editMouseUp(id, event)
- Parameters:
- id
- event
editTouchEnd(id, event)
- Parameters:
- id
- event
editTouchMove(id, event)
- Parameters:
- id
- event
editTouchStart(id, event)
- Parameters:
- id
- event
removeAllItems()
This method removes all of the dashboard view's items by removing all of its content in the DOM. This
method is based on jQuery's empty().
renderChildViews()
renderDashboardItemView(item, itemIndex)
- Parameters:
- item
- itemIndex
renderUpdate()
setValue(items)
- Parameters:
- items
sortItemsByValues(items, values)
- Parameters:
- items
- values
stopEditMode()