01: /*
02: * uDig - User Friendly Desktop Internet GIS client
03: * http://udig.refractions.net
04: * (C) 2004, Refractions Research Inc.
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation;
09: * version 2.1 of the License.
10: *
11: * This library is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: */
17: package net.refractions.udig.printing.model;
18:
19: import net.refractions.udig.project.internal.Layer;
20: import net.refractions.udig.project.internal.Map;
21:
22: /**
23: * A generic implementation of a Decorator. It is associated with a Map and
24: * a Layer.
25: *
26: * A Decorator is typically used to display something on a Map. This allows
27: * it to removed from the Map and positioned around it on the Page. An example
28: * of this is a scalebar, which needs to reference a map to draw its scale.
29: *
30: * @author Richard Gould
31: * @since 0.3
32: * @model
33: */
34: public interface DecoratorBox extends Box {
35: /**
36: * @return the Map associated with this DecoratorBox
37: * @model many="false"
38: */
39: public Map getMap();
40:
41: /**
42: * Sets the value of the '{@link net.refractions.udig.printing.model.DecoratorBox#getMap <em>Map</em>}' reference.
43: * <!-- begin-user-doc -->
44: * Sets this DecoratorBox's Map
45: * <!-- end-user-doc -->
46: * @param value the new value of the '<em>Map</em>' reference.
47: * @see #getMap()
48: * @generated
49: */
50: void setMap(Map value);
51:
52: /**
53: * @return the Layer associated with this DecoratorBox
54: * @model
55: */
56: public Layer getLayer();
57:
58: /**
59: * Sets the value of the '{@link net.refractions.udig.printing.model.DecoratorBox#getLayer <em>Layer</em>}' reference.
60: * <!-- begin-user-doc -->
61: * Sets this DecoratorBox's Layer
62: * <!-- end-user-doc -->
63: * @param value the new value of the '<em>Layer</em>' reference.
64: * @see #getLayer()
65: * @generated
66: */
67: void setLayer(Layer value);
68:
69: }
|