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
(→Porting from 2.0 to 3.0) |
(→Removed Tasks API) |
||
Line 51: | Line 51: | ||
== Removed Tasks API == | == Removed Tasks API == | ||
− | * <code>AbstractAttachmentHandler</code> has been | + | * <code>AbstractAttachmentHandler</code> has been removed, use <code>AbstractTaskAttachmentHandler</code> instead |
** <code>MESSAGE_ATTACHMENTS_NOT_SUPPORTED</code> has been removed | ** <code>MESSAGE_ATTACHMENTS_NOT_SUPPORTED</code> has been removed | ||
** <code>MYLAR_CONTEXT_DESCRIPTION</code> has been removed | ** <code>MYLAR_CONTEXT_DESCRIPTION</code> has been removed | ||
Line 61: | Line 61: | ||
** <code>retrieveContext()</code> has been moved to the internal class <code>AttachmentUtil</code> | ** <code>retrieveContext()</code> has been moved to the internal class <code>AttachmentUtil</code> | ||
− | * <code>AbstractAttributeFactory</code> has been | + | * <code>AbstractAttributeFactory</code> has been removed, use <code>TaskAttributeMapper</code> instead |
* <code>AbstractDuplicateDetector</code> has been moved to tasks.core | * <code>AbstractDuplicateDetector</code> has been moved to tasks.core | ||
Line 67: | Line 67: | ||
* <code>AbstractEditQueryWizard</code> has been renamed to <code>AbstractRepositoryQueryWizard</code> | * <code>AbstractEditQueryWizard</code> has been renamed to <code>AbstractRepositoryQueryWizard</code> | ||
− | * <code>AbstractNewRepositoryTaskEditor</code> has been | + | * <code>AbstractNewRepositoryTaskEditor</code> has been removed, use <code>AbstractTaskEditorPage</code> instead |
* <code>AbstractRepositoryConnector</code> | * <code>AbstractRepositoryConnector</code> | ||
− | ** All methods that used | + | ** All methods that used removed types have been moved to the internal class <code>AbstractLegacyRepositoryConnector</code>. Connectors that have not been ported to the new task data architecture may extend this class to continue using old APIs. Support for the old architecture may be '''removed at any time'''. |
* <code>AbstractRepositoryConnectorUi</code> | * <code>AbstractRepositoryConnectorUi</code> | ||
+ | ** <code>forceSubtaskHierarchy()</code> has been removed, override <code>hasStrictSubtaskHierarchy()</code> instead | ||
** <code>getNewTaskWizard(TaskRepository)</code> has been removed, use <code>getNewTaskWizard(TaskRepository, ITaskMapping)</code> instead | ** <code>getNewTaskWizard(TaskRepository)</code> has been removed, use <code>getNewTaskWizard(TaskRepository, ITaskMapping)</code> instead | ||
− | ** <code>getTaskKindLabel(RepositoryTaskData)</code> has been removed, | + | ** <code>getTaskKindLabel(RepositoryTaskData)</code> has been removed |
+ | ** <code>getTaskListElementIcon()</code> has been removed, override <code>getImageDescriptor()</code> instead | ||
+ | ** <code>isCustomNotificationHandling()</code> has been removed, override <code>hasCustomNotificationHandling()</code> instead | ||
** <code>openEditQueryDialog(AbstractRepositoryQuery)</code> has been moved to the internal class <code>TasksUiInternal</code> | ** <code>openEditQueryDialog(AbstractRepositoryQuery)</code> has been moved to the internal class <code>TasksUiInternal</code> | ||
− | ** <code>setCustomNotificationHandling()</code> has been removed, override <code> | + | ** <code>openRepositoryTask()</code> has been moved to the internal class <code>TasksUiInternal</code> |
+ | ** <code>setCustomNotificationHandling()</code> has been removed, override <code>hasCustomNotificationHandling()</code> instead | ||
** <code>supportsDueDates(AbstractTask)</code> has been removed, override <code>AbstractRepositoryConnector.hasRepositoryDueDate()</code> instead | ** <code>supportsDueDates(AbstractTask)</code> has been removed, override <code>AbstractRepositoryConnector.hasRepositoryDueDate()</code> instead | ||
− | * <code>AbstractRepositoryQuery</code> has been | + | * <code>AbstractRepositoryQuery</code> has been removed, use <code>IRepositoryQuery</code> instead |
** <code>getRepositoryKind()</code> has been renamed to <code>getConnectorKind()</code> | ** <code>getRepositoryKind()</code> has been renamed to <code>getConnectorKind()</code> | ||
* <code>AbstractRepositoryQueryPage</code> has been moved to <code>org.eclipse.mylyn.tasks.ui.wizards</code> | * <code>AbstractRepositoryQueryPage</code> has been moved to <code>org.eclipse.mylyn.tasks.ui.wizards</code> | ||
− | * <code>AbstractRepositoryTaskEditor</code> has been | + | * <code>AbstractRepositoryTaskEditor</code> has been removed, use <code>AbstractTaskEditorPage</code> instead |
* <code>AbstractRepositoryQueryWizard</code> has been removed, use <code>RepositoryQueryWizard</code> instead | * <code>AbstractRepositoryQueryWizard</code> has been removed, use <code>RepositoryQueryWizard</code> instead | ||
− | * <code>AbstractTask</code> has been | + | * <code>AbstractTask</code> has been removed, use <code>ITask</code> instead |
** <code>hasValidUrl()</code> has been moved to <code>TasksUiInternal.isValidUrl()</code> | ** <code>hasValidUrl()</code> has been moved to <code>TasksUiInternal.isValidUrl()</code> | ||
** <code>setCompleted()</code> has been removed, a non-null completion date indicates a task is complete | ** <code>setCompleted()</code> has been removed, a non-null completion date indicates a task is complete | ||
− | * <code>AttributeContainer</code> has been | + | * <code>AttributeContainer</code> has been removed, use <code>TaskAttribute</code> instead |
* <code>DatePicker</code> has been moved to <code>org.eclipse.mylyn.commons.ui</code> | * <code>DatePicker</code> has been moved to <code>org.eclipse.mylyn.commons.ui</code> | ||
Line 98: | Line 102: | ||
* <code>DateSelectionDialog</code> has been moved to <code>org.eclipse.mylyn.commons.ui</code> | * <code>DateSelectionDialog</code> has been moved to <code>org.eclipse.mylyn.commons.ui</code> | ||
− | * <code>FileAttachment</code> has been | + | * <code>FileAttachment</code> has been removed, use <code>AbstractTaskAttachmentSource</code> instead |
* <code>GzipGetMethod</code> has been moved to an internal package | * <code>GzipGetMethod</code> has been moved to an internal package | ||
Line 106: | Line 110: | ||
* <code>IStatusHandler</code> has been removed, use <code>AbstractErrorReporter</code> instead | * <code>IStatusHandler</code> has been removed, use <code>AbstractErrorReporter</code> instead | ||
− | * <code>ITaskCollector</code> has been | + | * <code>ITaskCollector</code> has been removed, use <code>TaskDataCollector</code> instead |
− | * <code>ITaskFactory</code> has been | + | * <code>ITaskFactory</code> has been removed |
− | * <code> | + | * <code>ITaskRepositoryListener</code> has been renamed to <code>IRepositoryListener</code> |
− | * <code> | + | * <code>ITaskListChangeListener</code> has been moved to an internal package |
− | * <code> | + | * <code>NewTaskEditorInput</code> has been removed, use <code>TaskEditorInput</code> instead |
− | * <code>RepositoryOperation</code> has been | + | * <code>QueryHitCollector</code> has been removed, use <code>TaskDataCollector</code> instead |
+ | |||
+ | * <code>RepositoryAttachment</code> has been removed, use <code>TaskAttachmentMapper</code> instead | ||
+ | |||
+ | * <code>RepositoryOperation</code> has been removed, use <code>TaskOperationMapper</code> instead | ||
* <code>RepositorySearchResult</code> has been moved to an internal package | * <code>RepositorySearchResult</code> has been moved to an internal package | ||
− | * <code>RepositoryTaskData</code> has been | + | * <code>RepositoryTaskData</code> has been removed, use <code>TaskData</code> instead |
− | * <code>RepositoryTaskEditorInput</code> has been | + | * <code>RepositoryTaskEditorInput</code> has been removed, use <code>TaskEditorInput</code> instead |
* <code>SearchHitCollector</code> has been moved to an internal package | * <code>SearchHitCollector</code> has been moved to an internal package | ||
Line 147: | Line 155: | ||
** <code>actionContributor</code> has been removed | ** <code>actionContributor</code> has been removed | ||
− | * <code>TaskFactory</code> has been | + | * <code>TaskFactory</code> has been removed |
* <code>TaskListManager</code> has been moved to an internal package and replaced by <code>ITaskListManager</code> | * <code>TaskListManager</code> has been moved to an internal package and replaced by <code>ITaskListManager</code> | ||
Line 161: | Line 169: | ||
* <code>TaskList</code> has been moved to an internal package and replaced by <code>ITaskList</code> | * <code>TaskList</code> has been moved to an internal package and replaced by <code>ITaskList</code> | ||
− | * <code>TaskSelection</code> has been | + | * <code>TaskSelection</code> has been removed, use <code>ITaskMapping</code> instead |
* <code>TasksUiProxyChangeListener</code> has been removed | * <code>TasksUiProxyChangeListener</code> has been removed | ||
Line 180: | Line 188: | ||
* <code>WebCorePlugin</code> has been moved to an internal package | * <code>WebCorePlugin</code> has been moved to an internal package | ||
+ | |||
+ | * <code>WebHyperlink</code> has been moved to an internal package | ||
== New Context API == | == New Context API == |
Revision as of 23:56, 1 June 2008
NOTE: Mylyn 3.0 changes are currently in progress, and we recommend building against the Mylyn 2.x stream. See bug 227660 for the plan and for details. If interested in API progress, we recommend adding a watch for this page and a CC for that bug.
Contents
Porting from 1.0 to 2.0
See the Mylyn Porting Guide 2.0
Porting from 2.0 to 3.0
Migrating Data
- Migration of LastReadTimeStamp
- Migration of date formats when using attribute mappers
- Migration of TaskData
Plug-in Refactorings
-
org.eclipse.mylyn.web.core
is noworg.eclipse.mylyn.commons.net
- Core classes from
org.eclipse.mylyn.monitor.core
was split in order to make API not coupled to the Monitor component be reusable independently, now in the neworg.eclipse.mylyn.commons.core
plug-in. -
org.eclipse.mylyn.commons.ui
is a new API for common UI components that are not coupled to the rest of Mylyn.
Changed Extension Points
-
org.eclipse.mylyn.tasks.ui.editors
-
hyperLinkDetector
has been removed, useorg.eclipse.ui.workbench.texteditor.hyperlinkDetectors
instead and settargetId
toorg.eclipse.mylyn.tasks.ui.TaskEditor
-
editorFactory
has been removed, usepageFactory
instead
-
-
repositories
-
taskListFactory
has been removed, usetaskListMirgrator
instead -
connectorCore
-
userManaged
has been removed, overrideisUserManaged()
inAbstractRepositoryConnector
instead
-
-
connectorUi
-
customNotifications
has been removed, overrideisCustomNotification()
inAbstractRepositoryConnectorUi
instead
-
-
Changed Team API
-
org.eclipse.mylyn.tasks.core.ILinkedTaskInfo
is noworg.eclipse.mylyn.team.ui.AbstractTaskReference
-
getComment()
has been renamed togetText()
-
New Tasks API
-
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
Removed Tasks API
-
AbstractAttachmentHandler
has been removed, useAbstractTaskAttachmentHandler
instead-
MESSAGE_ATTACHMENTS_NOT_SUPPORTED
has been removed -
MYLAR_CONTEXT_DESCRIPTION
has been removed -
MYLAR_CONTEXT_DESCRIPTION_LEGACY
has been removed -
MYLAR_CONTEXT_FILENAME
has been removed -
attachContextAttachments()
has been moved to the internal classAttachmentUtil
-
getContextAttachments()
has been moved to the internal classAttachmentUtil
-
hasRepositoryContext()
has been moved to the internal classAttachmentUtil
-
retrieveContext()
has been moved to the internal classAttachmentUtil
-
-
AbstractAttributeFactory
has been removed, useTaskAttributeMapper
instead
-
AbstractDuplicateDetector
has been moved to tasks.core
-
AbstractEditQueryWizard
has been renamed toAbstractRepositoryQueryWizard
-
AbstractNewRepositoryTaskEditor
has been removed, useAbstractTaskEditorPage
instead
-
AbstractRepositoryConnector
- All methods that used removed types have been moved to the internal class
AbstractLegacyRepositoryConnector
. Connectors that have not been ported to the new task data architecture may extend this class to continue using old APIs. Support for the old architecture may be removed at any time.
- All methods that used removed types have been moved to the internal class
-
AbstractRepositoryConnectorUi
-
forceSubtaskHierarchy()
has been removed, overridehasStrictSubtaskHierarchy()
instead -
getNewTaskWizard(TaskRepository)
has been removed, usegetNewTaskWizard(TaskRepository, ITaskMapping)
instead -
getTaskKindLabel(RepositoryTaskData)
has been removed -
getTaskListElementIcon()
has been removed, overridegetImageDescriptor()
instead -
isCustomNotificationHandling()
has been removed, overridehasCustomNotificationHandling()
instead -
openEditQueryDialog(AbstractRepositoryQuery)
has been moved to the internal classTasksUiInternal
-
openRepositoryTask()
has been moved to the internal classTasksUiInternal
-
setCustomNotificationHandling()
has been removed, overridehasCustomNotificationHandling()
instead -
supportsDueDates(AbstractTask)
has been removed, overrideAbstractRepositoryConnector.hasRepositoryDueDate()
instead
-
-
AbstractRepositoryQuery
has been removed, useIRepositoryQuery
instead-
getRepositoryKind()
has been renamed togetConnectorKind()
-
-
AbstractRepositoryQueryPage
has been moved toorg.eclipse.mylyn.tasks.ui.wizards
-
AbstractRepositoryTaskEditor
has been removed, useAbstractTaskEditorPage
instead
-
AbstractRepositoryQueryWizard
has been removed, useRepositoryQueryWizard
instead
-
AbstractTask
has been removed, useITask
instead-
hasValidUrl()
has been moved toTasksUiInternal.isValidUrl()
-
setCompleted()
has been removed, a non-null completion date indicates a task is complete
-
-
AttributeContainer
has been removed, useTaskAttribute
instead
-
DatePicker
has been moved toorg.eclipse.mylyn.commons.ui
-
DateSelectionDialog
has been moved toorg.eclipse.mylyn.commons.ui
-
FileAttachment
has been removed, useAbstractTaskAttachmentSource
instead
-
GzipGetMethod
has been moved to an internal package
-
GzipPostMethod
has been moved to an internal package
-
IStatusHandler
has been removed, useAbstractErrorReporter
instead
-
ITaskCollector
has been removed, useTaskDataCollector
instead
-
ITaskFactory
has been removed
-
ITaskRepositoryListener
has been renamed toIRepositoryListener
-
ITaskListChangeListener
has been moved to an internal package
-
NewTaskEditorInput
has been removed, useTaskEditorInput
instead
-
QueryHitCollector
has been removed, useTaskDataCollector
instead
-
RepositoryAttachment
has been removed, useTaskAttachmentMapper
instead
-
RepositoryOperation
has been removed, useTaskOperationMapper
instead
-
RepositorySearchResult
has been moved to an internal package
-
RepositoryTaskData
has been removed, useTaskData
instead
-
RepositoryTaskEditorInput
has been removed, useTaskEditorInput
instead
-
SearchHitCollector
has been moved to an internal package
-
SslProtocolSocketFactory
has been moved to an internal package
-
StatusHandler
-
addDefaultStatusHandler(IStatusHandler)
has been removed -
addStatusHandler(IStatusHandler)
has been removed -
fail(Throwable,String,boolean)
has been removed -
fail(Throwable,String,boolean,int)
has been removed -
getDefaultStatusHandler()
has been removed -
getStatusHandler()
has been removed -
log(String,Object)
has been removed -
log(Throwable,String)
has been removed -
setDefaultStatusHandler(IStatusHandler)
has been removed -
removeStatusHandler(IStatusHandler)
has been removed
-
-
TaskActivityManager
-
getInstance()
has been removed, useTasksUiPlugin.getTaskActivityManager()
instead -
init()
has been replaced by a public constructor
-
-
TaskFormPage
-
actionContributor
has been removed
-
-
TaskFactory
has been removed
-
TaskListManager
has been moved to an internal package and replaced byITaskListManager
- task activity related methods have been removed (see
TaskActivityManager
)
- task activity related methods have been removed (see
-
TaskRepositoryManager
has been moved to an internal package and replaced byITaskRepositoryManager
-
TaskEditor
-
configureContextMenuManager(MenuManager,TextViewer)
has been removed -
getAdapterDelegate()
has been removed -
getContributor()
has been removed
-
-
TaskList
has been moved to an internal package and replaced byITaskList
-
TaskSelection
has been removed, useITaskMapping
instead
-
TasksUiProxyChangeListener
has been removed
-
TasksUiUtil
-
closeEditorInActivePage(ITask,boolean)
has been moved to the internal classTasksUiInternal
-
getActiveRepositoryTaskEditor()
has been moved to the internal classTasksUiInternal
-
isAnimationsEnabled()
has been moved to the internal classTasksUiInternal
-
openEditor(TaskCategory)
has been moved to the internal classTasksUiInternal
-
openEditor(AbstractTask, boolean)
has been replaced byopenTask(ITask)
-
openEditor(AbstractTask, boolean, boolean)
has been replaced byopenTask(ITask)
-
openEditor(AbstractTask, String)
has been replaced byopenTask(ITask)
-
openUrl(String, boolean)
has been replaced byopenTask(String)
andopenUrl(String)
-
refreshAndOpenTaskListElement()
has been moved to the internal classTasksUiInternal
-
showPreferencesPage(String, IPreferencePAge)
has been removed
-
-
TrustAllTrustManager
has been moved to an internal package
-
WebCorePlugin
has been moved to an internal package
-
WebHyperlink
has been moved to an internal package
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
Removed Context API
-
IInteractionContextListener
was renamed toAbstractContextListener
-
BrowseFilteredAction
has been moved to an internal package -
ContextCorePlugin
has been moved to an internal package and replaced byContextCore
-
ContextUiPlugin
has been moved to an internal package and replaced byContextUi
-
InteractionContextReader
has been moved to an internal package -
InteractionContextWriter
has been moved to an internal package -
MonitorUiPlugin
has been moved to an internal package and replaced byMonitorUi
-
ResourcesUiPlugin
has been moved to an internal package and replaced byResourcesUi
New Monitor API
-
MonitorUiPlugin.getMonitoredWindows()
: use insteand ofPlatformUI.getWorkbench().getWorkbenchWindows()
-
MonitorUiPlugin.getLaunchingWorkbenchWindow()
: use to get the first active window when the monitor started.
Removed Monitor API
-
IMylarMonitorLifecycleListener
has been renamed toIMonitorLifecycleListener
-
ReportGenerator
has been moved to an internal package
Pending Changes
This list is stale. Also see all source code tags titled "API-3.0"
- Refactor
TaskActivationHistory
into aTaskActivityManager
that encapsulates both activity monitoring and activation history - Merge ITaskActivityListener and ITaskActivityListner2
- Refactor ITaskActivityListener into ITaskActivationListener
- Move timing related methods to ITaskTimingListener
- Make
IMonitoredWindow
API and put alongsideIContextAwareEditor
- Make API:
InteractionContextScaling
- Add
InteractionContextScaling
parameter toIInteractionContextReader.readContext(..)
- Make a subset of
InteractionContextManager
API.