annotate src/de/mpg/mpiwg/itgroup/digilib/digiImage/IDigiImage.java @ 27:ee955cf6c9c5

first commit
author dwinter
date Fri, 17 Jun 2011 14:24:34 +0200
parents e63a64652f4d
children fbcf122a6a24
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
27
ee955cf6c9c5 first commit
dwinter
parents: 9
diff changeset
3 import org.eclipse.jface.viewers.ISelectionProvider;
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
4 import org.eclipse.swt.widgets.Composite;
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
5 import org.eclipse.swt.widgets.Label;
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
6
9
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
7 import de.mpg.mpiwg.itgroup.digilib.manipulator.extensions.ZoomAreaRectangleListener;
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
8
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
9
9
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
10 /**
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
11 * Interface for an general scalable image object.
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
12 * @author dwinter
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
13 *
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
14 */
27
ee955cf6c9c5 first commit
dwinter
parents: 9
diff changeset
15 public interface IDigiImage extends ISelectionProvider {
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
16
9
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
17 /**
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
18 * Gets the current set of parameters.
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
19 * @return
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
20 */
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
21 public DigiImageParameter getParameter();
9
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
22
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
23 /** Set the parameter, no other action, image is only recreated by calling @see {@link #redraw()}.
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
24 * @param dp
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
25 */
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
26 public void setParameter(DigiImageParameter dp);
9
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
27
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
28 /**
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
29 * Draws the image defined by the parameter set.
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
30 *
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
31 */
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
32 public void redraw();
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
33
9
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
34 /**
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
35 *
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
36 * @return the label @object which contains the image
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
37 */
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
38 public Label getLabel();
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
39
9
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
40 /**
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
41 * 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
42 * @param label
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
43 */
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
44 public void setLabel(Label label);
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
45
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
46
9
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
47 /**
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
48 * 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
49 * @return
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
50 */
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
51 public ZoomAreaRectangleListener getRectangleListener();
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
52 /**
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
53 * 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
54 * @param rectangleListener
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
55 */
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
56 public void setRectangleListener(ZoomAreaRectangleListener rectangleListener);
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
57
9
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
58 /**
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
59 * @return Parent of the composite object of the label.
e63a64652f4d added comments
dwinter
parents: 1
diff changeset
60 */
1
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
61 public Composite getParent();
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
62
83c58ea33792 first release (continued)
dwinter
parents:
diff changeset
63 }