Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Mylyn/Porting Guide"
(→Notable API changes in 3.2) |
(→Notable API changes in 3.2) |
||
Line 45: | Line 45: | ||
* {{bug|276651}} Severity and version have been added to the common task schema. Connectors are encouraged to map <code>TaskAttribute.SEVERITY</code> and <code>TaskAttribute.VERSION</code> in <code>TaskAttributeMapper.mapToRepositoryKey()</code>. | * {{bug|276651}} Severity and version have been added to the common task schema. Connectors are encouraged to map <code>TaskAttribute.SEVERITY</code> and <code>TaskAttribute.VERSION</code> in <code>TaskAttributeMapper.mapToRepositoryKey()</code>. | ||
− | ''Integrated Support'' | + | '''Integrated Support''' |
* {{bug|150278}} The org.eclipse.mylyn.tasks.bugs plug-in specifies an extension point for contributing a mapping from plug-in ids to task repositories or custom support handlers. | * {{bug|150278}} The org.eclipse.mylyn.tasks.bugs plug-in specifies an extension point for contributing a mapping from plug-in ids to task repositories or custom support handlers. | ||
Revision as of 02:52, 22 June 2009
Contents
General
Mylyn follows the Eclipse conventions for version numbering and guarantees binary backwards compatibility for minor releases. Internals are binary backwards compatible between service releases.
API enhancements can be tracked by searching the source code for the corresponding @since JavaDoc tags or by querying for bugs that have [api] in their summary.
Porting from 1.0 to 2.0
See the Mylyn Porting Guide 2.0
Porting from 2.0 to 3.0
See the Mylyn/Porting Guide/3.0
Notable API changes in 3.1
-
AbstractRepositoryConnectorUi.getAddExistingTaskWizard()
now returns null - New hyperlink detection bug 167941
-
AttributeEditorFactory
now requires anIContextService
to enable the WikiText task editor extensions -
AbstractTaskRepositoryLinkProvider.setTaskRepository()
may have repository set tonull
if association is cleared -
AbstractRepositorySettingsPage
is now extensible -
IUserAttentionListener.userAttentionGained()
only fired once bug 250072 -
AbstractTaskEditorPage.getEditor()
's signature has changed. - Closing of idle HttpClient connections
Breaking changes
- Constants in
AbstractRepositorySettingsPage
have changed
Notable API changes in 3.2
Context Framework
- bug 274904
AbstractContextListener
uses a singlecontextChanged(ContextChangeEvent)
method instead of separate methods for each event type. The old notification methods have been deprecated.
Tasks Framework
- bug 269407
TaskDataModel.getChangedOldAttributes()
has been implemented and the list of changed attributes is now passed toAbstractTaskDataHandler.postTaskData()
to support incremental updates to tasks. - bug 278298 To make use of the private section in the editor
setNeedsPrivateSection(true)
needs to be invoked in the constructor of classes extendingAbstractTaskEditorPage
. To suppress the planning pageAbstractTaskEditorPageFactory.getConflictingIds()
needs to returnnew String[] { ITasksUiConstants.ID_PAGE_PLANNING }
. - bug 274790 To enable the submit button in the header toolbar of the Task Editor
setNeedsSubmitButton(true)
needs to be invoked in the constructor of classes extendingAbstractTaskEditorPage
. - bug 278708 Classes extending
AbstractTaskEditorPage
that do not support submission are encouraged to invokesetNeedsSubmit(false)
in their constructor. This flag may be used in the future to hide submit button contributions and to disable key-bindings for submitting. - bug 276651 Severity and version have been added to the common task schema. Connectors are encouraged to map
TaskAttribute.SEVERITY
andTaskAttribute.VERSION
inTaskAttributeMapper.mapToRepositoryKey()
.
Integrated Support
- bug 150278 The org.eclipse.mylyn.tasks.bugs plug-in specifies an extension point for contributing a mapping from plug-in ids to task repositories or custom support handlers.
WikiText 1.1
WikiText 1.1 was released as part of Mylyn 3.2. WikiText 1.1 has several new API additions which can be found in the source by searching for @since 1.1. All API additions are non-breaking changes unless your project subclasses WikiText classes. When porting to WikiText 1.1 care should be taken to review these additions where subclassing is used.
The following changes should be noted when porting, as they may cause warnings in your projects:
- Several methods in WikiText have been marked as @noreference. These methods were previously marked as Not API in the javadoc, however @noreference is more explicit and works well with the PDT API tools. More information about these changes can be found on bug 280614
-
org.eclipse.mylyn.wikitext.ui.viewer.HtmlViewer.getStylesheet()
-
org.eclipse.mylyn.wikitext.ui.viewer.HtmlViewer.setStylesheet(Stylesheet)
-
org.eclipse.mylyn.wikitext.ui.viewer.HtmlViewerConfiguration.createAnnotationHyperlinkDetector()
-
org.eclipse.mylyn.wikitext.tasks.ui.editor.MarkupTaskEditorExtension.TaskMarkupViewerConfiguration.createAnnotationHyperlinkDetector()
-
Pending changes for 3.3
None.