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

View differences:

FLyrDefault.java
68 68
import com.iver.utiles.XMLEntity;
69 69

  
70 70
/**
71
 * <p>Implementation of the high level characteristics of the layers: visibility, activation, name, ...</p>
71
 * <p>Implementation of the common characteristics of all layers: visibility, activation, name, ...</p>
72 72
 * 
73
 * <p>Represents a definition of a basic <a href="http://www.gvsig.gva.es/">gvSIG</a> layer, with the implementation of 
74
 *  the <code>FLayer</code> methods, and new functionality: 
73
 * <p>Represents the definition of a basic layer, implementing {@link FLayer FLayer}, and new functionality: 
75 74
 * <ul>
76 75
 *  <li>Supports transparency.
77 76
 *  <li>Notification of evens produced using this layer.
......
82 81
 * </ul>
83 82
 * </p>
84 83
 *
85
 * <p>Each graphical layer will inherit from this class and adapt to its particular logic and model.</p>
84
 * <p>Each graphical layer will inherit from this class and adapt to its particular logic and model according
85
 *  its nature.</p>
86 86
 *
87 87
 * @see FLayer
88
 * @see FLayerStatus
88 89
 */
89 90
public abstract class FLyrDefault implements FLayer {
90 91
	// private PropertyChangeSupport lnkPropertyChangeSupport;
......
424 425
	 *
425 426
	 * <p>This XML entity has elements (properties) that represent and store information about this layer.</p>
426 427
	 *
427
	 * <p>There are two kinds of information: default properties of this layer, and extended properties (they added that weren't by default)</p>
428
	 * <p>There are two kinds of information, <i>default properties</i>, and <i>extended properties</i> of this layer:</p>
428 429
	 *
429 430
	 * <p> <b>Default properties:</b>
430 431
	 *  <ul>
......
436 437
	 *   <li> visible : if this layer is visible or not
437 438
	 *   <li> proj : the projection of this layer (only if it's defined)
438 439
	 *   <li> transparency : transparency level of this layer
439
	 *   <li> isInTOC : if this layer is in the TOC or not
440
	 *   <li> isInTOC : if this layer is in the TOC (being listed) or not
440 441
	 *   <li> numProperties : number of extended properties
441 442
	 *  </ul>
442 443
	 * </p>
443 444
	 *
444 445
	 * <p> <b>Extended properties:</b> are stored as children of the tree-node returned. There are two kinds of information for a child,
445
	 *  according if it's an instance of an <code>String</code> or of an object that implements the interface <code>IPersistance</code>.
446
	 *  according if it's an instance of an <code>String</code> or an object that implements the interface <code>IPersistance</code>.
446 447
	 *
447 448
	 *  <ul>
448 449
	 *   <li> <i>Instance of <code>String</code>:</i>
......
460 461
	 *   </ul>
461 462
	 *  <ul>
462 463
	 * </p>
463
	 *
464
	 * 
464 465
	 * @return an XML entity with information to the current layer
465 466
	 * @throws com.iver.cit.gvsig.fmap.layers.XMLException if there is an error obtaining the object.
466 467
	 * 
......
730 731
	}
731 732

  
732 733
	/**
733
	 * Inserts virtual layers to this layer.
734
	 * Inserts a virtual layer node to this layer.
734 735
	 *
735 736
	 * @param virtualLayers a node with the layers
736 737
	 * 
......
763 764
	}
764 765

  
765 766
	/**
766
	 * Sets transformation coordinates for this layer.
767
	 * Sets the transformation coordinates for this layer.
767 768
	 *
768
	 * @param ct an object that implements the <code>ICoordTrans</code> interface, and with the transformation coordinates
769
	 * @param ct the new transformation coordinates
769 770
	 * 
770 771
	 * @see #getCoordTrans()
771 772
	 */
......
776 777
	/**
777 778
	 * Returns the transformation coordinates of this layer.
778 779
	 *
779
	 * @return ct an object that implements the <code>ICoordTrans</code> interface, and with the transformation coordinates
780
	 * @return ct current transformation coordinates
780 781
	 * 
781 782
	 * @see #setCoordTrans(ICoordTrans)
782 783
	 */
......
787 788
	/**
788 789
	 * <p>Method called by {@link FLayers FLayers} to notify this layer that is going to be added.
789 790
	 *  This previous notification is useful for the layers that need do something before being added. For
790
	 *  example, the raster needs reopen a file that could have been closed recently.</p>
791
	 *  example, a <i>raster</i> layer needs reopen a file that could have been closed recently.</p>
791 792
	 */
792 793
	public void wakeUp() {
793 794
	}
......
844 845
	}
845 846

  
846 847
	/**
847
	 * Returns the strategy of drawing and processing for this layer.
848
	 * Returns the strategy of drawing and processing this layer.
848 849
	 *
849 850
	 * @return an object that implements the <code>Strategy</code> interface.
850 851
	 * 
......
1096 1097
	}
1097 1098

  
1098 1099
	/**
1099
	 * <p>This method is called when the layer is going to be removed from the view.</p>
1100
	 * <p>Layers that find it useful can overwrite it.</p>
1100
	 * <p>This method is called when the layer is going to be removed.</p>
1101
	 * <p>Layers that found it useful can overwrite it.</p>
1101 1102
	 */
1102 1103
	public void removingThisLayer() {}
1103 1104

  

Also available in: Unified diff