PHP FCKEditor的API

获取Editor实例的方法:

//在引用即包含FCKeditor的地方获取其实例   
  1. var oEditor = FCKeditorAPI.GetInstance('InstanceName');   
  2.   
  3. //在编辑器内部的弹出窗口中(如菜单的弹出窗口)获取其实例   
  4. var oEditor = window.parent.InnerDialogLoaded().FCK;  

当我们获取了这个实例了以后,便可以访问很多有用的属性及方法。

属性:下图是在vs 2008中调试js文件时试用快速窗口查看FCKeditor对象属性时的截图,我们可以看到从这个FCK对象我们可以获取很多属性,有的是对其他对象的引用,比如Commands和Event等。Commands属性是FCKCommand对象(我们可以从下载的源文件的/editor/_source/internals文件夹的fckcomand.js文件中找到这个对象),他有一个GetCommand方法来获取一个已经注册了的命令,方法返回的这些定义好的命令一般都会有一个Excute方法,这样我们就可以在外部执行FCK编辑器的命令了。比如我们打开一个添加表格或者是设置表格属性的对话框:

//获取编辑器对象   
  1. var oEditor = FCKeditorAPI.GetInstance('InstanceName');   
  2.   
  3. //通过Command属性的GetCommand方法获取一个命令对象并调用他的Excute方法执行命令   
  4. oEditor.Commands.GetCommand("Table").Excute();  

以下为几个比较常用的属性:

  • oEditor.Name ( string ) :获取实例的名称。
  • oEditor.Status ( integer ) :获取实例的状态。
  • oEditor.EditorDocument ( object ) :获取编辑区域的document对象。这document对象包括的内容只有编辑区域里面的html代码。
  • oEditor.EditorWindow ( object ) :获取编辑区域的window对象。

方法:我们在获取了一个编辑器的对象了以后,可以执行很多的方法来实现在编辑器的外部对编辑区域的操作。下图是在vs 2008中调试js文件时试用快速窗口查看FCKeditor对象属性时的截图,其中画了红线的时我们经常会用到的方法。包括注册当选择的元素发生变化时的事件处理方法AttachToOnSelectionChange方法(类似于C#中的委托),以及执行已命名的命令ExecuteNamedCommand方法,还有获取编辑器内的内容GetData,GetHTML,GetXHTML等方法,想编辑区域添加元素和html代码InsertElement,InsertElementAndGetIt,InsertHtml,设置编辑区域内的的html元素等方法SetHtml。

以下为几个常用的方法:

  • AttachToOnSelectionChange( functionPointer ):
  • ExcuteNamedCommand():
  • GetData():
  • GetHtm():
  • InsertElement()
  • InsertElementAndGetIt()
  • InsertHtml():在光标处插入html代码
  • SetData()
  • SetHtml()
  • SetInnerHtml()

你可能感兴趣的:(PHP FCKEditor的API)