API Docs for: 3.8.0
Show:

File: node/js/shim-plugin.js

  1.     /**
  2.      * Provides shimming support for Node via a Plugin.
  3.      * This fixes SELECT bleedthrough for IE6 & Mac scrollbars
  4.      * @module shim-plugin
  5.      */

  7.     /**
  8.      * Node plugin which can be used to add shim support.
  9.      *
  10.      * @class Plugin.Shim
  11.      * @param {Object} User configuration object
  12.      */
  13.     function Shim(config) {
  14.         this.init(config);
  15.     }

  17.     /**
  18.      * Default class used to mark the shim element
  19.      *
  20.      * @property CLASS_NAME
  21.      * @type String
  22.      * @static
  23.      * @default "yui-node-shim"
  24.      */
  25.     // TODO: use ClassNameManager
  26.     Shim.CLASS_NAME = 'yui-node-shim';

  28.     /**
  29.      * Default markup template used to generate the shim element.
  30.      * 
  31.      * @property TEMPLATE
  32.      * @type String
  33.      * @static
  34.      */
  35.     Shim.TEMPLATE = '<iframe class="' + Shim.CLASS_NAME +
  36.             '" frameborder="0" title="Node Stacking Shim"' +
  37.             'src="javascript:false" tabindex="-1" role="presentation"' +
  38.             'style="position:absolute; z-index:-1;"></iframe>';

  40.     Shim.prototype = {
  41.         init: function(config) {
  42.             this._host = config.host;
  43.             this.initEvents();
  44.             this.insert();
  45.             this.sync();
  46.         },

  48.         initEvents: function() {
  49.             this._resizeHandle = this._host.on('resize', this.sync, this);
  50.         },
  51.         
  52.         getShim: function() {
  53.             return this._shim || (
  54.                 this._shim = Y.Node.create(
  55.                     Shim.TEMPLATE,
  56.                     this._host.get('ownerDocument')
  57.                 )
  58.             );
  59.         },

  61.         insert: function() {
  62.             var node = this._host;
  63.             this._shim = node.insertBefore( this.getShim(),
  64.                     node.get('firstChild'));
  65.         },

  67.         /**
  68.          * Updates the size of the shim to fill its container
  69.          * @method sync
  70.          */
  71.         sync: function() {
  72.             var shim = this._shim,
  73.                 node = this._host;

  75.             if (shim) {
  76.                 shim.setAttrs({
  77.                     width: node.getStyle('width'),
  78.                     height: node.getStyle('height')
  79.                 });
  80.             }
  81.         },

  83.         /**
  84.          * Removes the shim and destroys the plugin
  85.          * @method destroy
  86.          */
  87.         destroy: function() {
  88.             var shim = this._shim;
  89.             if (shim) {
  90.                 shim.remove(true);
  91.             }

  93.             this._resizeHandle.detach();
  94.         }
  95.     };

  97.     Shim.NAME = 'Shim';
  98.     Shim.NS = 'shim';

  100.     Y.namespace('Plugin');
  101.     Y.Plugin.Shim = Shim;

  103.