01: package org.netbeans.modules.reportgenerator.api;
02:
03: import java.awt.Image;
04: import java.util.List;
05:
06: /**
07: * ReportElement represents one element in a ReportSection.
08: * Typically a ReportElement represents one node on a canvas.
09: * It is the basic building bloc for which a report will be generated with
10: * details about it.
11: * For example it can represents one IEP operator or one BPEL activity like receive/invoke
12: * etc.
13: *
14: * @author radval
15: *
16: */
17: public interface ReportElement extends ReportNode,
18: ReportAttributeContainer {
19:
20: /**
21: * Get the name of this report element.
22: * The name usually is the used to start a section
23: * for this report element.
24: * @return name
25: */
26: String getName();
27:
28: /**
29: * Set the name of this report element.
30: * The name usually is the used to start a section
31: * for this report element.
32: * @param name name
33: */
34: void setName(String name);
35:
36: /**
37: * Get image for this element. Usually it is an
38: * image specific for this element.
39: * @return
40: */
41: Image getImage();
42:
43: /**
44: * Set image for this element. Usually it is an
45: * image specific for this element.
46: * @param image Image
47: */
48: void setImage(Image image);
49:
50: /**
51: * Get the description for this element.
52: * This is usually a documentation about what
53: * this element represents.
54: * @return description.
55: */
56: String getDescription();
57:
58: /**
59: * Set the description for this element.
60: * This is usually a documentation about what
61: * this element represents.
62: * @param description
63: */
64: void setDescription(String description);
65:
66: }
|