Attachment #5231 for bug #24632

View | Details | Raw Unified | Return to bug 24632
Collapse All | Expand All






/**
 * Interface to an object which is capable of supplying properties for display by
 * the standard property sheet page implementation (<code>PropertySheetPage</code>).
 * <p>
 * This interface should be implemented by clients.
 * <code>PropertySheetPage</code> discovers the properties to display from 

public IPropertyDescriptor[] getPropertyDescriptors();
/**
 * Returns the value of the property with the given id if it has one.
 * Returns <code>null</code> if the property's value is <code>null</code> 
 * value or if this source does not have the specified property.
 * property.
 *
 * @see #setPropertyValue
 *

 * specified property.
 * <p>
 * In general, a property source should not directly reference the value
 * parameter unless it is an atomic object that can be shared, such as a 
 * string.
 * </p>
 * <p>
 * An important reason for this is that several property sources with 
 * compatible descriptors could be appearing in the property sheet at 
 * the same time. An editor produces a single edited value which is passed
 * as the value parameter of this message to all the property sources.
 * Thus to avoid a situation where all of the property sources reference
 * the same value they should use the value parameter to create a
 * new instance of the real value for the given property.

 * <p>Another variation on returning a value other than the real property value in 
 * <code>getPropertyValue</code> is to return a value which is an
 * <code>IPropertySource</code> (or for which the property sheet can obtain an
 * <code>IPropertySource</code>). In this case the value to edit is obtained from the
 * for the value itself. In this case the value to edit is obtained from the
 * child property source using <code>getEditableValue</code>. It is this editable value
 * that will be passed back via this method when the it has been editted
 * </p>
 *
 * @see #getPropertyValue

Return to bug 24632

Lines 12-19 Link Here

(-)src/org/eclipse/ui/views/properties/IPropertySource.java (-10 / +8 lines)
12		12
13		13
14	/**	14	/**
15	* Interface to an object capable of supplying properties for display by the	15	* Interface to an object which is capable of supplying properties for display by
16	* standard property sheet page implementation (<code>PropertySheetPage</code>).	16	* the standard property sheet page implementation (<code>PropertySheetPage</code>).
17	* <p>	17	* <p>
18	* This interface should be implemented by clients.	18	* This interface should be implemented by clients.
19	* <code>PropertySheetPage</code> discovers the properties to display from	19	* <code>PropertySheetPage</code> discovers the properties to display from
Lines 88-96 Link Here
88	public IPropertyDescriptor[] getPropertyDescriptors();	88	public IPropertyDescriptor[] getPropertyDescriptors();
89	/**	89	/**
90	* Returns the value of the property with the given id if it has one.	90	* Returns the value of the property with the given id if it has one.
91	* Returns <code>null</code> if this source if the property's value is	91	* Returns <code>null</code> if the property's value is <code>null</code>
92	* <code>null</code> value or if this source does not have the specified	92	* value or if this source does not have the specified property.
93	* property.
94	*	93	*
95	* @see #setPropertyValue	94	* @see #setPropertyValue
96	*	95	*
Lines 124-137 Link Here
124	* specified property.	123	* specified property.
125	* <p>	124	* <p>
126	* In general, a property source should not directly reference the value	125	* In general, a property source should not directly reference the value
127	* parameter unless it is an atomic object that can be shared such as a	126	* parameter unless it is an atomic object that can be shared, such as a
128	* string.	127	* string.
129	* </p>	128	* </p>
130	* <p>	129	* <p>
131	* An important reason for this is that several property sources with	130	* An important reason for this is that several property sources with
132	* compatible descriptors could be appearing in the property sheet at	131	* compatible descriptors could be appearing in the property sheet at
133	* the same time. An editor produces a single edited value which is passed	132	* the same time. An editor produces a single edited value which is passed
134	* at the value parameter of this message to all the property sources.	133	* as the value parameter of this message to all the property sources.
135	* Thus to avoid a situation where all of the property sources reference	134	* Thus to avoid a situation where all of the property sources reference
136	* the same value they should use the value parameter to create a	135	* the same value they should use the value parameter to create a
137	* new instance of the real value for the given property.	136	* new instance of the real value for the given property.
Lines 147-156 Link Here
147	* <p>Another variation on returning a value other than the real property value in	146	* <p>Another variation on returning a value other than the real property value in
148	* <code>getPropertyValue</code> is to return a value which is an	147	* <code>getPropertyValue</code> is to return a value which is an
149	* <code>IPropertySource</code> (or for which the property sheet can obtain an	148	* <code>IPropertySource</code> (or for which the property sheet can obtain an
150	* <code>IPropertySource</code>). This allows the property sheet to properties	149	* <code>IPropertySource</code>). In this case the value to edit is obtained from the
151	* for the value itself. In this case the value to edit is obtained from the
152	* child property source using <code>getEditableValue</code>. It is this editable value	150	* child property source using <code>getEditableValue</code>. It is this editable value
153	* that will be passed back via this method when the it has been edited	151	* that will be passed back via this method when the it has been editted
154	* </p>	152	* </p>
155	*	153	*
156	* @see #getPropertyValue	154	* @see #getPropertyValue