Source: lists/views/layouts/Column.js

/**
 * Copyright (C) 2005-2016 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Use this widget to render a column. Every widget rendered within it will be "stacked" vertically.
 * 
 * @module alfresco/lists/views/layouts/Column
 * @extends module:aikau/core/BaseWidget
 * @mixes module:alfresco/lists/views/layouts/_LayoutMixin
 * @author Dave Draper
 */
define(["dojo/_base/declare",
        "aikau/core/BaseWidget",
        "alfresco/lists/views/layouts/_LayoutMixin",
        "dojo/_base/lang",
        "dojo/dom-construct"], 
        function(declare, BaseWidget, _LayoutMixin, lang, domConstruct) {

   return declare([BaseWidget, _LayoutMixin], {
      
      /**
       * An array of the CSS files to use with this widget.
       * 
       * @instance
       * @type {object[]}
       * @default [{cssFile:"./css/Column.css"}]
       */
      cssRequirements: [{cssFile:"./css/Column.css"}],
      
      /**
       * Overrides [the inherited function]{@link module:aikau/core/BaseWidget#createWidgetDom}
       * to construct the DOM for the widget using native browser capabilities.
       *
       * @instance
       * @since 1.0.101
       */
      createWidgetDom: function alfresco_lists_views_layouts_CellContainer__createWidgetDom() {
         this.containerNode = this.domNode = document.createElement("table");
         this.domNode.classList.add("alfresco-lists-views-layouts-Column");
         this.domNode.setAttribute("cellspacing", "0");
         this.domNode.setAttribute("cellpadding", "0");
      },

      /**
       * Calls [processWidgets]{@link module:alfresco/core/Core#processWidgets}
       * 
       * @instance postCreate
       */
      postCreate: function alfresco_lists_views_layouts_Column__postCreate() {
         if (this.widgets)
         {
            this.processWidgets(this.widgets, this.containerNode);
         }
      },
      
      /**
       * Overrides the superclass implementation to add an additional TR element to get the column effect.
       * 
       * @instance
       * @param {Object} widget The widget definition to create the DOM node for
       * @param {element} rootNode The DOM node to create the new DOM node as a child of
       * @param {String} rootClassName A string containing one or more space separated CSS classes to set on the DOM node
       * @returns {element} A new DOM node for a processed widget to attach to
       */
      createWidgetDomNode: function alfresco_renderers_Column__createWidgetDomNode(widget, rootNode, /*jshint unused:false*/ rootClassName) {
         var nodeToAdd = domConstruct.create("TR", {}, rootNode);
         return domConstruct.create("TD", {}, nodeToAdd);
      }
   });
});