Changes between Version 7 and Version 8 of Migration_of_MSPlugins

Timestamp:

11/10/2016 10:10:44 PM (4 years ago)

Author:

sena

Comment:

--

Migration_of_MSPlugins

@@ -63 +63 @@
 }}}
 
-The above code is from MassSpecMultiPageViewer class. This multi-page editor needs to update its table's column visibility whenever MassSpecViewerPreference gets updated.
+The above code is from MassSpecMultiPageViewer class (entry.ms plugin). This multi-page editor needs to update its table's column visibility whenever MassSpecViewerPreference gets updated.
+
+Similarly, MSAnnotationMultiPageViewer (entry.ms.annotation plugin) needs to listen to the changes in MSAnnotationViewerPreference as shown below:
+
+{{{
+        @Optional @Inject
+        public void updatePreferences(@UIEventTopic(IGritsPreferenceStore.EVENT_TOPIC_PREF_VALUE_CHANGED)
+                                                String preferenceName)
+        {
+                if(preferenceName != null && preferenceName.startsWith(MSAnnotationViewerPreference.class.getName())) {
+                        PreferenceEntity preferenceEntity;
+                        try {
+                                preferenceEntity = gritsPreferenceStore.getPreferenceEntity(preferenceName);
+                        
+                                MSAnnotationViewerPreference updatePref = (MSAnnotationViewerPreference) TableViewerPreference.getTableViewerPreference(preferenceEntity, MSAnnotationViewerPreference.class);
+                                this.updateColumnVisibility(updatePref);
+                        } catch (UnsupportedVersionException e) {
+                                logger.error("Error updating column visibility", e);
+                        }
+                }
+        }
+}}}
+
+
+MSGlycanAnnotationMultiPageViewer (entry.ms.annotation.glycan) needs to listen to the changes for two types (MSGlycanAnnotationViewerPreference and MSGlycanAnnotationSummaryViewerPreference) of preferences.
+
+{{{
+        @Optional @Inject
+        public void updatePreferences(@UIEventTopic(IGritsPreferenceStore.EVENT_TOPIC_PREF_VALUE_CHANGED)
+                                                String preferenceName)
+        {
+                if(preferenceName != null && preferenceName.startsWith(MSGlycanAnnotationViewerPreference.class.getName())) {
+                        PreferenceEntity preferenceEntity;
+                        try {
+                                preferenceEntity = gritsPreferenceStore.getPreferenceEntity(preferenceName);
+                        
+                                MSGlycanAnnotationViewerPreference updatePref = (MSGlycanAnnotationViewerPreference) TableViewerPreference.getTableViewerPreference(preferenceEntity,        MSGlycanAnnotationViewerPreference.class);
+                                this.updateColumnVisibility(updatePref);
+                        } catch (UnsupportedVersionException e) {
+                                logger.error("Error updating column visibility", e);
+                        }
+                }
+                
+                if(preferenceName != null && preferenceName.startsWith(MSGlycanAnnotationSummaryViewerPreference.class.getName())) {
+                        PreferenceEntity preferenceEntity;
+                        try {
+                                preferenceEntity = gritsPreferenceStore.getPreferenceEntity(preferenceName);
+                        
+                                MSGlycanAnnotationSummaryViewerPreference updatePref = (MSGlycanAnnotationSummaryViewerPreference) TableViewerPreference.getTableViewerPreference(preferenceEntity, MSGlycanAnnotationSummaryViewerPreference.class);
+                                this.updateColumnVisibility(updatePref);
+                        } catch (UnsupportedVersionException e) {
+                                logger.error("Error updating column visibility", e);
+                        }
+                }
+        }
+}}}
+
+The tables in this multi-page editor also need to be updated with cartoon options changes (MSGlycanAnnotationCartoonPreferences).
+
+This is handled in MSGlycanAnnotationPeakView as shown below:
+
+{{{
+        /**
+         * This method is called whenever a preference change occurs
+         * We need to act upon cartoon preference changes for this view 
+         * 
+         * @param preferenceName
+         */
+        @Optional @Inject
+        public void updatePreferences(@UIEventTopic(IGritsPreferenceStore.EVENT_TOPIC_PREF_VALUE_CHANGED)
+                                                String preferenceName)
+        {
+                if (MSGlycanAnnotationCartoonPreferences.getPreferenceID().equals(preferenceName)) {
+                        try {
+                                MSGlycanAnnotationSelectionView sv = (MSGlycanAnnotationSelectionView) this.getCurrentSelectionView();
+                                if( sv != null && sv.getSubTable() != null ) {
+                                        ((MSGlycanAnnotationTable) sv.getSubTable()).refreshTableImages();
+                                }
+                        } catch( Exception e ) {
+                                logger.error("Could not refresh subtable images", e);
+                        }
+                        
+                        try {
+                                MassSpecTableBase viewBase = (MassSpecTableBase) ( (IMSPeaksViewer) this ).getViewBase();
+                                ((MSGlycanAnnotationTable) viewBase.getNatTable()).refreshTableImages();
+                        } catch( Exception e ) {
+                                logger.error("Could not refresh table images", e);
+                        }
+                }
+        }
+}}}
+
+
+