HOME > Community > Projects >    
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

org.netbeans.modules.externaleditor
Interface ExtEdProtocol

All Known Implementing Classes:
ExtEdCaret, ExtEdConnection, ExtEdDocument, ExtEdKit, ExtEdProxier
public interface ExtEdProtocol

Protocol for communication between external editor and NetBeans. All messages are in ASCII, with the following syntax: 


 CMD:    proxyID : verb ! seqno [ arg ... ]
 FUN:    proxyID : verb / seqno [ arg ... ]
 EVT:    proxyID : verb = seqno [ arg ... ]
 REPLY:  seqno [ arg ... | err ]

 CMDs are sent by NetBeans; no reply is necessary.
 FUNs are sent by NetBeans and expect a matching REPLY.
 EVTs are sent by the external editor; no reply is necessary.

 proxyID is a decimal integer, starting at 1 (0 is reserved for
      "global" EVTs); it identifies the particular buffer.

 verbs are listed below

 seqno is a positive decimal integer that monotonically increases
      with each CMD or FUN; REPLY uses the seqno of the corresponding
      FUN.

 arg may be any of
      "string"      (literal quotes; newlines, carriage returns, double
                     quotes, and backslashes encoded as \n \r \" \\, resp.)
      T             ("true")
      F             ("false")
      [+-]digits    (decimal integer)

 err is 
      ! "string"    (FUN failed; throws an exception containing the string)

 Comments below indicate the types of args and results thusly:

      TXT           quoted, escaped string
      BOOL          literal T or F
      NUM           decimal integer with optional sign
      OPTNUM	      either a NUM or the word "none" (no quotes)

 Argument/results named "pos", "off", "dot", or "mark" indicate a
 zero-based character position in the document.

 "pathname" indicates a full pathname, if it's a "real" file, or the full
 pathname of the JAR file plus "," and the name of the file in the jar.

Field Summary
static java.lang.String CMD_actionMenuItem
          actionMenuItem (name, action, enabled, accel) { TXT, TXT, BOOL, TXT }
static java.lang.String CMD_actionSensitivity
          actionSensitivity (action, enabled) { TXT, BOOL }
static java.lang.String CMD_addAnno
          addAnno (serial, typeNum, off, len) { NUM, NUM, NUM, NUM }
static java.lang.String CMD_balloonResult
          balloonResult (text) { TXT }
static java.lang.String CMD_close
          close ()
static java.lang.String CMD_create
          create ()
static java.lang.String CMD_defineAnnoType
          defineAnnoType (typeNum, typeName, tooltip, glyphFile, fg, bg) { NUM, TXT, TXT, TXT, OPTNUM, OPTNUM }
static java.lang.String CMD_destroyPosition
           
static java.lang.String CMD_enableBalloonEval
          enableBalloonEval ()
static java.lang.String CMD_endAtomic
          endAtomic ()
static java.lang.String CMD_guard
           
static java.lang.String CMD_ignore
           
static java.lang.String CMD_initDone
          initDone ()
static java.lang.String CMD_moveAnnoToFront
          moveAnnoToFront (serial) { NUM }
static java.lang.String CMD_removeAnno
          removeAnno (serial) { NUM }
static java.lang.String CMD_setAsUser
          setAsUser (asuser) { BOOL }
static java.lang.String CMD_setBufferNumber
          setBufferNumber (pathname) { TXT }
static java.lang.String CMD_setContentType
          setContentType (type) { TXT }
static java.lang.String CMD_setDot
          setDot (off) { NUM }
static java.lang.String CMD_setFullName
          setFullName (name) { TXT }
static java.lang.String CMD_setLocAndSize
          setLocAndSize (x, y, w, h) { NUM, NUM, NUM, NUM }
static java.lang.String CMD_setMark
          setMark (off) { NUM }
static java.lang.String CMD_setModified
          setModified (isMod) { BOOL }
static java.lang.String CMD_setReadOnly
          setReadOnly (isReadOnly) { BOOL }
static java.lang.String CMD_setTitle
          setTitle (title) { TXT }
static java.lang.String CMD_setVisible
          setVisible (isVis) { BOOL }
static java.lang.String CMD_specialKeys
          specialKeys ( keys ) { TXT }
static java.lang.String CMD_startAtomic
          startAtomic ()
static java.lang.String CMD_startCaretListen
          startCaretListen ()
static java.lang.String CMD_startDocumentListen
          startDocumentListen ()
static java.lang.String CMD_stopCaretListen
          stopCaretListen ()
static java.lang.String CMD_stopDocumentListen
           
static java.lang.String CMD_unguard
           
static java.lang.String EVT_balloonEval
          balloonEval (pos, length, eval-type) { NUM, NUM, NUM } values for "eval-type" are currently unspecified and ignored
static java.lang.String EVT_fileClosed
          fileClosed (pathname) { TXT }
static java.lang.String EVT_fileModified
          fileModified (pathname, flag) { TXT, BOOL }
static java.lang.String EVT_fileOpened
          fileOpened (pathname, openInIDE, isModified) { TXT, BOOL, BOOL }
static java.lang.String EVT_geometry
          geometry (cols, rows, x, y) { NUM, NUM, NUM, NUM }
static java.lang.String EVT_insert
          insert (off, text) { NUM, TXT }
static java.lang.String EVT_invokeAction
          invokeAction (actionName) { TXT }
static java.lang.String EVT_keyCommand
          keyCommand (name) { TXT } see Utilities.stringToKey, e.g.
static java.lang.String EVT_killed
          killed ()
static java.lang.String EVT_newDotAndMark
          newDotAndMark (dot, mark) { NUM, NUM }
static java.lang.String EVT_quit
          quit () tell NetBeans to exit gracefully
static java.lang.String EVT_remove
          remove (off, len) { NUM, NUM } ( len = -1 means all text )
static java.lang.String EVT_revert
          revert ()
static java.lang.String EVT_save
          save ()
static java.lang.String EVT_unmodified
          unmodified() buffer became unmodified via UNDOs
static java.lang.String EVT_version
          version
static java.lang.String FUN_countLines
           
static java.lang.String FUN_createPosition
           
static java.lang.String FUN_findLineFromOffset
           
static java.lang.String FUN_getDot
          getDot () -> (off) { NUM }
static java.lang.String FUN_getLength
          getLength () -> (length) { NUM }
static java.lang.String FUN_getLineStartOffset
           
static java.lang.String FUN_getMark
          getMark () -> (off) { NUM }
static java.lang.String FUN_getText
          getText (off, length) -> (text) or (reason, off) { TXT, NUM }
static java.lang.String FUN_insert
          insert (off, text) -> () or (reason, off) { TXT, NUM }
static java.lang.String FUN_lookupPosition
           
static java.lang.String FUN_remove
          remove (off, length) -> () or (reason, off) { TXT, NUM }
static java.lang.String META_ACCEPT
           
static java.lang.String META_AUTH
           
static java.lang.String META_DISCONNECT
           
static java.lang.String META_REJECT
           
static java.lang.String PROP_locAndSize
           
static java.lang.String[] SERIAL_COMMANDS
           
static java.lang.String[] SERIAL_EVENTS
           
static java.lang.String[] SERIAL_FUNCTIONS
           
static java.lang.String STYLE_BREAKPOINT
           
static java.lang.String STYLE_CURRENT
           
static java.lang.String STYLE_ERROR
           
static java.lang.String STYLE_NORMAL
           
static int VERSION
          ExtEd protocol version
 

Field Detail

VERSION

public static final int VERSION
ExtEd protocol version

CMD_specialKeys

public static final java.lang.String CMD_specialKeys
specialKeys ( keys ) { TXT }

CMD_create

public static final java.lang.String CMD_create
create ()

CMD_setBufferNumber

public static final java.lang.String CMD_setBufferNumber
setBufferNumber (pathname) { TXT }

CMD_close

public static final java.lang.String CMD_close
close ()

CMD_startDocumentListen

public static final java.lang.String CMD_startDocumentListen
startDocumentListen ()

CMD_stopDocumentListen

public static final java.lang.String CMD_stopDocumentListen

CMD_ignore

public static final java.lang.String CMD_ignore

CMD_setTitle

public static final java.lang.String CMD_setTitle
setTitle (title) { TXT }

CMD_setFullName

public static final java.lang.String CMD_setFullName
setFullName (name) { TXT }

CMD_destroyPosition

public static final java.lang.String CMD_destroyPosition

CMD_setContentType

public static final java.lang.String CMD_setContentType
setContentType (type) { TXT }

CMD_setDot

public static final java.lang.String CMD_setDot
setDot (off) { NUM }

CMD_setMark

public static final java.lang.String CMD_setMark
setMark (off) { NUM }

CMD_setVisible

public static final java.lang.String CMD_setVisible
setVisible (isVis) { BOOL }

CMD_setLocAndSize

public static final java.lang.String CMD_setLocAndSize
setLocAndSize (x, y, w, h) { NUM, NUM, NUM, NUM }

CMD_startCaretListen

public static final java.lang.String CMD_startCaretListen
startCaretListen ()

CMD_stopCaretListen

public static final java.lang.String CMD_stopCaretListen
stopCaretListen ()

CMD_guard

public static final java.lang.String CMD_guard

CMD_unguard

public static final java.lang.String CMD_unguard

CMD_setReadOnly

public static final java.lang.String CMD_setReadOnly
setReadOnly (isReadOnly) { BOOL }

CMD_setModified

public static final java.lang.String CMD_setModified
setModified (isMod) { BOOL }

CMD_startAtomic

public static final java.lang.String CMD_startAtomic
startAtomic ()

CMD_endAtomic

public static final java.lang.String CMD_endAtomic
endAtomic ()

CMD_setAsUser

public static final java.lang.String CMD_setAsUser
setAsUser (asuser) { BOOL }

CMD_balloonResult

public static final java.lang.String CMD_balloonResult
balloonResult (text) { TXT }

CMD_enableBalloonEval

public static final java.lang.String CMD_enableBalloonEval
enableBalloonEval ()

STYLE_NORMAL

public static final java.lang.String STYLE_NORMAL

STYLE_BREAKPOINT

public static final java.lang.String STYLE_BREAKPOINT

STYLE_CURRENT

public static final java.lang.String STYLE_CURRENT

STYLE_ERROR

public static final java.lang.String STYLE_ERROR

CMD_defineAnnoType

public static final java.lang.String CMD_defineAnnoType
defineAnnoType (typeNum, typeName, tooltip, glyphFile, fg, bg) { NUM, TXT, TXT, TXT, OPTNUM, OPTNUM }

CMD_addAnno

public static final java.lang.String CMD_addAnno
addAnno (serial, typeNum, off, len) { NUM, NUM, NUM, NUM }

CMD_removeAnno

public static final java.lang.String CMD_removeAnno
removeAnno (serial) { NUM }

CMD_moveAnnoToFront

public static final java.lang.String CMD_moveAnnoToFront
moveAnnoToFront (serial) { NUM }

CMD_initDone

public static final java.lang.String CMD_initDone
initDone ()

CMD_actionMenuItem

public static final java.lang.String CMD_actionMenuItem
actionMenuItem (name, action, enabled, accel) { TXT, TXT, BOOL, TXT }

CMD_actionSensitivity

public static final java.lang.String CMD_actionSensitivity
actionSensitivity (action, enabled) { TXT, BOOL }

FUN_getLength

public static final java.lang.String FUN_getLength
getLength () -> (length) { NUM }

FUN_remove

public static final java.lang.String FUN_remove
remove (off, length) -> () or (reason, off) { TXT, NUM }

FUN_insert

public static final java.lang.String FUN_insert
insert (off, text) -> () or (reason, off) { TXT, NUM }

FUN_getText

public static final java.lang.String FUN_getText
getText (off, length) -> (text) or (reason, off) { TXT, NUM }

FUN_createPosition

public static final java.lang.String FUN_createPosition

FUN_lookupPosition

public static final java.lang.String FUN_lookupPosition

FUN_countLines

public static final java.lang.String FUN_countLines

FUN_findLineFromOffset

public static final java.lang.String FUN_findLineFromOffset

FUN_getLineStartOffset

public static final java.lang.String FUN_getLineStartOffset

FUN_getDot

public static final java.lang.String FUN_getDot
getDot () -> (off) { NUM }

FUN_getMark

public static final java.lang.String FUN_getMark
getMark () -> (off) { NUM }

EVT_insert

public static final java.lang.String EVT_insert
insert (off, text) { NUM, TXT }

EVT_remove

public static final java.lang.String EVT_remove
remove (off, len) { NUM, NUM } ( len = -1 means all text )

EVT_save

public static final java.lang.String EVT_save
save ()

EVT_newDotAndMark

public static final java.lang.String EVT_newDotAndMark
newDotAndMark (dot, mark) { NUM, NUM }

EVT_keyCommand

public static final java.lang.String EVT_keyCommand
keyCommand (name) { TXT } see Utilities.stringToKey, e.g. "CS-F9" for control-shift-function9

EVT_balloonEval

public static final java.lang.String EVT_balloonEval
balloonEval (pos, length, eval-type) { NUM, NUM, NUM } values for "eval-type" are currently unspecified and ignored

EVT_unmodified

public static final java.lang.String EVT_unmodified
unmodified() buffer became unmodified via UNDOs

EVT_killed

public static final java.lang.String EVT_killed
killed ()

EVT_revert

public static final java.lang.String EVT_revert
revert ()

EVT_fileOpened

public static final java.lang.String EVT_fileOpened
fileOpened (pathname, openInIDE, isModified) { TXT, BOOL, BOOL }

EVT_fileClosed

public static final java.lang.String EVT_fileClosed
fileClosed (pathname) { TXT }

EVT_fileModified

public static final java.lang.String EVT_fileModified
fileModified (pathname, flag) { TXT, BOOL }

EVT_invokeAction

public static final java.lang.String EVT_invokeAction
invokeAction (actionName) { TXT }

EVT_geometry

public static final java.lang.String EVT_geometry
geometry (cols, rows, x, y) { NUM, NUM, NUM, NUM }

EVT_quit

public static final java.lang.String EVT_quit
quit () tell NetBeans to exit gracefully

EVT_version

public static final java.lang.String EVT_version
version

META_AUTH

public static final java.lang.String META_AUTH

META_ACCEPT

public static final java.lang.String META_ACCEPT

META_REJECT

public static final java.lang.String META_REJECT

META_DISCONNECT

public static final java.lang.String META_DISCONNECT

PROP_locAndSize

public static final java.lang.String PROP_locAndSize

SERIAL_FUNCTIONS

public static final java.lang.String[] SERIAL_FUNCTIONS

SERIAL_COMMANDS

public static final java.lang.String[] SERIAL_COMMANDS

SERIAL_EVENTS

public static final java.lang.String[] SERIAL_EVENTS
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Built on March 19 2003.  |  Portions Copyright 1997-2003 Sun Microsystems, Inc. All rights reserved.