Revision: 21502
http://jedit.svn.sourceforge.net/jedit/?rev=21502&view=rev
Author: ezust
Date: 2012-03-29 17:19:44 +0000 (Thu, 29 Mar 2012)
Log Message:
-----------
Javadocs
Modified Paths:
--------------
jEdit/trunk/org/gjt/sp/jedit/MiscUtilities.java
jEdit/trunk/org/gjt/sp/jedit/gui/AboutDialog.java
jEdit/trunk/org/gjt/sp/jedit/gui/ActionBar.java
jEdit/trunk/org/gjt/sp/jedit/gui/AnimatedIcon.java
jEdit/trunk/org/gjt/sp/jedit/gui/BeanShellErrorDialog.java
jEdit/trunk/org/gjt/sp/jedit/gui/BufferOptions.java
jEdit/trunk/org/gjt/sp/jedit/gui/ColorWellButton.java
jEdit/trunk/org/gjt/sp/jedit/gui/CompleteWord.java
jEdit/trunk/org/gjt/sp/jedit/gui/CompletionPopup.java
jEdit/trunk/org/gjt/sp/jedit/gui/ContextAddDialog.java
jEdit/trunk/org/gjt/sp/jedit/gui/DefaultFocusComponent.java
jEdit/trunk/org/gjt/sp/jedit/gui/DefaultInputHandler.java
jEdit/trunk/org/gjt/sp/jedit/gui/DockableLayout.java
jEdit/trunk/org/gjt/sp/jedit/gui/DockablePanel.java
jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindow.java
jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowContainer.java
jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowFactory.java
jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManager.java
jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManagerImpl.java
jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManagerProvider.java
jEdit/trunk/org/gjt/sp/jedit/gui/DockingFrameworkProvider.java
jEdit/trunk/org/gjt/sp/jedit/gui/DynamicContextMenuService.java
jEdit/trunk/org/gjt/sp/jedit/gui/EnhancedButton.java
jEdit/trunk/org/gjt/sp/jedit/gui/EnhancedDialog.java
jEdit/trunk/org/gjt/sp/jedit/gui/ErrorListDialog.java
jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayout.java
jEdit/trunk/org/gjt/sp/jedit/gui/HistoryTextField.java
Modified: jEdit/trunk/org/gjt/sp/jedit/MiscUtilities.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/MiscUtilities.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/MiscUtilities.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -430,9 +430,9 @@
//{{{ getCompleteBaseName() method
/**
- * @return the complete basename of a file (before the last period).
+ * @return the complete basename of a fileName (before the last period).
* i.e. if your filename is
- * IP-192.168.1.1-data.tar.gz
+ * /net/log/IP-192.168.1.1-data.tar.gz
* it will return
* IP-192.168.1.1-data.tar
* @param path the path name
@@ -451,9 +451,9 @@
//{{{ getBaseName() method
/**
- * @return the base name of a file (before the first period).
+ * @return the base name of a fileName (before the first period).
* i.e. If your filename is
- * IP-192.168.1.1-data.tar.gz
+ * /net/log/IP-192.168.1.1-data.tar.gz
* it will return
* IP-192
* @param path The path name
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/AboutDialog.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/AboutDialog.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/AboutDialog.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -35,7 +35,8 @@
import org.gjt.sp.jedit.*;
import org.gjt.sp.util.Log;
//}}}
-
+/** "About jEdit" dialog
+*/
public class AboutDialog extends JDialog implements ActionListener
{
//{{{ AboutDialog constructor
@@ -185,12 +186,12 @@
}
else if ((e.getKeyCode() == KeyEvent.VK_LEFT) ||
(e.getKeyCode() == KeyEvent.VK_RIGHT) ||
- (e.getKeyCode() == KeyEvent.VK_SPACE))
+ (e.getKeyCode() == KeyEvent.VK_SPACE))
{
skipDrain = ! skipDrain;
e.consume();
}
- else if ((e.getKeyCode()) == KeyEvent.VK_ESCAPE)
+ else if ((e.getKeyCode()) == KeyEvent.VK_ESCAPE)
{
e.consume();
JDialog d = GUIUtilities.getParentDialog(this);
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/ActionBar.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/ActionBar.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/ActionBar.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -33,8 +33,7 @@
import org.gjt.sp.util.StandardUtilities;
//}}}
-/**
- * Action invocation bar.
+/** Action invocation bar.
*/
public class ActionBar extends JToolBar
{
@@ -43,7 +42,7 @@
{
this.view = view;
this.temp = temp;
-
+
setLayout(new BoxLayout(this,BoxLayout.X_AXIS));
setFloatable(false);
add(Box.createHorizontalStrut(2));
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/AnimatedIcon.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/AnimatedIcon.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/AnimatedIcon.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -28,8 +28,9 @@
import javax.swing.*;
//}}}
-/**
- * A animated version of ImageIcon. It can be used anywhere an ImageIcon can be.
+/** A Animated version of ImageIcon.
+ *
+ * It can be used anywhere an ImageIcon can be.
*/
public class AnimatedIcon extends ImageIcon
{
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/BeanShellErrorDialog.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/BeanShellErrorDialog.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/BeanShellErrorDialog.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -29,9 +29,7 @@
import org.gjt.sp.jedit.*;
//}}}
-/**
- * A dialog box showing a stack trace. Perhaps badly named, since any error, not
- * just a BeanShell error can be shown.
+/** A dialog box showing a stack trace. Perhaps badly named, since any error, not just a BeanShell error can be shown.
* @author Slava Pestov
* @version $Id$
*/
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/BufferOptions.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/BufferOptions.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/BufferOptions.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -40,12 +40,10 @@
//}}}
-/**
-
- * Buffer-specific options dialog.
+/** Buffer-specific options dialog.
* @author Slava Pestov
* @version $Id$
- *
+ *
*/
public class BufferOptions extends EnhancedDialog
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/ColorWellButton.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/ColorWellButton.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/ColorWellButton.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -31,8 +31,7 @@
import org.gjt.sp.jedit.OperatingSystem;
//}}}
-/**
- * A button that, when clicked, shows a color chooser.
+/** A button that, when clicked, shows a color chooser.
*
* You can get and set the currently selected color using
* {@link #getSelectedColor()} and {@link #setSelectedColor(Color)}.
@@ -120,7 +119,7 @@
ColorWellButton.this.getSelectedColor());
}
if (c != null) {
- setSelectedColor(c);
+ setSelectedColor(c);
}
}
} //}}}
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/CompleteWord.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/CompleteWord.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/CompleteWord.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -54,8 +54,7 @@
import org.gjt.sp.util.StandardUtilities;
//}}}
-/**
- * A completion popup class.
+/** A word completion popup.
*/
public class CompleteWord extends CompletionPopup
{
@@ -192,7 +191,7 @@
return word.toString();
} //}}}
-
+
//{{{ getVisibleBuffers() method
private static Collection<Buffer> getVisibleBuffers()
{
@@ -221,8 +220,8 @@
final KeywordMap keywordMap = buffer.getKeywordMapAtOffset(caret);
final String noWordSep = getNonAlphaNumericWordChars(
buffer,keywordMap);
-
- final Collection<Buffer> sourceBuffers =
+
+ final Collection<Buffer> sourceBuffers =
jEdit.getBooleanProperty("completeFromAllBuffers") ?
Arrays.asList(jEdit.getBuffers()) :
getVisibleBuffers();
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/CompletionPopup.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/CompletionPopup.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/CompletionPopup.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -50,8 +50,7 @@
import org.gjt.sp.jedit.View;
//}}}
-/**
- * Popup window for word completion in text area.
+/** Popup window for word completion in text area.
* This class provides basic UI of completion popup.
*
* @since jEdit 4.3pre11
@@ -78,7 +77,7 @@
* Do the completion.
*/
public void complete(int index);
-
+
/**
* Returns a component to render a cell for the index
* in the popup.
@@ -101,7 +100,7 @@
* candidates. All key events for the view are intercepted by
* this popup untill end of completion.
* @since jEdit 4.3pre13
- */
+ */
public CompletionPopup(View view)
{
super(view);
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/ContextAddDialog.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/ContextAddDialog.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/ContextAddDialog.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -51,11 +51,10 @@
//}}}
-/**
- * Dialog for showing ActionSets and adding actions to context menus
- * Was package private and located in AbstractContextOptionPane.java
- * until 4.3pre16
+/** Dialog for showing ActionSets and adding actions to context menus
*
+ * Was package private and located in AbstractContextOptionPane.java until 4.3pre16
+ *
*/
public class ContextAddDialog extends EnhancedDialog
{
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DefaultFocusComponent.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DefaultFocusComponent.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DefaultFocusComponent.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -22,9 +22,9 @@
package org.gjt.sp.jedit.gui;
-/**
- * An interface that provides a method for focusing on the default
- * component. The file system browser implements this in order to
+/** An interface that provides a method for focusing on the default component.
+ *
+ * The file system browser implements this in order to
* focus on the file system view by default, for example.
*
* @since jEdit 4.2pre1
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DefaultInputHandler.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DefaultInputHandler.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DefaultInputHandler.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -29,9 +29,8 @@
import org.gjt.sp.jedit.*;
//}}}
-/**
- * The default input handler. It maps sequences of keystrokes into actions
- * and inserts key typed events into the text area.
+/** The default input handler maps sequences of keystrokes into actions and inserts key typed events into the text area.
+ *
* @author Slava Pestov
* @version $Id$
*/
@@ -136,7 +135,7 @@
}
else
{
- if (!dryRun)
+ if (!dryRun)
{
readNextChar = null;
view.getStatus().setMessage(null);
@@ -147,7 +146,7 @@
Object o = currentBindings.get(keyStroke);
if(o == null)
{
- if (!dryRun)
+ if (!dryRun)
{
// Don't beep if the user presses some
// key we don't know about unless a
@@ -161,13 +160,13 @@
repeatCount = 1;
setCurrentBindings(bindings);
}
- else if(input != '\0')
+ else if(input != '\0')
{
- if (!keyStroke.isFromGlobalContext())
+ if (!keyStroke.isFromGlobalContext())
{ // let user input be only local
userInput(input);
}
- }
+ }
else
{
// this is retarded. excuse me while I drool
@@ -180,7 +179,7 @@
}
else if(o instanceof Hashtable)
{
- if (!dryRun)
+ if (!dryRun)
{
setCurrentBindings((Hashtable)o);
ShortcutPrefixActiveEvent.firePrefixStateChange(currentBindings, true);
@@ -190,7 +189,7 @@
}
else if(o instanceof String)
{
- if (!dryRun)
+ if (!dryRun)
{
setCurrentBindings(bindings);
sendShortcutPrefixOff();
@@ -214,7 +213,7 @@
}
return false;
} //}}}
-
+
//{{{ getSymbolicModifierName() method
/**
* Returns a the symbolic modifier name for the specified Java modifier
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DockableLayout.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DockableLayout.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DockableLayout.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -25,7 +25,7 @@
//{{{ Imports
import java.awt.*;
//}}}
-
+/** A more flexible BorderLayout with dockables. */
public class DockableLayout implements LayoutManager2
{
// for backwards compatibility with plugins that fiddle with
@@ -50,7 +50,7 @@
//{{{ isAlternateLayout() method
/**
- * jEdit View option: wide horizontal docking areas versus tall vertical docking areas
+ * jEdit View option: wide horizontal docking areas versus tall vertical docking areas
* @return true if using the "alternate layout"
*/
public boolean isAlternateLayout()
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DockablePanel.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DockablePanel.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DockablePanel.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -37,7 +37,8 @@
import javax.swing.border.Border;
//}}}
-/**
+/** A panel that holds dockable windows.
+ *
* @version $Id$
*/
class DockablePanel extends JPanel
@@ -139,7 +140,7 @@
/** This belong to ResizeMouseHandler but requires to be static. */
static Point dragStart;
-
+
//{{{ ResizeMouseHandler class
class ResizeMouseHandler extends MouseAdapter implements MouseMotionListener
{
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindow.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindow.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindow.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -1,9 +1,7 @@
package org.gjt.sp.jedit.gui;
-/**
- * <p>An interface for notifying MOVABLE dockable windows before their docking
- * position is changed. </p>
- *
+/** An interface for notifying MOVABLE dockable windows before their docking position is changed.
+ *
* @author Shlomy Reinstein
* @version $Id$
* @since jEdit 4.3pre11
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowContainer.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowContainer.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowContainer.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -19,9 +19,9 @@
package org.gjt.sp.jedit.gui;
-/**
- * A container for dockable windows. This class should never be used
- * directly.
+/** A container for dockable windows.
+ *
+ * This class should never be used directly, and is not public.
* @author Slava Pestov
* @version $Id$
* @since jEdit 2.6pre3
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowFactory.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowFactory.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowFactory.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -54,8 +54,7 @@
import org.gjt.sp.jedit.bsh.UtilEvalError;
//}}}
-/**
- * Loads <code>dockable.xml</code> files and manages creation
+/** Loads <code>dockable.xml</code> files and manages creation
* of new dockable windows.
*
* @see DockableWindowManager
@@ -174,7 +173,7 @@
{
return dockableWindowFactories.get(name);
}
-
+
public String getDockableWindowPluginClass(String name)
{
Window w = getDockableWindowFactory(name);
@@ -182,7 +181,7 @@
return null;
return w.plugin.getPlugin().getClassName();
}
-
+
//{{{ getDockableWindowIterator() method
Iterator<Window> getDockableWindowIterator()
{
@@ -310,7 +309,7 @@
{
return booleanListToArray(cachedDockableMovableFlags);
} //}}}
-
+
//{{{ booleanListToArray() method
/**
* This method transforms a List<Boolean> into the corresponding
@@ -340,13 +339,13 @@
private java.util.List<String> cachedDockableNames;
private java.util.List<Boolean> cachedDockableActionFlags;
private java.util.List<Boolean> cachedDockableMovableFlags;
-
+
private String dockableName;
private StringBuilder code;
private boolean actions;
private boolean movable;
static final boolean MOVABLE_DEFAULT = false;
-
+
private Stack<String> stateStack;
//}}}
@@ -467,13 +466,13 @@
}
JComponent win = (JComponent)BeanShell.eval(view,nameSpace,code);
- if (jEdit.getBooleanProperty("textColors")) {
+ if (jEdit.getBooleanProperty("textColors")) {
LookAndFeel laf = UIManager.getLookAndFeel();
if (!laf.getID().equals("Metal")) {
GUIUtilities.applyTextAreaColors(win);
}
}
-
+
synchronized(this)
{
isBeingCreated = false;
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManager.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManager.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManager.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -29,8 +29,7 @@
@SuppressWarnings("serial")
// {{{ abstract class DockableWindowManager
-/**
- * <p>Keeps track of all dockable windows for a single View, and provides
+/**<p>Keeps track of all dockable windows for a single View, and provides
* an API for getting/showing/hiding them. </p>
*
* <p>Each {@link org.gjt.sp.jedit.View} has an instance of this class.</p>
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManagerImpl.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManagerImpl.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManagerImpl.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -1,5 +1,5 @@
/*
- * DockableWindowManager.java - manages dockable windows
+ * DockableWindowManagerImpl.java - manages dockable windows
* :tabSize=8:indentSize=8:noTabs=false:
* :folding=explicit:collapseFolds=1:
*
@@ -67,15 +67,19 @@
import org.xml.sax.helpers.DefaultHandler;
// }}}
-/**
- * Concrete class for Dockable Window Managers.
- * Each View has a single DockableWindowManager, for managing the
- * specific dockable instances associated with that View.
+/** Manages dockable windows for a single View.
+ *
+ * Concrete implementation of a Dockable Window Manager.
+ * Aka the "classic" docking framework.
+ *
* @since jEdit 4.3pre16
+ * @author Slava Pestov
+ * @author Shlomy Reinstein
+ * @version $Id$
*/
public class DockableWindowManagerImpl extends DockableWindowManager
{
-
+
//{{{ DockableWindowConfig class
public static class DockableWindowConfig extends DockingLayout
{
@@ -109,7 +113,7 @@
rightPos = Integer.parseInt(value);
}
} // }}}
-
+
// dockables
public String top, left, bottom, right;
public int topPos, leftPos, bottomPos, rightPos;
@@ -178,7 +182,7 @@
}
return true;
}
-
+
@Override
public String getName()
{
@@ -199,7 +203,7 @@
public Stack<String> showStack = new Stack<String>();
// }}}
- // {{{ setDockingLayout()
+ // {{{ setDockingLayout()
public void setDockingLayout(DockingLayout docking)
{
DockableWindowConfig config = (DockableWindowConfig) docking;
@@ -216,15 +220,15 @@
if(config.right != null && config.right.length() != 0)
showDockableWindow(config.right);
-
+
} // }}}
-
+
// {{{ getDockingLayout()
@Override
public DockingLayout getDockingLayout(ViewConfig config)
{
DockableWindowConfig docking = new DockableWindowConfig();
-
+
docking.top = getTopDockingArea().getCurrent();
docking.left = getLeftDockingArea().getCurrent();
docking.bottom = getBottomDockingArea().getCurrent();
@@ -275,12 +279,12 @@
} //}}}
//{{{ setMainPanel() method
- public void setMainPanel(JPanel panel)
+ public void setMainPanel(JPanel panel)
{
add(panel, 0);
} //}}}
-
+
//{{{ init() method
/**
* Initialises dockable window manager. Do not call this method directly.
@@ -312,19 +316,19 @@
Log.log(Log.ERROR,this,"Unknown dockable window: " + name);
return null;
}
-
+
// create a copy of this dockable window and float it
Entry newEntry = new Entry(entry.factory,FLOATING);
newEntry.win = newEntry.factory.createDockableWindow(view,FLOATING);
-
+
if(newEntry.win != null)
{
- FloatingWindowContainer fwc = new FloatingWindowContainer(this,true);
+ FloatingWindowContainer fwc = new FloatingWindowContainer(this,true);
newEntry.container = fwc;
newEntry.container.register(newEntry);
newEntry.container.show(newEntry);
-
-
+
+
}
clones.add(newEntry);
return newEntry.win;
@@ -357,7 +361,7 @@
&& lastEntry.container == null)
{
FloatingWindowContainer fwc = new FloatingWindowContainer(
- this,view.isPlainView());
+ this,view.isPlainView());
lastEntry.container = fwc;
lastEntry.container.register(lastEntry);
}
@@ -444,7 +448,7 @@
//{{{ closeCurrentArea() method
/**
- * Closes the most recently focused dockable.
+ * Closes the most recently focused dockable.
* @since jEdit 4.1pre3
*/
public void closeCurrentArea()
@@ -464,7 +468,7 @@
return;
}
catch (Exception e) {}
-
+
Component comp = view.getFocusOwner();
while(comp != null)
{
@@ -472,9 +476,9 @@
if(comp instanceof DockablePanel)
{
DockablePanel panel = (DockablePanel) comp;
-
+
PanelWindowContainer container = panel.getWindowContainer();
-
+
container.show((DockableWindowManagerImpl.Entry) null);
return;
}
@@ -862,10 +866,10 @@
entry.win = null;
}
- if(newPosition.equals(FLOATING))
+ if(newPosition.equals(FLOATING))
{
}
-
+
else
{
if(newPosition.equals(TOP))
@@ -991,24 +995,24 @@
+ ".dock-position",FLOATING));
} //}}}
-
+
/**
* @return the long title for the dockable floating window.
*/
- public String longTitle()
+ public String longTitle()
{
String title = jEdit.getProperty(factory.name + ".longtitle");
if (title == null) return shortTitle();
else return title;
-
+
}
-
+
/**
* @return The short title, for the dockable button text
*/
- public String shortTitle()
+ public String shortTitle()
{
-
+
String title = jEdit.getProperty(factory.name + ".title");
if(title == null)
return "NO TITLE PROPERTY: " + factory.name;
@@ -1023,7 +1027,7 @@
{
String retval = jEdit.getProperty(factory.name + ".label");
retval = retval.replaceAll("\\$", "");
- return retval;
+ return retval;
}
//{{{ Entry constructor
@@ -1035,7 +1039,7 @@
// get the title here, not in the factory constructor,
// since the factory might be created before a plugin's
// props are loaded
-
+
} //}}}
} //}}}
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManagerProvider.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManagerProvider.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DockableWindowManagerProvider.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -5,12 +5,11 @@
import org.gjt.sp.jedit.gui.DockableWindowManager.DockingLayout;
-/**
- jEdit's classic dockable window manager, turned into a "provider" service.
-
- @author Shlomy Reinstein
- @since jEdit 4.3pre16
-*/
+/** jEdit's classic dockable window manager, turned into a "provider" service.
+ *
+ * @author Shlomy Reinstein
+ * @since jEdit 4.3pre16
+ */
public class DockableWindowManagerProvider implements DockingFrameworkProvider
{
public DockableWindowManager create(View view,
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DockingFrameworkProvider.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DockingFrameworkProvider.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DockingFrameworkProvider.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -5,15 +5,16 @@
import org.gjt.sp.jedit.gui.DockableWindowManager.DockingLayout;
-/** Base interface for Docking Framework Provider services.
- Plugins can offer alternate docking frameworks by offering a service
- that creates an instance of one of these.
- For an example, see jEdit's own services.xml, which provides jEdit's classic
- docking framework via the class DockableWindowManagerProvider.
-
- @since jEdit 4.3pre16
- @author Shlomy Reinstein
-*/
+/** Base interface for the Docking Framework Provider service.
+ *
+ * Plugins such as MyDoggy can offer an alternate docking framework
+ * by offering a service that creates an instance of one of these.
+ * For an example, see jEdit's own services.xml, which provides jEdit's classic
+ * docking framework via the class DockableWindowManagerProvider.
+ *
+ * @since jEdit 4.3pre16
+ * @author Shlomy Reinstein
+ */
public interface DockingFrameworkProvider {
DockableWindowManager create(View view, DockableWindowFactory instance,
ViewConfig config);
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/DynamicContextMenuService.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/DynamicContextMenuService.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/DynamicContextMenuService.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -6,27 +6,26 @@
import org.gjt.sp.jedit.textarea.JEditTextArea;
-/**
- * A service that can be offered by plugins when a text area context menu item
- * needs to be offered that is sensitive to the state of the TextArea it was requested from.
+/** <p> A service that can be offered by plugins when a text area context menu item
+ * needs to be offered that is sensitive to the state of the TextArea it was requested * from. </p>
* Note: this service should only be used by certain plugins that need context information at the time
* that the context menu is requested. For all other actions, it is already possible for users to
* add menu items to the context menu, so please do not use this service from Plugins
* to add non-dynamic actions to the context menu.
- *
+ *
* @author ezust
* @since jEdit 4.3pre15
*/
abstract public class DynamicContextMenuService {
/**
- *
+ *
* @param ta the TextArea where the context menu was requested.
* Use this to determine the location of the caret, or the edit mode of the buffer, etc.
* @param evt a mouseEvent that triggered this menu request, or null
* @return an array of menu items
* or null if there are no appropriate actions to be added at this time
*/
- public abstract JMenuItem[] createMenu(JEditTextArea ta, MouseEvent evt);
+ public abstract JMenuItem[] createMenu(JEditTextArea ta, MouseEvent evt);
}
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/EnhancedButton.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/EnhancedButton.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/EnhancedButton.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -28,7 +28,7 @@
import java.awt.*;
import org.gjt.sp.jedit.*;
//}}}
-
+/** A toolbar button */
public class EnhancedButton extends RolloverButton
{
//{{{ EnhancedButton constructor
@@ -54,7 +54,7 @@
{
setName(action.substring(iSuffix+1));
}
-
+
setEnabled(true);
addActionListener(new EditAction.Wrapper(context,action));
addMouseListener(new MouseHandler());
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/EnhancedDialog.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/EnhancedDialog.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/EnhancedDialog.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -23,7 +23,8 @@
import java.awt.event.*;
import java.awt.*;
-/**
+/** Dialog that handles OK/Cancel for you
+ *
* A dialog box that handles window closing, the ENTER key and the ESCAPE
* key for you. All you have to do is implement ok() (called when
* Enter is pressed) and cancel() (called when Escape is pressed, or window
@@ -142,12 +143,12 @@
if(selected != null)
combo.setSelectedItem(selected);
}
-
+
if(combo.isPopupVisible())
{
evt.consume();
combo.setPopupVisible(false);
- }
+ }
return;
}
// TODO: add other classes that need custom key handling here.
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/ErrorListDialog.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/ErrorListDialog.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/ErrorListDialog.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -37,7 +37,8 @@
import org.gjt.sp.jedit.pluginmgr.PluginManager;
import org.gjt.sp.util.Log;
//}}}
-
+/** Used to list I/O and plugin load errors
+ */
public class ErrorListDialog extends EnhancedDialog
{
//{{{ ErrorEntry class
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayout.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayout.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/ExtendedGridLayout.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -35,11 +35,10 @@
import static org.gjt.sp.jedit.gui.ExtendedGridLayoutConstraints.REMAINDER;
-/**
- * A layout manager that places components in a rectangular grid
- * with variable cell sizes that supports colspans and rowspans.
- * <p>
- * The container is divided into rectangles, and each component is placed
+/** <p>A layout manager that places components in a rectangular grid
+ * with variable cell sizes that supports colspans and rowspans. </p>
+ *
+ * <p> The container is divided into rectangles, and each component is placed
* in a rectangular space defined by its colspan and rowspan.
* Each row is as large as the largest component in
* that row, and each column is as wide as the widest component in
Modified: jEdit/trunk/org/gjt/sp/jedit/gui/HistoryTextField.java
===================================================================
--- jEdit/trunk/org/gjt/sp/jedit/gui/HistoryTextField.java 2012-03-29 16:38:03 UTC (rev 21501)
+++ jEdit/trunk/org/gjt/sp/jedit/gui/HistoryTextField.java 2012-03-29 17:19:44 UTC (rev 21502)
@@ -33,8 +33,8 @@
import org.gjt.sp.jedit.*;
//}}}
-/**
- * Text field with an arrow-key accessable history.
+/** Text field with an arrow-key + drop-down accessable history.
+ *
* @author Slava Pestov
* @version $Id$
*/
@@ -196,7 +196,7 @@
{
setBorder(new CompoundBorder(this.getBorder(), new HistoryBorder()));
}
-
+
repaint();
} //}}}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
