UNPKG

comindware.ui

Version:

Comindware Core UI provides the basic components like editors, lists, dropdowns, popups that we so desperately need while creating Marionette-based single-page applications.

547 lines (338 loc) 25.9 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>Comindware UI-Core API Classes</title> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.cerulean.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top navbar-inverse"> <div class="container"> <div class="navbar-header"> <a class="navbar-brand" href="index.html">Comindware UI-Core API</a> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> <div class="navbar-collapse collapse" id="topNavigation"> <ul class="nav navbar-nav"> <li class="dropdown"> <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="module-core.collections.html">core.collections</a></li><li><a href="module-core.collections.behaviors.html">core.collections.behaviors</a></li><li><a href="module-core.dropdown.html">core.dropdown</a></li><li><a href="module-core.dropdown.factory.html">core.dropdown.factory</a></li><li><a href="module-core.dropdown.views.html">core.dropdown.views</a></li><li><a href="module-core.dropdown.views.behaviors.html">core.dropdown.views.behaviors</a></li><li><a href="module-core.form.html">core.form</a></li><li><a href="module-core.form.behaviors.html">core.form.behaviors</a></li><li><a href="module-core.form.editors.html">core.form.editors</a></li><li><a href="module-core.form.editors.avatar.html">core.form.editors.avatar</a></li><li><a href="module-core.form.editors.avatar.controllers.html">core.form.editors.avatar.controllers</a></li><li><a href="module-core.form.editors.base.html">core.form.editors.base</a></li><li><a href="module-core.form.editors.reference.html">core.form.editors.reference</a></li><li><a href="module-core.form.editors.reference.controllers.html">core.form.editors.reference.controllers</a></li><li><a href="module-core.form.Field.html">core.form.Field</a></li><li><a href="module-core.form.repository.html">core.form.repository</a></li><li><a href="module-core.list.html">core.list</a></li><li><a href="module-core.list.cellFactory.html">core.list.cellFactory</a></li><li><a href="module-core.list.factory.html">core.list.factory</a></li><li><a href="module-core.list.models.html">core.list.models</a></li><li><a href="module-core.list.views.html">core.list.views</a></li><li><a href="module-core.meta.html">core.meta</a></li><li><a href="module-core.models.html">core.models</a></li><li><a href="module-core.nativeGrid.html">core.nativeGrid</a></li><li><a href="module-core.nativeGrid.factory.html">core.nativeGrid.factory</a></li><li><a href="module-core.nativeGrid.filterViewFactory.html">core.nativeGrid.filterViewFactory</a></li><li><a href="module-core.nativeGrid.views.html">core.nativeGrid.views</a></li><li><a href="module-core.services.html">core.services</a></li><li><a href="module-core.services.GlobalEventService.html">core.services.GlobalEventService</a></li><li><a href="module-core.services.WindowService.html">core.services.WindowService</a></li><li><a href="module-core.utils.html">core.utils</a></li><li><a href="module-core.utils.comparators.html">core.utils.comparators</a></li><li><a href="module-core.utils.cookieHelpers.html">core.utils.cookieHelpers</a></li><li><a href="module-core.utils.dateHelpers.html">core.utils.dateHelpers</a></li><li><a href="module-core.utils.helpers.html">core.utils.helpers</a></li><li><a href="module-core.utils.htmlHelpers.html">core.utils.htmlHelpers</a></li><li><a href="module-core.utils.keyCode.html">core.utils.keyCode</a></li> </ul> </li> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="module-core.collection.behaviors.HighlightableBehavior.html">core.collection.behaviors.HighlightableBehavior</a></li><li><a href="module-core.collections.SlidingWindowCollection.html">core.collections.SlidingWindowCollection</a></li><li><a href="module-core.collections.VirtualCollection.html">core.collections.VirtualCollection</a></li><li><a href="module-core.dropdown.views.behaviors.CustomAnchorBehavior.html">core.dropdown.views.behaviors.CustomAnchorBehavior</a></li><li><a href="module-core.dropdown.views.DefaultButtonView.html">core.dropdown.views.DefaultButtonView</a></li><li><a href="module-core.dropdown.views.DropdownView.html">core.dropdown.views.DropdownView</a></li><li><a href="module-core.dropdown.views.ListPanelView.html">core.dropdown.views.ListPanelView</a></li><li><a href="module-core.dropdown.views.MenuItemView.html">core.dropdown.views.MenuItemView</a></li><li><a href="module-core.dropdown.views.MenuPanelView.html">core.dropdown.views.MenuPanelView</a></li><li><a href="module-core.dropdown.views.PopoutView.html">core.dropdown.views.PopoutView</a></li><li><a href="module-core.form.behaviors.BackboneFormBehavior.html">core.form.behaviors.BackboneFormBehavior</a></li><li><a href="module-core.form.editors.avatar.controllers.BaseAvatarEditorController.html">core.form.editors.avatar.controllers.BaseAvatarEditorController</a></li><li><a href="module-core.form.editors.AvatarEditorView.html">core.form.editors.AvatarEditorView</a></li><li><a href="module-core.form.editors.base.BaseEditorView.html">core.form.editors.base.BaseEditorView</a></li><li><a href="module-core.form.editors.BooleanEditorView.html">core.form.editors.BooleanEditorView</a></li><li><a href="module-core.form.editors.DateEditorView.html">core.form.editors.DateEditorView</a></li><li><a href="module-core.form.editors.DateTimeEditorView.html">core.form.editors.DateTimeEditorView</a></li><li><a href="module-core.form.editors.DropdownEditorView.html">core.form.editors.DropdownEditorView</a></li><li><a href="module-core.form.editors.DurationEditorView.html">core.form.editors.DurationEditorView</a></li><li><a href="module-core.form.editors.MembersBubbleEditorView.html">core.form.editors.MembersBubbleEditorView</a></li><li><a href="module-core.form.editors.MemberSelectEditorView.html">core.form.editors.MemberSelectEditorView</a></li><li><a href="module-core.form.editors.MentionEditorView.html">core.form.editors.MentionEditorView</a></li><li><a href="module-core.form.editors.MultiSelectEditorView.html">core.form.editors.MultiSelectEditorView</a></li><li><a href="module-core.form.editors.NumberEditorView.html">core.form.editors.NumberEditorView</a></li><li><a href="module-core.form.editors.PasswordEditorView.html">core.form.editors.PasswordEditorView</a></li><li><a href="module-core.form.editors.RadioGroupEditorView.html">core.form.editors.RadioGroupEditorView</a></li><li><a href="module-core.form.editors.reference.controllers.BaseReferenceEditorController.html">core.form.editors.reference.controllers.BaseReferenceEditorController</a></li><li><a href="module-core.form.editors.ReferenceEditorView.html">core.form.editors.ReferenceEditorView</a></li><li><a href="module-core.form.editors.TextAreaEditorView.html">core.form.editors.TextAreaEditorView</a></li><li><a href="module-core.form.editors.TextEditorView.html">core.form.editors.TextEditorView</a></li><li><a href="module-core.form.editors.TimeEditorView.html">core.form.editors.TimeEditorView</a></li><li><a href="module-core.list.models.LoadingRowModel.html">core.list.models.LoadingRowModel</a></li><li><a href="module-core.list.views.EmptyGridView.html">core.list.views.EmptyGridView</a></li><li><a href="module-core.list.views.EmptyListView.html">core.list.views.EmptyListView</a></li><li><a href="module-core.list.views.GridColumnHeaderView.html">core.list.views.GridColumnHeaderView</a></li><li><a href="module-core.list.views.GridHeaderView.html">core.list.views.GridHeaderView</a></li><li><a href="module-core.list.views.GridView.html">core.list.views.GridView</a></li><li><a href="module-core.list.views.ListView.html">core.list.views.ListView</a></li><li><a href="module-core.list.views.LoadingRowView.html">core.list.views.LoadingRowView</a></li><li><a href="module-core.list.views.NoColumnsView.html">core.list.views.NoColumnsView</a></li><li><a href="module-core.list.views.RowView.html">core.list.views.RowView</a></li><li><a href="module-core.list.views.ScrollBarView.html">core.list.views.ScrollBarView</a></li><li><a href="module-core.nativeGrid.views.ColumnHeaderView.html">core.nativeGrid.views.ColumnHeaderView</a></li><li><a href="module-core.nativeGrid.views.HeaderView.html">core.nativeGrid.views.HeaderView</a></li><li><a href="module-core.nativeGrid.views.ListView.html">core.nativeGrid.views.ListView</a></li><li><a href="module-core.nativeGrid.views.NativeGridView.html">core.nativeGrid.views.NativeGridView</a></li><li><a href="module-core.nativeGrid.views.RowView.html">core.nativeGrid.views.RowView</a></li><li><a href="module-core.services.UserService.html">core.services.UserService</a></li> </ul> </li> </ul> <div class="col-sm-3 col-md-3"> <form class="navbar-form" role="search"> <div class="input-group"> <input type="text" class="form-control" placeholder="Search" name="q" id="search-input"> <div class="input-group-btn"> <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button> </div> </div> </form> </div> </div> </div> </div> <div class="container" id="toc-content"> <div class="row"> <div class="col-md-8"> <div id="main"> <h1 class="page-title">Classes</h1> <section> <header> <h2> </h2> </header> <article> <div class="container-overview"> <dl class="details"> </dl> </div> <h3 class="subsection-title">Classes</h3> <dl> <dt><a href="module-core.collection.behaviors.HighlightableBehavior.html">HighlightableBehavior</a></dt> <dd></dd> <dt><a href="module-core.collections.SlidingWindowCollection.html">SlidingWindowCollection</a></dt> <dd></dd> <dt><a href="module-core.collections.VirtualCollection.html">VirtualCollection</a></dt> <dd></dd> <dt><a href="module-core.dropdown.views.behaviors.CustomAnchorBehavior.html">CustomAnchorBehavior</a></dt> <dd></dd> <dt><a href="module-core.dropdown.views.DefaultButtonView.html">DefaultButtonView</a></dt> <dd></dd> <dt><a href="module-core.dropdown.views.DropdownView.html">DropdownView</a></dt> <dd></dd> <dt><a href="module-core.dropdown.views.ListPanelView.html">ListPanelView</a></dt> <dd></dd> <dt><a href="module-core.dropdown.views.MenuItemView.html">MenuItemView</a></dt> <dd></dd> <dt><a href="module-core.dropdown.views.MenuPanelView.html">MenuPanelView</a></dt> <dd></dd> <dt><a href="module-core.dropdown.views.PopoutView.html">PopoutView</a></dt> <dd></dd> <dt><a href="module-core.form.behaviors.BackboneFormBehavior.html">BackboneFormBehavior</a></dt> <dd></dd> <dt><a href="module-core.form.editors.avatar.controllers.BaseAvatarEditorController.html">BaseAvatarEditorController</a></dt> <dd></dd> <dt><a href="module-core.form.editors.AvatarEditorView.html">AvatarEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.base.BaseEditorView.html">BaseEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.BooleanEditorView.html">BooleanEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.DateEditorView.html">DateEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.DateTimeEditorView.html">DateTimeEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.DropdownEditorView.html">DropdownEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.DurationEditorView.html">DurationEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.MembersBubbleEditorView.html">MembersBubbleEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.MemberSelectEditorView.html">MemberSelectEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.MentionEditorView.html">MentionEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.MultiSelectEditorView.html">MultiSelectEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.NumberEditorView.html">NumberEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.PasswordEditorView.html">PasswordEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.RadioGroupEditorView.html">RadioGroupEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.reference.controllers.BaseReferenceEditorController.html">BaseReferenceEditorController</a></dt> <dd></dd> <dt><a href="module-core.form.editors.ReferenceEditorView.html">ReferenceEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.TextAreaEditorView.html">TextAreaEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.TextEditorView.html">TextEditorView</a></dt> <dd></dd> <dt><a href="module-core.form.editors.TimeEditorView.html">TimeEditorView</a></dt> <dd></dd> <dt><a href="module-core.list.models.LoadingRowModel.html">LoadingRowModel</a></dt> <dd></dd> <dt><a href="module-core.list.views.EmptyGridView.html">EmptyGridView</a></dt> <dd></dd> <dt><a href="module-core.list.views.EmptyListView.html">EmptyListView</a></dt> <dd></dd> <dt><a href="module-core.list.views.GridColumnHeaderView.html">GridColumnHeaderView</a></dt> <dd></dd> <dt><a href="module-core.list.views.GridHeaderView.html">GridHeaderView</a></dt> <dd></dd> <dt><a href="module-core.list.views.GridView.html">GridView</a></dt> <dd></dd> <dt><a href="module-core.list.views.ListView.html">ListView</a></dt> <dd></dd> <dt><a href="module-core.list.views.LoadingRowView.html">LoadingRowView</a></dt> <dd></dd> <dt><a href="module-core.list.views.NoColumnsView.html">NoColumnsView</a></dt> <dd></dd> <dt><a href="module-core.list.views.RowView.html">RowView</a></dt> <dd></dd> <dt><a href="module-core.list.views.ScrollBarView.html">ScrollBarView</a></dt> <dd></dd> <dt><a href="module-core.nativeGrid.views.ColumnHeaderView.html">ColumnHeaderView</a></dt> <dd></dd> <dt><a href="module-core.nativeGrid.views.HeaderView.html">HeaderView</a></dt> <dd></dd> <dt><a href="module-core.nativeGrid.views.ListView.html">ListView</a></dt> <dd></dd> <dt><a href="module-core.nativeGrid.views.NativeGridView.html">NativeGridView</a></dt> <dd></dd> <dt><a href="module-core.nativeGrid.views.RowView.html">RowView</a></dt> <dd></dd> <dt><a href="module-core.services.UserService.html">UserService</a></dt> <dd></dd> </dl> <h3 class="subsection-title">Namespaces</h3> <dl> <dt><a href="namespaces.html#module:core.collections"><a href="module-core.collections.html">collections</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.collections.behaviors"><a href="module-core.collections.behaviors.html">behaviors</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.dropdown"><a href="module-core.dropdown.html">dropdown</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.dropdown.factory"><a href="module-core.dropdown.factory.html">factory</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.dropdown.views"><a href="module-core.dropdown.views.html">views</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.dropdown.views.behaviors"><a href="module-core.dropdown.views.behaviors.html">behaviors</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form"><a href="module-core.form.html">form</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form.behaviors"><a href="module-core.form.behaviors.html">behaviors</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form.editors"><a href="module-core.form.editors.html">editors</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form.editors.avatar"><a href="module-core.form.editors.avatar.html">avatar</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form.editors.avatar.controllers"><a href="module-core.form.editors.avatar.controllers.html">controllers</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form.editors.base"><a href="module-core.form.editors.base.html">base</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form.editors.reference"><a href="module-core.form.editors.reference.html">reference</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form.editors.reference.controllers"><a href="module-core.form.editors.reference.controllers.html">controllers</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form.Field"><a href="module-core.form.Field.html">Field</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.form.repository"><a href="module-core.form.repository.html">repository</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.list"><a href="module-core.list.html">list</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.list.cellFactory"><a href="module-core.list.cellFactory.html">cellFactory</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.list.factory"><a href="module-core.list.factory.html">factory</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.list.models"><a href="module-core.list.models.html">models</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.list.views"><a href="module-core.list.views.html">views</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.meta"><a href="module-core.meta.html">meta</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.models"><a href="module-core.models.html">models</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.nativeGrid"><a href="module-core.nativeGrid.html">nativeGrid</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.nativeGrid.factory"><a href="module-core.nativeGrid.factory.html">factory</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.nativeGrid.filterViewFactory"><a href="module-core.nativeGrid.filterViewFactory.html">filterViewFactory</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.nativeGrid.views"><a href="module-core.nativeGrid.views.html">views</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.services"><a href="module-core.services.html">services</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.services.GlobalEventService"><a href="module-core.services.GlobalEventService.html">GlobalEventService</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.services.WindowService"><a href="module-core.services.WindowService.html">WindowService</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.utils"><a href="module-core.utils.html">utils</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.utils.comparators"><a href="module-core.utils.comparators.html">comparators</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.utils.cookieHelpers"><a href="module-core.utils.cookieHelpers.html">cookieHelpers</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.utils.dateHelpers"><a href="module-core.utils.dateHelpers.html">dateHelpers</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.utils.helpers"><a href="module-core.utils.helpers.html">helpers</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.utils.htmlHelpers"><a href="module-core.utils.htmlHelpers.html">htmlHelpers</a></a></dt> <dd></dd> <dt><a href="namespaces.html#module:core.utils.keyCode"><a href="module-core.utils.keyCode.html">keyCode</a></a></dt> <dd></dd> </dl> </article> </section> </div> </div> <div class="clearfix"></div> <div class="col-md-3"> <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div> </div> </div> </div> <div class="modal fade" id="searchResults"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button> <h4 class="modal-title">Search results</h4> </div> <div class="modal-body"></div> <div class="modal-footer"> <button type="button" class="btn btn-default" data-dismiss="modal">Close</button> </div> </div><!-- /.modal-content --> </div><!-- /.modal-dialog --> </div> <footer> <span class="copyright"> Comindware Copyright © 2016 </span> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha5</a> using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. </span> </footer> <script src="scripts/docstrap.lib.js"></script> <script src="scripts/toc.js"></script> <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script> <script> $( function () { $( "[id*='$']" ).each( function () { var $this = $( this ); $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) ); } ); $( ".tutorial-section pre, .readme-section pre" ).each( function () { var $this = $( this ); var example = $this.find( "code" ); exampleText = example.html(); var lang = /{@lang (.*?)}/.exec( exampleText ); if ( lang && lang[1] ) { exampleText = exampleText.replace( lang[0], "" ); example.html( exampleText ); lang = lang[1]; } else { var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/); lang = langClassMatch ? langClassMatch[1] : "javascript"; } if ( lang ) { $this .addClass( "sunlight-highlight-" + lang ) .addClass( "linenums" ) .html( example.html() ); } } ); Sunlight.highlightAll( { lineNumbers : true, showMenu : true, enableDoclinks : true } ); $.catchAnchorLinks( { navbarOffset: 10 } ); $( "#toc" ).toc( { anchorName : function ( i, heading, prefix ) { var id = $( heading ).attr( "id" ); return id && id.replace(/\~/g, '-inner-').replace(/\./g, '-static-') || ( prefix + i ); }, selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4", showAndHide : false, smoothScrolling: true } ); $( "#main span[id^='toc']" ).addClass( "toc-shim" ); $( '.dropdown-toggle' ).dropdown(); $( "table" ).each( function () { var $this = $( this ); $this.addClass('table'); } ); } ); </script> <!--Navigation and Symbol Display--> <!--Google Analytics--> <script type="text/javascript"> $(document).ready(function() { SearcherDisplay.init(); }); </script> </body> </html>