[ jEdit-commits ] SF.net SVN: jedit: [7625] jEdit/trunk/org/gjt/sp/jedit/GUIUtilities.java

[<vam...@us...>]

Revision: 7625
          http://svn.sourceforge.net/jedit/?rev=7625&view=rev
Author:   vampire0
Date:     2006-10-20 05:01:46 -0700 (Fri, 20 Oct 2006)

Log Message:
-----------
Added JavaDoc relationship about addSizeSaver() and saveGeometry()

Modified Paths:
--------------
    jEdit/trunk/org/gjt/sp/jedit/GUIUtilities.java

Modified: jEdit/trunk/org/gjt/sp/jedit/GUIUtilities.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/GUIUtilities.java	2006-10-19 21:19:47 UTC (rev 7624)
+++ jEdit/trunk/org/gjt/sp/jedit/GUIUtilities.java	2006-10-20 12:01:46 UTC (rev 7625)
@@ -419,7 +419,6 @@
 		return mi;
 	} //}}}
 
-	
 	//{{{ loadToolBar() method
 	/**
 	 * Creates a toolbar.
@@ -1212,9 +1211,12 @@
 	 * Saves a window's geometry to the properties.
 	 * The geometry is saved to the <code><i>name</i>.x</code>,
 	 * <code><i>name</i>.y</code>, <code><i>name</i>.width</code> and
-	 * <code><i>name</i>.height</code> properties.
+	 * <code><i>name</i>.height</code> properties.<br />
+	 * For Frame's and descendents use {@link #addSizeSaver(Frame,String)} to save the sizes
+	 * correct even if the Frame is in maximized or iconified state.
 	 * @param win The window to load geometry from
 	 * @param name The name of the window 
+	 * @see #addSizeSaver(Frame,String)
 	 */
 	public static void saveGeometry(Window win, String name) {
 		saveGeometry (win, win.getParent(), name);
@@ -1225,10 +1227,13 @@
 	 * Saves a window's geometry to the properties.
 	 * The geometry is saved to the <code><i>name</i>.x</code>,
 	 * <code><i>name</i>.y</code>, <code><i>name</i>.width</code> and
-	 * <code><i>name</i>.height</code> properties.
+	 * <code><i>name</i>.height</code> properties.<br />
+	 * For Frame's and descendents use {@link #addSizeSaver(Frame,Container,String)} to save the sizes
+	 * correct even if the Frame is in maximized or iconified state.
 	 * @param win The window to load geometry from
 	 * @param parent The parent frame to be relative to.
 	 * @param name The name of the window 
+	 * @see #addSizeSaver(Frame,Container,String)
 	 */
 	public static void saveGeometry(Window win, Container parent, String name)
 	{
@@ -1568,11 +1573,12 @@
 
 	//{{{ addSizeSaver() method
 	/**
-	 * Adds a SizeSaver to the specified Frame.
+	* Adds a SizeSaver to the specified Frame. For non-Frame's use {@link #saveGeometry(Window,String)}
 	 *
 	 * @param frame The Frame for which to save the size
 	 * @param name The prefix for the settings
 	 * @since jEdit 4.3pre6
+	 * @see #saveGeometry(Window,String)
 	 */
 	public static void addSizeSaver(Frame frame, String name) 
 	{
@@ -1581,12 +1587,13 @@
 
 	//{{{ addSizeSaver() method
 	/**
-	 * Adds a SizeSaver to the specified Frame.
+	 * Adds a SizeSaver to the specified Frame. For non-Frame's use {@link #saveGeometry(Window,Container,String)}
 	 *
 	 * @param frame The Frame for which to save the size
 	 * @param parent The parent to be relative to
 	 * @param name The prefix for the settings
 	 * @since jEdit 4.3pre7
+	 * @see #saveGeometry(Window,Container,String)
 	 */
 	public static void addSizeSaver(Frame frame, Container parent, String name)
 	{
@@ -1637,11 +1644,13 @@
 
 	//{{{ SizeSaver class
 	/**
-	 * A combined ComponentListener and WindowStateListener to continually save a Frames size.<p>
+	 * A combined ComponentListener and WindowStateListener to continually save a Frames size.<br />
+	 * For non-Frame's use {@link #saveGeometry(Window,String)}
 	 *
 	 * @author Bj\xF6rn Kautler
 	 * @version $Id$
 	 * @since jEdit 4.3pre6
+	 * @see #saveGeometry(Window,Container,String)
 	 */
 	static class SizeSaver extends ComponentAdapter implements WindowStateListener
 	{


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.