Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Mylyn/Porting Guide"

(→‎Porting from Mylar 1.0 to 2.0)
(→‎Tasks Framework)
Line 17: Line 17:
 
** When returning <code>CoreException</code> pass in a <code>MylarStatus</code> with appropriate code (see <code>IMylarStatusConstants</code>).
 
** When returning <code>CoreException</code> pass in a <code>MylarStatus</code> with appropriate code (see <code>IMylarStatusConstants</code>).
 
** If <code>IMylarStatusConstants.INTERNAL_ERROR</code> is sent to <code>MylarStatusHandler.displayStatus</code> an error dialog will appear and the error will be logged.
 
** If <code>IMylarStatusConstants.INTERNAL_ERROR</code> is sent to <code>MylarStatusHandler.displayStatus</code> an error dialog will appear and the error will be logged.
 +
** <code>IMylarStatusConstants.REPOSITORY_COLLISION</code> used for mid-air collision. Pass repository url and appropriate dialog will be displayed.
  
 
* <code>ITaskDataHandler</code>
 
* <code>ITaskDataHandler</code>
 
** <code>getChangedSinceLastSync()</code> method moved to <code>AbstractRepositoryConnector</code>
 
** <code>getChangedSinceLastSync()</code> method moved to <code>AbstractRepositoryConnector</code>
 +
** New comment now held in an attribute: <code>RepositoryTaskAttribute.COMMENT_NEW</code> will need to update handler and factory to produce connector specific attribute
 +
 +
* RepositorySynchronizationManager
 +
** <code>updateOfflineState</code> is now <code>saveIncoming</code> and <code>saveOutgoing</code>.
 +
** <code>discardOutgoing</code> discards any pending outgoing changes
  
 
* <code>TaskEditor</code>
 
* <code>TaskEditor</code>
 
** <code>protected void pageChange(intNewPageIndex)</code> method removed (only called super)
 
** <code>protected void pageChange(intNewPageIndex)</code> method removed (only called super)
 +
 +
* <code>AbstractRepositoryTaskEditor</code>
 +
**<code>attributeChanged()</code> Anything that needs to be saved must be in attribute form and passed to this method. Most if this is all done for you but if you override AbstractRepositoryTaskEditor.createCustomAttributeLayout() then you will want to ensure that attributeChanged is called upon editing. Utility method createTextField() handles this call. 
 +
** <code>createLabel()</code> Utility method  added. It will put an '*' at the front of the label if the attribute has been modified. Eventually this will be applied upon editing but currently only happens after re-freshing or re-opening the editor.
  
 
* <code>TaskList</code>
 
* <code>TaskList</code>

Revision as of 19:50, 5 February 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.

Porting from Mylar 1.0 to 2.0

Tasks Framework

  • AbstractRepositoryConnectorUi
    • openRemoteTask(String repositoryUrl, String id): removed, this method no longer needs to be implemented by the connector. Instead classes can rely on the new openRepositoryTask(..) method, and override it if necessary.
  • ITaskListElement: now extends java.lang.Comparable, so Collections support of sorting can be used, since task list elements have a natural ordering. Default implementations are provided for tasks and containers. (bug 171590)
  • TasksUiUtil
    • openUrl(String url): moved to openBrowser(String url)
  • Task
    • getTooltipText(): deleted, not used
  • MylarStatus (place holder, will improve as we solidify this)
    • MylarStatusHandler.displayStatus(dialog title, IStatus status) - call to display error and information dialogs
    • When returning CoreException pass in a MylarStatus with appropriate code (see IMylarStatusConstants).
    • If IMylarStatusConstants.INTERNAL_ERROR is sent to MylarStatusHandler.displayStatus an error dialog will appear and the error will be logged.
    • IMylarStatusConstants.REPOSITORY_COLLISION used for mid-air collision. Pass repository url and appropriate dialog will be displayed.
  • ITaskDataHandler
    • getChangedSinceLastSync() method moved to AbstractRepositoryConnector
    • New comment now held in an attribute: RepositoryTaskAttribute.COMMENT_NEW will need to update handler and factory to produce connector specific attribute
  • RepositorySynchronizationManager
    • updateOfflineState is now saveIncoming and saveOutgoing.
    • discardOutgoing discards any pending outgoing changes
  • TaskEditor
    • protected void pageChange(intNewPageIndex) method removed (only called super)
  • AbstractRepositoryTaskEditor
    • attributeChanged() Anything that needs to be saved must be in attribute form and passed to this method. Most if this is all done for you but if you override AbstractRepositoryTaskEditor.createCustomAttributeLayout() then you will want to ensure that attributeChanged is called upon editing. Utility method createTextField() handles this call.
    • createLabel() Utility method added. It will put an '*' at the front of the label if the attribute has been modified. Eventually this will be applied upon editing but currently only happens after re-freshing or re-opening the editor.
  • TaskList
    • getChangeListeners(): returns a Set instead of List

Context Framework

  • AbstractContextStore
    • notifyContextStoreMoved(): change to contextStoreMoved()

Monitor Framework

  • org.eclipse.mylar.monitor: split into monitor.core and monitor.ui, organize imports and update extension point IDs
Retrieved from "https://wiki.eclipse.org/index.php?title=Mylyn/Porting_Guide&oldid=26163"

Back to the top