Revision 866 org.gvsig.proj/branches/refactor2018/org.gvsig.proj/org.gvsig.proj.swing/org.gvsig.proj.swing.api/src/main/java/org/gvsig/proj/swing/CoordinateReferenceSystemSwingManager.java

View differences:

CoordinateReferenceSystemSwingManager.java
23 23
 */
24 24
package org.gvsig.proj.swing;
25 25

  
26
import org.gvsig.proj.CoordinateReferenceSystem;
26
import java.util.Set;
27

  
27 28
import org.gvsig.proj.CoordinateReferenceSystemManager;
28
import org.gvsig.proj.CoordinateTransformation;
29 29
import org.gvsig.proj.catalog.CRSCatalogManager;
30
import org.gvsig.tools.swing.api.windowmanager.WindowManager;
31
import org.gvsig.tools.swing.icontheme.IconTheme;
30
import org.gvsig.proj.catalog.CRSDefinition;
31
import org.gvsig.proj.catalog.TransformationDefinition;
32
import org.gvsig.tools.dynobject.DynObject;
32 33

  
33 34
/**
34 35
 * This class is responsible of the management of the library's swing user
......
57 58
     */
58 59
    CoordinateTransformationSelectorComponent createCoordinateTransformSelectionComponent();
59 60
    
60
    RecentHistory<CoordinateReferenceSystem> getCoordinateReferenceSystemHistory();
61
    /**
62
     * Gets the list of recently used CoordinateReferenceSystems.
63
     * 
64
     * @return A <code>RecentHistory</code> object, which can be used to add new
65
     * elements to the history or to iterate on history elements.
66
     */
67
    RecentHistory<CRSDefinition> getCoordinateReferenceSystemHistory();
68

  
69
    /**
70
     * Gets the list of recently used CoordinateTransformations.
71
     * 
72
     * @return A <code>RecentHistory</code> object, which can be used to add new
73
     * elements to the history or to iterate on history elements.
74
     */
75
    RecentHistory<TransformationDefinition> getTransformationHistory();
61 76
    
62
    RecentHistory<CoordinateTransformation> getTransformationHistory();
63
    
77
    /**
78
     * Gets the list of recently used strings in the CRS search UI.
79
     * 
80
     * @return A <code>RecentHistory</code> object, which can be used to add new
81
     * elements to the history or to iterate on history elements.
82
     */
64 83
    RecentHistory<String> getCoordinateReferenceSystemTextFilterHistory();
65 84
    
85
    /**
86
     * Gets the list of recently used strings in the CoordinateTransformation search UI.
87
     * 
88
     * @return A <code>RecentHistory</code> object, which can be used to add new
89
     * elements to the history or to iterate on history elements.
90
     */
66 91
    RecentHistory<String> getTransformationTextFilterHistory();
67 92
    
68
    //List<IProjection> getCoordinateReferenceSystemFavorites();
69
    //List<IProjection> getTransformationFavorites();
93
    /**
94
     * Gets the list of favorite CoordinateReferenceSystems.
95
     * 
96
     * @return A <code>List</code> object, which can be used to add new favorites
97
     * or to iterate on existing favorites.
98
     */
99
    Set<CRSDefinition> getCoordinateReferenceSystemFavorites();
100
 
101
    /**
102
     * Gets the list of favorite CoordinateTransformations.
103
     * 
104
     * @return A <code>List</code> object, which can be used to add new favorites
105
     * or to iterate on existing favorites.
106
     */
107
    Set<TransformationDefinition> getTransformationFavorites();
70 108

  
71 109
    /**
72 110
     * Returns the {@link CoordinateReferenceSystemManager}.
......
77 115
    CoordinateReferenceSystemManager getCRSManager();
78 116
    
79 117
    CRSCatalogManager getCatalogManager();
118
    
119
    /**
120
     * <p>Gets the preferences of the manager, as a DynObject. Don't store an instance of
121
     * this object, use this method to retrieve it when needed, since it is only updated
122
     * when retrieved.</p>
123
     * 
124
     * <p>The object contains the following fields:
125
     * <ul>
126
     * <li><code>crsHistory</code> of type List (containing {@code CRSDefinition}s)</li>
127
     * <li><code>crsHistorySize</code> of type Integer, which defines the maximum number of elements to store on
128
     * the CRS history</li>
129
     * <li><code>transformationHistory</code> of type List (containing {@code TransformationDefinition}s)</li>
130
     * <li><code>transformationHistorySize</code> of type Integer, which defines the maximum number of elements to store on
131
     * the transformation history</li>
132
     * <li><code>crsTextFilterHistory</code> of type List (containing {@code String}s)</li>
133
     * <li><code>crsTextFilterHistorySize</code> of type Integer, which defines the maximum number of elements to store on
134
     * the CRS text filter history</li>
135
     * <li><code>transformationTextFilterHistory</code> of type List (containing {@code String}s)</li>
136
     * <li><code>transformationTextFilterHistorySize</code> of type Integer, which defines the maximum number of elements to store on
137
     * the transformation text filter history</li>
138
     * <li><code>crsFavorites</code> of type List (containing {@code CRSDefinition}s)</li>
139
     * <li><code>transformationFavorites</code> of type List (containing {@code TransformationDefinition}s)</li>
140
     * </ul>
141
     * </p>
142
     * 
143
     * @return
144
     */
145
    public DynObject getPreferences();
146

  
147
    /**
148
     * Sets the preferences of the plugin, as a DynObject. The favorite and history lists
149
     * will be updated according to the provided DynObject values.
150
     * 
151
     * Check {@link #getPreferences()}
152
     * documentation to see the expected structure of the DynObject.
153
     */
154
    public void setPreferences(DynObject preferences);
80 155
}

Also available in: Unified diff