ang/crmUi.js

   1 /// crmUi: Sundry UI helpers
   2 (function (angular, $, _) {
   3
   4   var uidCount = 0;
   5
   6   angular.module('crmUi', [])
   7
   8     // example <div crm-ui-accordion crm-title="ts('My Title')" crm-collapsed="true">...content...</div>
   9     // WISHLIST: crmCollapsed should support two-way/continuous binding
  10     .directive('crmUiAccordion', function() {
  11       return {
  12         scope: {
  13           crmUiAccordion: '='
  14         },
  15         template: '<div ng-class="cssClasses"><div class="crm-accordion-header">{{crmUiAccordion.title}} <a crm-ui-help="help" ng-if="help"></a></div><div class="crm-accordion-body" ng-transclude></div></div>',
  16         transclude: true,
  17         link: function (scope, element, attrs) {
  18           scope.cssClasses = {
  19             'crm-accordion-wrapper': true,
  20             collapsed: scope.crmUiAccordion.collapsed
  21           };
  22           scope.help = null;
  23           scope.$watch('crmUiAccordion', function(crmUiAccordion) {
  24             if (crmUiAccordion && crmUiAccordion.help) {
  25               scope.help = crmUiAccordion.help.clone({}, {
  26                 title: crmUiAccordion.title
  27               });
  28             }
  29           });
  30         }
  31       };
  32     })
  33
  34     // Examples:
  35     //   crmUiAlert({text: 'My text', title: 'My title', type: 'error'});
  36     //   crmUiAlert({template: '<a ng-click="ok()">Hello</a>', scope: $scope.$new()});
  37     //   var h = crmUiAlert({templateUrl: '~/crmFoo/alert.html', scope: $scope.$new()});
  38     //   ... h.close(); ...
  39     .service('crmUiAlert', function($compile, $rootScope, $templateRequest, $q) {
  40       var count = 0;
  41       return function crmUiAlert(params) {
  42         var id = 'crmUiAlert_' + (++count);
  43         var tpl = null;
  44         if (params.templateUrl) {
  45           tpl = $templateRequest(params.templateUrl);
  46         }
  47         else if (params.template) {
  48           tpl = params.template;
  49         }
  50         if (tpl) {
  51           params.text = '<div id="' + id + '"></div>'; // temporary stub
  52         }
  53         var result = CRM.alert(params.text, params.title, params.type, params.options);
  54         if (tpl) {
  55           $q.when(tpl, function(html) {
  56             var scope = params.scope || $rootScope.$new();
  57             var linker = $compile(html);
  58             $('#' + id).append($(linker(scope)));
  59           });
  60         }
  61         return result;
  62       };
  63     })
  64
  65     // Simple wrapper around $.crmDatepicker.
  66     // example with no time input: <input crm-ui-datepicker="{time: false}" ng-model="myobj.datefield"/>
  67     // example with custom date format: <input crm-ui-datepicker="{dateFormat: 'm/d/y'}" ng-model="myobj.datefield"/>
  68     .directive('crmUiDatepicker', function () {
  69       return {
  70         restrict: 'AE',
  71         require: 'ngModel',
  72         scope: {
  73           crmUiDatepicker: '='
  74         },
  75         link: function (scope, element, attrs, ngModel) {
  76           ngModel.$render = function () {
  77             element.val(ngModel.$viewValue).change();
  78           };
  79
  80           element
  81             .crmDatepicker(scope.crmUiDatepicker)
  82             .on('change', function() {
  83               var requiredLength = 19;
  84               if (scope.crmUiDatepicker && scope.crmUiDatepicker.time === false) {
  85                 requiredLength = 10;
  86               }
  87               if (scope.crmUiDatepicker && scope.crmUiDatepicker.date === false) {
  88                 requiredLength = 8;
  89               }
  90               ngModel.$setValidity('incompleteDateTime', !($(this).val().length && $(this).val().length !== requiredLength));
  91             });
  92         }
  93       };
  94     })
  95
  96     // Display debug information (if available)
  97     // For richer DX, checkout Batarang/ng-inspector (Chrome/Safari), or AngScope/ng-inspect (Firefox).
  98     // example: <div crm-ui-debug="myobject" />
  99     .directive('crmUiDebug', function ($location) {
 100       return {
 101         restrict: 'AE',
 102         scope: {
 103           crmUiDebug: '@'
 104         },
 105         template: function() {
 106           var args = $location.search();
 107           return (args && args.angularDebug) ? '<div crm-ui-accordion=\'{title: ts("Debug (%1)", {1: crmUiDebug}), collapsed: true}\'><pre>{{data|json}}</pre></div>' : '';
 108         },
 109         link: function(scope, element, attrs) {
 110           var args = $location.search();
 111           if (args && args.angularDebug) {
 112             scope.ts = CRM.ts(null);
 113             scope.$parent.$watch(attrs.crmUiDebug, function(data) {
 114               scope.data = data;
 115             });
 116           }
 117         }
 118       };
 119     })
 120
 121     // Display a field/row in a field list
 122     // example: <div crm-ui-field="{title: ts('My Field')}"> {{mydata}} </div>
 123     // example: <div crm-ui-field="{name: 'subform.myfield', title: ts('My Field')}"> <input crm-ui-id="subform.myfield" name="myfield" /> </div>
 124     // example: <div crm-ui-field="{name: 'subform.myfield', title: ts('My Field')}"> <input crm-ui-id="subform.myfield" name="myfield" required /> </div>
 125     // example: <div crm-ui-field="{name: 'subform.myfield', title: ts('My Field'), help: hs('help_field_name')}"> {{mydata}} </div>
 126     .directive('crmUiField', function() {
 127       // Note: When writing new templates, the "label" position is particular. See/patch "var label" below.
 128       var templateUrls = {
 129         default: '~/crmUi/field.html',
 130         checkbox: '~/crmUi/field-cb.html'
 131       };
 132
 133       return {
 134         require: '^crmUiIdScope',
 135         restrict: 'EA',
 136         scope: {
 137           // {title, name, help, helpFile}
 138           crmUiField: '='
 139         },
 140         templateUrl: function(tElement, tAttrs){
 141           var layout = tAttrs.crmLayout ? tAttrs.crmLayout : 'default';
 142           return templateUrls[layout];
 143         },
 144         transclude: true,
 145         link: function (scope, element, attrs, crmUiIdCtrl) {
 146           $(element).addClass('crm-section');
 147           scope.help = null;
 148           scope.$watch('crmUiField', function(crmUiField) {
 149             if (crmUiField && crmUiField.help) {
 150               scope.help = crmUiField.help.clone({}, {
 151                 title: crmUiField.title
 152               });
 153             }
 154           });
 155         }
 156       };
 157     })
 158
 159     // example: <div ng-form="subform" crm-ui-id-scope><label crm-ui-for="subform.foo">Foo:</label><input crm-ui-id="subform.foo" name="foo"/></div>
 160     .directive('crmUiId', function () {
 161       return {
 162         require: '^crmUiIdScope',
 163         restrict: 'EA',
 164         link: {
 165           pre: function (scope, element, attrs, crmUiIdCtrl) {
 166             var id = crmUiIdCtrl.get(attrs.crmUiId);
 167             element.attr('id', id);
 168           }
 169         }
 170       };
 171     })
 172
 173     // for example, see crmUiHelp
 174     .service('crmUiHelp', function(){
 175       // example: var h = new FieldHelp({id: 'foo'}); h.open();
 176       function FieldHelp(options) {
 177         this.options = options;
 178       }
 179       angular.extend(FieldHelp.prototype, {
 180         get: function(n) {
 181           return this.options[n];
 182         },
 183         open: function open() {
 184           CRM.help(this.options.title, {id: this.options.id, file: this.options.file});
 185         },
 186         clone: function clone(options, defaults) {
 187           return new FieldHelp(angular.extend({}, defaults, this.options, options));
 188         }
 189       });
 190
 191       // example: var hs = crmUiHelp({file: 'CRM/Foo/Bar'});
 192       return function(defaults){
 193         // example: hs('myfield')
 194         // example: hs({id: 'myfield', title: 'Foo Bar', file: 'Whiz/Bang'})
 195         return function(options) {
 196           if (_.isString(options)) {
 197             options = {id: options};
 198           }
 199           return new FieldHelp(angular.extend({}, defaults, options));
 200         };
 201       };
 202     })
 203
 204     // Display a help icon
 205     // Example: Use a default *.hlp file
 206     //   scope.hs = crmUiHelp({file: 'Path/To/Help/File'});
 207     //   HTML: <a crm-ui-help="hs({title:ts('My Field'), id:'my_field'})">
 208     // Example: Use an explicit *.hlp file
 209     //   HTML: <a crm-ui-help="hs({title:ts('My Field'), id:'my_field', file:'CRM/Foo/Bar'})">
 210     .directive('crmUiHelp', function() {
 211       return {
 212         restrict: 'EA',
 213         link: function(scope, element, attrs) {
 214           setTimeout(function() {
 215             var crmUiHelp = scope.$eval(attrs.crmUiHelp);
 216             var title = crmUiHelp && crmUiHelp.get('title') ? ts('%1 Help', {1: crmUiHelp.get('title')}) : ts('Help');
 217             element.attr('title', title);
 218           }, 50);
 219
 220           element
 221             .addClass('helpicon')
 222             .attr('href', '#')
 223             .on('click', function(e) {
 224               e.preventDefault();
 225               scope.$eval(attrs.crmUiHelp).open();
 226             });
 227         }
 228       };
 229     })
 230
 231     // example: <div ng-form="subform" crm-ui-id-scope><label crm-ui-for="subform.foo">Foo:</label><input crm-ui-id="subform.foo" name="foo"/></div>
 232     .directive('crmUiFor', function ($parse, $timeout) {
 233       return {
 234         require: '^crmUiIdScope',
 235         restrict: 'EA',
 236         template: '<span ng-class="cssClasses"><span ng-transclude/><span crm-ui-visible="crmIsRequired" class="crm-marker" title="This field is required.">*</span></span>',
 237         transclude: true,
 238         link: function (scope, element, attrs, crmUiIdCtrl) {
 239           scope.crmIsRequired = false;
 240           scope.cssClasses = {};
 241
 242           if (!attrs.crmUiFor) return;
 243
 244           var id = crmUiIdCtrl.get(attrs.crmUiFor);
 245           element.attr('for', id);
 246           var ngModel = null;
 247
 248           var updateCss = function () {
 249             scope.cssClasses['crm-error'] = !ngModel.$valid && !ngModel.$pristine;
 250           };
 251
 252           // Note: if target element is dynamically generated (eg via ngInclude), then it may not be available
 253           // immediately for initialization. Use retries/retryDelay to initialize such elements.
 254           var init = function (retries, retryDelay) {
 255             var input = $('#' + id);
 256             if (input.length === 0) {
 257               if (retries) {
 258                 $timeout(function(){
 259                   init(retries-1, retryDelay);
 260                 }, retryDelay);
 261               }
 262               return;
 263             }
 264
 265             var tgtScope = scope;//.$parent;
 266             if (attrs.crmDepth) {
 267               for (var i = attrs.crmDepth; i > 0; i--) {
 268                 tgtScope = tgtScope.$parent;
 269               }
 270             }
 271
 272             if (input.attr('ng-required')) {
 273               scope.crmIsRequired = scope.$parent.$eval(input.attr('ng-required'));
 274               scope.$parent.$watch(input.attr('ng-required'), function (isRequired) {
 275                 scope.crmIsRequired = isRequired;
 276               });
 277             }
 278             else {
 279               scope.crmIsRequired = input.prop('required');
 280             }
 281
 282             ngModel = $parse(attrs.crmUiFor)(tgtScope);
 283             if (ngModel) {
 284               ngModel.$viewChangeListeners.push(updateCss);
 285             }
 286           };
 287
 288           $timeout(function(){
 289             init(3, 100);
 290           });
 291         }
 292       };
 293     })
 294
 295     // Define a scope in which a name like "subform.foo" maps to a unique ID.
 296     // example: <div ng-form="subform" crm-ui-id-scope><label crm-ui-for="subform.foo">Foo:</label><input crm-ui-id="subform.foo" name="foo"/></div>
 297     .directive('crmUiIdScope', function () {
 298       return {
 299         restrict: 'EA',
 300         scope: {},
 301         controllerAs: 'crmUiIdCtrl',
 302         controller: function($scope) {
 303           var ids = {};
 304           this.get = function(name) {
 305             if (!ids[name]) {
 306               ids[name] = "crmUiId_" + (++uidCount);
 307             }
 308             return ids[name];
 309           };
 310         },
 311         link: function (scope, element, attrs) {}
 312       };
 313     })
 314
 315     // Display an HTML blurb inside an IFRAME.
 316     // example: <iframe crm-ui-iframe="getHtmlContent()"></iframe>
 317     .directive('crmUiIframe', function ($parse) {
 318       return {
 319         scope: {
 320           crmUiIframe: '@' // expression which evalutes to HTML content
 321         },
 322         link: function (scope, elm, attrs) {
 323           var iframe = $(elm)[0];
 324           iframe.setAttribute('width', '100%');
 325           iframe.setAttribute('frameborder', '0');
 326
 327           var refresh = function () {
 328             // var iframeHtml = '<html><head><base target="_blank"></head><body onload="parent.document.getElementById(\'' + iframe.id + '\').style.height=document.body.scrollHeight + \'px\'"><scr' + 'ipt type="text/javascript" src="https://gist.github.com/' + iframeId + '.js"></sc' + 'ript></body></html>';
 329             var iframeHtml = scope.$parent.$eval(attrs.crmUiIframe);
 330
 331             var doc = iframe.document;
 332             if (iframe.contentDocument) {
 333               doc = iframe.contentDocument;
 334             }
 335             else if (iframe.contentWindow) {
 336               doc = iframe.contentWindow.document;
 337             }
 338
 339             doc.open();
 340             doc.writeln(iframeHtml);
 341             doc.close();
 342           };
 343
 344           // If the iframe is in a dialog, respond to resize events
 345           $(elm).parent().on('dialogresize dialogopen', function(e, ui) {
 346             $(this).css({padding: '0', margin: '0', overflow: 'hidden'});
 347             iframe.setAttribute('height', '' + $(this).innerHeight() + 'px');
 348           });
 349
 350           scope.$parent.$watch(attrs.crmUiIframe, refresh);
 351         }
 352       };
 353     })
 354
 355     // Example:
 356     //   <a ng-click="$broadcast('my-insert-target', 'some new text')>Insert</a>
 357     //   <textarea crm-ui-insert-rx='my-insert-target'></textarea>
 358     .directive('crmUiInsertRx', function() {
 359       return {
 360         link: function(scope, element, attrs) {
 361           scope.$on(attrs.crmUiInsertRx, function(e, tokenName) {
 362             CRM.wysiwyg.insert(element, tokenName);
 363             $(element).select2('close').select2('val', '');
 364             CRM.wysiwyg.focus(element);
 365           });
 366         }
 367       };
 368     })
 369
 370     // Define a rich text editor.
 371     // example: <textarea crm-ui-id="myForm.body_html" crm-ui-richtext name="body_html" ng-model="mailing.body_html"></textarea>
 372     .directive('crmUiRichtext', function ($timeout) {
 373       return {
 374         require: '?ngModel',
 375         link: function (scope, elm, attr, ngModel) {
 376
 377           var editor = CRM.wysiwyg.create(elm);
 378           if (!ngModel) {
 379             return;
 380           }
 381
 382           if (attr.ngBlur) {
 383             $(elm).on('blur', function() {
 384               $timeout(function() {
 385                 scope.$eval(attr.ngBlur);
 386               });
 387             });
 388           }
 389
 390           // CRM-16445 - When one inserts an image, none of these events seem to fire at the right time:
 391           // afterCommandExec, afterInsertHtml, afterPaste, afterSetData, change, insertElement,
 392           // insertHtml, insertText, pasteState. It seems that 'pasteState' is the general equivalent of
 393           // what 'change' should be, except (in the case of image insertion) it fires too soon.
 394           // The 'key' event is needed to detect changes in "Source" mode.
 395           var debounce = null;
 396           angular.forEach(['key', 'pasteState'], function(evName){
 397             ck.on(evName, function(evt) {
 398               $timeout.cancel(debounce);
 399               debounce = $timeout(function() {
 400                 ngModel.$setViewValue(ck.getData());
 401               }, 50);
 402             });
 403           });
 404
 405           ngModel.$render = function(value) {
 406             CRM.wysiwyg.setVal(elm, ngModel.$viewValue);
 407           };
 408         }
 409       };
 410     })
 411
 412     // Display a lock icon (based on a boolean).
 413     // example: <a crm-ui-lock binding="mymodel.boolfield"></a>
 414     // example: <a crm-ui-lock
 415     //            binding="mymodel.boolfield"
 416     //            title-locked="ts('Boolfield is locked')"
 417     //            title-unlocked="ts('Boolfield is unlocked')"></a>
 418     .directive('crmUiLock', function ($parse, $rootScope) {
 419       var defaultVal = function (defaultValue) {
 420         var f = function (scope) {
 421           return defaultValue;
 422         };
 423         f.assign = function (scope, value) {
 424           // ignore changes
 425         };
 426         return f;
 427       };
 428
 429       // like $parse, but accepts a defaultValue in case expr is undefined
 430       var parse = function (expr, defaultValue) {
 431         return expr ? $parse(expr) : defaultVal(defaultValue);
 432       };
 433
 434       return {
 435         template: '',
 436         link: function (scope, element, attrs) {
 437           var binding = parse(attrs.binding, true);
 438           var titleLocked = parse(attrs.titleLocked, ts('Locked'));
 439           var titleUnlocked = parse(attrs.titleUnlocked, ts('Unlocked'));
 440
 441           $(element).addClass('ui-icon lock-button');
 442           var refresh = function () {
 443             var locked = binding(scope);
 444             if (locked) {
 445               $(element)
 446                 .removeClass('ui-icon-unlocked')
 447                 .addClass('ui-icon-locked')
 448                 .prop('title', titleLocked(scope))
 449               ;
 450             }
 451             else {
 452               $(element)
 453                 .removeClass('ui-icon-locked')
 454                 .addClass('ui-icon-unlocked')
 455                 .prop('title', titleUnlocked(scope))
 456               ;
 457             }
 458           };
 459
 460           $(element).click(function () {
 461             binding.assign(scope, !binding(scope));
 462             //scope.$digest();
 463             $rootScope.$digest();
 464           });
 465
 466           scope.$watch(attrs.binding, refresh);
 467           scope.$watch(attrs.titleLocked, refresh);
 468           scope.$watch(attrs.titleUnlocked, refresh);
 469
 470           refresh();
 471         }
 472       };
 473     })
 474
 475     // CrmUiOrderCtrl is a controller class which manages sort orderings.
 476     // Ex:
 477     //   JS:   $scope.myOrder = new CrmUiOrderCtrl(['+field1', '-field2]);
 478     //         $scope.myOrder.toggle('field1');
 479     //         $scope.myOrder.setDir('field2', '');
 480     //   HTML: <tr ng-repeat="... | order:myOrder.get()">...</tr>
 481     .service('CrmUiOrderCtrl', function(){
 482       //
 483       function CrmUiOrderCtrl(defaults){
 484         this.values = defaults;
 485       }
 486       angular.extend(CrmUiOrderCtrl.prototype, {
 487         get: function get() {
 488           return this.values;
 489         },
 490         getDir: function getDir(name) {
 491           if (this.values.indexOf(name) >= 0 || this.values.indexOf('+' + name) >= 0) {
 492             return '+';
 493           }
 494           if (this.values.indexOf('-' + name) >= 0) {
 495             return '-';
 496           }
 497           return '';
 498         },
 499         // @return bool TRUE if something is removed
 500         remove: function remove(name) {
 501           var idx = this.values.indexOf(name);
 502           if (idx >= 0) {
 503             this.values.splice(idx, 1);
 504             return true;
 505           }
 506           else {
 507             return false;
 508           }
 509         },
 510         setDir: function setDir(name, dir) {
 511           return this.toggle(name, dir);
 512         },
 513         // Toggle sort order on a field.
 514         // To set a specific order, pass optional parameter 'next' ('+', '-', or '').
 515         toggle: function toggle(name, next) {
 516           if (!next && next !== '') {
 517             next = '+';
 518             if (this.remove(name) || this.remove('+' + name)) {
 519               next = '-';
 520             }
 521             if (this.remove('-' + name)) {
 522               next = '';
 523             }
 524           }
 525
 526           if (next == '+') {
 527             this.values.unshift('+' + name);
 528           }
 529           else if (next == '-') {
 530             this.values.unshift('-' + name);
 531           }
 532         }
 533       });
 534       return CrmUiOrderCtrl;
 535     })
 536
 537     // Define a controller which manages sort order. You may interact with the controller
 538     // directly ("myOrder.toggle('fieldname')") order using the helper, crm-ui-order-by.
 539     // example:
 540     //   <span crm-ui-order="{var: 'myOrder', defaults: {'-myField'}}"></span>
 541     //   <th><a crm-ui-order-by="[myOrder,'myField']">My Field</a></th>
 542     //   <tr ng-repeat="... | order:myOrder.get()">...</tr>
 543     //   <button ng-click="myOrder.toggle('myField')">
 544     .directive('crmUiOrder', function(CrmUiOrderCtrl) {
 545       return {
 546         link: function(scope, element, attrs){
 547           var options = angular.extend({var: 'crmUiOrderBy'}, scope.$eval(attrs.crmUiOrder));
 548           scope[options.var] = new CrmUiOrderCtrl(options.defaults);
 549         }
 550       };
 551     })
 552
 553     // For usage, see crmUiOrder (above)
 554     .directive('crmUiOrderBy', function() {
 555       return {
 556         link: function(scope, element, attrs) {
 557           function updateClass(crmUiOrderCtrl, name) {
 558             var dir = crmUiOrderCtrl.getDir(name);
 559             element
 560               .toggleClass('sorting_asc', dir === '+')
 561               .toggleClass('sorting_desc', dir === '-')
 562               .toggleClass('sorting', dir === '');
 563           }
 564
 565           element.on('click', function(e){
 566             var tgt = scope.$eval(attrs.crmUiOrderBy);
 567             tgt[0].toggle(tgt[1]);
 568             updateClass(tgt[0], tgt[1]);
 569             e.preventDefault();
 570             scope.$digest();
 571           });
 572
 573           var tgt = scope.$eval(attrs.crmUiOrderBy);
 574           updateClass(tgt[0], tgt[1]);
 575         }
 576       };
 577     })
 578
 579     // Display a fancy SELECT (based on select2).
 580     // usage: <select crm-ui-select="{placeholder:'Something',allowClear:true,...}" ng-model="myobj.field"><option...></select>
 581     .directive('crmUiSelect', function ($parse, $timeout) {
 582       return {
 583         require: '?ngModel',
 584         scope: {
 585           crmUiSelect: '='
 586         },
 587         link: function (scope, element, attrs, ngModel) {
 588           // In cases where UI initiates update, there may be an extra
 589           // call to refreshUI, but it doesn't create a cycle.
 590
 591           if (ngModel) {
 592             ngModel.$render = function () {
 593               $timeout(function () {
 594                 // ex: msg_template_id adds new item then selects it; use $timeout to ensure that
 595                 // new item is added before selection is made
 596                 element.select2('val', ngModel.$viewValue);
 597               });
 598             };
 599           }
 600           function refreshModel() {
 601             var oldValue = ngModel.$viewValue, newValue = element.select2('val');
 602             if (oldValue != newValue) {
 603               scope.$parent.$apply(function () {
 604                 ngModel.$setViewValue(newValue);
 605               });
 606             }
 607           }
 608
 609           function init() {
 610             // TODO watch select2-options
 611             element.select2(scope.crmUiSelect || {});
 612             if (ngModel) {
 613               element.on('change', refreshModel);
 614               $timeout(ngModel.$render);
 615             }
 616           }
 617
 618           init();
 619         }
 620       };
 621     })
 622
 623     // Render a crmEntityRef widget
 624     // usage: <input crm-entityref="{entity: 'Contact', select: {allowClear:true}}" ng-model="myobj.field" />
 625     .directive('crmEntityref', function ($parse, $timeout) {
 626       return {
 627         require: '?ngModel',
 628         scope: {
 629           crmEntityref: '='
 630         },
 631         link: function (scope, element, attrs, ngModel) {
 632           // In cases where UI initiates update, there may be an extra
 633           // call to refreshUI, but it doesn't create a cycle.
 634
 635           ngModel.$render = function () {
 636             $timeout(function () {
 637               // ex: msg_template_id adds new item then selects it; use $timeout to ensure that
 638               // new item is added before selection is made
 639               element.select2('val', ngModel.$viewValue);
 640             });
 641           };
 642           function refreshModel() {
 643             var oldValue = ngModel.$viewValue, newValue = element.select2('val');
 644             if (oldValue != newValue) {
 645               scope.$parent.$apply(function () {
 646                 ngModel.$setViewValue(newValue);
 647               });
 648             }
 649           }
 650
 651           function init() {
 652             // TODO can we infer "entity" from model?
 653             element.crmEntityRef(scope.crmEntityref || {});
 654             element.on('change', refreshModel);
 655             $timeout(ngModel.$render);
 656           }
 657
 658           init();
 659         }
 660       };
 661     })
 662
 663     // example <div crm-ui-tab crm-title="ts('My Title')">...content...</div>
 664     // WISHLIST: use a full Angular component instead of an incomplete jQuery wrapper
 665     .directive('crmUiTab', function($parse) {
 666       return {
 667         require: '^crmUiTabSet',
 668         restrict: 'EA',
 669         scope: {
 670           crmTitle: '@',
 671           id: '@'
 672         },
 673         template: '<div ng-transclude></div>',
 674         transclude: true,
 675         link: function (scope, element, attrs, crmUiTabSetCtrl) {
 676           crmUiTabSetCtrl.add(scope);
 677         }
 678       };
 679     })
 680
 681     // example: <div crm-ui-tab-set><div crm-ui-tab crm-title="Tab 1">...</div><div crm-ui-tab crm-title="Tab 2">...</div></div>
 682     .directive('crmUiTabSet', function() {
 683       return {
 684         restrict: 'EA',
 685         scope: {
 686           crmUiTabSet: '@'
 687         },
 688         templateUrl: '~/crmUi/tabset.html',
 689         transclude: true,
 690         controllerAs: 'crmUiTabSetCtrl',
 691         controller: function($scope, $parse) {
 692           var tabs = $scope.tabs = []; // array<$scope>
 693           this.add = function(tab) {
 694             if (!tab.id) throw "Tab is missing 'id'";
 695             tabs.push(tab);
 696           };
 697         },
 698         link: function (scope, element, attrs) {}
 699       };
 700     })
 701
 702     // Generic, field-independent form validator.
 703     // example: <span ng-model="placeholder" crm-ui-validate="foo && bar || whiz" />
 704     // example: <span ng-model="placeholder" crm-ui-validate="foo && bar || whiz" crm-ui-validate-name="myError" />
 705     .directive('crmUiValidate', function() {
 706       return {
 707         restrict: 'EA',
 708         require: 'ngModel',
 709         link: function(scope, element, attrs, ngModel) {
 710           var validationKey = attrs.crmUiValidateName ? attrs.crmUiValidateName : 'crmUiValidate';
 711           scope.$watch(attrs.crmUiValidate, function(newValue){
 712             ngModel.$setValidity(validationKey, !!newValue);
 713           });
 714         }
 715       };
 716     })
 717
 718     // like ng-show, but hides/displays elements using "visibility" which maintains positioning
 719     // example <div crm-ui-visible="false">...content...</div>
 720     .directive('crmUiVisible', function($parse) {
 721       return {
 722         restrict: 'EA',
 723         scope: {
 724           crmUiVisible: '@'
 725         },
 726         link: function (scope, element, attrs) {
 727           var model = $parse(attrs.crmUiVisible);
 728           function updatecChildren() {
 729             element.css('visibility', model(scope.$parent) ? 'inherit' : 'hidden');
 730           }
 731           updatecChildren();
 732           scope.$parent.$watch(attrs.crmUiVisible, updatecChildren);
 733         }
 734       };
 735     })
 736
 737     // example: <div crm-ui-wizard="myWizardCtrl"><div crm-ui-wizard-step crm-title="ts('Step 1')">...</div><div crm-ui-wizard-step crm-title="ts('Step 2')">...</div></div>
 738     // Note: "myWizardCtrl" has various actions/properties like next() and $first().
 739     // WISHLIST: Allow each step to determine if it is "complete" / "valid" / "selectable"
 740     // WISHLIST: Allow each step to enable/disable (show/hide) itself
 741     .directive('crmUiWizard', function() {
 742       return {
 743         restrict: 'EA',
 744         scope: {
 745           crmUiWizard: '@'
 746         },
 747         templateUrl: '~/crmUi/wizard.html',
 748         transclude: true,
 749         controllerAs: 'crmUiWizardCtrl',
 750         controller: function($scope, $parse) {
 751           var steps = $scope.steps = []; // array<$scope>
 752           var crmUiWizardCtrl = this;
 753           var maxVisited = 0;
 754           var selectedIndex = null;
 755
 756           var findIndex = function() {
 757             var found = null;
 758             angular.forEach(steps, function(step, stepKey) {
 759               if (step.selected) found = stepKey;
 760             });
 761             return found;
 762           };
 763
 764           /// @return int the index of the current step
 765           this.$index = function() { return selectedIndex; };
 766           /// @return bool whether the currentstep is first
 767           this.$first = function() { return this.$index() === 0; };
 768           /// @return bool whether the current step is last
 769           this.$last = function() { return this.$index() === steps.length -1; };
 770           this.$maxVisit = function() { return maxVisited; };
 771           this.$validStep = function() {
 772             return steps[selectedIndex] && steps[selectedIndex].isStepValid();
 773           };
 774           this.iconFor = function(index) {
 775             if (index < this.$index()) return '√';
 776             if (index === this.$index()) return '»';
 777             return ' ';
 778           };
 779           this.isSelectable = function(step) {
 780             if (step.selected) return false;
 781             var result = false;
 782             angular.forEach(steps, function(otherStep, otherKey) {
 783               if (step === otherStep && otherKey <= maxVisited) result = true;
 784             });
 785             return result;
 786           };
 787
 788           /*** @param Object step the $scope of the step */
 789           this.select = function(step) {
 790             angular.forEach(steps, function(otherStep, otherKey) {
 791               otherStep.selected = (otherStep === step);
 792               if (otherStep === step && maxVisited < otherKey) maxVisited = otherKey;
 793             });
 794             selectedIndex = findIndex();
 795           };
 796           /*** @param Object step the $scope of the step */
 797           this.add = function(step) {
 798             if (steps.length === 0) {
 799               step.selected = true;
 800               selectedIndex = 0;
 801             }
 802             steps.push(step);
 803             steps.sort(function(a,b){
 804               return a.crmUiWizardStep - b.crmUiWizardStep;
 805             });
 806             selectedIndex = findIndex();
 807           };
 808           this.remove = function(step) {
 809             var key = null;
 810             angular.forEach(steps, function(otherStep, otherKey) {
 811               if (otherStep === step) key = otherKey;
 812             });
 813             if (key !== null) {
 814               steps.splice(key, 1);
 815             }
 816           };
 817           this.goto = function(index) {
 818             if (index < 0) index = 0;
 819             if (index >= steps.length) index = steps.length-1;
 820             this.select(steps[index]);
 821           };
 822           this.previous = function() { this.goto(this.$index()-1); };
 823           this.next = function() { this.goto(this.$index()+1); };
 824           if ($scope.crmUiWizard) {
 825             $parse($scope.crmUiWizard).assign($scope.$parent, this);
 826           }
 827         },
 828         link: function (scope, element, attrs) {
 829           scope.ts = CRM.ts(null);
 830         }
 831       };
 832     })
 833
 834     // Use this to add extra markup to wizard
 835     .directive('crmUiWizardButtons', function() {
 836       return {
 837         require: '^crmUiWizard',
 838         restrict: 'EA',
 839         scope: {},
 840         template: '<span ng-transclude></span>',
 841         transclude: true,
 842         link: function (scope, element, attrs, crmUiWizardCtrl) {
 843           var realButtonsEl = $(element).closest('.crm-wizard').find('.crm-wizard-buttons');
 844           $(element).appendTo(realButtonsEl);
 845         }
 846       };
 847     })
 848
 849     // Example: <button crm-icon="check">Save</button>
 850     .directive('crmIcon', function() {
 851       return {
 852         restrict: 'EA',
 853         scope: {},
 854         link: function (scope, element, attrs) {
 855           $(element).prepend('<span class="icon ui-icon-' + attrs.crmIcon + '"></span> ');
 856           if ($(element).is('button')) {
 857             $(element).addClass('crm-button');
 858           }
 859         }
 860       };
 861     })
 862
 863     // example: <div crm-ui-wizard-step crm-title="ts('My Title')" ng-form="mySubForm">...content...</div>
 864     // If there are any conditional steps, then be sure to set a weight explicitly on *all* steps to maintain ordering.
 865     // example: <div crm-ui-wizard-step="100" crm-title="..." ng-if="...">...content...</div>
 866     .directive('crmUiWizardStep', function() {
 867       var nextWeight = 1;
 868       return {
 869         require: ['^crmUiWizard', 'form'],
 870         restrict: 'EA',
 871         scope: {
 872           crmTitle: '@', // expression, evaluates to a printable string
 873           crmUiWizardStep: '@' // int, a weight which determines the ordering of the steps
 874         },
 875         template: '<div class="crm-wizard-step" ng-show="selected" ng-transclude/></div>',
 876         transclude: true,
 877         link: function (scope, element, attrs, ctrls) {
 878           var crmUiWizardCtrl = ctrls[0], form = ctrls[1];
 879           if (scope.crmUiWizardStep) {
 880             scope.crmUiWizardStep = parseInt(scope.crmUiWizardStep);
 881           } else {
 882             scope.crmUiWizardStep = nextWeight++;
 883           }
 884           scope.isStepValid = function() {
 885             return form.$valid;
 886           };
 887           crmUiWizardCtrl.add(scope);
 888           element.on('$destroy', function(){
 889             crmUiWizardCtrl.remove(scope);
 890           });
 891         }
 892       };
 893     })
 894
 895     // Example: <button crm-confirm="{message: ts('Are you sure you want to continue?')}" on-yes="frobnicate(123)">Frobincate</button>
 896     // Example: <button crm-confirm="{type: 'disable', obj: myObject}" on-yes="myObject.is_active=0; myObject.save()">Disable</button>
 897     // Example: <button crm-confirm="{templateUrl: '~/path/to/view.html', export: {foo: bar}}" on-yes="frobnicate(123)">Frobincate</button>
 898     .directive('crmConfirm', function ($compile, $rootScope, $templateRequest, $q) {
 899       // Helpers to calculate default options for CRM.confirm()
 900       var defaultFuncs = {
 901         'disable': function (options) {
 902           return {
 903             message: ts('Are you sure you want to disable this?'),
 904             options: {no: ts('Cancel'), yes: ts('Disable')},
 905             width: 300,
 906             title: ts('Disable %1?', {
 907               1: options.obj.title || options.obj.label || options.obj.name || ts('the record')
 908             })
 909           };
 910         },
 911         'revert': function (options) {
 912           return {
 913             message: ts('Are you sure you want to revert this?'),
 914             options: {no: ts('Cancel'), yes: ts('Revert')},
 915             width: 300,
 916             title: ts('Revert %1?', {
 917               1: options.obj.title || options.obj.label || options.obj.name || ts('the record')
 918             })
 919           };
 920         },
 921         'delete': function (options) {
 922           return {
 923             message: ts('Are you sure you want to delete this?'),
 924             options: {no: ts('Cancel'), yes: ts('Delete')},
 925             width: 300,
 926             title: ts('Delete %1?', {
 927               1: options.obj.title || options.obj.label || options.obj.name || ts('the record')
 928             })
 929           };
 930         }
 931       };
 932       var confirmCount = 0;
 933       return {
 934         link: function (scope, element, attrs) {
 935           $(element).click(function () {
 936             var options = scope.$eval(attrs.crmConfirm);
 937             if (attrs.title && !options.title) {
 938               options.title = attrs.title;
 939             }
 940             var defaults = (options.type) ? defaultFuncs[options.type](options) : {};
 941
 942             var tpl = null, stubId = null;
 943             if (!options.message) {
 944               if (options.templateUrl) {
 945                 tpl = $templateRequest(options.templateUrl);
 946               }
 947               else if (options.template) {
 948                 tpl = options.template;
 949               }
 950               if (tpl) {
 951                 stubId = 'crmUiConfirm_' + (++confirmCount);
 952                 options.message = '<div id="' + stubId + '"></div>';
 953               }
 954             }
 955
 956             CRM.confirm(_.extend(defaults, options))
 957               .on('crmConfirm:yes', function() { scope.$apply(attrs.onYes); })
 958               .on('crmConfirm:no', function() { scope.$apply(attrs.onNo); });
 959
 960             if (tpl && stubId) {
 961               $q.when(tpl, function(html) {
 962                 var scope = options.scope || $rootScope.$new();
 963                 if (options.export) {
 964                   angular.extend(scope, options.export);
 965                 }
 966                 var linker = $compile(html);
 967                 $('#' + stubId).append($(linker(scope)));
 968               });
 969             }
 970           });
 971         }
 972       };
 973     })
 974     .run(function($rootScope, $location) {
 975       /// Example: <button ng-click="goto('home')">Go home!</button>
 976       $rootScope.goto = function(path) {
 977         $location.path(path);
 978       };
 979       // useful for debugging: $rootScope.log = console.log || function() {};
 980     })
 981   ;
 982
 983 })(angular, CRM.$, CRM._);