Package: EditorMarkable

EditorMarkable

Coverage

1: package de.fhdw.wtf.common.exception.editor;
2:
3: import de.fhdw.wtf.common.token.Position;
4:
5: /**
6: * Interface for the Editor. If a class implements this Interface, the Editor can mark with it an area in the wtf-Model
7: * and show the description.
8: */
9: public interface EditorMarkable {
10:         
11:         /**
12:          * Returns the Start-Position of the area which the editor have to mark.
13:          *
14:          * @return Start-Position
15:          */
16:         Position getStartPosition();
17:         
18:         /**
19:          * Returns a description why this area is marked.
20:          *
21:          * @return description
22:          */
23:         String getDescription();
24:         
25:         /**
26:          * Returns the End-Position of the area which the editor have to mark.
27:          *
28:          * @return End-Position
29:          */
30:         Position getEndPos();
31:         
32:         /**
33:          * Returns the Marker.
34:          *
35:          * @return Marker
36:          */
37:         EditorMarker getMarker();
38: }