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.
Difference between revisions of "Mylyn/Porting Guide"
< Mylyn
(→Removed Tasks API) |
(→Pending Changes for Mylyn 3.0) |
||
Line 13: | Line 13: | ||
== Pending Changes for Mylyn 3.0 == | == Pending Changes for Mylyn 3.0 == | ||
Also see all tags of "API-3.0" | Also see all tags of "API-3.0" | ||
− | |||
* Rename <code>IMylarMonitorLifecycleListener</code> to <code>IMonitorLifecycleListener</code> | * Rename <code>IMylarMonitorLifecycleListener</code> to <code>IMonitorLifecycleListener</code> | ||
* Rename <code>MockRepositoryTask</code> to <code>MockTask</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 | * Refactor <code>TaskActivationHistory</code> into a <code>TaskActivityManager</code> that encapsulates both activity monitoring and activation history | ||
− | * | + | * Merge ITaskActivityListener and ITaskActivityListner2 |
− | + | ||
* Refactor ITaskActivityListener into ITaskActivationListener | * Refactor ITaskActivityListener into ITaskActivationListener | ||
* Move timing related methods to ITaskTimingListener | * Move timing related methods to ITaskTimingListener | ||
Line 34: | Line 32: | ||
* Add <code>InteractionContextScaling</code> parameter to <code>IInteractionContextReader.readContext(..)</code> | * Add <code>InteractionContextScaling</code> parameter to <code>IInteractionContextReader.readContext(..)</code> | ||
* Make a subset of <code>InteractionContextManager</code> API. | * Make a subset of <code>InteractionContextManager</code> API. | ||
− | |||
* Make <code>TaskRepository.getUserName()</code>, <code>getHttpUser</code> and <code>getProxyUsername</code> consistent | * Make <code>TaskRepository.getUserName()</code>, <code>getHttpUser</code> and <code>getProxyUsername</code> consistent | ||
* Move highlighters stuff out of <code>ContextUiPlugin</code> | * Move highlighters stuff out of <code>ContextUiPlugin</code> | ||
− | |||
* Move to using the new public URLTransfer {{bug|100095}} | * Move to using the new public URLTransfer {{bug|100095}} | ||
* Merge <code>IInteractionContextListener</code> and <code>IInteractionContextListener2</code> | * Merge <code>IInteractionContextListener</code> and <code>IInteractionContextListener2</code> | ||
* Move <code>NewTaskFromErrorAction</code> to be available to more EPP distros | * Move <code>NewTaskFromErrorAction</code> to be available to more EPP distros | ||
− | |||
* Delete <code>UiUtil</code> | * Delete <code>UiUtil</code> | ||
* Move <code>JavaStackTraceHyperlinkDetector</code> out of java.ui? See {{bug|217656}} | * Move <code>JavaStackTraceHyperlinkDetector</code> out of java.ui? See {{bug|217656}} |
Revision as of 23:11, 31 March 2008
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
IMylarMonitorLifecycleListener
toIMonitorLifecycleListener
- Rename
MockRepositoryTask
toMockTask
- 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
-
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
TaskRepository.getUserName()
,getHttpUser
andgetProxyUsername
consistent - Move highlighters stuff out of
ContextUiPlugin
- Move to using the new public URLTransfer bug 100095
- Merge
IInteractionContextListener
andIInteractionContextListener2
- Move
NewTaskFromErrorAction
to be available to more EPP distros - Delete
UiUtil
- Move
JavaStackTraceHyperlinkDetector
out of java.ui? See bug 217656
New Tasks API
-
AbstractEditQueryWizard
-
getQuerySummary()
: added
-
-
AbstractRepositoryConnector
-
isRepositoryConfigurationStale(TaskRepository)
has been added
-
-
AbstractRepositoryConnectorUi
-
getNewTaskWizard(TaskRepository, TaskSelection)
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
-
-
AbstractTaskDataHandler
-
cloneTaskData(RepositoryTaskData, RepositoryTaskData)
: 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
-
-
TaskSelection
has been added
-
TaskTextViewerConfiguration
has been added (former name was RepositoryViewerConfig)
Removed Tasks API
-
AbstractAttachmentHandler
-
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
-
-
AbstractRepositoryConnectorUi
-
getNewTaskWizard(TaskRepository taskRepository)
has been removed
-
-
TaskListManager
does not implementsIPropertyChangeListener
anymore-
ESTIMATE_TIMES
has been removed -
getActivityFuture()
has been removed (seeTaskActivityManager
) -
getActivityNextWeek()
has been removed (seeTaskActivityManager
) -
getActivityPast()
has been removed (seeTaskActivityManager
) -
getActivityPrevious()
has been removed (seeTaskActivityManager
) -
getActivityThisWeek()
has been removed (seeTaskActivityManager
) -
getActivityWeekDays()
has been removed (seeTaskActivityManager
) -
getDateRanges()
has been removed (seeTaskActivityManager
) -
getElapsedTime(AbstractTask task)
has been removed (seeTaskActivityManager
) -
getScheduledForThisWeek()
has been removed (seeTaskActivityManager
) -
getStartHour()
has been removed (seeTaskActivityManager
) -
isActiveThisWeek(AbstractTask task)
has been removed (seeTaskActivityManager
) -
isCompletedToday(AbstractTask task)
has been removed (seeTaskActivityManager
) -
isOverdue(AbstractTask task)
has been removed (seeTaskActivityManager
) -
isOwnedByUser(AbstractTask task)
has been removed (seeTaskActivityManager
) -
isScheduledAfterThisWeek(AbstractTask task)
has been removed (seeTaskActivityManager
) -
isScheduledForLater(AbstractTask task)
has been removed (seeTaskActivityManager
) -
isScheduledForThisWeek(AbstractTask task)
has been removed (seeTaskActivityManager
) -
isScheduledForToday(AbstractTask task)
has been removed (seeTaskActivityManager
) -
isWeekDay(ScheduledTaskContainer dateRangeTaskContainer)
has been removed (seeTaskActivityManager
) -
parseFutureReminders()
has been removed (seeTaskActivityManager
) -
propertyChange(PropertyChangeEvent)
has been removed (seeTaskActivityManager
) -
scheduleNewTask(AbstractTask newTask)
has been removed (seeTaskActivityManager
) -
setDueDate(AbstractTask task, Date dueDate)
has been removed (seeTaskActivityManager
) -
setScheduledEndOfDay(Calendar calendar)
has been removed (seeTaskActivityManager
) -
setScheduledFor(AbstractTask task, Date reminderDate)
has been removed (seeTaskActivityManager
) -
setScheduledNextWeek(Calendar calendar)
has been removed (seeTaskActivityManager
) -
setSecheduledIn(Calendar calendar, int days)
has been removed (seeTaskActivityManager
) -
snapToEndOfDay(Calendar cal)
has been removed (seeTaskActivityManager
) -
snapToEndOfHour(Calendar cal)
has been removed (seeTaskActivityManager
) -
snapToEndOfWeek(Calendar cal)
has been removed (seeTaskActivityManager
) -
snapToEndOfWeek(Calendar cal)
has been removed (seeTaskActivityManager
) -
snapToNextDay(Calendar cal)
has been removed (seeTaskActivityManager
) -
snapToStartOfDay(Calendar cal)
has been removed (seeTaskActivityManager
) -
snapToStartOfHour(Calendar cal)
has been removed (seeTaskActivityManager
) -
snapToStartOfWeek(Calendar cal)
has been removed (seeTaskActivityManager
)
-
-
TasksUiUtil
-
openEditor(TaskCategory)
has been removed
-
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.