1 /*
2 * $Id: IVisibilityCapability.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 IVisibilityCapability {
14
15 /**
16 * Marks the receiver as visible if the argument is
17 * <code>{@link Boolean#TRUE TRUE}</code>, and marks it invisible if
18 * argument is <code>{@link Boolean#FALSE FALSE}</code>. <br>
19 * If one of the receiver's ancestors is not visible or some other condition
20 * makes the receiver not visible, marking it visible may not actually cause
21 * it to be displayed.
22 *
23 * @param visible
24 * the new visibility state.
25 */
26 void setVisible(boolean visible);
27
28 boolean isVisible();
29
30 /**
31 * Returns <code>{@link Boolean#TRUE TRUE}</code> if the receiver is
32 * visible, <code>{@link Boolean#FALSE FALSE}</code> if the receiver is
33 * specified "not visible", and <code>null</code> otherwise. <br>
34 * If one of the receiver's ancestors is not visible or some other condition
35 * makes the receiver not visible, this method may still indicate that it is
36 * considered visible even though it may not actually be showing.
37 *
38 * @return the receiver's visibility state
39 */
40 Boolean getVisibleState();
41 }