Revision 20098 trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/core/Handler.java

View differences:

Handler.java
48 48 

  		




  49
  49
  
    

  		




  50
  50
  
    
/**


  		




  51
  
  
    
* <p>In a <i>FMap</i> graphic layer, each geometry drawn has control points named <i>handlers</i>


  		




  52
  
  
    
* that allow user to move, modify, set, ... that geometry.</p>


  		




  53
  
  
    
*  


  		




  54
  
  
    
* <p>Each geometry will have its own handlers, and each one can have different behavior 


  		




  55
  
  
    
* according its nature.</p>


  		




  56
  
  
    
* 


  		




  57
  
  
    
* <p>The <code>Handler</code> interface defines the least set of common methods for all


  		




  58
  
  
    
* geometry handlers.</p>


  		




  59
  
  
    
*/


  		




  
  51
  
    
 * <p>In a {@link GraphicLayer GraphicLayer}, each geometry drawn has control points named <i>handlers</i> that allow


  		




  
  52
  
    
 *  user to move, modify, deform, ... that geometry.</p>


  		




  
  53
  
    
 *  


  		




  
  54
  
    
 * <p>Each geometry will have its own handlers, and each one can have different behavior according its nature.</p>


  		




  
  55
  
    
 * 


  		




  
  56
  
    
 * <p>The <code>Handler</code> interface defines the least set of common methods for all geometry handlers.</p>


  		




  
  57
  
    
 */


  		




  60
  58
  
    
public interface Handler {


  		




  61
  59
  
    
	/**


  		




  62
  60
  
    
	 * <p>Generic method of moving in 2D a handler of a geometry using two numbers that


  		




  63
  61
  
    
	 * represent the 2D coordinates.</p>


  		




  64
  62
  
    
	 * 


  		




  65
  
  
    
	 * <p>Each handler of each geometry adapts this method to its own behavior in that 


  		




  66
  
  
    
	 * geometry, that implies that could not be implemented.</p>


  		




  
  63
  
    
	 * <p>Each handler of each geometry adapts this method to its own behavior in that geometry, that


  		




  
  64
  
    
	 * implies that could not be implemented.</p>


  		




  67
  65
  
    
	 *


  		




  68
  66
  
    
	 * @param x first dimension coordinate


  		




  69
  67
  
    
	 * @param y second dimension coordinate


  		




  ......




  71
  69
  
    
	 * @see #set(double, double)


  		




  72
  70
  
    
	 */


  		




  73
  71
  
    
	public void move(double x, double y);


  		




  
  72
  
    

  		




  74
  73
  
    
	/**


  		




  75
  
  
    
 	 * <p>Generic method of situating in 2D a handler of a geometry using two numbers


  		




  76
  
  
    
 	 * that represent the 2D coordinates.</p>


  		




  
  74
  
    
 	 * <p>Generic method of situating in 2D a handler of a geometry using two numbers that


  		




  
  75
  
    
	 * represent the 2D coordinates.</p>


  		




  77
  76
  
    
	 * 


  		




  78
  
  
    
	 * <p>Each handler of each geometry adapts this method to its own behavior in that 


  		




  79
  
  
    
	 * geometry, that implies that could not be implemented.</p>


  		




  
  77
  
    
	 * <p>Each handler of each geometry adapts this method to its own behavior in that geometry, that


  		




  
  78
  
    
	 * implies that could not be implemented.</p>


  		




  80
  79
  
    
	 *


  		




  81
  80
  
    
	 * @param x first dimension coordinate


  		




  82
  81
  
    
	 * @param y second dimension coordinate


  		




  ......




  89
  88
  
    
	/**


  		




  90
  89
  
    
 	 * <p>Generic method of getting the 2D point that represents a handler of a geometry.</p>


  		




  91
  90
  
    
	 * 


  		




  92
  
  
    
	 * <p>Each handler of each geometry adapts this method to its own behavior in that


  		




  93
  
  
    
	 * geometry, that implies that could not be implemented.</p>


  		




  
  91
  
    
	 * <p>Each handler of each geometry adapts this method to its own behavior in that geometry, that


  		




  
  92
  
    
	 * implies that could not be implemented.</p>


  		




  94
  93
  
    
	 *


  		




  95
  94
  
    
	 * @return point 2D that represents this handler of geometry


  		




  96
  95
  
    
	 * 


  		




  ......




  98
  97
  
    
	 * @see #move(double, double)


  		




  99
  98
  
    
	 */


  		




  100
  99
  
    
	public Point2D getPoint();


  		




  
  100
  
    

  		




  101
  101
  
    
	/**


  		




  102
  102
  
    
	 * <p>Returns <code>true</code> if the object is a <code>Handler</code> and has the


  		




  103
  103
  
    
	 *  same coordinates as this one.</p>


  		




  104
  104
  
    
	 * 


  		




  105
  105
  
    
	 * @param obj the reference object with which to compare 


  		




  106
  
  
    
	 * @return <code>true</code> if this object is the same as the <code>obj</code> 


  		




  107
  
  
    
	 * argument; <code>false</code> otherwise


  		




  
  106
  
    
	 * @return <code>true</code> if this object is the same as the <code>obj</code> argument; <code>false</code> otherwise


  		




  108
  107
  
    
	 * 


  		




  109
  108
  
    
	 * @see #getPoint()


  		




  110
  109
  
    
	 */


  		












Also available in:  Unified diff