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