changeset 26:183c3e96f6c3

cleaned code
author dwinter
date Mon, 10 Jan 2011 12:01:25 +0100
parents 6e7bb3467531
children 361d8c89338a
files plugin.xml src/de/mpg/mpiwg/itgroup/digilib/digiImage/DigiImage.java src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/DigiImagePropertyListener.java src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/DigiImagePropertySection.java src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/PropertyListener.java src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/RedrawButtonListener.java src/de/mpg/mpiwg/itgroup/digilib/plugin/PluginPreferenceInitializer.java src/de/mpg/mpiwg/itgroup/digilib/plugin/PluginPreferencePage.java src/de/mpg/mpiwg/itgroup/digilib/plugin/editors/DigilibLinkEditorPart.java src/de/mpg/mpiwg/itgroup/digilib/plugin/preferences/PluginPreferenceInitializer.java src/de/mpg/mpiwg/itgroup/digilib/plugin/preferences/PluginPreferencePage.java
diffstat 11 files changed, 146 insertions(+), 132 deletions(-) [+]
line wrap: on
line diff
--- a/plugin.xml	Mon Jan 10 11:38:03 2011 +0100
+++ b/plugin.xml	Mon Jan 10 12:01:25 2011 +0100
@@ -108,7 +108,7 @@
    <extension
          point="org.eclipse.ui.preferencePages">
       <page
-            class="de.mpg.mpiwg.itgroup.digilib.plugin.PluginPreferencePage"
+            class="de.mpg.mpiwg.itgroup.digilib.plugin.preferences.PluginPreferencePage"
             id="de.mpg.mpiwg.itgroup.digilib.plugin.page1"
             name="Digilib viewer">
       </page>
@@ -116,7 +116,7 @@
    <extension
          point="org.eclipse.core.runtime.preferences">
       <initializer
-            class="de.mpg.mpiwg.itgroup.digilib.plugin.PluginPreferenceInitializer">
+            class="de.mpg.mpiwg.itgroup.digilib.plugin.preferences.PluginPreferenceInitializer">
       </initializer>
    </extension>
    <extension
--- a/src/de/mpg/mpiwg/itgroup/digilib/digiImage/DigiImage.java	Mon Jan 10 11:38:03 2011 +0100
+++ b/src/de/mpg/mpiwg/itgroup/digilib/digiImage/DigiImage.java	Mon Jan 10 12:01:25 2011 +0100
@@ -24,8 +24,8 @@
 import de.mpg.mpiwg.itgroup.digilib.digiImage.properties.DigiImageProperties;
 import de.mpg.mpiwg.itgroup.digilib.manipulator.extensions.ZoomAreaRectangleListener;
 import de.mpg.mpiwg.itgroup.digilib.plugin.Activator;
-import de.mpg.mpiwg.itgroup.digilib.plugin.PluginPreferencePage;
 import de.mpg.mpiwg.itgroup.digilib.plugin.editors.DigilibLinkEditorObservable;
+import de.mpg.mpiwg.itgroup.digilib.plugin.preferences.PluginPreferencePage;
 
 
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/DigiImagePropertyListener.java	Mon Jan 10 12:01:25 2011 +0100
@@ -0,0 +1,40 @@
+package de.mpg.mpiwg.itgroup.digilib.digiImage.properties;
+
+import org.eclipse.swt.events.ModifyEvent;
+import org.eclipse.swt.events.ModifyListener;
+import org.eclipse.swt.widgets.Text;
+import org.eclipse.ui.views.properties.IPropertySource;
+
+import de.mpg.mpiwg.itgroup.digilib.digiImage.DigiImage;
+
+/**
+ * @author dwinter
+ *
+ * Listener on digiImage properties
+ */
+public class DigiImagePropertyListener implements ModifyListener {
+
+	private String key;
+	private DigiImage digiImage;
+	public DigiImagePropertyListener(String key, DigiImage digiImage){
+		this.key = key;
+		this.digiImage = digiImage;
+	}
+	
+	
+		
+		   public void modifyText(ModifyEvent event) {
+               DigiImageProperties properties = (DigiImageProperties) digiImage
+                   .getAdapter(IPropertySource.class);
+              Text t = (Text)event.getSource();
+              String c = t.getText();
+              System.out.println(c);
+            
+              properties.setPropertyValueNoDraw(key, (String)c);
+           }
+		
+		  
+		   
+	}
+
+
--- a/src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/DigiImagePropertySection.java	Mon Jan 10 11:38:03 2011 +0100
+++ b/src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/DigiImagePropertySection.java	Mon Jan 10 12:01:25 2011 +0100
@@ -1,33 +1,33 @@
 package de.mpg.mpiwg.itgroup.digilib.digiImage.properties;
 
-import java.util.ArrayList;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 
 import org.eclipse.jface.viewers.ISelection;
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.custom.CLabel;
-import org.eclipse.swt.events.ModifyEvent;
 import org.eclipse.swt.events.ModifyListener;
 import org.eclipse.swt.layout.FormAttachment;
 import org.eclipse.swt.layout.FormData;
 import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Composite;
-import org.eclipse.swt.widgets.Table;
 import org.eclipse.swt.widgets.Text;
 import org.eclipse.ui.IWorkbenchPart;
 import org.eclipse.ui.views.properties.IPropertySource;
 import org.eclipse.ui.views.properties.tabbed.AbstractPropertySection;
 import org.eclipse.ui.views.properties.tabbed.ITabbedPropertyConstants;
 import org.eclipse.ui.views.properties.tabbed.TabbedPropertySheetPage;
-import org.eclipse.jface.util.Assert;
 
 import de.mpg.mpiwg.itgroup.digilib.digiImage.DigiImage;
 import de.mpg.mpiwg.itgroup.digilib.digiImage.DigiImageParameter;
 
+/**
+ * @author dwinter
+ * Shows the properties of a digiImage
+ *
+ */
 public class DigiImagePropertySection extends AbstractPropertySection {
 		  
 		private DigiImage digiImage;
@@ -37,11 +37,11 @@
 		private Map<String,ModifyListener> listeners = new HashMap<String,ModifyListener>();
 		private Button button;
 		
-		
-		
+	
 	        
-	      
-	        
+	        /* (non-Javadoc)
+	         * @see org.eclipse.ui.views.properties.tabbed.AbstractPropertySection#createControls(org.eclipse.swt.widgets.Composite, org.eclipse.ui.views.properties.tabbed.TabbedPropertySheetPage)
+	         */
 	        public void createControls(Composite parent,
 	                TabbedPropertySheetPage aTabbedPropertySheetPage) {
 	            super.createControls(parent, aTabbedPropertySheetPage);
@@ -79,20 +79,27 @@
 	            
 	        }
 	    
+	        /* (non-Javadoc)
+	         * @see org.eclipse.ui.views.properties.tabbed.AbstractPropertySection#setInput(org.eclipse.ui.IWorkbenchPart, org.eclipse.jface.viewers.ISelection)
+	         */
 	        public void setInput(IWorkbenchPart part, ISelection selection) {
 	            super.setInput(part, selection);
 	
-	            Assert.isTrue(selection instanceof IStructuredSelection);
+	            //Assert.isTrue(selection instanceof IStructuredSelection);
+	            assert (IStructuredSelection.class.isInstance(selection)==true) : "wrong instance type";
+	            
 	            Object input = ((IStructuredSelection) selection).getFirstElement();
-	            Assert.isTrue(input instanceof DigiImage);
+	            //Assert.isTrue(input instanceof DigiImage);
+	            
+	            assert (DigiImage.class.isInstance(input)==true) : "wrong instance type for input";
 	            this.digiImage = (DigiImage) input;
 	            
-	            Map<String, String> pms = digiImage.getParameter().createMapFromParameters(null);
+	            //Map<String, String> pms = digiImage.getParameter().createMapFromParameters(null);
 	            
 	            for(String key: digiImage.getParameter().createMapFromParameters(null).keySet()){
 	            	
 	            
-	            ModifyListener listener = new PropertyListener(key,digiImage); 
+	            ModifyListener listener = new DigiImagePropertyListener(key,digiImage); 
 	            
 	            texts.get(key).addModifyListener(listener);
 	            listeners.put(key, listener);
@@ -101,6 +108,9 @@
 	    
 	        }
 	        
+	        /* (non-Javadoc)
+	         * @see org.eclipse.ui.views.properties.tabbed.AbstractPropertySection#refresh()
+	         */
 	        public void refresh() {
 	        	
 	        	 DigiImageProperties properties = (DigiImageProperties) digiImage
@@ -118,11 +128,5 @@
 	        	super.refresh();
 	        }
 
-	        @Override
-	        public void aboutToBeShown() {
-	        	System.out.println("about to be shown");
-	        
-	        	
-	        super.aboutToBeShown();
-	        }
+	       
 }
--- a/src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/PropertyListener.java	Mon Jan 10 11:38:03 2011 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,35 +0,0 @@
-package de.mpg.mpiwg.itgroup.digilib.digiImage.properties;
-
-import org.eclipse.swt.events.ModifyEvent;
-import org.eclipse.swt.events.ModifyListener;
-import org.eclipse.swt.widgets.Text;
-import org.eclipse.ui.views.properties.IPropertySource;
-
-import de.mpg.mpiwg.itgroup.digilib.digiImage.DigiImage;
-
-public class PropertyListener implements ModifyListener {
-
-	private String key;
-	private DigiImage digiImage;
-	public PropertyListener(String key, DigiImage digiImage){
-		this.key = key;
-		this.digiImage = digiImage;
-	}
-	
-	
-		
-		   public void modifyText(ModifyEvent event) {
-               DigiImageProperties properties = (DigiImageProperties) digiImage
-                   .getAdapter(IPropertySource.class);
-              Text t = (Text)event.getSource();
-              String c = t.getText();
-              System.out.println(c);
-            
-              properties.setPropertyValueNoDraw(key, (String)c);
-           }
-		
-		  
-		   
-	}
-
-
--- a/src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/RedrawButtonListener.java	Mon Jan 10 11:38:03 2011 +0100
+++ b/src/de/mpg/mpiwg/itgroup/digilib/digiImage/properties/RedrawButtonListener.java	Mon Jan 10 12:01:25 2011 +0100
@@ -2,23 +2,25 @@
 
 import java.util.Map;
 
-import org.eclipse.swt.events.ModifyEvent;
 import org.eclipse.swt.events.MouseEvent;
 import org.eclipse.swt.events.MouseListener;
 import org.eclipse.swt.widgets.Text;
-import org.eclipse.ui.views.properties.IPropertySource;
 
 import de.mpg.mpiwg.itgroup.digilib.digiImage.DigiImage;
 
+/**
+ * @author dwinter
+ * Listens on a button to redraw the image.
+ *
+ */
 public class RedrawButtonListener implements MouseListener {
 
 	
 	private DigiImage digiImage;
-	private Map<String, Text> texts;
 
 	public RedrawButtonListener(DigiImage digiImage, Map<String, Text> texts) {
 		this.digiImage=digiImage;
-		this.texts=texts;
+	
 	}
 
 	public void mouseDoubleClick(MouseEvent e) {
@@ -33,14 +35,6 @@
 
 	public void mouseUp(MouseEvent e) {
 	
-//             DigiImageProperties properties = (DigiImageProperties) digiImage
-//                   .getAdapter(IPropertySource.class);
-//              
-//             
-//             for (String key: texts.keySet()){
-//              properties.setPropertyValue(key, (String)texts.get(key).getText());
-//              
-//           }
 		digiImage.redraw();
 	}
 
--- a/src/de/mpg/mpiwg/itgroup/digilib/plugin/PluginPreferenceInitializer.java	Mon Jan 10 11:38:03 2011 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,23 +0,0 @@
-package de.mpg.mpiwg.itgroup.digilib.plugin;
-
-import org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer;
-import org.eclipse.jface.preference.IPreferenceStore;
-
-
-public class PluginPreferenceInitializer extends
-		AbstractPreferenceInitializer {
-
-	public PluginPreferenceInitializer() {
-		super();
-	}
-
-	@Override
-	public void initializeDefaultPreferences() {
-		//IEclipsePreferences node = new DefaultScope().getNode(Activator.PLUGIN_ID);
-		IPreferenceStore store = Activator.getDefault().getPreferenceStore();
-
-		store.setDefault(PluginPreferencePage.baseUrl_id, "http://digilib.mpiwg-berlin.mpg.de/digitallibrary/servlet/Scaler");
-		
-		
-	}
-}
--- a/src/de/mpg/mpiwg/itgroup/digilib/plugin/PluginPreferencePage.java	Mon Jan 10 11:38:03 2011 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,30 +0,0 @@
-package de.mpg.mpiwg.itgroup.digilib.plugin;
-
-import org.eclipse.jface.preference.FieldEditorPreferencePage;
-import org.eclipse.jface.preference.StringFieldEditor;
-import org.eclipse.ui.IWorkbench;
-import org.eclipse.ui.IWorkbenchPreferencePage;
-
-//private static final String baseUrl_default="http://digilib.mpiwg-berlin.mpg.de/digitallibrary/servlet/Scaler";
-
-public class PluginPreferencePage extends FieldEditorPreferencePage implements
-		IWorkbenchPreferencePage {
-	public static String baseUrl_id="baseurl";
-	public void init(IWorkbench workbench){
-		setPreferenceStore(Activator.getDefault().getPreferenceStore());
-	}
-	
-
-	public PluginPreferencePage() {
-		super(GRID);
-	}
-
-
-	@Override
-	protected void createFieldEditors() {
-		addField(new StringFieldEditor(baseUrl_id, "digilib base url", getFieldEditorParent()));
-	
-	}
-
-	
-}
--- a/src/de/mpg/mpiwg/itgroup/digilib/plugin/editors/DigilibLinkEditorPart.java	Mon Jan 10 11:38:03 2011 +0100
+++ b/src/de/mpg/mpiwg/itgroup/digilib/plugin/editors/DigilibLinkEditorPart.java	Mon Jan 10 12:01:25 2011 +0100
@@ -15,16 +15,9 @@
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.ui.IEditorInput;
 import org.eclipse.ui.IEditorSite;
-import org.eclipse.ui.IPageLayout;
-import org.eclipse.ui.IPartService;
-import org.eclipse.ui.IViewPart;
-import org.eclipse.ui.IWorkbenchPage;
 import org.eclipse.ui.PartInitException;
-import org.eclipse.ui.internal.WWinPartService;
 import org.eclipse.ui.part.EditorPart;
 import org.eclipse.ui.views.properties.IPropertySheetPage;
-import org.eclipse.ui.views.properties.PropertySheet;
-import org.eclipse.ui.views.properties.PropertySheetPage;
 import org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor;
 import org.eclipse.ui.views.properties.tabbed.TabbedPropertySheetPage;
 import org.jdom.JDOMException;
@@ -33,7 +26,6 @@
 import de.mpg.mpiwg.itgroup.digilib.digiImage.DigiImageController;
 import de.mpg.mpiwg.itgroup.digilib.digiImage.DigiImageParameter;
 import de.mpg.mpiwg.itgroup.digilib.digiImage.DigiNav;
-import de.mpg.mpiwg.itgroup.digilib.plugin.Activator;
 import de.mpg.mpiwg.itgroup.indexMeta.Utils.ParseIndexMeta;
 
 /**
@@ -156,7 +148,14 @@
 		
 	}
 
+	/* (non-Javadoc)
+	 * @see java.util.Observer#update(java.util.Observable, java.lang.Object)
+	 * Called from the observable
+	 */
 	public void update(Observable o, Object arg) {
+		/*
+		 * If the argument ist digiImage then rerender the editor and update the properties
+		 */
 		if (DigiImage.class.isInstance(arg)){
 			mainComposite.pack();
 			sc.setMinSize(mainComposite.computeSize(SWT.DEFAULT, SWT.DEFAULT));
@@ -172,6 +171,7 @@
 			
 		
 		} else if (Integer.class.isInstance(arg)){
+			//if it is in integer then the argument is the status of the cursor
 			int b = (Integer) arg;
 			
 			Cursor waitCursor = new Cursor(mainComposite.getDisplay(),b);
@@ -182,12 +182,19 @@
 	
 	}
 
+	/* (non-Javadoc)
+	 * @see org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor#getContributorId()
+	 */
 	public String getContributorId() {
 		String contribId = getSite().getId();
 		return contribId;
 	}
     	
-	 public Object getAdapter(Class adapter) {
+	 /* (non-Javadoc)
+	 * @see org.eclipse.ui.part.WorkbenchPart#getAdapter(java.lang.Class)
+	 */
+	@SuppressWarnings("rawtypes")
+	public Object getAdapter(Class adapter) {
 	        if (adapter == IPropertySheetPage.class){
 	           
 	            tp =  new TabbedPropertySheetPage(this);
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/de/mpg/mpiwg/itgroup/digilib/plugin/preferences/PluginPreferenceInitializer.java	Mon Jan 10 12:01:25 2011 +0100
@@ -0,0 +1,25 @@
+package de.mpg.mpiwg.itgroup.digilib.plugin.preferences;
+
+import org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer;
+import org.eclipse.jface.preference.IPreferenceStore;
+
+import de.mpg.mpiwg.itgroup.digilib.plugin.Activator;
+
+
+public class PluginPreferenceInitializer extends
+		AbstractPreferenceInitializer {
+
+	public PluginPreferenceInitializer() {
+		super();
+	}
+
+	@Override
+	public void initializeDefaultPreferences() {
+		//IEclipsePreferences node = new DefaultScope().getNode(Activator.PLUGIN_ID);
+		IPreferenceStore store = Activator.getDefault().getPreferenceStore();
+
+		store.setDefault(PluginPreferencePage.baseUrl_id, "http://digilib.mpiwg-berlin.mpg.de/digitallibrary/servlet/Scaler");
+		
+		
+	}
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/de/mpg/mpiwg/itgroup/digilib/plugin/preferences/PluginPreferencePage.java	Mon Jan 10 12:01:25 2011 +0100
@@ -0,0 +1,32 @@
+package de.mpg.mpiwg.itgroup.digilib.plugin.preferences;
+
+import org.eclipse.jface.preference.FieldEditorPreferencePage;
+import org.eclipse.jface.preference.StringFieldEditor;
+import org.eclipse.ui.IWorkbench;
+import org.eclipse.ui.IWorkbenchPreferencePage;
+
+import de.mpg.mpiwg.itgroup.digilib.plugin.Activator;
+
+//private static final String baseUrl_default="http://digilib.mpiwg-berlin.mpg.de/digitallibrary/servlet/Scaler";
+
+public class PluginPreferencePage extends FieldEditorPreferencePage implements
+		IWorkbenchPreferencePage {
+	public static String baseUrl_id="baseurl";
+	public void init(IWorkbench workbench){
+		setPreferenceStore(Activator.getDefault().getPreferenceStore());
+	}
+	
+
+	public PluginPreferencePage() {
+		super(GRID);
+	}
+
+
+	@Override
+	protected void createFieldEditors() {
+		addField(new StringFieldEditor(baseUrl_id, "digilib base url", getFieldEditorParent()));
+	
+	}
+
+	
+}