diff src/de/mpg/mpiwg/itgroup/digilib/digiImage/IDigiImage.java @ 9:e63a64652f4d

added comments
author dwinter
date Mon, 03 Jan 2011 16:53:48 +0100
parents 83c58ea33792
children
line wrap: on
line diff
--- a/src/de/mpg/mpiwg/itgroup/digilib/digiImage/IDigiImage.java	Mon Jan 03 09:13:17 2011 +0100
+++ b/src/de/mpg/mpiwg/itgroup/digilib/digiImage/IDigiImage.java	Mon Jan 03 16:53:48 2011 +0100
@@ -3,23 +3,60 @@
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Label;
 
-import de.mpg.mpiwg.itgroup.digilib.manipulator.extensions.RectangleListener;
+import de.mpg.mpiwg.itgroup.digilib.manipulator.extensions.ZoomAreaRectangleListener;
 
 
+/**
+ * Interface for an general scalable image object.
+ * @author dwinter
+ *
+ */
 public interface IDigiImage {
 	
+	/**
+	 * Gets the current set of parameters.
+	 * @return
+	 */
 	public DigiImageParameter getParameter();
+	
+	/** Set the parameter, no other action, image is only recreated by calling @see {@link #redraw()}.
+	 * @param dp
+	 */
 	public void setParameter(DigiImageParameter dp);
+	
+	/**
+	 * Draws the image defined by the parameter set.
+	 * 
+	 */
 	public void redraw();
 	
+	/**
+	 *
+	 * @return the label @object which contains the image
+	 */
 	public Label getLabel();
 
+	/**
+	 * Sets a new label object, should normally not be externally called. Label should be set by @see {@link #redraw()}.
+	 * @param label
+	 */
 	public void setLabel(Label label);
 
 
-	public RectangleListener getRectangleListener();
-	public void setRectangleListener(RectangleListener rectangleListener);
+	/**
+	 * Get the listener to a rectangle object used for marking a part of the image for zooming.
+	 * @return
+	 */
+	public ZoomAreaRectangleListener getRectangleListener();
+	/**
+	 * et the listener to a rectangle object used for marking a part of the image for zooming.
+	 * @param rectangleListener
+	 */
+	public void setRectangleListener(ZoomAreaRectangleListener rectangleListener);
 	
+	/**
+	 * @return Parent of the composite object of the label.
+	 */
 	public Composite getParent();
 
 }