diff options
Diffstat (limited to 'plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.html')
| -rw-r--r-- | plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.html | 150 |
1 files changed, 12 insertions, 138 deletions
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.html index 2e73acd011..1360d24d80 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.html @@ -191,8 +191,7 @@ Class DefaultPropertySource<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.html#getEditableValue()">getEditableValue</A></B>()</CODE>
<BR>
- Returns a value for this property source that can be edited in a property
- sheet.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -216,7 +215,7 @@ Class DefaultPropertySource<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.html#getPropertyDescriptors()">getPropertyDescriptors</A></B>()</CODE>
<BR>
- Returns the list of property descriptors for this property source.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -224,7 +223,7 @@ Class DefaultPropertySource<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.html#getPropertyValue(java.lang.Object)">getPropertyValue</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> id)</CODE>
<BR>
- Returns the value of the property with the given id if it has one.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -240,8 +239,7 @@ Class DefaultPropertySource<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.html#isPropertySet(java.lang.Object)">isPropertySet</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> id)</CODE>
<BR>
- Returns whether the value of the property with the given id has changed
- from its default value.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -249,7 +247,7 @@ Class DefaultPropertySource<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.html#resetPropertyValue(java.lang.Object)">resetPropertyValue</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> id)</CODE>
<BR>
- Resets the property with the given id to its default value if possible.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -258,7 +256,7 @@ Class DefaultPropertySource<RECEIVER></H2> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</CODE>
<BR>
- Sets the property with the given id if possible.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -359,23 +357,11 @@ getPropertyDescriptors</H3> <PRE>
public org.eclipse.ui.views.properties.IPropertyDescriptor[] <B>getPropertyDescriptors</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></B></DD>
-<DD>Returns the list of property descriptors for this property source. The
- <code>getPropertyValue</code> and <code>setPropertyValue</code>
- methods are used to read and write the actual property values by
- specifying the property ids from these property descriptors.
- <p>
- Implementors should cache the descriptors as they will be asked for the
- descriptors with any edit/update. Since descriptors provide cell editors,
- returning the same descriptors if possible allows for efficient updating.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getPropertyDescriptors</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the property descriptors</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -413,17 +399,11 @@ getPropertyValue</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getPropertyValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> id)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></B></DD>
-<DD>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.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getPropertyValue</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>id</CODE> - the id of the property being set
-<DT><B>Returns:</B><DD>the value of the property, or <code>null</code><DT><B>See Also:</B><DD><CODE>IPropertySource.setPropertyValue(java.lang.Object, java.lang.Object)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -433,26 +413,11 @@ isPropertySet</H3> <PRE>
public boolean <B>isPropertySet</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> id)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></B></DD>
-<DD>Returns whether the value of the property with the given id has changed
- from its default value. Returns <code>false</code> if this source does
- not have the specified property.
- <p>
- If the notion of default value is not meaningful for the specified
- property then <code>false</code> is returned.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isPropertySet</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>id</CODE> - the id of the property
-<DT><B>Returns:</B><DD><code>true</code> if the value of the specified property has
- changed from its original default value, <code>false</code> if
- the specified property does not have a meaningful default value,
- and <code>false</code> if this source does not have the
- specified property<DT><B>See Also:</B><DD><CODE>IPropertySource2.isPropertyResettable(Object)</CODE>,
-<CODE>IPropertySource.resetPropertyValue(Object)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -462,26 +427,11 @@ resetPropertyValue</H3> <PRE>
public void <B>resetPropertyValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> id)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></B></DD>
-<DD>Resets the property with the given id to its default value if possible.
- <p>
- Does nothing if the notion of a default value is not meaningful for the
- specified property, or if the property's value cannot be changed, or if
- this source does not have the specified property.
- </p>
- <p>
- Callers will check if this <code>IPropertySource</code> implements
- <code>IPropertySource2</code> and this method will only be called if
- <code>IPropertySource2#isPropertyResettable(Object)</code> returns
- <code>true</code> for the property with the given id.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>resetPropertyValue</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>id</CODE> - the id of the property being reset<DT><B>See Also:</B><DD><CODE>IPropertySource.isPropertySet(Object)</CODE>,
-<CODE>IPropertySource2.isPropertyResettable(Object)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -492,49 +442,11 @@ setPropertyValue</H3> public void <B>setPropertyValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> id,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></B></DD>
-<DD>Sets the property with the given id if possible. Does nothing if the
- property's value cannot be changed or if this source does not have the
- 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>
- <p>
- There is another reason why a level of indirection is useful. The real
- value of property may be a type that cannot be edited with a standard
- cell editor. However instead of returning the real value in
- <code>getPropertyValue</code>, the value could be converted to a
- <code>String</code> which could be edited with a standard cell editor.
- The edited value will be passed to this method which can then turn it
- back into the real property value.
- </p>
- <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 child property source using
- <code>getEditableValue</code>. It is this editable value that will be
- passed back via this method when it has been editted
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setPropertyValue</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>id</CODE> - the id of the property being set<DD><CODE>value</CODE> - the new value for the property; <code>null</code> is allowed<DT><B>See Also:</B><DD><CODE>IPropertySource.getPropertyValue(java.lang.Object)</CODE>,
-<CODE>IPropertySource.getEditableValue()</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -544,49 +456,11 @@ getEditableValue</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getEditableValue</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></B></DD>
-<DD>Returns a value for this property source that can be edited in a property
- sheet.
- <p>
- This value is used when this <code>IPropertySource</code> is appearing
- in the property sheet as the value of a property of some other
- <code>IPropertySource</code>
- </p>
- <p>
- This value is passed as the input to a cell editor opening on an
- <code>IPropertySource</code>.
- </p>
- <p>
- This value is also used when an <code>IPropertySource</code> is being
- used as the value in a <code>setPropertyValue</code> message. The
- reciever of the message would then typically use the editable value to
- update the original property source or construct a new instance.
- </p>
- <p>
- For example an email address which is a property source may have an
- editable value which is a string so that it can be edited in a text cell
- editor. The email address would also have a constructor or setter that
- takes the edited string so that an appropriate instance can be created or
- the original instance modified when the edited value is set.
- </p>
- <p>
- This behavior is important for another reason. When the property sheet is
- showing properties for more than one object (multiple selection), a
- property sheet entry will display and edit a single value (typically
- coming from the first selected object). After a property has been edited
- in a cell editor, the same value is set as the property value for all of
- the objects. This is fine for primitive types but otherwise all of the
- objects end up with a reference to the same value. Thus by creating an
- editable value and using it to update the state of the original property
- source object, one is able to edit several property source objects at
- once (multiple selection).
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getEditableValue</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertySource</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>a value that can be edited</DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
|