Changeset 1296

Timestamp:

11/24/10 20:48:25 (2 years ago)

Author:

ejucovy

Message:

close #1541: add xinha_config.formatblockDetector option, which can be used, in coordination with a clever onExecCommand(formatblock), to customize the behavior of the formatblock dropdown with custom options that don't directly correspond one-to-one to HTML block tags and/or require application-specific logic to identify.

Files:

• trunk/XinhaCore.js (modified) (3 diffs)

trunk/XinhaCore.js

@@ -1059 +1059 @@
     "Formatted": "pre"
   };
-  
+
+  /** You can provide custom functions that will be used to determine which of the
+   * "formatblock" options is currently active and selected in the dropdown.
+   *
+   * Example:
+   * <pre>
+   * xinha_config.formatblockDetector['h5'] = function(xinha, currentElement)
+   * {
+   *   if (my_special_matching_logic(currentElement)) {
+   *     return true;
+   *   } else {
+   *     return false;
+   *   }
+   * };
+   * </pre>
+   *
+   * You probably don't want to mess with this, unless you are adding new, custom
+   * "formatblock" options which don't correspond to real HTML tags.  If you want
+   * to do that, you can use this configuration option to tell xinha how to detect
+   * when it is within your custom context.
+   *
+   * For more, see: http://www.coactivate.org/projects/xinha/custom-formatblock-options
+   */
+  this.formatblockDetector = {};
+
   this.dialogOptions =
-  { 
+  {
     'centered' : true, //true: dialog is shown in the center the screen, false dialog is shown near the clicked toolbar button
     'greyout':true, //true: when showing modal dialogs, the page behind the dialoge is greyed-out
@@ -4902 +4926 @@
         for ( var indexBlock in this.config.formatblock )
         {
+          var blockname = this.config.formatblock[indexBlock];
           // prevent iterating over wrong type
-          if ( typeof this.config.formatblock[indexBlock] == 'string' )
+          if ( typeof blockname  == 'string' )
           {
-            blocks[blocks.length] = this.config.formatblock[indexBlock];
+            blocks[blocks.length] = this.config.formatblockDetector[blockname] || blockname;
           }
         }
@@ -4911 +4936 @@
         var match = this._getFirstAncestorAndWhy(this.getSelection(), blocks);
         var deepestAncestor = match[0];
-        var matchIndex = match[1]; 
+        var matchIndex = match[1];