001: /*
002: * Copyright (c) 2004 JETA Software, Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without modification,
005: * are permitted provided that the following conditions are met:
006: *
007: * o Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * o Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: *
014: * o Neither the name of JETA Software nor the names of its contributors may
015: * be used to endorse or promote products derived from this software without
016: * specific prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
020: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
021: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
022: * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
023: * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
024: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
025: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
026: * INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: */
029:
030: package com.jeta.forms.gui.beans;
031:
032: import java.lang.reflect.Method;
033:
034: import com.jeta.forms.gui.common.FormException;
035:
036: /**
037: * An enhanced PropertyDescriptor to support dynamically adding and removing
038: * properties to a Java Bean. This type of descriptor also defines how a
039: * property value is set and retrieved.
040: *
041: * @see java.beans.PropertyDescriptor
042: *
043: * @author Jeff Tassin
044: */
045: public interface JETAPropertyDescriptor {
046: /**
047: * Return the display name for the property.
048: */
049: public String getDisplayName();
050:
051: /**
052: * Return the name of the property.
053: */
054: public String getName();
055:
056: /**
057: * Returns the value of the associated property in the given bean.
058: *
059: * @return the value for property
060: */
061: public Object getPropertyValue(JETABean bean) throws FormException;
062:
063: /**
064: * Gets a PropertyEditor class that has been registered for the property.
065: * Null is returned if no property editor class has been registered.
066: */
067: public Class getPropertyEditorClass();
068:
069: /**
070: * Returns the class object for the property.
071: */
072: public Class getPropertyType();
073:
074: /**
075: * Gets the short description for the property.
076: */
077: public String getShortDescription();
078:
079: /**
080: * Returns a method object used to set the property value. Null is returned
081: * if the property is not writable.
082: */
083: public Method getWriteMethod();
084:
085: /**
086: * The "hidden" flag is used to identify features that are intended only for
087: * tool use, and which should not be exposed to humans.
088: */
089: public boolean isHidden();
090:
091: /**
092: * The "preferred" flag is used to identify features that are particularly
093: * important for presenting to humans
094: */
095: public boolean isPreferred();
096:
097: /**
098: * Returns true if the property should not be stored.
099: */
100: public boolean isTransient();
101:
102: /**
103: * Returns true if the property is writable.
104: */
105: public boolean isWritable();
106:
107: /**
108: * Sets this property to preferred.
109: */
110: public void setPreferred(boolean bpref);
111:
112: /**
113: * Sets the value for this property on the given bean.
114: *
115: * @param bean
116: * the JETABean that contains the property to set
117: * @param value
118: * the value of the property
119: */
120: public void setPropertyValue(JETABean bean, Object value)
121: throws FormException;
122:
123: }
|