01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package com.sun.rave.designtime.faces;
43:
44: import javax.faces.el.ValueBinding;
45: import com.sun.rave.designtime.DesignProperty;
46:
47: /**
48: * <p>A FacesDesignProperty represents a single property (setter/getter method pair) on a single
49: * instance of a FacesDesignBean at design-time. This interface adds methods for dealing with
50: * value binding expressions on a DesignProperty.</p>
51: *
52: * <P><B>IMPLEMENTED BY CREATOR</B> - This interface is implemented by Creator for use by the
53: * component (bean) author.</P>
54: *
55: * @author Joe Nuxoll
56: * @version 1.0
57: * @see DesignProperty
58: * @see com.sun.rave.designtime.DesignBean#getProperties()
59: * @see com.sun.rave.designtime.DesignBean#getProperty(String)
60: */
61: public interface FacesDesignProperty extends DesignProperty {
62:
63: /**
64: * Returns <code>true</code> if this property is currently bound with a value expression,
65: * <code>false</code> if not.
66: *
67: * @return <code>true</code> if this property is currently bound with a value expression,
68: * <code>false</code> if not
69: */
70: public boolean isBound();
71:
72: /**
73: * Returns the ValueBinding object that this property is bound to, IF this property is currently
74: * bound via a value expression, or null if it is not bound
75: *
76: * @return the ValueBinding object that this property is bound to, IF this property is currently
77: * bound via a value expression, or null if it is not bound
78: */
79: public ValueBinding getValueBinding();
80:
81: /**
82: * Sets the ValueBinding on this property, resulting in the property value being set to the
83: * appropriate value binding expression
84: *
85: * @param binding The desired ValueBinding to set as the value on this property
86: */
87: public void setValueBinding(ValueBinding binding);
88: }
|