diff options
| author | Eike Stepper | 2011-09-15 07:50:18 +0000 |
|---|---|---|
| committer | Eike Stepper | 2011-09-15 07:50:18 +0000 |
| commit | 8fd24ebf464e7af8b0b62f0b821805cdacc46318 (patch) | |
| tree | 66f981d1e2b23fc4ff5c10ef00eceb9f9da38835 /plugins/org.eclipse.net4j.util.doc/javadoc | |
| parent | 7009dc64b0cce9a62f0b114257b3451043e453e9 (diff) | |
| download | cdo-8fd24ebf464e7af8b0b62f0b821805cdacc46318.tar.gz cdo-8fd24ebf464e7af8b0b62f0b821805cdacc46318.tar.xz cdo-8fd24ebf464e7af8b0b62f0b821805cdacc46318.zip | |
tutorials
Diffstat (limited to 'plugins/org.eclipse.net4j.util.doc/javadoc')
26 files changed, 246 insertions, 1581 deletions
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/OSGiActivator.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/OSGiActivator.html index 84d80fb881..0ede5eef42 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/OSGiActivator.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/OSGiActivator.html @@ -250,8 +250,7 @@ A default implementation of an OSGi <CODE>bundle activator</CODE> for OM <A HREF <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/om/OSGiActivator.html#start(org.osgi.framework.BundleContext)">start</A></B>(org.osgi.framework.BundleContext context)</CODE>
<BR>
- Called when this bundle is started so the Framework can perform the
- bundle-specific activities necessary to start this bundle.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -259,8 +258,7 @@ A default implementation of an OSGi <CODE>bundle activator</CODE> for OM <A HREF <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/om/OSGiActivator.html#stop(org.osgi.framework.BundleContext)">stop</A></B>(org.osgi.framework.BundleContext context)</CODE>
<BR>
- Called when this bundle is stopped so the Framework can perform the
- bundle-specific activities necessary to stop the bundle.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -367,25 +365,13 @@ start</H3> public final void <B>start</B>(org.osgi.framework.BundleContext context)
throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.osgi.framework.BundleActivator</CODE></B></DD>
-<DD>Called when this bundle is started so the Framework can perform the
- bundle-specific activities necessary to start this bundle. This method
- can be used to register services or to allocate any resources that this
- bundle needs.
-
- <p>
- This method must complete and return to its caller in a timely manner.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>start</CODE> in interface <CODE>org.osgi.framework.BundleActivator</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>context</CODE> - The execution context of the bundle being started.
+
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - If this method throws an exception, this
- bundle is marked as stopped and the Framework will remove this
- bundle's listeners, unregister all services registered by this
- bundle, and release all services used by this bundle.</DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
</DD>
</DL>
<HR>
@@ -396,27 +382,13 @@ stop</H3> public final void <B>stop</B>(org.osgi.framework.BundleContext context)
throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.osgi.framework.BundleActivator</CODE></B></DD>
-<DD>Called when this bundle is stopped so the Framework can perform the
- bundle-specific activities necessary to stop the bundle. In general, this
- method should undo the work that the <code>BundleActivator.start</code>
- method started. There should be no active threads that were started by
- this bundle when this bundle returns. A stopped bundle must not call any
- Framework objects.
-
- <p>
- This method must complete and return to its caller in a timely manner.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>stop</CODE> in interface <CODE>org.osgi.framework.BundleActivator</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>context</CODE> - The execution context of the bundle being stopped.
+
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - If this method throws an exception, the
- bundle is still marked as stopped, and the Framework will remove
- the bundle's listeners, unregister all services registered by the
- bundle, and release all services used by the bundle.</DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/OSGiApplication.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/OSGiApplication.html index 7652fee84b..74bb00ee93 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/OSGiApplication.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/OSGiApplication.html @@ -206,7 +206,7 @@ A default implementation of an OSGi <CODE>application</CODE>. <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/om/OSGiApplication.html#start(org.eclipse.equinox.app.IApplicationContext)">start</A></B>(org.eclipse.equinox.app.IApplicationContext context)</CODE>
<BR>
- Starts this application with the given context and returns a result.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -214,7 +214,7 @@ A default implementation of an OSGi <CODE>application</CODE>. <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/om/OSGiApplication.html#stop()">stop</A></B>()</CODE>
<BR>
- Forces this running application to exit.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -320,33 +320,13 @@ start</H3> public final <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>start</B>(org.eclipse.equinox.app.IApplicationContext context)
throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.equinox.app.IApplication</CODE></B></DD>
-<DD>Starts this application with the given context and returns a result. The content of
- the context is unchecked and should conform to the expectations of the application being
- invoked. This method can return the value <CODE>IApplicationContext.EXIT_ASYNC_RESULT</CODE> if
- the application will deliver its results asynchronously with the
- <CODE>IApplicationContext.setResult(Object, IApplication)</CODE> method; otherwise this method must not exit
- until the application is finished and is ready to exit.
- <p>
- Applications can return any object they like. If an <code>Integer</code> is returned
- it is treated as the program exit code if Eclipse is exiting.
- </p>
- <p>
- Note: This method is called by the platform; it is not intended
- to be called directly by clients.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>start</CODE> in interface <CODE>org.eclipse.equinox.app.IApplication</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>context</CODE> - the application context to pass to the application
-<DT><B>Returns:</B><DD>the return value of the application
+
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if there is a problem running this application.<DT><B>See Also:</B><DD><CODE>IApplication.EXIT_OK</CODE>,
-<CODE>IApplication.EXIT_RESTART</CODE>,
-<CODE>IApplication.EXIT_RELAUNCH</CODE>,
-<CODE>IApplicationContext.EXIT_ASYNC_RESULT</CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
</DD>
</DL>
<HR>
@@ -356,19 +336,6 @@ stop</H3> <PRE>
public final void <B>stop</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.equinox.app.IApplication</CODE></B></DD>
-<DD>Forces this running application to exit. This method should wait until the
- running application is ready to exit. The <CODE>IApplication.start(IApplicationContext)</CODE>
- should already have exited or should exit very soon after this method exits<p>
-
- This method is only called to force an application to exit.
- This method will not be called if an application exits normally from
- the <CODE>IApplication.start(IApplicationContext)</CODE> method.
- <p>
- Note: This method is called by the platform; it is not intended
- to be called directly by clients.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>stop</CODE> in interface <CODE>org.eclipse.equinox.app.IApplication</CODE></DL>
</DD>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html index 8be2ed930e..e427c85f23 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html @@ -186,8 +186,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta int totalWork)</CODE>
<BR>
- This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -195,8 +194,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html#clearBlocked()">clearBlocked</A></B>()</CODE>
<BR>
- This implementation of a <code>IProgressMonitorWithBlocking</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -204,8 +202,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html#done()">done</A></B>()</CODE>
<BR>
- This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -213,8 +210,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html#internalWorked(double)">internalWorked</A></B>(double work)</CODE>
<BR>
- This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -222,8 +218,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html#isCanceled()">isCanceled</A></B>()</CODE>
<BR>
- This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -231,8 +226,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html#setBlocked(org.eclipse.core.runtime.IStatus)">setBlocked</A></B>(org.eclipse.core.runtime.IStatus reason)</CODE>
<BR>
- This implementation of a <code>IProgressMonitorWithBlocking</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -240,8 +234,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html#setCanceled(boolean)">setCanceled</A></B>(boolean b)</CODE>
<BR>
- This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -249,8 +242,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html#setTaskName(java.lang.String)">setTaskName</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -258,8 +250,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html#subTask(java.lang.String)">subTask</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -267,8 +258,7 @@ A sub progress monitor that synchronizes all methods on the parent monitor insta <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/om/monitor/EclipseMonitor.SynchronizedSubProgressMonitor.html#worked(int)">worked</A></B>(int work)</CODE>
<BR>
- This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.eclipse.core.runtime.ProgressMonitorWrapper"><!-- --></A>
@@ -326,20 +316,11 @@ beginTask</H3> public void <B>beginTask</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
int totalWork)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>beginTask</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitor</CODE><DT><B>Overrides:</B><DD><CODE>beginTask</CODE> in class <CODE>org.eclipse.core.runtime.SubProgressMonitor</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name (or description) of the main task<DD><CODE>totalWork</CODE> - the total number of work units into which
- the main task is been subdivided. If the value is <code>UNKNOWN</code>
- the implementation is free to indicate progress in a way which
- doesn't require the total number of work units in advance.<DT><B>See Also:</B><DD><CODE>IProgressMonitor.beginTask(String, int)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -349,17 +330,11 @@ clearBlocked</H3> <PRE>
public void <B>clearBlocked</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitorWithBlocking</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>clearBlocked</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitorWithBlocking</CODE><DT><B>Overrides:</B><DD><CODE>clearBlocked</CODE> in class <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></DL>
</DD>
<DD><DL>
-<DT><B>See Also:</B><DD><CODE>IProgressMonitorWithBlocking.clearBlocked()</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -369,17 +344,11 @@ done</H3> <PRE>
public void <B>done</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>done</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitor</CODE><DT><B>Overrides:</B><DD><CODE>done</CODE> in class <CODE>org.eclipse.core.runtime.SubProgressMonitor</CODE></DL>
</DD>
<DD><DL>
-<DT><B>See Also:</B><DD><CODE>IProgressMonitor.done()</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -389,17 +358,11 @@ internalWorked</H3> <PRE>
public void <B>internalWorked</B>(double work)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>internalWorked</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitor</CODE><DT><B>Overrides:</B><DD><CODE>internalWorked</CODE> in class <CODE>org.eclipse.core.runtime.SubProgressMonitor</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>work</CODE> - the amount of work done<DT><B>See Also:</B><DD><CODE>IProgressMonitor.internalWorked(double)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -409,19 +372,11 @@ isCanceled</H3> <PRE>
public boolean <B>isCanceled</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isCanceled</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitor</CODE><DT><B>Overrides:</B><DD><CODE>isCanceled</CODE> in class <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD><code>true</code> if cancellation has been requested,
- and <code>false</code> otherwise<DT><B>See Also:</B><DD><CODE>IProgressMonitor.isCanceled()</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -431,19 +386,11 @@ setBlocked</H3> <PRE>
public void <B>setBlocked</B>(org.eclipse.core.runtime.IStatus reason)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitorWithBlocking</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setBlocked</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitorWithBlocking</CODE><DT><B>Overrides:</B><DD><CODE>setBlocked</CODE> in class <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>reason</CODE> - an optional status object whose message describes the
- reason why this operation is blocked, or <code>null</code> if this
- information is not available.<DT><B>See Also:</B><DD><CODE>IProgressMonitorWithBlocking.setBlocked(IStatus)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -453,19 +400,11 @@ setCanceled</H3> <PRE>
public void <B>setCanceled</B>(boolean b)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setCanceled</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitor</CODE><DT><B>Overrides:</B><DD><CODE>setCanceled</CODE> in class <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>b</CODE> - <code>true</code> indicates that cancelation has
- been requested (but not necessarily acknowledged);
- <code>false</code> clears this flag<DT><B>See Also:</B><DD><CODE>IProgressMonitor.setCanceled(boolean)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -475,17 +414,11 @@ setTaskName</H3> <PRE>
public void <B>setTaskName</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setTaskName</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitor</CODE><DT><B>Overrides:</B><DD><CODE>setTaskName</CODE> in class <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name (or description) of the main task<DT><B>See Also:</B><DD><CODE>IProgressMonitor.setTaskName(String)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -495,17 +428,11 @@ subTask</H3> <PRE>
public void <B>subTask</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>subTask</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitor</CODE><DT><B>Overrides:</B><DD><CODE>subTask</CODE> in class <CODE>org.eclipse.core.runtime.SubProgressMonitor</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name (or description) of the subtask<DT><B>See Also:</B><DD><CODE>IProgressMonitor.subTask(String)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -515,17 +442,11 @@ worked</H3> <PRE>
public void <B>worked</B>(int work)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.core.runtime.ProgressMonitorWrapper</CODE></B></DD>
-<DD>This implementation of a <code>IProgressMonitor</code>
- method forwards to the wrapped progress monitor.
- Clients may override this method to do additional
- processing.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>worked</CODE> in interface <CODE>org.eclipse.core.runtime.IProgressMonitor</CODE><DT><B>Overrides:</B><DD><CODE>worked</CODE> in class <CODE>org.eclipse.core.runtime.SubProgressMonitor</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>work</CODE> - a non-negative number of work units just completed<DT><B>See Also:</B><DD><CODE>IProgressMonitor.worked(int)</CODE></DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/properties/DefaultPropertyTester.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/properties/DefaultPropertyTester.html index 0318e54800..f55f5b64b2 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/properties/DefaultPropertyTester.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/properties/DefaultPropertyTester.html @@ -206,7 +206,7 @@ Tests properties of receiver objects against expected values. <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> expectedValue)</CODE>
<BR>
- Executes the property test determined by the parameter <code>property</code>.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.eclipse.core.expressions.PropertyTester"><!-- --></A>
@@ -336,19 +336,11 @@ public boolean <B>test</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs <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>[] args,
<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> expectedValue)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.core.expressions.IPropertyTester</CODE></B></DD>
-<DD>Executes the property test determined by the parameter <code>property</code>.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>test</CODE> in interface <CODE>org.eclipse.core.expressions.IPropertyTester</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>receiver</CODE> - the receiver of the property test<DD><CODE>propertyName</CODE> - the property to test<DD><CODE>args</CODE> - additional arguments to evaluate the property. If no arguments are specified in
- the <code>test</code> expression an array of length 0 is passed<DD><CODE>expectedValue</CODE> - the expected value of the property. The value is either of type
- <code>java.lang.String</code> or a boxed base type. If no value was specified in
- the <code>test</code> expressions then <code>null</code> is passed
-<DT><B>Returns:</B><DD>returns <code>true</code> if the property is equal to the expected value; otherwise
- <code>false</code> is returned</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/AbstractPropertyAdapterFactory.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/AbstractPropertyAdapterFactory.html index 7801d91a04..9a8a0fb37d 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/AbstractPropertyAdapterFactory.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/AbstractPropertyAdapterFactory.html @@ -157,8 +157,7 @@ Class AbstractPropertyAdapterFactory</H2> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> adapterType)</CODE>
<BR>
- Returns an object which is an instance of the given class
- associated with the given object.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -166,8 +165,7 @@ Class AbstractPropertyAdapterFactory</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/AbstractPropertyAdapterFactory.html#getAdapterList()">getAdapterList</A></B>()</CODE>
<BR>
- Returns the collection of adapter types handled by this
- factory.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -214,21 +212,11 @@ getAdapterList</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>[] <B>getAdapterList</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.core.runtime.IAdapterFactory</CODE></B></DD>
-<DD>Returns the collection of adapter types handled by this
- factory.
- <p>
- This method is generally used by an adapter manager
- to discover which adapter types are supported, in advance
- of dispatching any actual <code>getAdapter</code> requests.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getAdapterList</CODE> in interface <CODE>org.eclipse.core.runtime.IAdapterFactory</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the collection of adapter types</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -239,21 +227,11 @@ getAdapter</H3> 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>getAdapter</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> adaptableObject,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> adapterType)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.core.runtime.IAdapterFactory</CODE></B></DD>
-<DD>Returns an object which is an instance of the given class
- associated with the given object. Returns <code>null</code> if
- no such object can be found.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getAdapter</CODE> in interface <CODE>org.eclipse.core.runtime.IAdapterFactory</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>adaptableObject</CODE> - the adaptable object being queried
- (usually an instance of <code>IAdaptable</code>)<DD><CODE>adapterType</CODE> - the type of adapter to look up
-<DT><B>Returns:</B><DD>a object castable to the given adapter type,
- or <code>null</code> if this adapter factory
- does not have an adapter of the given type for the
- given object</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html index a3833ccdd6..5eee5995cc 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html @@ -147,7 +147,7 @@ Class DefaultPropertySource.DelegatingPropertyDescriptor<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html#createPropertyEditor(org.eclipse.swt.widgets.Composite)">createPropertyEditor</A></B>(org.eclipse.swt.widgets.Composite parent)</CODE>
<BR>
- Creates and returns a new cell editor for editing this property.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -155,7 +155,7 @@ Class DefaultPropertySource.DelegatingPropertyDescriptor<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html#getCategory()">getCategory</A></B>()</CODE>
<BR>
- Returns the name of the category to which this property belongs.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -163,7 +163,7 @@ Class DefaultPropertySource.DelegatingPropertyDescriptor<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html#getDescription()">getDescription</A></B>()</CODE>
<BR>
- Returns a brief description of this property.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -171,7 +171,7 @@ Class DefaultPropertySource.DelegatingPropertyDescriptor<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html#getDisplayName()">getDisplayName</A></B>()</CODE>
<BR>
- Returns the display name for this property.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -179,7 +179,7 @@ Class DefaultPropertySource.DelegatingPropertyDescriptor<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html#getFilterFlags()">getFilterFlags</A></B>()</CODE>
<BR>
- Returns a list of filter types to which this property belongs.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -187,8 +187,7 @@ Class DefaultPropertySource.DelegatingPropertyDescriptor<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html#getHelpContextIds()">getHelpContextIds</A></B>()</CODE>
<BR>
- Returns the help context id for this property or
- <code>null</code> if this property has no help context id.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -196,7 +195,7 @@ Class DefaultPropertySource.DelegatingPropertyDescriptor<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html#getId()">getId</A></B>()</CODE>
<BR>
- Returns the id for this property.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -204,7 +203,7 @@ Class DefaultPropertySource.DelegatingPropertyDescriptor<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html#getLabelProvider()">getLabelProvider</A></B>()</CODE>
<BR>
- Returns the label provider for this property.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -220,7 +219,7 @@ Class DefaultPropertySource.DelegatingPropertyDescriptor<RECEIVER></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DefaultPropertySource.DelegatingPropertyDescriptor.html#isCompatibleWith(org.eclipse.ui.views.properties.IPropertyDescriptor)">isCompatibleWith</A></B>(org.eclipse.ui.views.properties.IPropertyDescriptor anotherProperty)</CODE>
<BR>
- Returns whether this property descriptor and the given one are compatible.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -289,18 +288,11 @@ getCategory</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getCategory</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></B></DD>
-<DD>Returns the name of the category to which this property belongs. Properties
- belonging to the same category are grouped together visually. This localized
- string is shown to the user
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getCategory</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the category name, or <code>null</code> if the default category is to
- be used</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -310,17 +302,11 @@ getId</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getId</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></B></DD>
-<DD>Returns the id for this property. This object is
- used internally to distinguish one property descriptor
- from another.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getId</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the property id</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -330,16 +316,11 @@ getDisplayName</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDisplayName</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></B></DD>
-<DD>Returns the display name for this property. This localized string is shown to
- the user as the name of this property.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDisplayName</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>a displayable name</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -349,16 +330,11 @@ getDescription</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDescription</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></B></DD>
-<DD>Returns a brief description of this property. This localized string is shown
- to the user when this property is selected.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDescription</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>a brief description, or <code>null</code> if none</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -368,21 +344,11 @@ isCompatibleWith</H3> <PRE>
public boolean <B>isCompatibleWith</B>(org.eclipse.ui.views.properties.IPropertyDescriptor anotherProperty)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></B></DD>
-<DD>Returns whether this property descriptor and the given one are compatible.
- <p>
- The property sheet uses this method during multiple selection to determine
- whether two property descriptors with the same id are in fact the same
- property and can be displayed as a single entry in the property sheet.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isCompatibleWith</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>anotherProperty</CODE> - the other property descriptor
-<DT><B>Returns:</B><DD><code>true</code> if the property descriptors are compatible, and
- <code>false</code> otherwise</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -392,17 +358,11 @@ getLabelProvider</H3> <PRE>
public org.eclipse.jface.viewers.ILabelProvider <B>getLabelProvider</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></B></DD>
-<DD>Returns the label provider for this property. The label provider is used
- to obtain the text (and possible image) for displaying the <it>value</it>
- of this property.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getLabelProvider</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the label provider used to display this property</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -426,26 +386,11 @@ getHelpContextIds</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>getHelpContextIds</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></B></DD>
-<DD>Returns the help context id for this property or
- <code>null</code> if this property has no help context id.
- <p>
- NOTE: Help support system API's changed since 2.0 and arrays
- of contexts are no longer supported.
- </p>
- <p>
- Thus the only valid non-<code>null</code> return type for this method
- is a <code>String</code> representing a context id. The previously
- valid return types are deprecated. The plural name for this method
- is unfortunate.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getHelpContextIds</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the help context id for this entry</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -455,22 +400,11 @@ getFilterFlags</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>getFilterFlags</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></B></DD>
-<DD>Returns a list of filter types to which this property belongs.
- The user is able to toggle the filters to show/hide properties belonging to
- a filter type.
- <p>
- Valid values for these flags are declared as constants on
- <code>IPropertySheetEntry</code>
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getFilterFlags</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>a list of filter types to which this property belongs, or
- <code>null</code> if none</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -480,17 +414,11 @@ createPropertyEditor</H3> <PRE>
public org.eclipse.jface.viewers.CellEditor <B>createPropertyEditor</B>(org.eclipse.swt.widgets.Composite parent)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></B></DD>
-<DD>Creates and returns a new cell editor for editing this property. Returns
- <code>null</code> if the property is not editable.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>createPropertyEditor</CODE> in interface <CODE>org.eclipse.ui.views.properties.IPropertyDescriptor</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent widget for the cell editor
-<DT><B>Returns:</B><DD>the cell editor for this property, or <code>null</code> if this
- property cannot be edited</DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
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 ========= -->
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DelegatingContentProvider.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DelegatingContentProvider.html index 52f41a958e..d7af88ccdd 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DelegatingContentProvider.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/DelegatingContentProvider.html @@ -168,7 +168,7 @@ Class DelegatingContentProvider</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DelegatingContentProvider.html#dispose()">dispose</A></B>()</CODE>
<BR>
- Disposes of this content provider.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -184,8 +184,7 @@ Class DelegatingContentProvider</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/DelegatingContentProvider.html#getElements(java.lang.Object)">getElements</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> inputElement)</CODE>
<BR>
- Returns the elements to display in the viewer
- when its input is set to the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -195,8 +194,7 @@ Class DelegatingContentProvider</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> newInput)</CODE>
<BR>
- Notifies this content provider that the given viewer's input
- has been switched to a different element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -307,14 +305,6 @@ dispose</H3> <PRE>
public void <B>dispose</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IContentProvider</CODE></B></DD>
-<DD>Disposes of this content provider.
- This is called by the viewer when it is disposed.
- <p>
- The viewer should not be updated during this call, as it is in the process
- of being disposed.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>dispose</CODE> in interface <CODE>org.eclipse.jface.viewers.IContentProvider</CODE></DL>
</DD>
@@ -329,18 +319,11 @@ getElements</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>getElements</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> inputElement)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IStructuredContentProvider</CODE></B></DD>
-<DD>Returns the elements to display in the viewer
- when its input is set to the given element.
- These elements can be presented as rows in a table, items in a list, etc.
- The result is not modified by the viewer.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getElements</CODE> in interface <CODE>org.eclipse.jface.viewers.IStructuredContentProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>inputElement</CODE> - the input element
-<DT><B>Returns:</B><DD>the array of elements to display in the viewer</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -352,27 +335,11 @@ public void <B>inputChanged</B>(org.eclipse.jface.viewers.Viewer viewer, <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> oldInput,
<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> newInput)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IContentProvider</CODE></B></DD>
-<DD>Notifies this content provider that the given viewer's input
- has been switched to a different element.
- <p>
- A typical use for this method is registering the content provider as a listener
- to changes on the new input (using model-specific means), and deregistering the viewer
- from the old input. In response to these change notifications, the content provider
- should update the viewer (see the add, remove, update and refresh methods on the viewers).
- </p>
- <p>
- The viewer should not be updated during this call, as it might be in the process
- of being disposed.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>inputChanged</CODE> in interface <CODE>org.eclipse.jface.viewers.IContentProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>viewer</CODE> - the viewer<DD><CODE>oldInput</CODE> - the old input element, or <code>null</code> if the viewer
- did not previously have an input<DD><CODE>newInput</CODE> - the new input element, or <code>null</code> if the viewer
- does not have an input</DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/StaticContentProvider.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/StaticContentProvider.html index 867da51e60..790eacd33e 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/StaticContentProvider.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/StaticContentProvider.html @@ -157,8 +157,7 @@ Class StaticContentProvider</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/StaticContentProvider.html#getElements(java.lang.Object)">getElements</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> inputElement)</CODE>
<BR>
- Returns the elements to display in the viewer
- when its input is set to the given element.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.eclipse.net4j.util.ui.StructuredContentProvider"><!-- --></A>
@@ -230,15 +229,8 @@ getElements</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>getElements</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> inputElement)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IStructuredContentProvider</CODE></B></DD>
-<DD>Returns the elements to display in the viewer
- when its input is set to the given element.
- These elements can be presented as rows in a table, items in a list, etc.
- The result is not modified by the viewer.
-<P>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>inputElement</CODE> - the input element
-<DT><B>Returns:</B><DD>the array of elements to display in the viewer</DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/StructuredContentProvider.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/StructuredContentProvider.html index 5ec1dd5ddc..b02bdc4842 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/StructuredContentProvider.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/StructuredContentProvider.html @@ -166,7 +166,7 @@ Class StructuredContentProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/StructuredContentProvider.html#dispose()">dispose</A></B>()</CODE>
<BR>
- Disposes of this content provider.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -208,8 +208,7 @@ Class StructuredContentProvider<INPUT></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> newInput)</CODE>
<BR>
- Notifies this content provider that the given viewer's input
- has been switched to a different element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -324,14 +323,6 @@ dispose</H3> <PRE>
public void <B>dispose</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IContentProvider</CODE></B></DD>
-<DD>Disposes of this content provider.
- This is called by the viewer when it is disposed.
- <p>
- The viewer should not be updated during this call, as it is in the process
- of being disposed.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>dispose</CODE> in interface <CODE>org.eclipse.jface.viewers.IContentProvider</CODE></DL>
</DD>
@@ -376,27 +367,11 @@ public void <B>inputChanged</B>(org.eclipse.jface.viewers.Viewer viewer, <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> oldInput,
<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> newInput)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IContentProvider</CODE></B></DD>
-<DD>Notifies this content provider that the given viewer's input
- has been switched to a different element.
- <p>
- A typical use for this method is registering the content provider as a listener
- to changes on the new input (using model-specific means), and deregistering the viewer
- from the old input. In response to these change notifications, the content provider
- should update the viewer (see the add, remove, update and refresh methods on the viewers).
- </p>
- <p>
- The viewer should not be updated during this call, as it might be in the process
- of being disposed.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>inputChanged</CODE> in interface <CODE>org.eclipse.jface.viewers.IContentProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>viewer</CODE> - the viewer<DD><CODE>oldInput</CODE> - the old input element, or <code>null</code> if the viewer
- did not previously have an input<DD><CODE>newInput</CODE> - the new input element, or <code>null</code> if the viewer
- does not have an input</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/UIActivator.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/UIActivator.html index ad211d49ee..6bc4e32e25 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/UIActivator.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/UIActivator.html @@ -225,8 +225,7 @@ Class UIActivator</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/UIActivator.html#start(org.osgi.framework.BundleContext)">start</A></B>(org.osgi.framework.BundleContext context)</CODE>
<BR>
- The <code>AbstractUIPlugin</code> implementation of this <code>Plugin</code>
- method refreshes the plug-in actions.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -234,9 +233,7 @@ Class UIActivator</H2> <TD><CODE><B><A HREF="../../../../../org/eclipse/net4j/util/ui/UIActivator.html#stop(org.osgi.framework.BundleContext)">stop</A></B>(org.osgi.framework.BundleContext context)</CODE>
<BR>
- The <code>AbstractUIPlugin</code> implementation of this <CODE>Plugin</CODE>
- method saves this plug-in's preference and dialog stores and shuts down
- its image registry (if they are in use).</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.eclipse.ui.plugin.AbstractUIPlugin"><!-- --></A>
@@ -347,53 +344,13 @@ start</H3> public final void <B>start</B>(org.osgi.framework.BundleContext context)
throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.ui.plugin.AbstractUIPlugin</CODE></B></DD>
-<DD>The <code>AbstractUIPlugin</code> implementation of this <code>Plugin</code>
- method refreshes the plug-in actions. Subclasses may extend this method,
- but must send super <b>first</b>.
- Starts up this plug-in.
- <p>
- This method should be overridden in subclasses that need to do something
- when this plug-in is started. Implementors should call the inherited method
- at the first possible point to ensure that any system requirements can be met.
- </p>
- <p>
- If this method throws an exception, it is taken as an indication that
- plug-in initialization has failed; as a result, the plug-in will not
- be activated; moreover, the plug-in will be marked as disabled and
- ineligible for activation for the duration.
- </p>
- <p>
- Note 1: This method is automatically invoked by the platform
- the first time any code in the plug-in is executed.
- </p>
- <p>
- Note 2: This method is intended to perform simple initialization
- of the plug-in environment. The platform may terminate initializers
- that do not complete in a timely fashion.
- </p>
- <p>
- Note 3: The class loader typically has monitors acquired during invocation of this method. It is
- strongly recommended that this method avoid synchronized blocks or other thread locking mechanisms,
- as this would lead to deadlock vulnerability.
- </p>
- <p>
- Note 4: The supplied bundle context represents the plug-in to the OSGi framework.
- For security reasons, it is strongly recommended that this object should not be divulged.
- </p>
- <p>
- Note 5: This method and the <CODE>Plugin.stop(BundleContext)</CODE> may be called from separate threads,
- but the OSGi framework ensures that both methods will not be called simultaneously.
- </p>
- <b>Clients must never explicitly call this method.</b>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>start</CODE> in interface <CODE>org.osgi.framework.BundleActivator</CODE><DT><B>Overrides:</B><DD><CODE>start</CODE> in class <CODE>org.eclipse.ui.plugin.AbstractUIPlugin</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>context</CODE> - the bundle context for this plug-in
+
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if this plug-in did not start up properly</DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
</DD>
</DL>
<HR>
@@ -404,50 +361,13 @@ stop</H3> public final void <B>stop</B>(org.osgi.framework.BundleContext context)
throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.ui.plugin.AbstractUIPlugin</CODE></B></DD>
-<DD>The <code>AbstractUIPlugin</code> implementation of this <CODE>Plugin</CODE>
- method saves this plug-in's preference and dialog stores and shuts down
- its image registry (if they are in use). Subclasses may extend this
- method, but must send super <b>last</b>. A try-finally statement should
- be used where necessary to ensure that <code>super.stop()</code> is
- always done.
- Stops this plug-in.
- <p>
- This method should be re-implemented in subclasses that need to do something
- when the plug-in is shut down. Implementors should call the inherited method
- as late as possible to ensure that any system requirements can be met.
- </p>
- <p>
- Plug-in shutdown code should be robust. In particular, this method
- should always make an effort to shut down the plug-in. Furthermore,
- the code should not assume that the plug-in was started successfully.
- </p>
- <p>
- Note 1: If a plug-in has been automatically started, this method will be automatically
- invoked by the platform when the platform is shut down.
- </p>
- <p>
- Note 2: This method is intended to perform simple termination
- of the plug-in environment. The platform may terminate invocations
- that do not complete in a timely fashion.
- </p>
- <p>
- Note 3: The supplied bundle context represents the plug-in to the OSGi framework.
- For security reasons, it is strongly recommended that this object should not be divulged.
- </p>
- <p>
- Note 4: This method and the <CODE>Plugin.start(BundleContext)</CODE> may be called from separate threads,
- but the OSGi framework ensures that both methods will not be called simultaneously.
- </p>
- <b>Clients must never explicitly call this method.</b>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>stop</CODE> in interface <CODE>org.osgi.framework.BundleActivator</CODE><DT><B>Overrides:</B><DD><CODE>stop</CODE> in class <CODE>org.eclipse.ui.plugin.AbstractUIPlugin</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>context</CODE> - the bundle context for this plug-in
+
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if this method fails to shut down this plug-in</DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/actions/SafeAction.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/actions/SafeAction.html index 5fe6d48eca..daf33f34c7 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/actions/SafeAction.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/actions/SafeAction.html @@ -214,8 +214,7 @@ Class SafeAction</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/actions/SafeAction.html#run()">run</A></B>()</CODE>
<BR>
- The default implementation of this <code>IAction</code> method does
- nothing.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -370,12 +369,6 @@ run</H3> <PRE>
public final void <B>run</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.action.Action</CODE></B></DD>
-<DD>The default implementation of this <code>IAction</code> method does
- nothing. Subclasses should override this method if they do not need
- information from the triggering event, or override
- <code>runWithEvent(Event)</code> if they do.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>org.eclipse.jface.action.IAction</CODE><DT><B>Overrides:</B><DD><CODE>run</CODE> in class <CODE>org.eclipse.jface.action.Action</CODE></DL>
</DD>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/actions/SafeActionDelegate.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/actions/SafeActionDelegate.html index 78d37630f0..4197f4bed6 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/actions/SafeActionDelegate.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/actions/SafeActionDelegate.html @@ -172,7 +172,7 @@ Class SafeActionDelegate</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/actions/SafeActionDelegate.html#run(org.eclipse.jface.action.IAction)">run</A></B>(org.eclipse.jface.action.IAction action)</CODE>
<BR>
- Performs this action.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -189,7 +189,7 @@ Class SafeActionDelegate</H2> org.eclipse.jface.viewers.ISelection selection)</CODE>
<BR>
- Notifies this action delegate that the selection in the workbench has changed.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -265,25 +265,11 @@ selectionChanged</H3> public void <B>selectionChanged</B>(org.eclipse.jface.action.IAction action,
org.eclipse.jface.viewers.ISelection selection)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.IActionDelegate</CODE></B></DD>
-<DD>Notifies this action delegate that the selection in the workbench has changed.
- <p>
- Implementers can use this opportunity to change the availability of the
- action or to modify other presentation properties.
- </p><p>
- When the selection changes, the action enablement state is updated based on
- the criteria specified in the plugin.xml file. Then the delegate is notified
- of the selection change regardless of whether the enablement criteria in the
- plugin.xml file is met.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>selectionChanged</CODE> in interface <CODE>org.eclipse.ui.IActionDelegate</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>action</CODE> - the action proxy that handles presentation portion of
- the action<DD><CODE>selection</CODE> - the current selection, or <code>null</code> if there
- is no selection.</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -293,23 +279,11 @@ run</H3> <PRE>
public void <B>run</B>(org.eclipse.jface.action.IAction action)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.IActionDelegate</CODE></B></DD>
-<DD>Performs this action.
- <p>
- This method is called by the proxy action when the action has been
- triggered. Implement this method to do the actual work.
- </p><p>
- <b>Note:</b> If the action delegate also implements
- <code>IActionDelegate2</code>, then this method is not invoked but
- instead the <code>runWithEvent(IAction, Event)</code> method is called.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>org.eclipse.ui.IActionDelegate</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>action</CODE> - the action proxy that handles the presentation portion of the
- action</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/dnd/DNDDropAdapter.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/dnd/DNDDropAdapter.html index 541433b190..499d5e3b9c 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/dnd/DNDDropAdapter.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/dnd/DNDDropAdapter.html @@ -167,7 +167,7 @@ Class DNDDropAdapter<TYPE></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/dnd/DNDDropAdapter.html#determineLocation(org.eclipse.swt.dnd.DropTargetEvent)">determineLocation</A></B>(org.eclipse.swt.dnd.DropTargetEvent event)</CODE>
<BR>
- Returns the position of the given event's coordinates relative to its target.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -199,7 +199,7 @@ Class DNDDropAdapter<TYPE></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/dnd/DNDDropAdapter.html#performDrop(java.lang.Object)">performDrop</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> data)</CODE>
<BR>
- Performs any work associated with the drop.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -226,7 +226,7 @@ Class DNDDropAdapter<TYPE></H2> org.eclipse.swt.dnd.TransferData type)</CODE>
<BR>
- Validates dropping on the given object.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -322,8 +322,7 @@ public org.eclipse.jface.viewers.StructuredViewer <B>getViewer</B>()</PRE> <DT><B>Overrides:</B><DD><CODE>getViewer</CODE> in class <CODE>org.eclipse.jface.viewers.ViewerDropAdapter</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the viewer to which this drop support has been added.</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -355,17 +354,11 @@ determineLocation</H3> <PRE>
protected int <B>determineLocation</B>(org.eclipse.swt.dnd.DropTargetEvent event)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.viewers.ViewerDropAdapter</CODE></B></DD>
-<DD>Returns the position of the given event's coordinates relative to its target.
- The position is determined to be before, after, or on the item, based on
- some threshold value.
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>determineLocation</CODE> in class <CODE>org.eclipse.jface.viewers.ViewerDropAdapter</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>event</CODE> - the event
-<DT><B>Returns:</B><DD>one of the <code>LOCATION_* </code>constants defined in this class</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -375,19 +368,11 @@ performDrop</H3> <PRE>
public boolean <B>performDrop</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> data)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.viewers.ViewerDropAdapter</CODE></B></DD>
-<DD>Performs any work associated with the drop.
- <p>
- Subclasses must implement this method to provide drop behavior.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>performDrop</CODE> in class <CODE>org.eclipse.jface.viewers.ViewerDropAdapter</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>data</CODE> - the drop data
-<DT><B>Returns:</B><DD><code>true</code> if the drop was successful, and
- <code>false</code> otherwise</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -399,21 +384,11 @@ public boolean <B>validateDrop</B>(<A HREF="http://download.oracle.com/javase/1. int operation,
org.eclipse.swt.dnd.TransferData type)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.viewers.ViewerDropAdapter</CODE></B></DD>
-<DD>Validates dropping on the given object. This method is called whenever some
- aspect of the drop operation changes.
- <p>
- Subclasses must implement this method to define which drops make sense.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>validateDrop</CODE> in class <CODE>org.eclipse.jface.viewers.ViewerDropAdapter</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>target</CODE> - the object that the mouse is currently hovering over, or
- <code>null</code> if the mouse is hovering over empty space<DD><CODE>operation</CODE> - the current drag operation (copy, move, etc.)<DD><CODE>type</CODE> - the current transfer type
-<DT><B>Returns:</B><DD><code>true</code> if the drop is valid, and <code>false</code>
- otherwise</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/prefs/OMPreferencePage.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/prefs/OMPreferencePage.html index 3e75c97743..7f956a8199 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/prefs/OMPreferencePage.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/prefs/OMPreferencePage.html @@ -173,8 +173,7 @@ Class OMPreferencePage</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferencePage.html#createContents(org.eclipse.swt.widgets.Composite)">createContents</A></B>(org.eclipse.swt.widgets.Composite parent)</CODE>
<BR>
- Creates and returns the SWT control for the customized body
- of this preference page under the given parent composite.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -198,7 +197,7 @@ Class OMPreferencePage</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferencePage.html#doGetPreferenceStore()">doGetPreferenceStore</A></B>()</CODE>
<BR>
- Returns the preference store of this preference page.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -238,7 +237,7 @@ Class OMPreferencePage</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferencePage.html#init(org.eclipse.ui.IWorkbench)">init</A></B>(org.eclipse.ui.IWorkbench workbench)</CODE>
<BR>
- Initializes this preference page for the given workbench.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.eclipse.jface.preference.PreferencePage"><!-- --></A>
@@ -349,18 +348,11 @@ init</H3> <PRE>
public void <B>init</B>(org.eclipse.ui.IWorkbench workbench)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.IWorkbenchPreferencePage</CODE></B></DD>
-<DD>Initializes this preference page for the given workbench.
- <p>
- This method is called automatically as the preference page is being created
- and initialized. Clients must not call this method.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>init</CODE> in interface <CODE>org.eclipse.ui.IWorkbenchPreferencePage</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>workbench</CODE> - the workbench</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -370,20 +362,11 @@ doGetPreferenceStore</H3> <PRE>
protected org.eclipse.jface.preference.IPreferenceStore <B>doGetPreferenceStore</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.preference.PreferencePage</CODE></B></DD>
-<DD>Returns the preference store of this preference page.
- <p>
- This is a framework hook method for subclasses to return a
- page-specific preference store. The default implementation
- returns <code>null</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>doGetPreferenceStore</CODE> in class <CODE>org.eclipse.jface.preference.PreferencePage</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the preference store, or <code>null</code> if none</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -435,22 +418,11 @@ createContents</H3> <PRE>
protected final org.eclipse.swt.widgets.Control <B>createContents</B>(org.eclipse.swt.widgets.Composite parent)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.preference.PreferencePage</CODE></B></DD>
-<DD>Creates and returns the SWT control for the customized body
- of this preference page under the given parent composite.
- <p>
- This framework method must be implemented by concrete subclasses. Any
- subclass returning a <code>Composite</code> object whose <code>Layout</code>
- has default margins (for example, a <code>GridLayout</code>) are expected to
- set the margins of this <code>Layout</code> to 0 pixels.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>createContents</CODE> in class <CODE>org.eclipse.jface.preference.PreferencePage</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent composite
-<DT><B>Returns:</B><DD>the new control</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html index d02ea6d33a..72859d6201 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html @@ -162,8 +162,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#addPropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener)">addPropertyChangeListener</A></B>(org.eclipse.jface.util.IPropertyChangeListener listener)</CODE>
<BR>
-
- Adds a property change listener to this preference store.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -171,8 +170,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#contains(java.lang.String)">contains</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns whether the named preference is known to this preference
- store.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -190,8 +188,7 @@ Class OMPreferenceStore</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> newValue)</CODE>
<BR>
- Fires a property change event corresponding to a change to the
- current value of the preference with the given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -199,8 +196,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getBoolean(java.lang.String)">getBoolean</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the current value of the boolean-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -208,8 +204,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getDefaultBoolean(java.lang.String)">getDefaultBoolean</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the default value for the boolean-valued preference
- with the given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -217,8 +212,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getDefaultDouble(java.lang.String)">getDefaultDouble</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the default value for the double-valued preference
- with the given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -226,8 +220,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getDefaultFloat(java.lang.String)">getDefaultFloat</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the default value for the float-valued preference
- with the given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -235,8 +228,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getDefaultInt(java.lang.String)">getDefaultInt</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the default value for the integer-valued preference
- with the given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -244,8 +236,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getDefaultLong(java.lang.String)">getDefaultLong</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the default value for the long-valued preference
- with the given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -253,8 +244,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getDefaultString(java.lang.String)">getDefaultString</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the default value for the string-valued preference
- with the given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -262,8 +252,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getDouble(java.lang.String)">getDouble</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the current value of the double-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -271,8 +260,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getFloat(java.lang.String)">getFloat</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the current value of the float-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -280,8 +268,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getInt(java.lang.String)">getInt</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the current value of the integer-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -289,8 +276,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getLong(java.lang.String)">getLong</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the current value of the long-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -306,8 +292,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#getString(java.lang.String)">getString</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns the current value of the string-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -315,8 +300,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#isDefault(java.lang.String)">isDefault</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Returns whether the current value of the preference with the given name
- has the default value.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -324,8 +308,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#needsSaving()">needsSaving</A></B>()</CODE>
<BR>
- Returns whether the current values in this property store
- require saving.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -334,8 +317,7 @@ Class OMPreferenceStore</H2> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</CODE>
<BR>
- Sets the current value of the preference with the given name to
- the given string value without sending a property change.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -343,7 +325,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener)">removePropertyChangeListener</A></B>(org.eclipse.jface.util.IPropertyChangeListener listener)</CODE>
<BR>
- Removes the given listener from this preference store.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -352,8 +334,7 @@ Class OMPreferenceStore</H2> boolean value)</CODE>
<BR>
- Sets the default value for the boolean-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -362,8 +343,7 @@ Class OMPreferenceStore</H2> double value)</CODE>
<BR>
- Sets the default value for the double-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -372,8 +352,7 @@ Class OMPreferenceStore</H2> float value)</CODE>
<BR>
- Sets the default value for the float-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -382,8 +361,7 @@ Class OMPreferenceStore</H2> int value)</CODE>
<BR>
- Sets the default value for the integer-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -392,8 +370,7 @@ Class OMPreferenceStore</H2> long value)</CODE>
<BR>
- Sets the default value for the long-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -402,8 +379,7 @@ Class OMPreferenceStore</H2> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> defaultObject)</CODE>
<BR>
- Sets the default value for the string-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -411,8 +387,7 @@ Class OMPreferenceStore</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/prefs/OMPreferenceStore.html#setToDefault(java.lang.String)">setToDefault</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
- Sets the current value of the preference with the given name back
- to its default value.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -421,8 +396,7 @@ Class OMPreferenceStore</H2> boolean value)</CODE>
<BR>
- Sets the current value of the boolean-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -431,8 +405,7 @@ Class OMPreferenceStore</H2> double value)</CODE>
<BR>
- Sets the current value of the double-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -441,8 +414,7 @@ Class OMPreferenceStore</H2> float value)</CODE>
<BR>
- Sets the current value of the float-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -451,8 +423,7 @@ Class OMPreferenceStore</H2> int value)</CODE>
<BR>
- Sets the current value of the integer-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -461,8 +432,7 @@ Class OMPreferenceStore</H2> long value)</CODE>
<BR>
- Sets the current value of the long-valued preference with the
- given name.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -471,8 +441,7 @@ Class OMPreferenceStore</H2> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</CODE>
<BR>
- Sets the current value of the string-valued preference with the
- given name.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -547,45 +516,11 @@ addPropertyChangeListener</H3> <PRE>
public void <B>addPropertyChangeListener</B>(org.eclipse.jface.util.IPropertyChangeListener listener)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD><p>
- Adds a property change listener to this preference store.
- </p>
- <p>
- <b>Note</b> The types of the oldValue and newValue of the
- generated PropertyChangeEvent are determined by whether
- or not the typed API in IPreferenceStore was called.
- If values are changed via setValue(name,type) the
- values in the PropertyChangedEvent will be of that type.
- If they are set using a non typed API (i.e. #setToDefault
- or using the OSGI Preferences) the values will be unconverted
- Strings.
- </p>
- <p>
- A listener will be called in the same Thread
- that it is invoked in. Any Thread dependant listeners (such as
- those who update an SWT widget) will need to update in the
- correct Thread. In the case of an SWT update you can update
- using Display#syncExec(Runnable) or Display#asyncExec(Runnable).
- </p>
- <p>
- Likewise any application that updates an IPreferenceStore
- from a Thread other than the UI Thread should be aware of
- any listeners that require an update in the UI Thread.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>addPropertyChangeListener</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>listener</CODE> - a property change listener<DT><B>See Also:</B><DD><CODE>PropertyChangeEvent</CODE>,
-<CODE>IPreferenceStore.setToDefault(String)</CODE>,
-<CODE>IPreferenceStore.setValue(String, boolean)</CODE>,
-<CODE>IPreferenceStore.setValue(String, double)</CODE>,
-<CODE>IPreferenceStore.setValue(String, float)</CODE>,
-<CODE>IPreferenceStore.setValue(String, int)</CODE>,
-<CODE>IPreferenceStore.setValue(String, long)</CODE>,
-<CODE>IPreferenceStore.setValue(String, String)</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -595,15 +530,11 @@ removePropertyChangeListener</H3> <PRE>
public void <B>removePropertyChangeListener</B>(org.eclipse.jface.util.IPropertyChangeListener listener)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Removes the given listener from this preference store. Has no effect if the listener is not
- registered.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>removePropertyChangeListener</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>listener</CODE> - a property change listener, must not be <code>null</code></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -615,23 +546,11 @@ public void <B>firePropertyChangeEvent</B>(<A HREF="http://download.oracle.com/j <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> oldValue,
<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> newValue)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Fires a property change event corresponding to a change to the
- current value of the preference with the given name.
- <p>
- This method is provided on this interface to simplify the implementation
- of decorators. There is normally no need to call this method since
- <code>setValue</code> and <code>setToDefault</code> report such
- events in due course. Implementations should funnel all preference
- changes through this method.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>firePropertyChangeEvent</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference, to be used as the property
- in the event object<DD><CODE>oldValue</CODE> - the old value<DD><CODE>newValue</CODE> - the new value</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -641,17 +560,11 @@ contains</H3> <PRE>
public boolean <B>contains</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns whether the named preference is known to this preference
- store.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>contains</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD><code>true</code> if either a current value or a default
- value is known for the named preference, and <code>false</code> otherwise</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -661,18 +574,11 @@ isDefault</H3> <PRE>
public boolean <B>isDefault</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns whether the current value of the preference with the given name
- has the default value.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isDefault</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD><code>true</code> if the preference has a known default value
- and its current value is the same, and <code>false</code> otherwise
- (including the case where the preference is unknown to this store)</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -682,18 +588,11 @@ needsSaving</H3> <PRE>
public boolean <B>needsSaving</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns whether the current values in this property store
- require saving.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>needsSaving</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD><code>true</code> if at least one of values of
- the preferences known to this store has changed and
- requires saving, and <code>false</code> otherwise.</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -703,19 +602,11 @@ getDefaultBoolean</H3> <PRE>
public boolean <B>getDefaultBoolean</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the default value for the boolean-valued preference
- with the given name.
- Returns the default-default value (<code>false</code>) if there
- is no default preference with the given name, or if the default
- value cannot be treated as a boolean.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDefaultBoolean</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the default value of the named preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -725,19 +616,11 @@ getDefaultDouble</H3> <PRE>
public double <B>getDefaultDouble</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the default value for the double-valued preference
- with the given name.
- Returns the default-default value (<code>0.0</code>) if there
- is no default preference with the given name, or if the default
- value cannot be treated as a double.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDefaultDouble</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the default value of the named preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -747,19 +630,11 @@ getDefaultFloat</H3> <PRE>
public float <B>getDefaultFloat</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the default value for the float-valued preference
- with the given name.
- Returns the default-default value (<code>0.0f</code>) if there
- is no default preference with the given name, or if the default
- value cannot be treated as a float.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDefaultFloat</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the default value of the named preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -769,19 +644,11 @@ getDefaultInt</H3> <PRE>
public int <B>getDefaultInt</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the default value for the integer-valued preference
- with the given name.
- Returns the default-default value (<code>0</code>) if there
- is no default preference with the given name, or if the default
- value cannot be treated as an integer.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDefaultInt</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the default value of the named preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -791,19 +658,11 @@ getDefaultLong</H3> <PRE>
public long <B>getDefaultLong</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the default value for the long-valued preference
- with the given name.
- Returns the default-default value (<code>0L</code>) if there
- is no default preference with the given name, or if the default
- value cannot be treated as a long.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDefaultLong</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the default value of the named preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -813,19 +672,11 @@ getDefaultString</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDefaultString</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the default value for the string-valued preference
- with the given name.
- Returns the default-default value (the empty string <code>""</code>)
- is no default preference with the given name, or if the default
- value cannot be treated as a string.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDefaultString</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the default value of the named preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -836,23 +687,11 @@ setDefault</H3> public void <B>setDefault</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
boolean value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the default value for the boolean-valued preference with the
- given name.
- <p>
- Note that the current value of the preference is affected if
- the preference's current value was its old default value, in which
- case it changes to the new default value. If the preference's current
- is different from its old default value, its current value is
- unaffected. No property change events are reported by changing default
- values.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setDefault</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new default value for the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -863,23 +702,11 @@ setDefault</H3> public void <B>setDefault</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
double value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the default value for the double-valued preference with the
- given name.
- <p>
- Note that the current value of the preference is affected if
- the preference's current value was its old default value, in which
- case it changes to the new default value. If the preference's current
- is different from its old default value, its current value is
- unaffected. No property change events are reported by changing default
- values.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setDefault</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new default value for the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -890,23 +717,11 @@ setDefault</H3> public void <B>setDefault</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
float value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the default value for the float-valued preference with the
- given name.
- <p>
- Note that the current value of the preference is affected if
- the preference's current value was its old default value, in which
- case it changes to the new default value. If the preference's current
- is different from its old default value, its current value is
- unaffected. No property change events are reported by changing default
- values.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setDefault</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new default value for the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -917,23 +732,11 @@ setDefault</H3> public void <B>setDefault</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
int value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the default value for the integer-valued preference with the
- given name.
- <p>
- Note that the current value of the preference is affected if
- the preference's current value was its old default value, in which
- case it changes to the new default value. If the preference's current
- is different from its old default value, its current value is
- unaffected. No property change events are reported by changing default
- values.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setDefault</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new default value for the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -944,23 +747,11 @@ setDefault</H3> public void <B>setDefault</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
long value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the default value for the long-valued preference with the
- given name.
- <p>
- Note that the current value of the preference is affected if
- the preference's current value was its old default value, in which
- case it changes to the new default value. If the preference's current
- is different from its old default value, its current value is
- unaffected. No property change events are reported by changing default
- values.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setDefault</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new default value for the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -971,23 +762,11 @@ setDefault</H3> public void <B>setDefault</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> defaultObject)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the default value for the string-valued preference with the
- given name.
- <p>
- Note that the current value of the preference is affected if
- the preference's current value was its old default value, in which
- case it changes to the new default value. If the preference's current
- is different from its old default value, its current value is
- unaffected. No property change events are reported by changing default
- values.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setDefault</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>defaultObject</CODE> - the new default value for the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -997,21 +776,11 @@ setToDefault</H3> <PRE>
public void <B>setToDefault</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the current value of the preference with the given name back
- to its default value.
- <p>
- Note that the preferred way of re-initializing a preference to the
- appropriate default value is to call <code>setToDefault</code>.
- This is implemented by removing the named value from the store,
- thereby exposing the default value.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setToDefault</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1021,19 +790,11 @@ getBoolean</H3> <PRE>
public boolean <B>getBoolean</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the current value of the boolean-valued preference with the
- given name.
- Returns the default-default value (<code>false</code>) if there
- is no preference with the given name, or if the current value
- cannot be treated as a boolean.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getBoolean</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the boolean-valued preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1043,19 +804,11 @@ getDouble</H3> <PRE>
public double <B>getDouble</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the current value of the double-valued preference with the
- given name.
- Returns the default-default value (<code>0.0</code>) if there
- is no preference with the given name, or if the current value
- cannot be treated as a double.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDouble</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the double-valued preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1065,19 +818,11 @@ getFloat</H3> <PRE>
public float <B>getFloat</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the current value of the float-valued preference with the
- given name.
- Returns the default-default value (<code>0.0f</code>) if there
- is no preference with the given name, or if the current value
- cannot be treated as a float.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getFloat</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the float-valued preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1087,19 +832,11 @@ getInt</H3> <PRE>
public int <B>getInt</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the current value of the integer-valued preference with the
- given name.
- Returns the default-default value (<code>0</code>) if there
- is no preference with the given name, or if the current value
- cannot be treated as an integter.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getInt</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the int-valued preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1109,19 +846,11 @@ getLong</H3> <PRE>
public long <B>getLong</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the current value of the long-valued preference with the
- given name.
- Returns the default-default value (<code>0L</code>) if there
- is no preference with the given name, or if the current value
- cannot be treated as a long.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getLong</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the long-valued preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1131,19 +860,11 @@ getString</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getString</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Returns the current value of the string-valued preference with the
- given name.
- Returns the default-default value (the empty string <code>""</code>)
- if there is no preference with the given name, or if the current value
- cannot be treated as a string.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getString</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference
-<DT><B>Returns:</B><DD>the string-valued preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1154,21 +875,11 @@ putValue</H3> public void <B>putValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the current value of the preference with the given name to
- the given string value without sending a property change.
- <p>
- This method does not fire a property change event and
- should only be used for setting internal preferences
- that are not meant to be processed by listeners.
- Normal clients should instead call #setValue.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>putValue</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new current value of the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1179,25 +890,11 @@ setValue</H3> public void <B>setValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
boolean value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the current value of the boolean-valued preference with the
- given name.
- <p>
- A property change event is reported if the current value of the
- preference actually changes from its previous value. In the event
- object, the property name is the name of the preference, and the
- old and new values are wrapped as objects.
- </p>
- <p>
- Note that the preferred way of re-initializing a preference to its
- default value is to call <code>setToDefault</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setValue</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new current value of the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1208,25 +905,11 @@ setValue</H3> public void <B>setValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
double value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the current value of the double-valued preference with the
- given name.
- <p>
- A property change event is reported if the current value of the
- preference actually changes from its previous value. In the event
- object, the property name is the name of the preference, and the
- old and new values are wrapped as objects.
- </p>
- <p>
- Note that the preferred way of re-initializing a preference to its
- default value is to call <code>setToDefault</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setValue</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new current value of the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1237,25 +920,11 @@ setValue</H3> public void <B>setValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
float value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the current value of the float-valued preference with the
- given name.
- <p>
- A property change event is reported if the current value of the
- preference actually changes from its previous value. In the event
- object, the property name is the name of the preference, and the
- old and new values are wrapped as objects.
- </p>
- <p>
- Note that the preferred way of re-initializing a preference to its
- default value is to call <code>setToDefault</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setValue</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new current value of the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1266,25 +935,11 @@ setValue</H3> public void <B>setValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
int value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the current value of the integer-valued preference with the
- given name.
- <p>
- A property change event is reported if the current value of the
- preference actually changes from its previous value. In the event
- object, the property name is the name of the preference, and the
- old and new values are wrapped as objects.
- </p>
- <p>
- Note that the preferred way of re-initializing a preference to its
- default value is to call <code>setToDefault</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setValue</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new current value of the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1295,25 +950,11 @@ setValue</H3> public void <B>setValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
long value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the current value of the long-valued preference with the
- given name.
- <p>
- A property change event is reported if the current value of the
- preference actually changes from its previous value. In the event
- object, the property name is the name of the preference, and the
- old and new values are wrapped as objects.
- </p>
- <p>
- Note that the preferred way of re-initializing a preference to its
- default value is to call <code>setToDefault</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setValue</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new current value of the preference</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -1324,25 +965,11 @@ setValue</H3> public void <B>setValue</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></B></DD>
-<DD>Sets the current value of the string-valued preference with the
- given name.
- <p>
- A property change event is reported if the current value of the
- preference actually changes from its previous value. In the event
- object, the property name is the name of the preference, and the
- old and new values are wrapped as objects.
- </p>
- <p>
- Note that the preferred way of re-initializing a preference to its
- default value is to call <code>setToDefault</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setValue</CODE> in interface <CODE>org.eclipse.jface.preference.IPreferenceStore</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the preference<DD><CODE>value</CODE> - the new current value of the preference</DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/proposals/RegExContentProposalProvider.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/proposals/RegExContentProposalProvider.html index c73fc0e333..db93f151c9 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/proposals/RegExContentProposalProvider.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/proposals/RegExContentProposalProvider.html @@ -161,8 +161,7 @@ Content assist proposal provider for regular expressions. int position)</CODE>
<BR>
- Return an array of content proposals representing the valid proposals for a
- field.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -215,17 +214,11 @@ getProposals</H3> public org.eclipse.jface.fieldassist.IContentProposal[] <B>getProposals</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> contents,
int position)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.fieldassist.IContentProposalProvider</CODE></B></DD>
-<DD>Return an array of content proposals representing the valid proposals for a
- field.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getProposals</CODE> in interface <CODE>org.eclipse.jface.fieldassist.IContentProposalProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>contents</CODE> - the current contents of the text field<DD><CODE>position</CODE> - the current position of the cursor in the contents
-<DT><B>Returns:</B><DD>the array of <CODE>IContentProposal</CODE> that represent valid
- proposals for the field.</DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/security/CredentialsDialog.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/security/CredentialsDialog.html index fe17f9f20c..646b290825 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/security/CredentialsDialog.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/security/CredentialsDialog.html @@ -233,7 +233,7 @@ Class CredentialsDialog</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/security/CredentialsDialog.html#okPressed()">okPressed</A></B>()</CODE>
<BR>
- Notifies that the ok button of this dialog has been pressed.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.eclipse.net4j.util.ui.widgets.BaseDialog"><!-- --></A>
@@ -350,14 +350,6 @@ okPressed</H3> <PRE>
protected void <B>okPressed</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.dialogs.Dialog</CODE></B></DD>
-<DD>Notifies that the ok button of this dialog has been pressed.
- <p>
- The <code>Dialog</code> implementation of this framework method sets
- this dialog's return code to <code>Window.OK</code> and closes the
- dialog. Subclasses may override.
- </p>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>okPressed</CODE> in class <CODE>org.eclipse.jface.dialogs.Dialog</CODE></DL>
</DD>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerItemProvider.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerItemProvider.html index 7a19d4760f..66ccb81bb7 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerItemProvider.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerItemProvider.html @@ -291,7 +291,7 @@ Class ContainerItemProvider<CONTAINER extends <A HREF="../../../../../../org/ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html#dispose()">dispose</A></B>()</CODE>
<BR>
- Disposes of this content provider.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -342,7 +342,7 @@ Class ContainerItemProvider<CONTAINER extends <A HREF="../../../../../../org/ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html#getChildren(java.lang.Object)">getChildren</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> element)</CODE>
<BR>
- Returns the child elements of the given parent element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -358,7 +358,7 @@ Class ContainerItemProvider<CONTAINER extends <A HREF="../../../../../../org/ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html#getFont(java.lang.Object)">getFont</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> obj)</CODE>
<BR>
- Provides a font for the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -366,7 +366,7 @@ Class ContainerItemProvider<CONTAINER extends <A HREF="../../../../../../org/ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html#getForeground(java.lang.Object)">getForeground</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> obj)</CODE>
<BR>
- Provides a foreground color for the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -374,7 +374,7 @@ Class ContainerItemProvider<CONTAINER extends <A HREF="../../../../../../org/ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html#getImage(java.lang.Object)">getImage</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> obj)</CODE>
<BR>
- Returns the image for the label of the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -398,8 +398,7 @@ Class ContainerItemProvider<CONTAINER extends <A HREF="../../../../../../org/ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html#getParent(java.lang.Object)">getParent</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> element)</CODE>
<BR>
- Returns the parent for the given element, or <code>null</code>
- indicating that the parent can't be computed.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -440,7 +439,7 @@ Class ContainerItemProvider<CONTAINER extends <A HREF="../../../../../../org/ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html#hasChildren(java.lang.Object)">hasChildren</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> element)</CODE>
<BR>
- Returns whether the given element has children.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -549,21 +548,11 @@ hasChildren</H3> <PRE>
public boolean <B>hasChildren</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> element)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ITreeContentProvider</CODE></B></DD>
-<DD>Returns whether the given element has children.
- <p>
- Intended as an optimization for when the viewer does not
- need the actual children. Clients may be able to implement
- this more efficiently than <code>getChildren</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>hasChildren</CODE> in interface <CODE>org.eclipse.jface.viewers.ITreeContentProvider</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#hasChildren(java.lang.Object)">hasChildren</A></CODE> in class <CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html" title="class in org.eclipse.net4j.util.ui.views">ItemProvider</A><<A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html" title="type parameter in ContainerItemProvider">CONTAINER</A> extends <A HREF="../../../../../../org/eclipse/net4j/util/container/IContainer.html" title="interface in org.eclipse.net4j.util.container">IContainer</A><<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>>></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element
-<DT><B>Returns:</B><DD><code>true</code> if the given element has children,
- and <code>false</code> if it has no children</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -573,19 +562,8 @@ getChildren</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>getChildren</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> element)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ITreeContentProvider</CODE></B></DD>
-<DD>Returns the child elements of the given parent element.
- <p>
- The difference between this method and <code>IStructuredContentProvider.getElements</code>
- is that <code>getElements</code> is called to obtain the
- tree viewer's root elements, whereas <code>getChildren</code> is used
- to obtain the children of a given parent element in the tree (including a root).
- </p>
- The result is not modified by the viewer.
-<P>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>element</CODE> - the parent element
-<DT><B>Returns:</B><DD>an array of child elements</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -595,16 +573,8 @@ getParent</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>getParent</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> element)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ITreeContentProvider</CODE></B></DD>
-<DD>Returns the parent for the given element, or <code>null</code>
- indicating that the parent can't be computed.
- In this case the tree-structured viewer can't expand
- a given node correctly if requested.
-<P>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element
-<DT><B>Returns:</B><DD>the parent element, or <code>null</code> if it
- has none or if the parent cannot be computed</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -614,14 +584,6 @@ dispose</H3> <PRE>
public void <B>dispose</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IContentProvider</CODE></B></DD>
-<DD>Disposes of this content provider.
- This is called by the viewer when it is disposed.
- <p>
- The viewer should not be updated during this call, as it is in the process
- of being disposed.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>dispose</CODE> in interface <CODE>org.eclipse.jface.viewers.IBaseLabelProvider</CODE><DT><B>Specified by:</B><DD><CODE>dispose</CODE> in interface <CODE>org.eclipse.jface.viewers.IContentProvider</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/StructuredContentProvider.html#dispose()">dispose</A></CODE> in class <CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/StructuredContentProvider.html" title="class in org.eclipse.net4j.util.ui">StructuredContentProvider</A><<A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html" title="type parameter in ContainerItemProvider">CONTAINER</A> extends <A HREF="../../../../../../org/eclipse/net4j/util/container/IContainer.html" title="interface in org.eclipse.net4j.util.container">IContainer</A><<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>>></CODE></DL>
</DD>
@@ -872,16 +834,11 @@ getFont</H3> <PRE>
public org.eclipse.swt.graphics.Font <B>getFont</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> obj)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IFontProvider</CODE></B></DD>
-<DD>Provides a font for the given element.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getFont</CODE> in interface <CODE>org.eclipse.jface.viewers.IFontProvider</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#getFont(java.lang.Object)">getFont</A></CODE> in class <CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html" title="class in org.eclipse.net4j.util.ui.views">ItemProvider</A><<A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html" title="type parameter in ContainerItemProvider">CONTAINER</A> extends <A HREF="../../../../../../org/eclipse/net4j/util/container/IContainer.html" title="interface in org.eclipse.net4j.util.container">IContainer</A><<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>>></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the element
-<DT><B>Returns:</B><DD>the font for the element, or <code>null</code>
- to use the default font</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -891,16 +848,11 @@ getForeground</H3> <PRE>
public org.eclipse.swt.graphics.Color <B>getForeground</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> obj)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IColorProvider</CODE></B></DD>
-<DD>Provides a foreground color for the given element.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getForeground</CODE> in interface <CODE>org.eclipse.jface.viewers.IColorProvider</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#getForeground(java.lang.Object)">getForeground</A></CODE> in class <CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html" title="class in org.eclipse.net4j.util.ui.views">ItemProvider</A><<A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html" title="type parameter in ContainerItemProvider">CONTAINER</A> extends <A HREF="../../../../../../org/eclipse/net4j/util/container/IContainer.html" title="interface in org.eclipse.net4j.util.container">IContainer</A><<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>>></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the element
-<DT><B>Returns:</B><DD>the foreground color for the element, or <code>null</code>
- to use the default foreground color</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -910,18 +862,11 @@ getImage</H3> <PRE>
public org.eclipse.swt.graphics.Image <B>getImage</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> obj)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ILabelProvider</CODE></B></DD>
-<DD>Returns the image for the label of the given element. The image
- is owned by the label provider and must not be disposed directly.
- Instead, dispose the label provider when no longer needed.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getImage</CODE> in interface <CODE>org.eclipse.jface.viewers.ILabelProvider</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#getImage(java.lang.Object)">getImage</A></CODE> in class <CODE><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html" title="class in org.eclipse.net4j.util.ui.views">ItemProvider</A><<A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerItemProvider.html" title="type parameter in ContainerItemProvider">CONTAINER</A> extends <A HREF="../../../../../../org/eclipse/net4j/util/container/IContainer.html" title="interface in org.eclipse.net4j.util.container">IContainer</A><<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>>></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the element for which to provide the label image
-<DT><B>Returns:</B><DD>the image used to label the element, or <code>null</code>
- if there is no image for the given object</DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerPathItemProvider.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerPathItemProvider.html index b9951c1b0c..2c3fd22f74 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerPathItemProvider.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerPathItemProvider.html @@ -211,7 +211,7 @@ Class ContainerPathItemProvider<CONTAINER extends <A HREF="../../../../../../ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerPathItemProvider.html#getChildren(org.eclipse.jface.viewers.TreePath)">getChildren</A></B>(org.eclipse.jface.viewers.TreePath path)</CODE>
<BR>
- <B>Deprecated.</B> Returns the child elements of the last element in the given path.</TD>
+ <B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -227,7 +227,7 @@ Class ContainerPathItemProvider<CONTAINER extends <A HREF="../../../../../../ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerPathItemProvider.html#getParents(java.lang.Object)">getParents</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> element)</CODE>
<BR>
- <B>Deprecated.</B> Return the possible parent paths for the given element.</TD>
+ <B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -235,7 +235,7 @@ Class ContainerPathItemProvider<CONTAINER extends <A HREF="../../../../../../ <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerPathItemProvider.html#hasChildren(org.eclipse.jface.viewers.TreePath)">hasChildren</A></B>(org.eclipse.jface.viewers.TreePath path)</CODE>
<BR>
- <B>Deprecated.</B> Returns whether the last element of the given path has children.</TD>
+ <B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -343,21 +343,11 @@ hasChildren</H3> <PRE>
public boolean <B>hasChildren</B>(org.eclipse.jface.viewers.TreePath path)</PRE>
<DL>
-<DD><B>Deprecated.</B> <DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ITreePathContentProvider</CODE></B></DD>
-<DD>Returns whether the last element of the given path has children.
- <p>
- Intended as an optimization for when the viewer does not need the actual
- children. Clients may be able to implement this more efficiently than
- <code>getChildren</code>.
- </p>
-<P>
-<DD><DL>
+<DD><B>Deprecated.</B> <DD><DL>
<DT><B>Specified by:</B><DD><CODE>hasChildren</CODE> in interface <CODE>org.eclipse.jface.viewers.ITreePathContentProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>path</CODE> - the path
-<DT><B>Returns:</B><DD><code>true</code> if the lat element of the path has children,
- and <code>false</code> if it has no children</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -367,23 +357,11 @@ getChildren</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>getChildren</B>(org.eclipse.jface.viewers.TreePath path)</PRE>
<DL>
-<DD><B>Deprecated.</B> <DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ITreePathContentProvider</CODE></B></DD>
-<DD>Returns the child elements of the last element in the given path.
- Implementors may want to use the additional context of the complete path
- of a parent element in order to decide which children to return.
- <p>
- The provided path is relative to the input. The root elements must
- be obtained by calling
- <CODE>IStructuredContentProvider.getElements(Object)</CODE>.
- </p>
- The result is not modified by the viewer.
-<P>
-<DD><DL>
+<DD><B>Deprecated.</B> <DD><DL>
<DT><B>Specified by:</B><DD><CODE>getChildren</CODE> in interface <CODE>org.eclipse.jface.viewers.ITreePathContentProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>path</CODE> - the path of the parent element
-<DT><B>Returns:</B><DD>an array of child elements</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -393,18 +371,11 @@ getParents</H3> <PRE>
public org.eclipse.jface.viewers.TreePath[] <B>getParents</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> element)</PRE>
<DL>
-<DD><B>Deprecated.</B> <DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ITreePathContentProvider</CODE></B></DD>
-<DD>Return the possible parent paths for the given element. An empty array
- can be returned if the paths cannot be computed. If the element is
- a potential child of the input of the viewer, an empty tree path
- should be an entry in the returned array.
-<P>
-<DD><DL>
+<DD><B>Deprecated.</B> <DD><DL>
<DT><B>Specified by:</B><DD><CODE>getParents</CODE> in interface <CODE>org.eclipse.jface.viewers.ITreePathContentProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element
-<DT><B>Returns:</B><DD>the possible parent paths for the given element</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerView.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerView.html index fa3b3e22c5..3721f2d399 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerView.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ContainerView.html @@ -196,7 +196,7 @@ Class ContainerView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerView.html#addSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener)">addSelectionChangedListener</A></B>(org.eclipse.jface.viewers.ISelectionChangedListener listener)</CODE>
<BR>
- Adds a listener for selection changes in this selection provider.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -260,7 +260,7 @@ Class ContainerView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerView.html#createPartControl(org.eclipse.swt.widgets.Composite)">createPartControl</A></B>(org.eclipse.swt.widgets.Composite parent)</CODE>
<BR>
- Creates the SWT controls for this workbench part.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -405,7 +405,7 @@ Class ContainerView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerView.html#getSelection()">getSelection</A></B>()</CODE>
<BR>
- Returns the current selection for this provider.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -478,7 +478,7 @@ Class ContainerView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerView.html#removeSelectionChangedListener(org.eclipse.jface.viewers.ISelectionChangedListener)">removeSelectionChangedListener</A></B>(org.eclipse.jface.viewers.ISelectionChangedListener listener)</CODE>
<BR>
- Removes the given selection change listener from this selection provider.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -511,7 +511,7 @@ Class ContainerView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerView.html#selectReveal(org.eclipse.jface.viewers.ISelection)">selectReveal</A></B>(org.eclipse.jface.viewers.ISelection selection)</CODE>
<BR>
- Reveals and selects the given element within this target view.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -519,7 +519,7 @@ Class ContainerView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerView.html#setFocus()">setFocus</A></B>()</CODE>
<BR>
- Asks this part to take focus within the workbench.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -527,7 +527,7 @@ Class ContainerView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ContainerView.html#setSelection(org.eclipse.jface.viewers.ISelection)">setSelection</A></B>(org.eclipse.jface.viewers.ISelection selection)</CODE>
<BR>
- Sets the current selection for this selection provider.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -672,16 +672,6 @@ setFocus</H3> <PRE>
public void <B>setFocus</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.IWorkbenchPart</CODE></B></DD>
-<DD>Asks this part to take focus within the workbench. Parts must
- assign focus to one of the controls contained in the part's
- parent composite.
- <p>
- Clients should not call this method (the workbench calls this method at
- appropriate times). To have the workbench activate a part, use
- <code>IWorkbenchPage.activate(IWorkbenchPart) instead</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setFocus</CODE> in interface <CODE>org.eclipse.ui.IWorkbenchPart</CODE><DT><B>Specified by:</B><DD><CODE>setFocus</CODE> in class <CODE>org.eclipse.ui.part.WorkbenchPart</CODE></DL>
</DD>
@@ -710,15 +700,11 @@ getSelection</H3> <PRE>
public org.eclipse.jface.viewers.ISelection <B>getSelection</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ISelectionProvider</CODE></B></DD>
-<DD>Returns the current selection for this provider.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getSelection</CODE> in interface <CODE>org.eclipse.jface.viewers.ISelectionProvider</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the current selection<DT><B>Since:</B></DT>
+<DT><B>Since:</B></DT>
<DD>3.0</DD>
</DL>
</DD>
@@ -730,14 +716,11 @@ setSelection</H3> <PRE>
public void <B>setSelection</B>(org.eclipse.jface.viewers.ISelection selection)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ISelectionProvider</CODE></B></DD>
-<DD>Sets the current selection for this selection provider.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setSelection</CODE> in interface <CODE>org.eclipse.jface.viewers.ISelectionProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>selection</CODE> - the new selection<DT><B>Since:</B></DT>
+<DT><B>Since:</B></DT>
<DD>3.0</DD>
</DL>
</DD>
@@ -749,15 +732,11 @@ addSelectionChangedListener</H3> <PRE>
public void <B>addSelectionChangedListener</B>(org.eclipse.jface.viewers.ISelectionChangedListener listener)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ISelectionProvider</CODE></B></DD>
-<DD>Adds a listener for selection changes in this selection provider.
- Has no effect if an identical listener is already registered.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>addSelectionChangedListener</CODE> in interface <CODE>org.eclipse.jface.viewers.ISelectionProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>listener</CODE> - a selection changed listener<DT><B>Since:</B></DT>
+<DT><B>Since:</B></DT>
<DD>3.0</DD>
</DL>
</DD>
@@ -769,15 +748,11 @@ removeSelectionChangedListener</H3> <PRE>
public void <B>removeSelectionChangedListener</B>(org.eclipse.jface.viewers.ISelectionChangedListener listener)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ISelectionProvider</CODE></B></DD>
-<DD>Removes the given selection change listener from this selection provider.
- Has no effect if an identical listener is not registered.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>removeSelectionChangedListener</CODE> in interface <CODE>org.eclipse.jface.viewers.ISelectionProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>listener</CODE> - a selection changed listener<DT><B>Since:</B></DT>
+<DT><B>Since:</B></DT>
<DD>3.0</DD>
</DL>
</DD>
@@ -789,14 +764,11 @@ selectReveal</H3> <PRE>
public void <B>selectReveal</B>(org.eclipse.jface.viewers.ISelection selection)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.part.ISetSelectionTarget</CODE></B></DD>
-<DD>Reveals and selects the given element within this target view.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>selectReveal</CODE> in interface <CODE>org.eclipse.ui.part.ISetSelectionTarget</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>selection</CODE> - the new element to select</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -806,29 +778,11 @@ createPartControl</H3> <PRE>
public final void <B>createPartControl</B>(org.eclipse.swt.widgets.Composite parent)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.IWorkbenchPart</CODE></B></DD>
-<DD>Creates the SWT controls for this workbench part.
- <p>
- Clients should not call this method (the workbench calls this method when
- it needs to, which may be never).
- </p>
- <p>
- For implementors this is a multi-step process:
- <ol>
- <li>Create one or more controls within the parent.</li>
- <li>Set the parent layout as needed.</li>
- <li>Register any global actions with the site's <code>IActionBars</code>.</li>
- <li>Register any context menus with the site.</li>
- <li>Register a selection provider with the site, to make it available to
- the workbench's <code>ISelectionService</code> (optional). </li>
- </ol>
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>createPartControl</CODE> in interface <CODE>org.eclipse.ui.IWorkbenchPart</CODE><DT><B>Specified by:</B><DD><CODE>createPartControl</CODE> in class <CODE>org.eclipse.ui.part.WorkbenchPart</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent control</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ItemProvider.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ItemProvider.html index 5f37ad7edf..807a334b8d 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ItemProvider.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/ItemProvider.html @@ -170,7 +170,7 @@ Class ItemProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#addListener(org.eclipse.jface.viewers.ILabelProviderListener)">addListener</A></B>(org.eclipse.jface.viewers.ILabelProviderListener listener)</CODE>
<BR>
- Adds a listener to this label provider.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -211,7 +211,7 @@ Class ItemProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#getBackground(java.lang.Object)">getBackground</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> element)</CODE>
<BR>
- Provides a background color for the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -219,8 +219,7 @@ Class ItemProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#getElements(java.lang.Object)">getElements</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> parent)</CODE>
<BR>
- Returns the elements to display in the viewer
- when its input is set to the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -228,7 +227,7 @@ Class ItemProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#getFont(java.lang.Object)">getFont</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> element)</CODE>
<BR>
- Provides a font for the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -236,7 +235,7 @@ Class ItemProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#getForeground(java.lang.Object)">getForeground</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> element)</CODE>
<BR>
- Provides a foreground color for the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -244,7 +243,7 @@ Class ItemProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#getImage(java.lang.Object)">getImage</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> obj)</CODE>
<BR>
- Returns the image for the label of the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -260,7 +259,7 @@ Class ItemProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#getText(java.lang.Object)">getText</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> obj)</CODE>
<BR>
- Returns the text for the label of the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -268,7 +267,7 @@ Class ItemProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#hasChildren(java.lang.Object)">hasChildren</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> parent)</CODE>
<BR>
- Returns whether the given element has children.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -277,8 +276,7 @@ Class ItemProvider<INPUT></H2> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> property)</CODE>
<BR>
- Returns whether the label would be affected
- by a change to the given property of the given element.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -286,7 +284,7 @@ Class ItemProvider<INPUT></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/ItemProvider.html#removeListener(org.eclipse.jface.viewers.ILabelProviderListener)">removeListener</A></B>(org.eclipse.jface.viewers.ILabelProviderListener listener)</CODE>
<BR>
- Removes a listener to this label provider.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.eclipse.net4j.util.ui.StructuredContentProvider"><!-- --></A>
@@ -388,24 +386,11 @@ getElements</H3> <PRE>
public final <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>getElements</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> parent)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ITreeContentProvider</CODE></B></DD>
-<DD>Returns the elements to display in the viewer
- when its input is set to the given element.
- These elements can be presented as rows in a table, items in a list, etc.
- The result is not modified by the viewer.
- <p>
- <b>NOTE:</b> The returned array must not contain the given
- <code>inputElement</code>, since this leads to recursion issues in
- <CODE>AbstractTreeViewer</CODE> (see
- <a href="https://bugs.eclipse.org/9262">bug 9262</a>).
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getElements</CODE> in interface <CODE>org.eclipse.jface.viewers.IStructuredContentProvider</CODE><DT><B>Specified by:</B><DD><CODE>getElements</CODE> in interface <CODE>org.eclipse.jface.viewers.ITreeContentProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the input element
-<DT><B>Returns:</B><DD>the array of elements to display in the viewer</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -415,21 +400,11 @@ hasChildren</H3> <PRE>
public boolean <B>hasChildren</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> parent)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ITreeContentProvider</CODE></B></DD>
-<DD>Returns whether the given element has children.
- <p>
- Intended as an optimization for when the viewer does not
- need the actual children. Clients may be able to implement
- this more efficiently than <code>getChildren</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>hasChildren</CODE> in interface <CODE>org.eclipse.jface.viewers.ITreeContentProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the element
-<DT><B>Returns:</B><DD><code>true</code> if the given element has children,
- and <code>false</code> if it has no children</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -439,16 +414,11 @@ getText</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getText</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> obj)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ILabelProvider</CODE></B></DD>
-<DD>Returns the text for the label of the given element.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getText</CODE> in interface <CODE>org.eclipse.jface.viewers.ILabelProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the element for which to provide the label text
-<DT><B>Returns:</B><DD>the text string used to label the element, or <code>null</code>
- if there is no text label for the given object</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -458,18 +428,11 @@ getImage</H3> <PRE>
public org.eclipse.swt.graphics.Image <B>getImage</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> obj)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.ILabelProvider</CODE></B></DD>
-<DD>Returns the image for the label of the given element. The image
- is owned by the label provider and must not be disposed directly.
- Instead, dispose the label provider when no longer needed.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getImage</CODE> in interface <CODE>org.eclipse.jface.viewers.ILabelProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the element for which to provide the label image
-<DT><B>Returns:</B><DD>the image used to label the element, or <code>null</code>
- if there is no image for the given object</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -479,16 +442,11 @@ getBackground</H3> <PRE>
public org.eclipse.swt.graphics.Color <B>getBackground</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> element)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IColorProvider</CODE></B></DD>
-<DD>Provides a background color for the given element.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getBackground</CODE> in interface <CODE>org.eclipse.jface.viewers.IColorProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element
-<DT><B>Returns:</B><DD>the background color for the element, or <code>null</code>
- to use the default background color</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -498,16 +456,11 @@ getForeground</H3> <PRE>
public org.eclipse.swt.graphics.Color <B>getForeground</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> element)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IColorProvider</CODE></B></DD>
-<DD>Provides a foreground color for the given element.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getForeground</CODE> in interface <CODE>org.eclipse.jface.viewers.IColorProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element
-<DT><B>Returns:</B><DD>the foreground color for the element, or <code>null</code>
- to use the default foreground color</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -517,16 +470,11 @@ getFont</H3> <PRE>
public org.eclipse.swt.graphics.Font <B>getFont</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> element)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IFontProvider</CODE></B></DD>
-<DD>Provides a font for the given element.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getFont</CODE> in interface <CODE>org.eclipse.jface.viewers.IFontProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element
-<DT><B>Returns:</B><DD>the font for the element, or <code>null</code>
- to use the default font</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -537,20 +485,11 @@ isLabelProperty</H3> public boolean <B>isLabelProperty</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> element,
<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> property)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IBaseLabelProvider</CODE></B></DD>
-<DD>Returns whether the label would be affected
- by a change to the given property of the given element.
- This can be used to optimize a non-structural viewer update.
- If the property mentioned in the update does not affect the label,
- then the viewer need not update the label.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isLabelProperty</CODE> in interface <CODE>org.eclipse.jface.viewers.IBaseLabelProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element<DD><CODE>property</CODE> - the property
-<DT><B>Returns:</B><DD><code>true</code> if the label would be affected,
- and <code>false</code> if it would be unaffected</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -574,19 +513,11 @@ addListener</H3> <PRE>
public void <B>addListener</B>(org.eclipse.jface.viewers.ILabelProviderListener listener)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IBaseLabelProvider</CODE></B></DD>
-<DD>Adds a listener to this label provider.
- Has no effect if an identical listener is already registered.
- <p>
- Label provider listeners are informed about state changes
- that affect the rendering of the viewer that uses this label provider.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>addListener</CODE> in interface <CODE>org.eclipse.jface.viewers.IBaseLabelProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>listener</CODE> - a label provider listener</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -596,15 +527,11 @@ removeListener</H3> <PRE>
public void <B>removeListener</B>(org.eclipse.jface.viewers.ILabelProviderListener listener)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.jface.viewers.IBaseLabelProvider</CODE></B></DD>
-<DD>Removes a listener to this label provider.
- Has no effect if an identical listener is not registered.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>removeListener</CODE> in interface <CODE>org.eclipse.jface.viewers.IBaseLabelProvider</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>listener</CODE> - a label provider listener</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/MultiViewersView.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/MultiViewersView.html index 77df78e97e..9968238aa3 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/MultiViewersView.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/views/MultiViewersView.html @@ -199,7 +199,7 @@ Class MultiViewersView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/MultiViewersView.html#createPartControl(org.eclipse.swt.widgets.Composite)">createPartControl</A></B>(org.eclipse.swt.widgets.Composite parent)</CODE>
<BR>
- Creates the SWT controls for this workbench part.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -298,7 +298,7 @@ Class MultiViewersView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/MultiViewersView.html#selectReveal(org.eclipse.jface.viewers.ISelection)">selectReveal</A></B>(org.eclipse.jface.viewers.ISelection selection)</CODE>
<BR>
- Reveals and selects the given element within this target view.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -314,7 +314,7 @@ Class MultiViewersView</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/views/MultiViewersView.html#setFocus()">setFocus</A></B>()</CODE>
<BR>
- Asks this part to take focus within the workbench.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -473,16 +473,6 @@ setFocus</H3> <PRE>
public void <B>setFocus</B>()</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.IWorkbenchPart</CODE></B></DD>
-<DD>Asks this part to take focus within the workbench. Parts must
- assign focus to one of the controls contained in the part's
- parent composite.
- <p>
- Clients should not call this method (the workbench calls this method at
- appropriate times). To have the workbench activate a part, use
- <code>IWorkbenchPage.activate(IWorkbenchPart) instead</code>.
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setFocus</CODE> in interface <CODE>org.eclipse.ui.IWorkbenchPart</CODE><DT><B>Specified by:</B><DD><CODE>setFocus</CODE> in class <CODE>org.eclipse.ui.part.WorkbenchPart</CODE></DL>
</DD>
@@ -554,14 +544,11 @@ selectReveal</H3> <PRE>
public void <B>selectReveal</B>(org.eclipse.jface.viewers.ISelection selection)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.part.ISetSelectionTarget</CODE></B></DD>
-<DD>Reveals and selects the given element within this target view.
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>selectReveal</CODE> in interface <CODE>org.eclipse.ui.part.ISetSelectionTarget</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>selection</CODE> - the new element to select</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -585,29 +572,11 @@ createPartControl</H3> <PRE>
public final void <B>createPartControl</B>(org.eclipse.swt.widgets.Composite parent)</PRE>
<DL>
-<DD><B>Description copied from interface: <CODE>org.eclipse.ui.IWorkbenchPart</CODE></B></DD>
-<DD>Creates the SWT controls for this workbench part.
- <p>
- Clients should not call this method (the workbench calls this method when
- it needs to, which may be never).
- </p>
- <p>
- For implementors this is a multi-step process:
- <ol>
- <li>Create one or more controls within the parent.</li>
- <li>Set the parent layout as needed.</li>
- <li>Register any global actions with the site's <code>IActionBars</code>.</li>
- <li>Register any context menus with the site.</li>
- <li>Register a selection provider with the site, to make it available to
- the workbench's <code>ISelectionService</code> (optional). </li>
- </ol>
- </p>
-<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>createPartControl</CODE> in interface <CODE>org.eclipse.ui.IWorkbenchPart</CODE><DT><B>Specified by:</B><DD><CODE>createPartControl</CODE> in class <CODE>org.eclipse.ui.part.WorkbenchPart</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent control</DL>
+</DL>
</DD>
</DL>
<HR>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/BaseDialog.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/BaseDialog.html index 6ea05bbc01..d388e3d006 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/BaseDialog.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/BaseDialog.html @@ -229,7 +229,7 @@ Class BaseDialog<VIEWER extends org.eclipse.jface.viewers.Viewer></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/BaseDialog.html#configureShell(org.eclipse.swt.widgets.Shell)">configureShell</A></B>(org.eclipse.swt.widgets.Shell newShell)</CODE>
<BR>
- Configures the given shell in preparation for opening this window in it.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -237,8 +237,7 @@ Class BaseDialog<VIEWER extends org.eclipse.jface.viewers.Viewer></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/BaseDialog.html#createDialogArea(org.eclipse.swt.widgets.Composite)">createDialogArea</A></B>(org.eclipse.swt.widgets.Composite parent)</CODE>
<BR>
- Creates and returns the contents of the upper part of this dialog (above
- the button bar).</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -271,8 +270,7 @@ Class BaseDialog<VIEWER extends org.eclipse.jface.viewers.Viewer></H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/BaseDialog.html#getDialogBoundsSettings()">getDialogBoundsSettings</A></B>()</CODE>
<BR>
- Gets the dialog settings that should be used for remembering the bounds of
- of the dialog, according to the dialog bounds strategy.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -405,18 +403,11 @@ configureShell</H3> <PRE>
protected void <B>configureShell</B>(org.eclipse.swt.widgets.Shell newShell)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.window.Window</CODE></B></DD>
-<DD>Configures the given shell in preparation for opening this window in it.
- <p>
- The default implementation of this framework method sets the shell's
- image and gives it a grid layout. Subclasses may extend or reimplement.
- </p>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>configureShell</CODE> in class <CODE>org.eclipse.jface.window.Window</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>newShell</CODE> - the shell</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -426,21 +417,11 @@ createDialogArea</H3> <PRE>
protected org.eclipse.swt.widgets.Control <B>createDialogArea</B>(org.eclipse.swt.widgets.Composite parent)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.dialogs.TitleAreaDialog</CODE></B></DD>
-<DD>Creates and returns the contents of the upper part of this dialog (above
- the button bar).
- <p>
- The <code>Dialog</code> implementation of this framework method creates
- and returns a new <code>Composite</code> with no margins and spacing.
- Subclasses should override.
- </p>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>createDialogArea</CODE> in class <CODE>org.eclipse.jface.dialogs.TitleAreaDialog</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - The parent composite to contain the dialog area
-<DT><B>Returns:</B><DD>the dialog area control</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -506,18 +487,11 @@ getDialogBoundsSettings</H3> <PRE>
protected org.eclipse.jface.dialogs.IDialogSettings <B>getDialogBoundsSettings</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.dialogs.Dialog</CODE></B></DD>
-<DD>Gets the dialog settings that should be used for remembering the bounds of
- of the dialog, according to the dialog bounds strategy.
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>getDialogBoundsSettings</CODE> in class <CODE>org.eclipse.jface.dialogs.Dialog</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>settings the dialog settings used to store the dialog's location
- and/or size, or <code>null</code> if the dialog's bounds should
- never be stored.<DT><B>See Also:</B><DD><CODE>Dialog.getDialogBoundsStrategy()</CODE></DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/HistoryTextDialog.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/HistoryTextDialog.html index 6df43a8449..50a34fd9bf 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/HistoryTextDialog.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/HistoryTextDialog.html @@ -201,7 +201,7 @@ TODO extend BaseDialog <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/HistoryTextDialog.html#buttonPressed(int)">buttonPressed</A></B>(int buttonId)</CODE>
<BR>
- Notifies that this dialog's button with the given id has been pressed.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -209,7 +209,7 @@ TODO extend BaseDialog <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/HistoryTextDialog.html#createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)">createButtonsForButtonBar</A></B>(org.eclipse.swt.widgets.Composite parent)</CODE>
<BR>
- Adds buttons to this dialog's button bar.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -217,8 +217,7 @@ TODO extend BaseDialog <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/HistoryTextDialog.html#createDialogArea(org.eclipse.swt.widgets.Composite)">createDialogArea</A></B>(org.eclipse.swt.widgets.Composite parent)</CODE>
<BR>
- Creates and returns the contents of the upper part of this dialog (above
- the button bar).</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -242,7 +241,7 @@ TODO extend BaseDialog <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/HistoryTextDialog.html#getValue()">getValue</A></B>()</CODE>
<BR>
- Returns the string typed into this input dialog.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -250,7 +249,7 @@ TODO extend BaseDialog <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/HistoryTextDialog.html#validateInput()">validateInput</A></B>()</CODE>
<BR>
- Validates the input.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.eclipse.jface.dialogs.InputDialog"><!-- --></A>
@@ -350,15 +349,11 @@ getValue</H3> <PRE>
public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getValue</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.dialogs.InputDialog</CODE></B></DD>
-<DD>Returns the string typed into this input dialog.
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>getValue</CODE> in class <CODE>org.eclipse.jface.dialogs.InputDialog</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the input string</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -368,36 +363,11 @@ createDialogArea</H3> <PRE>
protected org.eclipse.swt.widgets.Control <B>createDialogArea</B>(org.eclipse.swt.widgets.Composite parent)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.dialogs.Dialog</CODE></B></DD>
-<DD>Creates and returns the contents of the upper part of this dialog (above
- the button bar).
- <p>
- The <code>Dialog</code> implementation of this framework method creates
- and returns a new <code>Composite</code> with standard margins and
- spacing.
- </p>
- <p>
- The returned control's layout data must be an instance of
- <code>GridData</code>. This method must not modify the parent's
- layout.
- </p>
- <p>
- Subclasses must override this method but may call <code>super</code> as
- in the following example:
- </p>
-
- <pre>
- Composite composite = (Composite) super.createDialogArea(parent);
- //add controls to composite as necessary
- return composite;
- </pre>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>createDialogArea</CODE> in class <CODE>org.eclipse.jface.dialogs.InputDialog</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent composite to contain the dialog area
-<DT><B>Returns:</B><DD>the dialog area control</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -407,23 +377,11 @@ buttonPressed</H3> <PRE>
protected void <B>buttonPressed</B>(int buttonId)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.dialogs.Dialog</CODE></B></DD>
-<DD>Notifies that this dialog's button with the given id has been pressed.
- <p>
- The <code>Dialog</code> implementation of this framework method calls
- <code>okPressed</code> if the ok button is the pressed, and
- <code>cancelPressed</code> if the cancel button is the pressed. All
- other button presses are ignored. Subclasses may override to handle other
- buttons, but should call <code>super.buttonPressed</code> if the
- default handling of the ok and cancel buttons is desired.
- </p>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>buttonPressed</CODE> in class <CODE>org.eclipse.jface.dialogs.InputDialog</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>buttonId</CODE> - the id of the button that was pressed (see
- <code>IDialogConstants.*_ID</code> constants)</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -433,21 +391,11 @@ createButtonsForButtonBar</H3> <PRE>
protected void <B>createButtonsForButtonBar</B>(org.eclipse.swt.widgets.Composite parent)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.dialogs.Dialog</CODE></B></DD>
-<DD>Adds buttons to this dialog's button bar.
- <p>
- The <code>Dialog</code> implementation of this framework method adds
- standard ok and cancel buttons using the <code>createButton</code>
- framework method. These standard buttons will be accessible from
- <code>getCancelButton</code>, and <code>getOKButton</code>.
- Subclasses may override.
- </p>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>createButtonsForButtonBar</CODE> in class <CODE>org.eclipse.jface.dialogs.InputDialog</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the button bar composite</DL>
+</DL>
</DD>
</DL>
<HR>
@@ -457,15 +405,6 @@ validateInput</H3> <PRE>
protected void <B>validateInput</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.dialogs.InputDialog</CODE></B></DD>
-<DD>Validates the input.
- <p>
- The default implementation of this framework method delegates the request
- to the supplied input validator object; if it finds the input invalid,
- the error message is displayed in the dialog's message line. This hook
- method is called whenever the text changes in the input field.
- </p>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>validateInput</CODE> in class <CODE>org.eclipse.jface.dialogs.InputDialog</CODE></DL>
</DD>
diff --git a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/LogDialog.html b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/LogDialog.html index 9c7a2137f5..e558f5e3b6 100644 --- a/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/LogDialog.html +++ b/plugins/org.eclipse.net4j.util.doc/javadoc/org/eclipse/net4j/util/ui/widgets/LogDialog.html @@ -242,8 +242,7 @@ Class LogDialog</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/LogDialog.html#close()">close</A></B>()</CODE>
<BR>
- Closes this window, disposes its shell, and removes this window from its
- window manager (if it has one).</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -251,7 +250,7 @@ Class LogDialog</H2> <TD><CODE><B><A HREF="../../../../../../org/eclipse/net4j/util/ui/widgets/LogDialog.html#createButtonsForButtonBar(org.eclipse.swt.widgets.Composite)">createButtonsForButtonBar</A></B>(org.eclipse.swt.widgets.Composite parent)</CODE>
<BR>
- Adds buttons to this dialog's button bar.</TD>
+ </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -426,26 +425,11 @@ close</H3> <PRE>
public boolean <B>close</B>()</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.window.Window</CODE></B></DD>
-<DD>Closes this window, disposes its shell, and removes this window from its
- window manager (if it has one).
- <p>
- This framework method may be extended (<code>super.close</code> must
- be called).
- </p>
- <p>
- Note that in order to prevent recursive calls to this method
- it does not call <code>Shell#close()</code>. As a result <code>ShellListener</code>s
- will not receive a <code>shellClosed</code> event.
- </p>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>close</CODE> in class <CODE>org.eclipse.jface.dialogs.TrayDialog</CODE></DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD><code>true</code> if the window is (or was already) closed, and
- <code>false</code> if it is still open<DT><B>See Also:</B><DD><CODE>Window.close()</CODE></DL>
+</DL>
</DD>
</DL>
<HR>
@@ -469,21 +453,11 @@ createButtonsForButtonBar</H3> <PRE>
protected void <B>createButtonsForButtonBar</B>(org.eclipse.swt.widgets.Composite parent)</PRE>
<DL>
-<DD><B>Description copied from class: <CODE>org.eclipse.jface.dialogs.Dialog</CODE></B></DD>
-<DD>Adds buttons to this dialog's button bar.
- <p>
- The <code>Dialog</code> implementation of this framework method adds
- standard ok and cancel buttons using the <code>createButton</code>
- framework method. These standard buttons will be accessible from
- <code>getCancelButton</code>, and <code>getOKButton</code>.
- Subclasses may override.
- </p>
-<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>createButtonsForButtonBar</CODE> in class <CODE>org.eclipse.jface.dialogs.Dialog</CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the button bar composite</DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
|