熱門精品專業(yè)JFace Text Editor是JFace里面一個功能強(qiáng)大,結(jié)構(gòu)復(fù)雜而且非常重要的組件,要掌握它還需要花不少的功夫,下面我們將通過"Building an Eclipse Text Editor with JFace Text"的翻譯來掌握它的用法
提到Text Editor,就不得不提到與之密切相關(guān)的SourceViewerConfiguration類,Text Editor的許多功能都是通過該類配置上去的,還有一個是IDocumentProvider接口,Text Editor所要編輯的文件對象就是通過該接口提供的.
Editor編輯的內(nèi)容封裝在IDocument這個類中,對于編輯內(nèi)容的遍歷,定位都是在IDocument的基礎(chǔ)上來實(shí)現(xiàn)的,而文檔的分割信息以及其他的元數(shù)據(jù)信息(比如高亮區(qū)域)則由Editor來保存,Document中的定位信息將使用一個Position類來加以封裝.
雖然IDocument有不同的實(shí)現(xiàn),但是他們都一個共同點(diǎn),那就是這些內(nèi)容都是可分割的,即能被分割成一塊一塊的互不重疊的文本塊.分割(Partition)在Text Editor中是一個非常非常重要的概念,基本上Text Editor的所有功能都是建立在文檔分割的基礎(chǔ)上的.
IDocument接口并不關(guān)心文本內(nèi)容的存儲和加載,它的工作就是初始化一個文檔對象實(shí)例,而文檔的各種屬性的初始化則交給IDocumentProvider來完成.
在打開一個文檔的時候編輯器將同時進(jìn)行文檔的分割處理,其結(jié)果是得到各種不同類型的互不重疊文本塊
下面我們來講講分割器,分割器的設(shè)置是在IDocumentProvider的createDocument()方法中實(shí)現(xiàn)的,如下代碼所示:
- protected IDocument createDocument(Object element) throws CoreException
- {
- IDocument document = super.createDocument(element);
- if (document != null)
- {
- IDocumentPartitioner partitioner = new XMLPartitioner(
- new XMLPartitionScanner(), new String[]
- {
- XMLPartitionScanner.XML_TAG, XMLPartitionScanner.XML_COMMENT
- });
- partitioner.connect(document);
- document.setDocumentPartitioner(partitioner);
- }
- return document;
- }
從上面的代碼我們可以看到,初始化一個IDocumentPartitioner我們需要兩個參數(shù),一個是必須指定一個IPartitionTokenScanner實(shí)例,另一個是所支持的內(nèi)容類型(content type)數(shù)組.
與分割相關(guān)的還有三個概念:Scanner, Token和Rule, Scanner的任務(wù)就是將當(dāng)前編輯的文檔對象進(jìn)行掃描并得到每一個文本塊所對應(yīng)的Token,對于Token需要解釋一下,它是IToken的一個實(shí)現(xiàn),被視為內(nèi)容類型的唯一標(biāo)識符.比如一個Token可能表示的是某種語言中的關(guān)鍵字,xml元素名,空格等.
通過下面的代碼來說明Scanner是如何來查找各個Token的.
- public class XMLPartitionScanner extends RuleBasedPartitionScanner
- {
- public final static String XML_DEFAULT = "__xml_default";
- public final static String XML_COMMENT = "__xml_comment";
- public final static String XML_TAG = "__xml_tag";
- public XMLPartitionScanner()
- {
- IToken xmlComment = new Token(XML_COMMENT);
- IToken tag = new Token(XML_TAG);
- IPredicateRule[] rules = new IPredicateRule[2];
- rules[0] = new MultiLineRule("", xmlComment);
- rules[1] = new TagRule(tag);
- setPredicateRules(rules);
- }
- }
在一個編輯器中每一種內(nèi)容類型(content type)都表示為一個字符串常量.在上面的代碼中,定義了三個內(nèi)容類型:默認(rèn),xml標(biāo)簽和xml注釋.為了簡化,這里我們沒有對xml中的節(jié)點(diǎn)文本內(nèi)容以及xml指令定義類型, 在XMLPartitionScanner中,每一個內(nèi)容類型都和一個IToken實(shí)例相關(guān)聯(lián)的,而IToken實(shí)例非常簡單,僅僅只是一個內(nèi)容類型標(biāo)識符,用來在XMLPartitionScanner對文檔進(jìn)行掃描的時候,對各種Token進(jìn)行識別, 由于我們的Scanner是繼承RuleBasedPartitionScanner的,因此它的Token將與一系列規(guī)則對應(yīng),而分割器通過這些規(guī)則來將文檔分割成所需要的結(jié)構(gòu),在XMLPartitionScanner中,我們使用了兩條規(guī)則來將內(nèi)容類型進(jìn)行配置:一個是MultiLineRule,對應(yīng)注釋內(nèi)容類型,一個是TagRule對應(yīng)xml標(biāo)簽類型,在根據(jù)內(nèi)容類型進(jìn)行分割時,當(dāng)找到一個匹配的分割片段之后將返回一個唯一的Token,這樣就在內(nèi)容類型,Rule 以及Token之間做到了一一對應(yīng).
使用一個基于規(guī)則的Scanner對文檔進(jìn)行分割的工作原理如下:
- 1.在RuleBasedPartitionScanner構(gòu)造器中配置一些規(guī)則
- 2.分割時調(diào)用Rule的evaluate()方法
- 3.在evaluate方法中根據(jù)配置的各種規(guī)則實(shí)現(xiàn)類將對得到的一段字符串片段進(jìn)行匹配,比如用于查找XML注釋的MultiLineRule只去匹配那些以注釋開始并以注釋結(jié)尾 結(jié)束的字符片段,這種匹配只有兩種結(jié)果:成功或失敗,還是拿匹配注釋的MultiLineRule來說,如果匹配的字符串片段為"一般節(jié)點(diǎn)"那么它會馬上返回,因?yàn)槠ヅ涞淖址皇且宰⑨岄_頭開始的,如果匹配失敗,掃描器將重新定位到匹配字符串的起始位置,并返回Token.UNDEFINED,接著調(diào)用下一個rule的evaluate()方法進(jìn)行匹配處理,如果找到則返回匹配的Token,而且Scanner將去獲取當(dāng)前字符串在整個文檔中的位置以及長度,并使用TypedPosition類將這些信息與其內(nèi)容類型加以封裝保存到IDocument實(shí)例中.
IDocumentPartitioner通過computePartitioning()方法將得到文檔的分割信息,當(dāng)然了,在得到分割信息之前,必須要將文檔對象與IDocumentPartitioner實(shí)例關(guān)聯(lián)起來,這個是通過IDocumentPartitioner.connect(document)來實(shí)現(xiàn)的.
當(dāng)使用規(guī)則對文檔進(jìn)行分割,可能主要的工作就是去定義IPredicateRule的各種實(shí)現(xiàn)類,該接口的實(shí)現(xiàn)包括MultiLineRule, SingleLineRule 和 PatternRule等,理解該接口的難點(diǎn)在于如何配置這些規(guī)則,有時候,我們可能需要提供自己的IPredicateRule實(shí)現(xiàn)類
除了自定義規(guī)則之外,我們也可以提供自己的ITokenScanner實(shí)現(xiàn).比如在JDT中,就實(shí)現(xiàn)了自己的ITokenScanner類FastJavaPartitionScanner,顯然這個工作是巨大的,一般我們不這樣做,除非有必要.
對文檔進(jìn)行分割之后,接下來將要介紹如何顯示,Text Editor的底層采用StyledText控件來顯示編輯的文本內(nèi)容, ITextViewer提供了一套API來封裝StyledText處理IDocument模型的細(xì)節(jié),這樣Text Editor的使用者就不用再與底層的StyledText打交道了.
ITextViewer除了對StyledText進(jìn)行封裝之外還提供了其他如Undo Management這樣的功能,要了解更多細(xì)節(jié)可以去看看JavaDoc文檔.
為了更容易的創(chuàng)建一個結(jié)構(gòu)化文檔編輯器,Eclipse在ITextViewer的基礎(chǔ)上又提供了一個ISourceViewer接口,它包括的功能更強(qiáng)大,比如錯誤標(biāo)記, 語法高亮等,下面我們將一一進(jìn)行介紹
JFace Text Editor通過SourceViewerConfiguration類來對Source Viewer進(jìn)行配置,我們需要做的就是繼承SourceViewerConfiguration類來對SourceViewer進(jìn)行定制,SourceViewer的很多功能比如文本格式化,語法高亮,雙擊選擇,自動提示等等都是通過對SourceViewerConfiguration配置來實(shí)現(xiàn)的,足見其重要性不容忽視.
下面將通過在一個增強(qiáng)版的XML編輯器來實(shí)戰(zhàn)Text Editor的用法
Eclipse插件開發(fā)套件提供一個向?qū)韼椭脩魟?chuàng)建一個簡單的XML Editor,下面我們將在該編輯器的基礎(chǔ)上來進(jìn)行擴(kuò)展
該XML編輯器將實(shí)現(xiàn)下面五個功能:語法高亮(Syntax hightlighting),錯誤標(biāo)識(Error marker),格式化(Formating),內(nèi)容輔助(Content Assistance), 內(nèi)容大綱(Content Outline)
進(jìn)行擴(kuò)展的第一步就是增加新的分割模型,我們增加了下面三個分割的內(nèi)容類型:XML文本, CData內(nèi)容, XML處理指令.
為了在我們的XMLPartionScanner中處理指令類型定義, 先:
java 代碼- public final static String XML_PI = "__xml_pi";
然后注冊到分割器中,這個是在構(gòu)造IDocumentPartitioner實(shí)例時作為參數(shù)傳遞進(jìn)去的:
java 代碼- protected IDocument createDocument(Object element) throws CoreException
- {
- IDocument document = super.createDocument(element);
- if (document != null)
- {
- IDocumentPartitioner partitioner = new XMLPartitioner(
- new XMLPartitionScanner(), new String[]
- {
- XMLPartitionScanner.XML_START_TAG,
- XMLPartitionScanner.XML_PI,
- XMLPartitionScanner.XML_DOCTYPE,
- XMLPartitionScanner.XML_END_TAG,
- XMLPartitionScanner.XML_TEXT,
- XMLPartitionScanner.XML_CDATA,
- XMLPartitionScanner.XML_COMMENT
- });
- partitioner.connect(document);
- document.setDocumentPartitioner(partitioner);
- }
- return document;
- }
接下來是創(chuàng)建用于標(biāo)識不同類型內(nèi)容的Token和Rule,由于我們使用的是基于規(guī)則的Scaner(RuleBasedPartitionScanner),因此我們需要添加一對Token和Rule,這樣才能讓我們的IPartitionTokenScanner實(shí)例能感知我們定義的內(nèi)容類型
根據(jù)XML定義規(guī)范,XML指令必須以結(jié)束,因此我們將這樣來定義我們的Token和Rule:
java 代碼- public XMLPartitionScanner()
- {
- IToken xmlComment = new Token(XML_COMMENT);
- IToken xmlPI = new Token(XML_PI);
- IToken startTag = new Token(XML_START_TAG);
- IToken endTag = new Token(XML_END_TAG);
- IToken docType = new Token(XML_DOCTYPE);
- IToken text = new Token(XML_TEXT);
- IPredicateRule[] rules = new IPredicateRule[7];
- rules[0] = new NonMatchingRule();
- rules[1] = new MultiLineRule("", xmlComment);
- rules[2] = new MultiLineRule(", "?>", xmlPI);
- rules[3] = new MultiLineRule(", ">", endTag);
- rules[4] = new StartTagRule(startTag);
- rules[5] = new MultiLineRule(", ">", docType);
- rules[6] = new XMLTextPredicateRule(text);
- setPredicateRules(rules);
- }
為了讓SourceViewerConfiguration能知道我們添加的新的內(nèi)容類型,我們還需要重載getConfiguredContentTypes方法:
java 代碼- public String[] getConfiguredContentTypes(ISourceViewer sourceViewer)
- {
- return new String[]
- {
- IDocument.DEFAULT_CONTENT_TYPE,
- XMLPartitionScanner.XML_COMMENT,
- XMLPartitionScanner.XML_PI,
- XMLPartitionScanner.XML_DOCTYPE,
- XMLPartitionScanner.XML_START_TAG,
- XMLPartitionScanner.XML_END_TAG,
- XMLPartitionScanner.XML_TEXT
- };
- }
安徽新華電腦學(xué)校專業(yè)職業(yè)規(guī)劃師為你提供更多幫助【在線咨詢】
