org.eclipse.mylyn.wikitext.core.parser.outline
Class OutlineParser

java.lang.Object
  extended by org.eclipse.mylyn.wikitext.core.parser.outline.OutlineParser
Direct Known Subclasses:
SplittingOutlineParser

public class OutlineParser
extends Object

A parser for creating an outline of a document based on the headings in the document. Uses a markup language to determine where headings start and end.

Since:
1.0
Author:
David Green
See Also:
OutlineItem

Nested Class Summary
protected  class OutlineParser.OutlineBuilder
          A document builder that creates the outline structure based on headings in the document
 
Constructor Summary
OutlineParser()
           
OutlineParser(MarkupLanguage markupLanguage)
           
 
Method Summary
protected  OutlineItem createOutlineItem(OutlineItem current, int level, String id, int offset, int length, String label)
           
 DocumentBuilder createOutlineUpdater(OutlineItem rootItem)
           
 OutlineItem createRootItem()
           
 int getLabelMaxLength()
           
 MarkupLanguage getMarkupLanguage()
           
protected  boolean isBlocksOnly()
          normally outline parsing is performed only on blocks.
 OutlineItem parse(OutlineItem root, String markup)
           
 OutlineItem parse(String markup)
           
 void setLabelMaxLength(int labelMaxLength)
           
 void setMarkupLanguage(MarkupLanguage markupLanguage)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutlineParser

public OutlineParser(MarkupLanguage markupLanguage)

OutlineParser

public OutlineParser()
Method Detail

getLabelMaxLength

public int getLabelMaxLength()

setLabelMaxLength

public void setLabelMaxLength(int labelMaxLength)

parse

public OutlineItem parse(String markup)

getMarkupLanguage

public MarkupLanguage getMarkupLanguage()

setMarkupLanguage

public void setMarkupLanguage(MarkupLanguage markupLanguage)

createRootItem

public OutlineItem createRootItem()

parse

public OutlineItem parse(OutlineItem root,
                         String markup)

isBlocksOnly

protected boolean isBlocksOnly()
normally outline parsing is performed only on blocks. Overriding classes may return false if they wish to process all content.


createOutlineItem

protected OutlineItem createOutlineItem(OutlineItem current,
                                        int level,
                                        String id,
                                        int offset,
                                        int length,
                                        String label)

createOutlineUpdater

public DocumentBuilder createOutlineUpdater(OutlineItem rootItem)


Copyright © 2011 FuseSource, Corp.. All Rights Reserved.