Mylyn WikiText

org.eclipse.mylyn.wikitext.tasks.ui.editor
Class MarkupTaskEditorExtension<MarkupLanguageType extends MarkupLanguage>

java.lang.Object
  extended by AbstractTaskEditorExtension
      extended by org.eclipse.mylyn.wikitext.tasks.ui.editor.MarkupTaskEditorExtension<MarkupLanguageType>

public class MarkupTaskEditorExtension<MarkupLanguageType extends MarkupLanguage>
extends AbstractTaskEditorExtension

A task editor extension that uses a markup language to parse content. Provides a markup-aware source editor, and a source viewer that displays markup in its intended formatted form.

Since:
1.0
Author:
David Green

Nested Class Summary
protected static class MarkupTaskEditorExtension.TaskMarkupSourceViewerConfiguration
           
protected static class MarkupTaskEditorExtension.TaskMarkupViewerConfiguration
           
 
Constructor Summary
MarkupTaskEditorExtension()
           
 
Method Summary
protected  void configureDefaultInternalLinkPattern(TaskRepository taskRepository, MarkupLanguageType markupLanguage)
          Overriding methods should set the internal hyperlink pattern of the given markup language based on some default rules applied to the task repository URL.
protected  void configureMarkupLanguage(TaskRepository taskRepository, MarkupLanguageType markupLanguage)
          Configures the markup language with settings from the task repository.
 SourceViewer createEditor(TaskRepository taskRepository, Composite parent, int style)
          Deprecated. 
 SourceViewer createEditor(TaskRepository taskRepository, Composite parent, int style, IAdaptable context)
           
protected  MarkupLanguageConfiguration createMarkupLanguageConfiguration(TaskRepository taskRepository)
           
protected  MarkupTaskEditorExtension.TaskMarkupSourceViewerConfiguration createSourceViewerConfiguration(TaskRepository taskRepository, SourceViewer viewer)
           
protected  MarkupTaskEditorExtension.TaskMarkupSourceViewerConfiguration createSourceViewerConfiguration(TaskRepository taskRepository, SourceViewer viewer, IAdaptable context)
           
 SourceViewer createViewer(TaskRepository taskRepository, Composite parent, int style)
          Deprecated. 
 SourceViewer createViewer(TaskRepository taskRepository, Composite parent, int style, IAdaptable context)
           
protected  MarkupTaskEditorExtension.TaskMarkupViewerConfiguration createViewerConfiguration(TaskRepository taskRepository, MarkupViewer markupViewer)
           
protected  MarkupTaskEditorExtension.TaskMarkupViewerConfiguration createViewerConfiguration(TaskRepository taskRepository, MarkupViewer markupViewer, IAdaptable context)
           
 String getEditorContextId()
           
 MarkupLanguageType getMarkupLanguage()
           
 void setMarkupLanguage(MarkupLanguageType markupLanguage)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MarkupTaskEditorExtension

public MarkupTaskEditorExtension()
Method Detail

getMarkupLanguage

public MarkupLanguageType getMarkupLanguage()

setMarkupLanguage

public void setMarkupLanguage(MarkupLanguageType markupLanguage)

getEditorContextId

public String getEditorContextId()

createViewer

@Deprecated
public SourceViewer createViewer(TaskRepository taskRepository,
                                            Composite parent,
                                            int style)
Deprecated. 


createViewer

public SourceViewer createViewer(TaskRepository taskRepository,
                                 Composite parent,
                                 int style,
                                 IAdaptable context)

createMarkupLanguageConfiguration

protected MarkupLanguageConfiguration createMarkupLanguageConfiguration(TaskRepository taskRepository)
Since:
1.3

createViewerConfiguration

protected MarkupTaskEditorExtension.TaskMarkupViewerConfiguration createViewerConfiguration(TaskRepository taskRepository,
                                                                                            MarkupViewer markupViewer)

createViewerConfiguration

protected MarkupTaskEditorExtension.TaskMarkupViewerConfiguration createViewerConfiguration(TaskRepository taskRepository,
                                                                                            MarkupViewer markupViewer,
                                                                                            IAdaptable context)
Since:
1.3

createSourceViewerConfiguration

protected MarkupTaskEditorExtension.TaskMarkupSourceViewerConfiguration createSourceViewerConfiguration(TaskRepository taskRepository,
                                                                                                        SourceViewer viewer)

createSourceViewerConfiguration

protected MarkupTaskEditorExtension.TaskMarkupSourceViewerConfiguration createSourceViewerConfiguration(TaskRepository taskRepository,
                                                                                                        SourceViewer viewer,
                                                                                                        IAdaptable context)
Since:
1.3

createEditor

@Deprecated
public SourceViewer createEditor(TaskRepository taskRepository,
                                            Composite parent,
                                            int style)
Deprecated. 


createEditor

public SourceViewer createEditor(TaskRepository taskRepository,
                                 Composite parent,
                                 int style,
                                 IAdaptable context)

configureMarkupLanguage

protected void configureMarkupLanguage(TaskRepository taskRepository,
                                       MarkupLanguageType markupLanguage)
Configures the markup language with settings from the task repository. Subclasses may override this method, but should call super.configureMarkupLanguage(taskRepository,markupLanguage).

Parameters:
taskRepository - the repository from which settings should be used
markupLanguage - the markup language to configure
See Also:
configureDefaultInternalLinkPattern(TaskRepository, MarkupLanguage)

configureDefaultInternalLinkPattern

protected void configureDefaultInternalLinkPattern(TaskRepository taskRepository,
                                                   MarkupLanguageType markupLanguage)
Overriding methods should set the internal hyperlink pattern of the given markup language based on some default rules applied to the task repository URL. The default implementation does nothing.

Parameters:
taskRepository - the task repository from which settings may be obtained
markupLanguage - the markup language to configure

Mylyn WikiText

Copyright © 2007, 2009 David Green and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html