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"
< Mylyn
(→Pending Changes for Mylyn 3.0) |
(→Porting from 2.0 to 3.0) |
||
| Line 10: | Line 10: | ||
There is currently no need to port Mylyn from the 2.0 APIs since current Mylyn releases are backwards compatible. Throughout the 2.x release cycle we will be using this wiki to gather changes and suggestions for improving the APIs for 3.0. | There is currently no need to port Mylyn from the 2.0 APIs since current Mylyn releases are backwards compatible. Throughout the 2.x release cycle we will be using this wiki to gather changes and suggestions for improving the APIs for 3.0. | ||
| − | == Tasks API == | + | |
| + | == Pending Changes for Mylyn 3.0 == | ||
| + | * Rename <code>AbstractRepositoryQuery.getRepositoryKind()</code> to <code>AbstractRepositoryQuery.getConnectorKind()</code> | ||
| + | * Rename <code>IMylarMonitorLifecycleListener</code> to <code>IMonitorLifecycleListener</code> | ||
| + | * Rename <code>MockRepositoryTask</code> to <code>MockTask</code> | ||
| + | * Refactor <code>TaskActivationHistory</code> into a <code>TaskActivityManager</code> that encapsulates both activity monitoring and activation history | ||
| + | ** Remove all deprecated methods from TaskListManager | ||
| + | * <code>AbstractTaskListPresentation</code>: make API, remove coupling to <code>TaskListView</code> | ||
| + | * <code>TaskGroup</code> and <code>TaskCategory</code>: consider for API, refactor or combine | ||
| + | * consider merging <code>TaskList.removeFromCategory()</code> and <code>TaskList.removeFromQuery()</code> | ||
| + | * Deprecate <code>WebClientUtil.getPlatformProxy()</code> | ||
| + | * Move <code>TasksUiPlugin.getIncomingNotification(..)</code> and related private classes | ||
| + | * <code>AbstractTask.setCompleted()</code> needs changing, it has the problematic side effect of setting the completion date to the current time. {{bug|203875}} | ||
| + | * Remove <code>AbstractInterestManipulationAction.isRemove()</code>: deprecated | ||
| + | |||
| + | |||
| + | |||
| + | == New Tasks API == | ||
* <code>AbstractEditQueryWizard</code> | * <code>AbstractEditQueryWizard</code> | ||
| Line 44: | Line 61: | ||
* <code>TaskTextViewerConfiguration</code> has been added (former name was RepositoryViewerConfig) | * <code>TaskTextViewerConfiguration</code> has been added (former name was RepositoryViewerConfig) | ||
| − | == | + | == New Context API == |
| − | * | + | |
| − | + | * <code>AbstractFocusViewAction.updateEnablementWithContextActivation()</code>: override to return false for focus actions that are not related to context activations (e.g. the Task List). | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Revision as of 17:10, 25 September 2007
This document will have Mylar 2.0 specific API changes added to it as we make them. If interested in keeping up with these changes we suggest setting a watch for this page. Note that changes involving classes moving packages are not listed, use Organize Imports to resolve.
Contents
Porting from 1.0 to 2.0
See the Mylyn Porting Guide 2.0
Porting from 2.0 to 3.0
There is currently no need to port Mylyn from the 2.0 APIs since current Mylyn releases are backwards compatible. Throughout the 2.x release cycle we will be using this wiki to gather changes and suggestions for improving the APIs for 3.0.
Pending Changes for Mylyn 3.0
- Rename
AbstractRepositoryQuery.getRepositoryKind()toAbstractRepositoryQuery.getConnectorKind() - Rename
IMylarMonitorLifecycleListenertoIMonitorLifecycleListener - Rename
MockRepositoryTasktoMockTask - Refactor
TaskActivationHistoryinto aTaskActivityManagerthat encapsulates both activity monitoring and activation history- Remove all deprecated methods from TaskListManager
-
AbstractTaskListPresentation: make API, remove coupling toTaskListView -
TaskGroupandTaskCategory: consider for API, refactor or combine - consider merging
TaskList.removeFromCategory()andTaskList.removeFromQuery() - Deprecate
WebClientUtil.getPlatformProxy() - Move
TasksUiPlugin.getIncomingNotification(..)and related private classes -
AbstractTask.setCompleted()needs changing, it has the problematic side effect of setting the completion date to the current time. bug 203875 - Remove
AbstractInterestManipulationAction.isRemove(): deprecated
New Tasks API
-
AbstractEditQueryWizard-
getQuerySummary(): added
-
-
AbstractRepositoryConnector-
isRepositoryConfigurationStale(TaskRepository)has been added
-
-
AbstractRenderingEnginehas been added for converting Wiki syntax to HTML
-
AbstractRepositoryTaskEditorhas been extended to provide HTML preview capabilities for repositories that support Wiki syntax in ticket descriptions and comments-
addSelectableControl(): added -
createReplyHyperlink()is now protected (was private) -
DescriptionListeneris now protected (was private) -
getParentEditor(): added -
getRenderingEngine(): added -
removeSelectableControl(): added -
fillToolBar(..): added
-
-
AbstractUserActivityMonitor-
isEnabled(): added -
getOriginId(): added -
getStructureKind(): added -
getStructureHandle(): added
-
-
TaskEditor- class no longer final (experimental extensibility)
-
TaskListManager-
resolveIdentifiersConflict(): added -
removeFromQuery(): added
-
-
TaskTextViewerConfigurationhas been added (former name was RepositoryViewerConfig)
New Context API
-
AbstractFocusViewAction.updateEnablementWithContextActivation(): override to return false for focus actions that are not related to context activations (e.g. the Task List).