View Javadoc

1   /*
2    * $Id: IDisabledCapability.java,v 1.18 2011/06/16 09:29:40 jbmeslin Exp $
3    * 
4    */
5   package org.rcfaces.core.component.capability;
6   
7   /**
8    * Enable/Disabled state.
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 IDisabledCapability {
14  
15      /**
16       * Returns <code>false</code> if the receiver is enabled and all ancestors
17       * up to and including the receiver's nearest ancestor shell are enabled.
18       * <br>
19       * Otherwise, false is returned. A disabled control is typically not
20       * selectable from the user interface and draws with an inactive or "grayed"
21       * look.
22       * 
23       * @return the receiver's enabled state
24       */
25      boolean isDisabled();
26  
27      /**
28       * Disabled the receiver if the argument is true, and enables it otherwise.
29       * A disabled control is typically not selectable from the user interface
30       * and draws with an inactive or "grayed" look.
31       * 
32       * @param disabled
33       *            the new enabled state
34       */
35      void setDisabled(boolean disabled);
36  }