/branches/v10/libraries/libFMap/src/com/iver/cit/gvsig/fmap/layers/layerOperations/LayerCollection.java - Diff - Application: gvSIG desktop - gvSIG

Revision 20100 branches/v10/libraries/libFMap/src/com/iver/cit/gvsig/fmap/layers/layerOperations/LayerCollection.java

LayerCollection.java
45	45	import com.iver.cit.gvsig.fmap.layers.LayerCollectionListener;
46	46
47	47	/**
48		* <p>Interface with methods of a collection of layers.</p>
	48	* <p>Interface with methods for a collection of layers.</p>
49	49	*/
50	50	public interface LayerCollection {
51	51	/**
52		* Adds a listener about the events produced on a layers collection.
	52	* <p>Adds a listener of events produced on a collection of layers.</p>
53	53	*
54	54	* @param listener a <code>LayerCollectionListener</code>
55	55	*
...	...
58	58	public void addLayerCollectionListener(LayerCollectionListener listener);
59	59
60	60	/**
61		* Removes a listener about the events produced on a layers collection.
	61	* <p>Removes a listener of events produced on a collection of layers.</p>
62	62	*
63	63	* @param listener a <code>LayerCollectionListener</code>
64	64	*
...	...
67	67	public void removeLayerCollectionListener(LayerCollectionListener listener);
68	68
69	69	/**
70		* Adds a layer at the end of the layers list.
	70	* <p>Adds a new layer to this collection.</p>
71	71	*
72		* @param layer a layer
	72	* @param layer the new layer
73	73	*
74	74	* @throws CancelationException any exception produced during the cancellation of the driver.
75	75	*
...	...
80	80	public void addLayer(FLayer layer) throws CancelationException;
81	81
82	82	/**
83		* <p>Moves a layer of the collection to another position in internal list. It does not consider subnodes.</p>
	83	* <p>Moves a layer of the collection to another position in internal list. It doesn't consider sub-nodes of layers.</p>
84	84	*
85	85	* @param from origin position
86	86	* @param to destination position
...	...
90	90	public void moveTo(int from, int to) throws CancelationException;
91	91
92	92	/**
93		* Removes a layer from the collection.
	93	* <p>Removes a layer from this collection.</p>
94	94	*
95	95	* @param lyr a layer
96	96	*
...	...
103	103	public void removeLayer(FLayer lyr) throws CancelationException;
104	104
105	105	/**
106		* Removes a layer using its identifier.
	106	* <p>Removes a layer using its identifier.</p>
107	107	*
108		* @param idLayer layer id
	108	* @param idLayer layer identifier
109	109	*
110	110	* @see #removeLayer(FLayer)
111	111	* @see #removeLayer(String)
...	...
114	114	public void removeLayer(int idLayer);
115	115
116	116	/**
117		* Removes a layer using its name.
	117	* <p>Removes a layer using its name.</p>
118	118	*
119	119	* @param layerName the name of the layer
120	120	*
...	...
125	125	public void removeLayer(String layerName);
126	126
127	127	/**
128		* Returns an array with all visible layers in this collection.
	128	* <p>Returns an array with all visible layers in this collection.</p>
129	129	*
130		* @return array with layers, or <code>null</code> if no there is no layer visible
	130	* @return array with first-level visible layer nodes, or <code>null</code> if no there is no layer visible
131	131	*
132	132	* @see #setAllVisibles(boolean)
133	133	*/
134	134	public FLayer[] getVisibles();
135	135
136	136	/**
137		* Returns an array with all active layers in this collection.
	137	* <p>Returns an array with all active layers in this collection.</p>
138	138	*
139		* @return array with layers, or <code>null</code> if no there is no layer active
	139	* @return array with first-level active layer nodes, or <code>null</code> if no there is no layer actived
140	140	*
141	141	* @see #setAllActives(boolean)
142	142	*/
143	143	public FLayer[] getActives();
144	144
145	145	/**
146		* Returns the ith-output directed son (from bottom up) of this collection.
	146	* <p>Returns the ith-output directed son (from bottom up) of this collection.</p>
147	147	*
148	148	* @param index index of the ith-output layer in this collection.
149	149	*
...	...
154	154	public FLayer getLayer(int index);
155	155
156	156	/**
157		* Returns a directed son layer of this collection, using its name.
	157	* <p>Returns a first-level layer of this collection, using its name.</p>
158	158	*
159	159	* @param layerName name of a layer of this collection
160	160	*
...	...
165	165	public FLayer getLayer(String layerName);
166	166
167	167	/**
168		* <p>Returns the number of layers that are at the same level as this one.</p>
	168	* <p>Returns the number of layers that are at the first level inside this one.</p>
169	169	*
170		* <p>Doesn't counts the sublayers of a <code>FLayers</code> node object.</p>
	170	* <p>Doesn't counts the sublayers (of <code>FLayers</code> subnodes).</p>
171	171	*
172		* @return number >= 0 with layers that are at the same level
	172	* @return number >= 0 with layers that are at the same first-level
173	173	*
174	174	* @see #getLayer(int)
175	175	* @see #getLayer(String)
...	...
177	177	public int getLayersCount();
178	178
179	179	/**
180		* Changes the status of all layers to active or inactive.
	180	* <p>Changes the status of all layers to active or inactive.</p>
181	181	*
182		* @param active the boolean to be set
	182	* @param active a boolean value
183	183	*
184	184	* @see #getActives()
185	185	*/
186	186	public void setAllActives(boolean active);
187	187
188	188	/**
189		* Changes the status of all layers to visible or invisible.
	189	* <p>Changes the status of all layers to visible or invisible.</p>
190	190	*
191		* @param visible the boolean to be set
	191	* @param visible a boolean value
192	192	*
193	193	* @see #getVisibles()
194	194	*/

Also available in: Unified diff