1 /*
2 * This file is a part of CAST project.
3 * (c) Copyright 2007, AGH University of Science & Technology
4 * https://caribou.iisg.agh.edu.pl/trac/cast
5 *
6 * Licensed under the Eclipse Public License, Version 1.0 (the "License").
7 * You may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 * http://www.eclipse.org/legal/epl-v10.html
10 */
11 /*
12 * File: IDiagramSettings.java
13 * Created: 2007-00-00
14 * Author: awos
15 * $Id: IDiagramSettings.java 2817 2009-05-05 13:17:57Z tmilos $
16 */
17
18 package pl.edu.agh.cast.model.visual.backward;
19
20 import java.io.Serializable;
21
22 import pl.edu.agh.cast.data.model.property.IPropertyChangeProvider;
23
24 /**
25 * Diagram settings.
26 *
27 * @author AGH CAST Team
28 */
29 public interface IDiagramSettings extends Serializable, IPropertyChangeProvider {
30
31 /**
32 * Whether the diagram legend should be displayed.
33 *
34 * @return <code>true</code> if diagram legend should be displayed
35 */
36 public boolean isShowLegend();
37
38 /**
39 * Sets the flag indicating whether diagram legend should be displayed.
40 *
41 * @param showLegend
42 * flag indicating whether diagram legend should be displayed
43 */
44 public void setShowLegend(boolean showLegend);
45
46 /**
47 * Returns diagram display name.
48 *
49 * @return diagram display name
50 */
51 public String getDisplayName();
52
53 /**
54 * Sets diagram display name.
55 *
56 * @param displayName
57 * diagram display name.
58 */
59 public void setDisplayName(String displayName);
60
61 /**
62 * Whether the diagram needs to be initial laid out.
63 *
64 * @return <code>true</code> if diagram needs to be initial laid out
65 */
66 public boolean needsInitialLayout();
67
68 /**
69 * Sets the flag indicating whether the diagram needs to be initial laid out.
70 *
71 * @param in
72 * flag indicating whether the diagram needs to be initial laid out
73 */
74 public void setNeedsInitialLayout(boolean in);
75
76 /**
77 * Returns the id of editor this diagram is displayed in.
78 *
79 * @return the id of editor this diagram is displayed in
80 */
81 public String getEditorId();
82
83 /**
84 * Sets the id of editor this diagram is displayed in.
85 *
86 * @param id
87 * the id of editor this diagram is displayed in
88 */
89 public void setEditorId(String id);
90
91 /**
92 * Gets the qualified name of diagram's layout manager class.
93 *
94 * @return {@link org.eclipse.draw2d.LayoutManager} class name
95 */
96 public String getDefaultLayoutManagerClass();
97
98 /**
99 * Sets layout manager class which model should be opened with by default.
100 *
101 * @param layoutManagerClass
102 * {@link org.eclipse.draw2d.LayoutManager} class name
103 */
104 public void setDefaultLayoutManagerClass(String layoutManagerClass);
105
106 }