Revision 22072 trunk/applications/appgvSIG/src/com/iver/cit/gvsig/project/documents/view/legend/gui/ILabelingStrategyPanel.java

View differences:

ILabelingStrategyPanel.java
43 43
import com.iver.cit.gvsig.fmap.layers.FLayer;
44 44
import com.iver.cit.gvsig.fmap.rendering.styling.labeling.ILabelingStrategy;
45 45

  
46
/**
47
 * Interface to be implemented for those panels whose purpose is to
48
 * set up labeling strategies.
49
 * 
50
 * ILabelingStrategyPanel.java
51
 *
52
 * 
53
 * @author jaume dominguez faus - jaume.dominguez@iver.es Jun 13, 2008
54
 *
55
 */
46 56
public interface ILabelingStrategyPanel {
57
	/**
58
	 * Invoked when de user accepts the settings, the returned value
59
	 * is a always ready-to-work labeling strategy.
60
	 * 
61
	 * @return ILabelingStrategy, a labeling strategy completely set up.
62
	 */
47 63
	public ILabelingStrategy getLabelingStrategy();
64
	
65
	/**
66
	 * Sets the model of the panel. As a general contract, after invoke
67
	 * this method, the panel should be filled with all the values
68
	 * needed and be able to be repainted successfully.
69
	 * 
70
	 * @param layer, the layer to whom the labeling strategy is associated.
71
	 * @param str, the current labeling strategy.
72
	 */
48 73
	public void setModel(FLayer layer, ILabelingStrategy str);
74
	
75
	/**
76
	 * A human-readable localized text to make this strategy easily
77
	 * recognizable among all the available strategies.
78
	 * @return
79
	 */
49 80
	public String getLabelingStrategyName();
50
	public Class getLabelingStrategyClass();
81
	
82
	/**
83
	 * <p>
84
	 * The panel shown in the layer properties dialog is selected through
85
	 * the class of the labeling strategy. This method returns such class.
86
	 * <br>
87
	 * </p>
88
	 * <p>
89
	 * <b>Note</b> that, as a collateral effect, the panel that sets up a labeling strategy
90
	 * can be substituted programatically by other of your wish if
91
	 * you return the same labeling strategy class than the one to
92
	 * be replaced with your new one. The last panel installed, will
93
	 * be the one to be shown.
94
	 * </p>
95
	 * @return Class, the labeling strategy's Class
96
	 */
97
	public Class<? extends ILabelingStrategy> getLabelingStrategyClass();
51 98
}

Also available in: Unified diff