1 /*
2 * $Id: ISelected3StatesCapability.java,v 1.18 2011/06/16 09:29:40 jbmeslin Exp $
3 *
4 */
5 package org.rcfaces.core.component.capability;
6
7 /**
8 *
9 *
10 * @author Olivier Oeuillot (latest modification by $Author: jbmeslin $)
11 * @version $Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
12 */
13 public interface ISelected3StatesCapability {
14
15 String NOT_SELECTED_STATE = "notSelected";
16
17 String SELECTED_STATE = "selected";
18
19 String UNDETERMINATED_STATE = "undeterminated";
20
21 /**
22 * Returns a string value indicating wether the component is selected.
23 *
24 * @return NOT_SELECTED_STATE:notSelected|SELECTED_STATE:selected|UNDETERMINATED_STATE:undeterminated
25 */
26 String getSelectedState();
27
28 /**
29 * Sets a string value indicating wether the component is selected.
30 *
31 * @param selectedState
32 * NOT_SELECTED_STATE:notSelected|SELECTED_STATE:selected|UNDETERMINATED_STATE:undeterminated
33 */
34 void setSelectedState(String selectedState);
35
36 /**
37 * Returns a boolean value indicating wether the component is selected.
38 *
39 * @return true if selected, false otherwise
40 */
41 boolean isSelected();
42
43 /**
44 * Sets a boolean value indicating wether the component is in a
45 * undeterminated select state.
46 *
47 * @return true if undeterminate select state, false otherwise
48 */
49 boolean isUndeterminated();
50 }