熱門精品專業JFace Text Editor是JFace里面一個功能強大,結構復雜而且非常重要的組件,要掌握它還需要花不少的功夫,下面我們將通過"Building an Eclipse Text Editor with JFace Text"的翻譯來掌握它的用法
提到Text Editor,就不得不提到與之密切相關的SourceViewerConfiguration類,Text Editor的許多功能都是通過該類配置上去的,還有一個是IDocumentProvider接口,Text Editor所要編輯的文件對象就是通過該接口提供的.
Editor編輯的內容封裝在IDocument這個類中,對于編輯內容的遍歷,定位都是在IDocument的基礎上來實現的,而文檔的分割信息以及其他的元數據信息(比如高亮區域)則由Editor來保存,Document中的定位信息將使用一個Position類來加以封裝.
雖然IDocument有不同的實現,但是他們都一個共同點,那就是這些內容都是可分割的,即能被分割成一塊一塊的互不重疊的文本塊.分割(Partition)在Text Editor中是一個非常非常重要的概念,基本上Text Editor的所有功能都是建立在文檔分割的基礎上的.
IDocument接口并不關心文本內容的存儲和加載,它的工作就是初始化一個文檔對象實例,而文檔的各種屬性的初始化則交給IDocumentProvider來完成.
在打開一個文檔的時候編輯器將同時進行文檔的分割處理,其結果是得到各種不同類型的互不重疊文本塊
下面我們來講講分割器,分割器的設置是在IDocumentProvider的createDocument()方法中實現的,如下代碼所示:
- 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我們需要兩個參數,一個是必須指定一個IPartitionTokenScanner實例,另一個是所支持的內容類型(content type)數組.
與分割相關的還有三個概念:Scanner, Token和Rule, Scanner的任務就是將當前編輯的文檔對象進行掃描并得到每一個文本塊所對應的Token,對于Token需要解釋一下,它是IToken的一個實現,被視為內容類型的唯一標識符.比如一個Token可能表示的是某種語言中的關鍵字,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);
- }
- }
在一個編輯器中每一種內容類型(content type)都表示為一個字符串常量.在上面的代碼中,定義了三個內容類型:默認,xml標簽和xml注釋.為了簡化,這里我們沒有對xml中的節點文本內容以及xml指令定義類型, 在XMLPartitionScanner中,每一個內容類型都和一個IToken實例相關聯的,而IToken實例非常簡單,僅僅只是一個內容類型標識符,用來在XMLPartitionScanner對文檔進行掃描的時候,對各種Token進行識別, 由于我們的Scanner是繼承RuleBasedPartitionScanner的,因此它的Token將與一系列規則對應,而分割器通過這些規則來將文檔分割成所需要的結構,在XMLPartitionScanner中,我們使用了兩條規則來將內容類型進行配置:一個是MultiLineRule,對應注釋內容類型,一個是TagRule對應xml標簽類型,在根據內容類型進行分割時,當找到一個匹配的分割片段之后將返回一個唯一的Token,這樣就在內容類型,Rule 以及Token之間做到了一一對應.
使用一個基于規則的Scanner對文檔進行分割的工作原理如下:
- 1.在RuleBasedPartitionScanner構造器中配置一些規則
- 2.分割時調用Rule的evaluate()方法
- 3.在evaluate方法中根據配置的各種規則實現類將對得到的一段字符串片段進行匹配,比如用于查找XML注釋的MultiLineRule只去匹配那些以注釋開始并以注釋結尾 結束的字符片段,這種匹配只有兩種結果:成功或失敗,還是拿匹配注釋的MultiLineRule來說,如果匹配的字符串片段為"一般節點"那么它會馬上返回,因為匹配的字符串不是以注釋開頭開始的,如果匹配失敗,掃描器將重新定位到匹配字符串的起始位置,并返回Token.UNDEFINED,接著調用下一個rule的evaluate()方法進行匹配處理,如果找到則返回匹配的Token,而且Scanner將去獲取當前字符串在整個文檔中的位置以及長度,并使用TypedPosition類將這些信息與其內容類型加以封裝保存到IDocument實例中.
IDocumentPartitioner通過computePartitioning()方法將得到文檔的分割信息,當然了,在得到分割信息之前,必須要將文檔對象與IDocumentPartitioner實例關聯起來,這個是通過IDocumentPartitioner.connect(document)來實現的.
當使用規則對文檔進行分割,可能主要的工作就是去定義IPredicateRule的各種實現類,該接口的實現包括MultiLineRule, SingleLineRule 和 PatternRule等,理解該接口的難點在于如何配置這些規則,有時候,我們可能需要提供自己的IPredicateRule實現類
除了自定義規則之外,我們也可以提供自己的ITokenScanner實現.比如在JDT中,就實現了自己的ITokenScanner類FastJavaPartitionScanner,顯然這個工作是巨大的,一般我們不這樣做,除非有必要.
對文檔進行分割之后,接下來將要介紹如何顯示,Text Editor的底層采用StyledText控件來顯示編輯的文本內容, ITextViewer提供了一套API來封裝StyledText處理IDocument模型的細節,這樣Text Editor的使用者就不用再與底層的StyledText打交道了.
ITextViewer除了對StyledText進行封裝之外還提供了其他如Undo Management這樣的功能,要了解更多細節可以去看看JavaDoc文檔.
為了更容易的創建一個結構化文檔編輯器,Eclipse在ITextViewer的基礎上又提供了一個ISourceViewer接口,它包括的功能更強大,比如錯誤標記, 語法高亮等,下面我們將一一進行介紹
JFace Text Editor通過SourceViewerConfiguration類來對Source Viewer進行配置,我們需要做的就是繼承SourceViewerConfiguration類來對SourceViewer進行定制,SourceViewer的很多功能比如文本格式化,語法高亮,雙擊選擇,自動提示等等都是通過對SourceViewerConfiguration配置來實現的,足見其重要性不容忽視.
下面將通過在一個增強版的XML編輯器來實戰Text Editor的用法
Eclipse插件開發套件提供一個向導來幫助用戶創建一個簡單的XML Editor,下面我們將在該編輯器的基礎上來進行擴展
該XML編輯器將實現下面五個功能:語法高亮(Syntax hightlighting),錯誤標識(Error marker),格式化(Formating),內容輔助(Content Assistance), 內容大綱(Content Outline)
進行擴展的第一步就是增加新的分割模型,我們增加了下面三個分割的內容類型:XML文本, CData內容, XML處理指令.
為了在我們的XMLPartionScanner中處理指令類型定義, 先:
java 代碼- public final static String XML_PI = "__xml_pi";
然后注冊到分割器中,這個是在構造IDocumentPartitioner實例時作為參數傳遞進去的:
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;
- }
接下來是創建用于標識不同類型內容的Token和Rule,由于我們使用的是基于規則的Scaner(RuleBasedPartitionScanner),因此我們需要添加一對Token和Rule,這樣才能讓我們的IPartitionTokenScanner實例能感知我們定義的內容類型
根據XML定義規范,XML指令必須以結束,因此我們將這樣來定義我們的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能知道我們添加的新的內容類型,我們還需要重載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
- };
- }
安徽新華電腦學校專業職業規劃師為你提供更多幫助【在線咨詢】
