View Javadoc

1   package org.kite9.diagram.primitives;
2   
3   /***
4    * This means that the element has an ID, so that the id can be used to reference 
5    * it from multiple places.  This is used where the element is likely to be given a
6    * specific name within either the diagram, or across all diagrams within the project.
7    * 
8    * @author robmoffat
9    *
10   */
11  public interface IdentifiableDiagramElement extends DiagramElement {
12  
13  	/***
14  	 * ID should be a project-unique ID to describe this element.  It is also used within the 
15  	 * XML to allow references between the elements of the XML file. 
16  	 * 
17  	 * ID is also used for hashcode and equals.  Set an ID to ensure sorting, maps
18  	 * and therefore diagram layouts, are deterministic.
19  	 * 
20  	 */
21  	public String getID();
22  	
23  	public void setID(String s);
24  
25  	
26  }