comparison 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 ee955cf6c9c5
comparison
equal deleted inserted replaced
8:52023cf79d86 9:e63a64652f4d
1 package de.mpg.mpiwg.itgroup.digilib.digiImage; 1 package de.mpg.mpiwg.itgroup.digilib.digiImage;
2 2
3 import org.eclipse.swt.widgets.Composite; 3 import org.eclipse.swt.widgets.Composite;
4 import org.eclipse.swt.widgets.Label; 4 import org.eclipse.swt.widgets.Label;
5 5
6 import de.mpg.mpiwg.itgroup.digilib.manipulator.extensions.RectangleListener; 6 import de.mpg.mpiwg.itgroup.digilib.manipulator.extensions.ZoomAreaRectangleListener;
7 7
8 8
9 /**
10 * Interface for an general scalable image object.
11 * @author dwinter
12 *
13 */
9 public interface IDigiImage { 14 public interface IDigiImage {
10 15
16 /**
17 * Gets the current set of parameters.
18 * @return
19 */
11 public DigiImageParameter getParameter(); 20 public DigiImageParameter getParameter();
21
22 /** Set the parameter, no other action, image is only recreated by calling @see {@link #redraw()}.
23 * @param dp
24 */
12 public void setParameter(DigiImageParameter dp); 25 public void setParameter(DigiImageParameter dp);
26
27 /**
28 * Draws the image defined by the parameter set.
29 *
30 */
13 public void redraw(); 31 public void redraw();
14 32
33 /**
34 *
35 * @return the label @object which contains the image
36 */
15 public Label getLabel(); 37 public Label getLabel();
16 38
39 /**
40 * Sets a new label object, should normally not be externally called. Label should be set by @see {@link #redraw()}.
41 * @param label
42 */
17 public void setLabel(Label label); 43 public void setLabel(Label label);
18 44
19 45
20 public RectangleListener getRectangleListener(); 46 /**
21 public void setRectangleListener(RectangleListener rectangleListener); 47 * Get the listener to a rectangle object used for marking a part of the image for zooming.
48 * @return
49 */
50 public ZoomAreaRectangleListener getRectangleListener();
51 /**
52 * et the listener to a rectangle object used for marking a part of the image for zooming.
53 * @param rectangleListener
54 */
55 public void setRectangleListener(ZoomAreaRectangleListener rectangleListener);
22 56
57 /**
58 * @return Parent of the composite object of the label.
59 */
23 public Composite getParent(); 60 public Composite getParent();
24 61
25 } 62 }