如何开发 HTML 编辑器

作者:卢春城 来源:卢春城的博客 日期:2010-5-9

在线的 HTML 内容编辑器为用户提供文本的样式控制,例如文字的颜色、字体大小等。虽然现在网上有不少功能强大的编辑器(如:FCKEditor),但是在使用中需要许多复杂的配置,而且代码往往比较“臃肿”。本文的目的就是介绍如何开发一个 HTML 编辑器。应用本文介绍的方法,可以方便的开发出满足自己需求的,代码相对比较精简的 HTML 编辑器。以下是一个应用本文方法开发的 HTML 编辑器,实现了一些简单的功能:

代码下载

开发方法如下:

1. 添加一个可编辑的 iframe

实现 HTML 编辑器的第 1 步就是在网页中放置一个可编辑的 iframe 用来输入文本,使 iframe 可编辑方法相当简单,只需要将 iframe 的 designMode 设置为 on 即可,具体步骤如下:

var editor = document.getElementById("IFRAME的ID");
 
var editorDoc = editor.contentWindow.document;
var editorWindow = editor.contentWindow;
 
editorDoc.designMode = "on";
 
editorDoc.open();
editorDoc.write("<html><head></head><body style='margin:0px; padding: 0px;'></body></html>");
editorDoc.close();

2. 设置选中文本的样式

设置选中文本样式的方法最简单的方式就是使用 document.execCommand, 但是 execCommand 功能比较局限,有时不能满足需求,例如:execCommand 设置字体大小只能是 1-7, 不能使用像素大小,而且如果你在点击工具栏按钮到调用 execCommand 的过程中点击了其他的 DIV,iframe 的选中内容会消失,这时调用 execCommand 是无效的。因此本文介绍另一种方法,基本思路如下:

(1) 获取选中的 HTML;

(2) 修改 HTML 的样式;

(3) 用修改后的 HTML 替换选中的 HTML。

2.1 获取选中的 HTML

在不同的浏览器中获取选中的 HTML 的方法是不同的,在 IE 中可以使用

var range = document.selection.createRange()

在 Firefox,Chrome 中则使用

var range = window.getSelection().getRangeAt(0);

2.2 替换选中的 HTML

通过 2.1 的方法获取了表示选中内容的对象后,就可以调用其方法来替换掉选中的内容。在不同的浏览器中替换选中的 HTML 的方法有所差异,在 IE 中可以只需调用 range.pasteHTML 就行了,在 Firefox,Chrome 中则使用 range.deleteContents 和 range.insertNode 两个方法来实现

2.3 封装一个操作选中 HTML 的类

由于 2.1 中获取的 range 对象的方法在不同浏览器中差异很大,因此,为了方便实现 2.1 和 2.2 提到的两个操作,封装了一个操作选中 HTML 的类 SelectionRange,该类有两个方法,GetSelectedHtml 和 Replace,分别用于获取 HTML 和替换 HTML。其代码如下:

//用于记录浏览器的类型
var browser = {};
 
var ua = navigator.userAgent.toLowerCase();
 
browser.msie = (/msie ([\d.]+)/).test(ua);
browser.firefox = (/firefox\/([\d.]+)/).test(ua);
browser.chrome = (/chrome\/([\d.]+)/).test(ua);
 
//获取多个节点的HTML
function GetInnerHTML(nodes)
{
    var builder = [];
    for (var i = 0; i < nodes.length; i++)
    {
        if (nodes[i].nodeValue != undefined)
        {
            builder.push(nodes[i].innerHTML);
        }
        else
        {
            if (nodes[i].textContent) builder.push(nodes[i].textContent.replace(/\</ig, function() { return "<"; }));
            else if (nodes[i].nodeValue) builder.push(nodes[i].nodeValue.replace(/\</ig, function() { return "<"; }));
        }
    }
    return builder.join("");
}
 
function SelectionRange(doc, range)
{
    //获取选中的内容的HTML
    this.GetSelectedHtml = function()
    {
        if (range == null) return "";
       
        if (browser.msie)
        {
            if (range.htmlText != undefined) return range.htmlText;
            else return "";
        }
        else if (browser.firefox || browser.chrome)
        {
            return GetInnerHTML(range.cloneContents().childNodes);
        }
        else
        {
            return "";
        }
    }
   
    //用html替换选中的内容的HTML
    this.Replace = function(html)
    {
        if (range != null)
        {
            if (browser.msie)
            {
                if (range.pasteHTML != undefined)
                {
                    //当前选中html可能以为某种原因(例如点击了另一个DIV)而丢失,重新选中
                    range.select();
                    range.pasteHTML(html);
                    return true;
                }
            }
            else if (browser.firefox || browser.chrome)
            {
                if (range.deleteContents != undefined && range.insertNode != undefined)
                {
                    //将文本html转换成DOM对象
                    var temp = doc.createElement("DIV");
                    temp.innerHTML = html;
                   
                    var elems = [];
                    for (var i = 0; i < temp.childNodes.length; i++)
                    {
                        elems.push(temp.childNodes[i]);
                    }
                   
                    //删除选中的节点
                    range.deleteContents();
                   
                    //将html对应的节点(即temp的所有子节点)逐个插入到range中,并从temp中删除
                    for (var i in elems)
                    {
                        temp.removeChild(elems[i]);
                        range.insertNode(elems[i]);
                    }
                     return true;
                }
            }
        }
        return false;
    }
}

与此同时,还实现了一个函数 GetSelectionRange 用于获取当前选中文本对应的 SelectionRange 对象,

function GetSelectionRange(win)
{
    var range = null;
   
    if (browser.msie)
    {
        range = win.document.selection.createRange();
        if (range.parentElement().document != win.document)
        {
            range = null;
        }
    }
    else if (browser.firefox || browser.chrome)
    {
        var sel = win.getSelection();
        if (sel.rangeCount > 0) range = sel.getRangeAt(0); else range = null;
    }
   
    return new SelectionRange(win.document, range);
}

2.4 修改选中的 HTML 的样式

修改选中的 HTML 的样式方法并不复杂,只需要将 HTML 转成 DOM 对象,然后递归的设置每一个节点对应的样式的值即可 , 具体代码如下:

function SetNodeStyle(doc, node, name, value)
{
    if (node.innerHTML == undefined)
    {
        return node;
    }
    else
    {
        node.style[name] = value;
       
        for (var i = 0; i < node.childNodes.length; i++)
        {
            var cn = node.childNodes[i];
            if (node.innerHTML != undefined)
            {
                SetNodeStyle(doc, cn, name, value);
            }
        }
       
        return node;
    }
}
 
function SetStyle(doc, html, name, value)
{
    var dom = doc.createElement("DIV");
    dom.innerHTML = html;
   
    for (var i = 0; i < dom.childNodes.length; i++)
    {
        var node = dom.childNodes[i];
       
        if (node.innerHTML == undefined)
        {
            //如果是文本节点,则转换转换成span
            var span = doc.createElement("SPAN");
            span.style[name] = value;
            if (node.nodeValue != undefined) span.innerHTML = node.nodeValue.replace(/\</ig, function() { return "<"; });
            else if (node.textContent != undefined) span.innetHTML = node.textContent.replace(/\</ig, function() { return "<"; });
            //替换掉文本节点
            dom.replaceChild(span, node);
        }
        else
        {
            SetNodeStyle(doc, node, name, value);
        }
    }
   
    return dom.innerHTML;
}

2.5 示例

使用以上的代码,就可以相当方便的实现一个 HTML 编辑器,例如,以下代码实现将选中文本的字体大小设置为 32px:

var range = GetSelectionRange(editorWindow);
var html = SetStyle(editorDoc, range.GetSelectedHtml(), "fontSize", "32px");
range.Replace(html);

同理,你可以实现设置行距,缩进,插入图片等功能。

3. 总结

本文给出的代码兼容 IE,Firefox 和 Chrome,如果有其它问题可以通过 EMail 或者 WebIM 与我联系。

作者:卢春城

E-mail:mrlucc@126.com

WebIM:http://los.luchuncheng.cn/Chat.aspx?User=luchuncheng&Nickname=%u5362%u6625%u57CE

出处:http://lucc.cnblogs.com/

本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接。

相关文章