Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Mylyn/Porting Guide
< Mylyn
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
Also see all tags of "API-3.0"
- Rename
AbstractRepositoryQuery.getRepositoryKind()
toAbstractRepositoryQuery.getConnectorKind()
- Rename
IMylarMonitorLifecycleListener
toIMonitorLifecycleListener
- Rename
MockRepositoryTask
toMockTask
- Refactor
TaskActivationHistory
into aTaskActivityManager
that encapsulates both activity monitoring and activation history- Remove all deprecated methods from TaskListManager
-
AbstractTaskListPresentation
: make API, remove coupling toTaskListView
-
TaskGroup
andTaskCategory
: 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 - Make
IMonitoredWindow
API and put alongsideIContextAwareEditor
- merge
AbstractRepositoryTaskEditor.createAttributeSection
intocreateAttributeLayout()
- Make API:
InteractionContextScaling
- Rename
AbstractTask.RepositoryTaskSyncState
toAbstractTask.SyncState
("sync" is used commonly enough that we should be able to standardize on it in the API, replacing "synchronization/synchronize" where applicable). - Add
InteractionContextScaling
parameter toIInteractionContextReader.readContext(..)
- Make a subset of
InteractionContextManager
API. - Make
AbstractContextUiPlugin
API. - Make
TaskRepository.getUserName()
,getHttpUser
andgetProxyUsername
consistent - Move highlighters stuff out of
ContextUiPlugin
New Tasks API
-
AbstractEditQueryWizard
-
getQuerySummary()
: added
-
-
AbstractRepositoryConnector
-
isRepositoryConfigurationStale(TaskRepository)
has been added
-
-
AbstractRenderingEngine
has been added for converting Wiki syntax to HTML
-
AbstractRepositoryQueryPage
-
setControlsEnabled(...)
: added - override to perform finer grain enablements if necessary
-
-
AbstractRepositoryTaskEditor
has 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) -
DescriptionListener
is now protected (was private) -
getParentEditor()
: added -
getRenderingEngine()
: added -
removeSelectableControl()
: added -
fillToolBar(..)
: added
-
-
AbstractUserActivityMonitor
-
isEnabled()
: added -
getOriginId()
: added -
getStructureKind()
: added -
getStructureHandle()
: added
-
-
RepositoryTaskAttribute
- task.common.user.reporter.name : added : key for full name of issue reporter
- task.common.comment.author.name : added : key for full name of comment author
- task.common.user.assigned.name : added : key for full name of issue assignee
-
TaskEditor
- class no longer final (experimental extensibility)
-
TaskListManager
-
resolveIdentifiersConflict()
: added -
removeFromQuery()
: added
-
-
TaskTextViewerConfiguration
has 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).
-
AbstractFocusViewAction.setLinkingActionEnabled(boolean)
: should be overridden if view provides linking
-
InteractionContextScaling.getScaling()
: new method, prevoiusly on subtype only
New Montior API
-
MonitorUiPlugin.getMonitoredWindows()
: use insteand ofPlatformUI.getWorkbench().getWorkbenchWindows()
-
MonitorUiPlugin.getLaunchingWorkbenchWindow()
: use to get the first active window when the monitor started.