Comments on: EditorMacro v2 – setting Command Window key-bindings

By: Yair Altman

Yair Altman — Fri, 13 Jan 2012 12:59:22 +0000

This is indeed a very good example of the risks in using internal Matlab components – their API can change dramatically from one release to another, without prior notice.

Here is the alternative in the latest Matlab release (12a):

% Get the reference to the editor application
jEditorApp = com.mathworks.mde.editor.MatlabEditorApplication.getInstance;
jEditorApp = com.mathworks.mlservices.MLEditorServices.getEditorApplication;  % an alternative
 
% Save the current file
jEditorApp.getActiveEditor.save();
jEditorApp.getActiveEditor.saveAs(filename);

Other useful methods of the jEditorApp.getActiveEditor reference are:

addEventListener(com.mathworks.matlab.api.editor.EditorEventListener)
addPropertyChangeListener(java.beans.PropertyChangeListener)
addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
appendText(java.lang.String)
bringToFront()
close()
closeNoPrompt()
dispose()
fireEditorEvent(com.mathworks.matlab.api.editor.EditorEvent)
firePropertyChange(java.lang.String, java.lang.Object, java.lang.Object)
getBreakpointMargin() : com.mathworks.matlab.api.debug.BreakpointMargin
getCaretPosition() : int
getComponent() : java.awt.Component
getDocument() : javax.swing.text.Document
getExecutionArrowMargin() : com.mathworks.matlab.api.debug.ExecutionArrowMargin
getLanguage() : com.mathworks.matlab.api.editor.EditorLanguage
getLength() : int
getLineNumber() : int
getLongName() : java.lang.String
getProperty(java.lang.Object) : java.lang.Object
getSelection() : java.lang.String
getShortName() : java.lang.String
getStorageLocation() : com.mathworks.matlab.api.datamodel.StorageLocation
getText() : java.lang.String
getTextComponent() : javax.swing.text.JTextComponent
getTextWithSystemLineEndings() : java.lang.String
goToFunction(java.lang.String, java.lang.String)
goToLine(int, boolean)
goToLine(int, int)
goToPositionAndHighlight(int, int)
insertAndFormatTextAtCaret(java.lang.String)
insertTextAtCaret(java.lang.String)
isBuffer() : boolean
isDirty() : boolean
isEditable() : boolean
isMCode() : boolean
isOpen() : boolean
lineAndColumnToPosition(int, int) : int
lockIfOpen() : boolean
negotiateSave() : boolean
positionToLineAndColumn(int) : int[]
putProperty(java.lang.String, java.lang.Object)
refreshMenus()
reload()
reloadAndReturnError() : java.lang.String
removeEventListener(com.mathworks.matlab.api.editor.EditorEventListener)
removePropertyChangeListener(java.beans.PropertyChangeListener)
removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
replaceText(java.lang.String, int, int)
save()
saveAndReturnError() : java.lang.String
saveAs(java.lang.String)
saveAsAndReturnError(java.lang.String) : java.lang.String
setCaretPosition(int)
setClean()
setDirtyUntilSave()
setEditable(boolean)
setEditorStatusBarText(java.lang.String)
setSelection(int, int)
setStatusText(java.lang.String)
smartIndentContents()
unlock()

By: mb

mb — Fri, 13 Jan 2012 12:38:05 +0000

Hi,
In Matlab 2011 com.mathworks.mlservices.MLEditorServices has no such method as saveDocument.
Instead of it one can use matlab editor api to save the document:

filehandle = matlab.desktop.editor.getActive 
filehandle.save() ;

More about it can be found here http://blogs.mathworks.com/desktop/2011/05/09/r2011a-matlab-editor-api/ .
I hope it will save someone’s time.

Regards,
mb

By: Yair Altman

Yair Altman — Sat, 22 Aug 2009 19:47:28 +0000

@Jo – Here’s a snippet of a sample macro (callback) function:

function myCallback(jDocument, jEventData, varargin)
   filename = jDocument.getFilename;
   % do some user-defined stuff
 
   % Now save the file:
   com.mathworks.mlservices.MLEditorServices.saveDocument(filename);
end  % myCallback

Also look at Perttu’s KeyBindings utility for other usage examples of MLEditorServices.

Yair

By: jo

jo — Fri, 21 Aug 2009 20:43:48 +0000

Thanks!
EditorMacro has been added to the startup.m file!
So far I’ve created few macros that remarkably speed up my work.
One of them is a macro that executes code between tags embedded in a comment of an m-file – excellent alternative for Edit Run Configuration… + F5 combination during debugging an m-file, but… I cannot solve one problem: automatic saving file before run (eg. to activate fresh breakpoints).
Your post about internal commands gave me new hope. I’ve made some trials to save m-file programmatically but without effect.

Do you know if such an action is possible from inside the macro?