jquery.metadata.js
上传用户:stephen_wu
上传日期:2008-07-05
资源大小:1757k
文件大小:4k
源码类别:

网络

开发平台:

Unix_Linux

  1. /*
  2.  * Metadata - jQuery plugin for parsing metadata from elements
  3.  *
  4.  * Copyright (c) 2006 John Resig, Yehuda Katz, J�örn Zaefferer, Paul McLanahan
  5.  *
  6.  * Dual licensed under the MIT and GPL licenses:
  7.  *   http://www.opensource.org/licenses/mit-license.php
  8.  *   http://www.gnu.org/licenses/gpl.html
  9.  *
  10.  * Revision: $Id: jquery.metadata.js 3640 2007-10-11 18:34:38Z pmclanahan $
  11.  *
  12.  */
  13. /**
  14.  * Sets the type of metadata to use. Metadata is encoded in JSON, and each property
  15.  * in the JSON will become a property of the element itself.
  16.  *
  17.  * There are three supported types of metadata storage:
  18.  *
  19.  *   attr:  Inside an attribute. The name parameter indicates *which* attribute.
  20.  *          
  21.  *   class: Inside the class attribute, wrapped in curly braces: { }
  22.  *   
  23.  *   elem:  Inside a child element (e.g. a script tag). The
  24.  *          name parameter indicates *which* element.
  25.  *          
  26.  * The metadata for an element is loaded the first time the element is accessed via jQuery.
  27.  *
  28.  * As a result, you can define the metadata type, use $(expr) to load the metadata into the elements
  29.  * matched by expr, then redefine the metadata type and run another $(expr) for other elements.
  30.  * 
  31.  * @name $.metadata.setType
  32.  *
  33.  * @example <p id="one" class="some_class {item_id: 1, item_label: 'Label'}">This is a p</p>
  34.  * @before $.metadata.setType("class")
  35.  * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label"
  36.  * @desc Reads metadata from the class attribute
  37.  * 
  38.  * @example <p id="one" class="some_class" data="{item_id: 1, item_label: 'Label'}">This is a p</p>
  39.  * @before $.metadata.setType("attr", "data")
  40.  * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label"
  41.  * @desc Reads metadata from a "data" attribute
  42.  * 
  43.  * @example <p id="one" class="some_class"><script>{item_id: 1, item_label: 'Label'}</script>This is a p</p>
  44.  * @before $.metadata.setType("elem", "script")
  45.  * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label"
  46.  * @desc Reads metadata from a nested script element
  47.  * 
  48.  * @param String type The encoding type
  49.  * @param String name The name of the attribute to be used to get metadata (optional)
  50.  * @cat Plugins/Metadata
  51.  * @descr Sets the type of encoding to be used when loading metadata for the first time
  52.  * @type undefined
  53.  * @see metadata()
  54.  */
  55. (function($) {
  56. $.extend({
  57. metadata : {
  58. defaults : {
  59. type: 'class',
  60. name: 'metadata',
  61. cre: /({.*})/,
  62. single: 'metadata'
  63. },
  64. setType: function( type, name ){
  65. this.defaults.type = type;
  66. this.defaults.name = name;
  67. },
  68. get: function( elem, opts ){
  69. var settings = $.extend({},this.defaults,opts);
  70. // check for empty string in single property
  71. if ( !settings.single.length ) settings.single = 'metadata';
  72. var data = $.data(elem, settings.single);
  73. // returned cached data if it already exists
  74. if ( data ) return data;
  75. data = "{}";
  76. if ( settings.type == "class" ) {
  77. var m = settings.cre.exec( elem.className );
  78. if ( m )
  79. data = m[1];
  80. } else if ( settings.type == "elem" ) {
  81. if( !elem.getElementsByTagName ) return;
  82. var e = elem.getElementsByTagName(settings.name);
  83. if ( e.length )
  84. data = $.trim(e[0].innerHTML);
  85. } else if ( elem.getAttribute != undefined ) {
  86. var attr = elem.getAttribute( settings.name );
  87. if ( attr )
  88. data = attr;
  89. }
  90. if ( data.indexOf( '{' ) <0 )
  91. data = "{" + data + "}";
  92. data = eval("(" + data + ")");
  93. $.data( elem, settings.single, data );
  94. return data;
  95. }
  96. }
  97. });
  98. /**
  99.  * Returns the metadata object for the first member of the jQuery object.
  100.  *
  101.  * @name metadata
  102.  * @descr Returns element's metadata object
  103.  * @param Object opts An object contianing settings to override the defaults
  104.  * @type jQuery
  105.  * @cat Plugins/Metadata
  106.  */
  107. $.fn.metadata = function( opts ){
  108. return $.metadata.get( this[0], opts );
  109. };
  110. })(jQuery);