001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package com.sun.rave.designtime;
043:
044: import java.beans.PropertyDescriptor;
045:
046: /**
047: * <p>A DesignProperty represents a single property (setter/getter method pair) on a single instance
048: * of a DesignBean at design-time. All manipulation of properties at design-time should be done via
049: * this interface. This allows the IDE to both persist the changes as well as reflect them in the
050: * design-time session.</p>
051: *
052: * <P><B>IMPLEMENTED BY CREATOR</B> - This interface is implemented by Creator for use by the
053: * component (bean) author.</P>
054: *
055: * @author Joe Nuxoll
056: * @version 1.0
057: * @see DesignBean#getProperties()
058: * @see DesignBean#getProperty(String)
059: */
060: public interface DesignProperty {
061:
062: /**
063: * Returns the PropertyDescriptor associated with this DesignProperty
064: *
065: * @return the PropertyDescriptor associated with this DesignProperty
066: */
067: public PropertyDescriptor getPropertyDescriptor();
068:
069: /**
070: * Returns the DesignBean that this DesignProperty is associated with
071: *
072: * @return the DesignBean that this DesignProperty is associated with
073: */
074: public DesignBean getDesignBean();
075:
076: /**
077: * Returns the current value of this DesignProperty. The returned value is the *actual* value
078: * that the design-time instance of the DesignBean has set for this property.
079: *
080: * @return the current value of this DesignProperty
081: */
082: public Object getValue();
083:
084: /**
085: * Sets the current value of this DesignProperty. This will set the *actual* value of this
086: * property on the design-time instance of this DesignBean. The associated PropertyEditor will
087: * be used to produce the appropriate Java or markup code to set the property. Calling this
088: * method results in the persistence being written, and will cause the backing file buffer to
089: * become "dirty".
090: *
091: * @param value The Object value to set as the currrent value of this property
092: * @return <code>true</code> if the property setting was successful, <code>false</code> if it
093: * was not
094: * @see java.beans.PropertyEditor
095: */
096: public boolean setValue(Object value);
097:
098: /**
099: * Returns the source-persistence String value of this property. This is the value that
100: * the associated PropertyEditor would use to persist the property's current value in source
101: * code.
102: *
103: * @return the source-persistence String value of this property
104: * @see java.beans.PropertyEditor#getJavaInitializationString()
105: */
106: public String getValueSource();
107:
108: /**
109: * Sets the source-persistence String value for this property. This is the value that will
110: * acutally appear in Java source code (or markup), depending on how the property setting is
111: * persisted.
112: *
113: * @param source the source-persistence String value for this property
114: * @return <code>true</code> if the property source setting was successful, <code>false</code>
115: * if not
116: */
117: public boolean setValueSource(String source);
118:
119: /**
120: * Returns the value that this property would have if it were unset. This is the property's
121: * original (default) state, which is determined by reading the property value on a fresh
122: * instance of the associated class (that owns this property).
123: *
124: * @return The unset (default) value for this property
125: */
126: public Object getUnsetValue();
127:
128: /**
129: * Removes the property setting (if it exists) from the source code, and reverts the property
130: * setting back to its original (default) state. The original state is determined by reading
131: * the property value on a fresh instance of the associated class (that owns this property),
132: * and reading the default value of the property.
133: *
134: * @return <code>true</code> if the unset operation was successful, <code>false</code> if not
135: */
136: public boolean unset();
137:
138: /**
139: * Returns <code>true</code> if this DesignProperty has been modified from the 'default' value.
140: * A 'modified' property is one that differs in value (== and .equals()) from a newly
141: * constructed instance of the DesignBean.
142: *
143: * @return <code>true</code> if this DesignProperty has been modified from the 'default' value,
144: * <code>false</code> if not
145: */
146: public boolean isModified();
147:
148: // /**
149: // * Returns an array of DesignProperty objects representing the sub-properties of this property
150: // * based on the static type of this property.
151: // *
152: // * @return
153: // */
154: // public DesignProperty[] getProperties();
155: //
156: // /**
157: // *
158: // * @param propertyName
159: // * @return
160: // */
161: // public DesignProperty getProperty(String propertyName);
162: //
163: // /**
164: // *
165: // * @param property
166: // * @return
167: // */
168: // public DesignProperty getProperty(PropertyDescriptor property);
169: }
|