SpringSide开发实战(七):在项目中整合FCKeditor

Web 2.0时代时代的Web项目,是无论如何也少不了一个在线编辑器的,因此在我们的项 目中整合一个Web编辑器就显得至关重要。在这里,我依然以前面的xkland项目为例,来探 讨在项目中整合FCKediTor的方方面面。

一、关于用户发表文章的功能设计

用户发表文章的功能,大家见过不少,也用过不少,最简单的,莫过于提供一个文本框 ,数据提交后直接写入数据库了事,稍复杂一点的最少也要提供一个输入标题和选择分类的 功能。当然,我们也可以把我们的功能设计得更有特色。在这个示例项目中,我假设开发的 是一个以图文为中心的网络社区,我们每一篇文章都需要用户在它上传的图片中选择一个作 为主题图片,那么,在网站首页的文章列表上,大家看到的将不仅仅只是一个文字的标题, 还有主题图片的缩略图。

先来看看数据表的结构,创建数据表的SQL语句如下:

CREATE  TABLE `topics` (  `id` int ( 11 ) NOT  NULL auto_increment,  `catalogid` int ( 11 ) NOT  NULL ,  `subject` varchar ( 60 ) default  NULL ,  `content` text ,  `pictures` varchar ( 2000 ) NOT  NULL ,  `mainpicture` varchar ( 40 ) NOT  NULL ,  `userid` int ( 11 ) NOT  NULL ,  `time` timestamp  NOT  NULL  default  CURRENT_TIMESTAMP  on  update   CURRENT_TIMESTAMP ,  `lastedittime` timestamp  NOT  NULL  default  ' 2007-01-01 00:00:00 ' ,  `lastreplytime` timestamp  NOT  NULL  default  ' 2007-01-01 00:00:00 ' ,  `visitcount` int ( 11 ) NOT  NULL ,  PRIMARY  KEY  (`id`),  KEY `subject` (`subject`),  KEY `userid` (`userid`),  KEY `time` (`time`),  KEY `lastreplytime` (`lastreplytime`)) ENGINE = InnoDB DEFAULT CHARSET = utf8 |

其中,catalogid字段为文章分类,subject字段为标题,content字段为正文。比较特殊 的是pictures字段和mainpicture字段,pictures保存文章中包含的所有图片的url,以“| ”符号分割,如“001.jpg|002.jpg|003.jpg…”,而mainpicture就是主题图片的url了。 有人会问:“保存主题图片的url就够了,为什么还要保存所有的图片url呢?”,这样设计 主要是为了考虑到用户有时候会修改文章,重新选择别的图片作为主题图片,这个时候 pictures字段就派上用场了,因为它可以向用户提供候选项。

这样的功能设计应该提供如下的用户界面,该页面文件名为EditPosts.jsp:

在这里,我们还没有Web编辑器可用,暂时用一个文本区域代替。

二、初识FCKediTor

在听说FCKediTor之前,我用过一个在线编辑器eWebEdiTor,提供ASP/JSP/PHP等好几个 版本,功能是非常的好,文档也很详细,但是听说只支持IE浏览器;而FCKediTor在网上大 名鼎鼎,是一个受关注非常高的开源项目,并且能够跨浏览器支持。因此我选择FCKediTor 。FCKediTor的最新版本是2.4,大家可以到

http://www.fckediTor.net/download这里下载,如下图

下载并解压缩到fckediTor文件夹,打开该文件夹,我们可以看到如下文件及目录:

其中_samples目录下是示例,_testcases目录下是测试用例,ediTor目录下是编辑器的 主要文件;此外,从该目录中的文件不难看出,FCKediTor提供支持asp、php、perl、 python等等各种服务器技术的版本,但不支持.net和Java Web。不过不要担心,FCKediTor 与Java Web之间的整合早就有人做好了,稍后我们就会用到。

了解浏览器技术的人都不难想到,Web编辑器其实应该是客户端技术,它是通过 JavaScript来控制页面上的元素和通过弹出窗口来模拟对话框而做到的;只有在提交文章或 者上传文件的时候才需要跟服务器端交互。因此,要将该编辑器快速整合到项目中以看到效 果,是非常简单的。

三、使用JavaScript整合FCKediTor

将刚刚解压得到的fckediTor目录拷贝到我们的项目中的src/main/webapp目录下,打开 刚才建立的EditPosts.jsp,加入如下代码:

1 2 3 window.onload =  function () {4   var FCKediTor =  new FCKediTor( 'myTextArea' ) ;5   oFCKediTor.BasePath =  " fckediTor/ " ;6   oFCKediTor.ReplaceTextarea();7 }   

在这里,第一行代码是引入fckediTor中的fckediTor.js文件,其中定义了FCKediTor类 ,第四行就是利用该类创建一个编辑器对象,而myTextArea是表单中文本区域的名字,在第 六行,通过FCKediTor类的ReplaceTextArea方法,文本区域就被替换成了Web编辑器。刷新 页面,就可以看到效果:

FCKediTor类提供几个基本属性,可以让我们对编辑器进行简单的控制,它们是:

InstanceName:返回编辑器示例的名字

Width:设置编辑器的宽度,默认为100%

Height:设置编辑器的高度,默认值为200

ToolbarSet:设置编辑器的工具条集合,默认值为”default”,稍后会讲到怎样自定义工 具条

Value:设置显示在编辑器中的内容(包含HTML),默认值为空

BasePath:编辑器的目录,一定要设置正确,否则编辑器会找不到它需要的文件,在本 例中,由于我们直接将fckediTor目录放到项目的根目录下,因此设置为”fckediTor/”

CheckBrowser:设置是否检测浏览器,默认为true

DisplayErrors:设置是否显示错误信息,默认为true

此外,FCKediTor类还有一个集合属性Config[ key ] = value,通过该集合属性,我们 可以进行一个更高级的设置,如设置默认语言、更换皮肤等等。

window.onload = function(){   var FCKediTor = new FCKediTor( 'myTextArea' ) ;   oFCKediTor.BasePath = "fckediTor/";   oFCKediTor.Width = "800";   oFCKediTor.Height = "300";   oFCKediTor.ToolbarSet = "Basic";   oFCKediTor.Config["SkinPath"] = "skins/office2003/";   oFCKediTor.ReplaceTextarea();}

效果图:

四、通过FCKediTor.java整合FCKediTor

使用JavaScript整合FCKediTor,我们很快就能看到编辑器的效果,并进行文章的编辑。 但是,在需要和服务器端进行交互的时候(比如上传图片),就会出错。因此,我们不得不 在服务器端做一点手脚。这里,我们需要使用的是FCKediTor.java,其最新版本是2.3,还 是在刚才的下载页面,找到下载链接,如下图:

将下载文件解压,我们可以看到有doc目录,有src目录,甚至还有一个build.xml,让我 们可以重新构建项目;但是,这些我们统统都不需要,我们只要web/WEB-INF目录下的东西 ,在这个目录下,提供了一个web.xml,同时在lib目录下提供了两个.jar文件,这便是全部 。看到这里,大家肯定能够想到,Java Web项目的灵魂是什么?那就是web.xml。我们所要 做的,就是把lib目录下的两个.jar文件拷贝到我们项目的src/main/webapp/WEB-INF/lib下 ,同时将web.xml中的内容整合到我们项目的src/main/webapp/WEB-INF/web.xml中。

web.xml中的内容很简单,只定义了两个Servlet映射,并且对上传文件的目录和允许哪 些文件上传、拒绝哪些文件上传做了设置,如下:     ConnecTor     com.fredck.FCKediTor.connecTor.ConnecTorServlet            baseDir       /UploadFiles/                 debug       true          1           SimpleUploader     com.fredck.FCKediTor.uploader.SimpleUploaderServlet            baseDir       /UploadFiles/                 debug       true                 enabled       true                 AllowedExtensionsFile                        DeniedExtensionsFile       php|php3|php5|phtml|asp|aspx|ascx|jsp|cfm|cfc|pl|bat|exe|dll|reg|cgi                 AllowedExtensionsImage       jpg|gif|jpeg|png|bmp                 DeniedExtensionsImage                        AllowedExtensionsFlash       swf|fla                 DeniedExtensionsFlash                 1            ConnecTor     /fckediTor/ediTor/filemanager/browser/default/connecTors/jsp/connecto r             SimpleUploader     /fckediTor/ediTor/filemanager/upload/simpleuploader   

请注意,这两个servlet的url-pattern我都在原来 代码的前面加上了/fckediTor。

然后,我们就可以抛开JavaScript,而在服务器端使用标签来创建Web编辑器了。先在 EditPosts.jsp中引入标签库:

再在原来放textarea的地方,放如下代码:       This is some sample text. You are using Tor/">FCKediTor.  

这里有一点一定要注意,那就是这里的属性都要避免使用相对路径。

刷新页面,又见编辑器,此时,可以顺利的上传文件了。整合编辑器的任务到此完成。 下一步,就是怎样对编辑器进行更多的控制了。

五、对编辑器进行更多控制

1、自定义工具条:打开fckediTor目录下的fckconfig.js文件,添加如下代码:

FCKConfig.ToolbarSets["Usable"] = [   ['Source','Preview'],   ['Undo','Redo','-','SelectAll','Cut','Copy','Paste','-','RemoveFormat','-','Find ','Replace'],   ['Link','Unlink','Anchor'],   ['FitWindow','-','About'],   '/',   ['Bold','Italic','Underline','StrikeThrough','-','Subscript','Superscript'],   ['OrderedList','UnorderedList','-','Outdent','Indent'],   ['JustifyLeft','JustifyCenter','JustifyRight','JustifyFull'],   ['Image','Flash','Table','Rule','Smiley'],   '/',   ['Style','FontFormat','FontName','FontSize'],   ['TextColor','BGColor']] ;

2、添加常用的中文字体:在上面打开的文件中找到

FCKConfig.FontNames = 'Arial;Comic Sans MS;Courier New;Tahoma;Times New Roman;Verdana' ;加上几种我们常用的字体 FCKConfig.FontNames = '宋体;黑体;隶书;楷体_GB2312;Arial;Comic Sans MS;Courier New;Tahoma;Times New Roman;Verdana' ;

3、更改JSP页面中定义编辑器的标签,如下:

       This is some sample text. You are using Tor/">FCKediTor.  

刷新页面,可以看到编辑器的效果如下:

六、如何获取编辑器中插入的图片

从文章开头的功能设计我们可以看出,当用户编辑完文章后,我们应该能获取文章中插 入的图片信息。怎样获取编辑器中的插入的图片呢?IT进行时在他的文章FCKediTor的几点 重要改进和使用心得,值得分享 中是这样做的:在上传图片的对话框的JavaScript中添加 代码,使得当用户插入图片点OK后通知列表框,代码如下:

try {         var bj = window.dialogArguments.EdiTor.parent.document;     obj.getElementById( " tip.c_tip_has_pic " ).value =  " 1 " ;   } catch (e) {}

我认为这个方法不好,第一,这个方法是侵入性的,需要修改FCKediTor的代码;第二, 这种方法能够在用户插入图片的时候获得图片信息,但是如果用户插入的图片,接着又把图 片从文章中删除了呢?这时候是无法跟踪的。

正确的思路应该是在编辑器失去焦点的时候,获取编辑器中的文档,通过DOM取得文章中 所有的图片。代码如下:

function FCKediTor_OnComplete( ediTorInstance ){   ediTorInstance.Events.AttachEvent( 'OnBlur', onEdiTorBlur ) ;}function onEdiTorBlur(){   var Select = $("img_select");   for(var i=oSelect.options.length-1; i>0; i--){     oSelect.options[i] = null;   }   EdiTor = FCKediTorAPI.GetInstance('EdiTorDefault');   var imgs = oEdiTor.EdiTorDocument.body.all.tags("img");   for(var i=0; i < imgs.length; i++){     var Option = document.createElement("option");     oOption.appendChild(document.createTextNode(imgs[i].src));     oSelect.appendChild(oOption);   }}

上面是我在探索FCKediTor中的一些心得,有问题的地方,欢迎大家探讨。

“过去酒逢知已千杯少,现在酒逢千杯知已少”。

SpringSide开发实战(七):在项目中整合FCKeditor

相关文章:

你感兴趣的文章:

标签云: