JDeveloper Extension Development - How to

Question

Based on the Clean White Space extension (by Daniel Work
CleanWhiteSpace.zip), I modified it to work with JDeveloper 5.0.5.2 (build 1618) and added new functionality to remove every other blank line.
(FYI: I work on Windows and my CVS server on Linux; when I export/import from CVS, the source code ends up with double line feeds. JDev bug?). In any case, I wrote this utility that cleans this up quickly.
My question is how to I activate the blicking caret (cursor) in the code editor window after the extension has finished processing the text? (i.e. How could I simulate a mouse click in the editor window where the cursor used to be?)
Thanks. [email protected]
Partial code below:
public class CleanWhiteLinesAddin implements Addin, Controller
private boolean doCleanWhiteLines(Context context)
boolean bUpdated = false;
EditDescriptor editUndoInfo = new EditDescriptor(TITLE);
BasicEditorPane editor = getCurrentEditorPane(context);
String initialText = null;
if (editor != null)
editor.beginEdit(editUndoInfo);
try
int origLinePos = editor.getLineFromOffset(editor.getCaretPosition());
int newLinePos = origLinePos;
editor.selectAll();
String allText = editor.getSelectedText().trim();
StringBuffer out = new StringBuffer( allText.length() );
// testing
//allText = allText.replaceAll("\n", "[[nl]]");
//allText = allText.replaceAll("\r", "[[cr]]");
// Write info in the log window
//LogManager.getLogManager().showLog();
//LogManager.getLogManager().getMsgPage().log("Source code is:\n" + allText + "\n");
//LogManager.getLogManager().getMsgPage().log("Line offset=" + origLinePos + "\n");
allText = allText.replaceAll("\r", "\n"); //if any...
String aLine = null;
int lineCount = 0;
int blankLineCount = 0;
int beginIndex = 0;
int endIndex = allText.indexOf('\n', beginIndex); //allText.charAt('\n');
while ( (beginIndex>=0) && (beginIndex<allText.length())
&& (endIndex>=0) && (endIndex<=allText.length()) )
aLine = allText.substring(beginIndex, endIndex).trim();
if ( (0 == aLine.length()) )//&& (!justPrintedBlankLine)
if (blankLineCount < 1)
++blankLineCount;
if ( (lineCount<newLinePos) && (newLinePos>0) )
--newLinePos;
else
out.append("\n");
blankLineCount = 0;
else
out.append(aLine);
out.append("\n");
blankLineCount = 0;
// forward
beginIndex = endIndex + 1;
endIndex = allText.indexOf('\n', beginIndex);
++lineCount;
// At loop exist, make sure that we have the last line in the case where
// there is not line feed
if (beginIndex < allText.length())
out.append( allText.substring(beginIndex) );
if (!out.equals(allText))
editor.replaceSelection( out.toString() );
bUpdated = true;
editor.moveCaretPosition( editor.getLineEndOffset(newLinePos) - 1);
editor.unselect();
// How to we activate the cursor to the line where we where
// in the column where we were?
catch (Exception ex)
ex.printStackTrace();
finally
editor.endEdit();
return bUpdated;

Answer 1

Hi,
I'm not sure what's causing your double-line issue with CVS. I routinely use CVS on Linux with a Windows client, and haven't experienced this issue. Do you get the same problem when using cvs from the command line?
The following addin cleans white lines and preserves the caret position. I converted the code to directly modify the document and use a Position to track the original caret location. This means that even if the line your cursor was on has changed because of removed lines, the cursor position will be restored to the right place:
package mypackage1;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.Position;
import oracle.ide.ContextMenu;
import oracle.ide.Ide;
import oracle.ide.IdeAction;
import oracle.ide.addin.Addin;
import oracle.ide.addin.Context;
import oracle.ide.addin.ContextMenuListener;
import oracle.ide.addin.Controller;
import oracle.ide.editor.EditorManager;
import oracle.javatools.editor.BasicDocument;
import oracle.javatools.editor.BasicEditorPane;
import oracle.javatools.editor.EditDescriptor;
import oracle.jdeveloper.ceditor.CodeEditor;
public class CleanWhiteLinesAddin implements Addin, Controller
  private static final String CLEAN_CMD = "oracle.sample.bduff.CleanCommand";
  private BasicEditorPane getCurrentEditorPane( Context context )
    if ( context.getView() instanceof CodeEditor )
      return ((CodeEditor)context.getView()).getFocusedEditorPane();
    return null;
  private int replaceAll( Document doc, char search, char replace )
    throws BadLocationException
    int count = 0;
    for ( int i=0; i < doc.getLength(); i++ )
      if ( doc.getText( i, 1 ).charAt( 0 ) == search )
        doc.remove( i, 1 );
        doc.insertString( i, String.valueOf( replace ), null );
        count++;
    return count;
  private int indexOf( Document doc, char search, int start )
    throws BadLocationException
    for ( int i=start; i < doc.getLength(); i++ )
      if ( doc.getText( i, 1 ).charAt( 0 ) == search )
        return i;
    return -1;
  private boolean doCleanWhiteLines(Context context)
    boolean bUpdated = false;
    EditDescriptor editUndoInfo = new EditDescriptor( "Clean White Lines" );
    BasicEditorPane editor = getCurrentEditorPane(context);
    if (editor != null)
      editor.beginEdit(editUndoInfo);
      Document doc = editor.getDocument();
      try
        // Create a position for the current caret that we can restore later.
        Position p = doc.createPosition( editor.getCaretPosition() );
        bUpdated = replaceAll( doc, '\r', '\n' ) > 0;
        int pos = 0;
        int length = doc.getLength();
        int consecutiveNewLines = 0;
        while ( pos < length )
          char c = ((BasicDocument)doc).getTextBuffer().getChar( pos );
          if ( c == '\n' )
            ++consecutiveNewLines;
          else
            consecutiveNewLines = 0;
          if ( consecutiveNewLines > 1 )
            // Swallow the newline at the current position.
            doc.remove( pos, 1 );
            length--;
            bUpdated = true;
          pos++;
        // Now restore the caret to the original position.
        editor.setCaretPosition( p.getOffset() );
      catch ( BadLocationException ble )
        ble.printStackTrace();
      finally
        editor.endEdit();
    return bUpdated;
  public void initialize()
    final IdeAction doItAction = IdeAction.get(
      Ide.createCmdID( CLEAN_CMD ),
      "Clean White Lines",
      new Integer( 'C' )
    doItAction.addController( this );
    EditorManager.getEditorManager().getContextMenu().addContextMenuListener(
      new ContextMenuListener()
        public boolean handleDefaultAction( Context context )
          return false;
        public void poppingDown( ContextMenu m ) {}
        public void poppingUp( ContextMenu m )
          m.add( m.createMenuItem( doItAction ) );
  public void shutdown()
  public float version()
    return 0;
  public float ideVersion()
    return 0;
  public boolean canShutdown()
    return true;
  public boolean handleEvent(IdeAction action, Context context)
    int myCmdId = Ide.findCmdID( CLEAN_CMD ).intValue();
    if ( action.getCommandId() == myCmdId )
      doCleanWhiteLines( context );
      return true;
    return false;
  public boolean update(IdeAction p0, Context p1)
    return false;
}