sidekick
Class SideKickPlugin

java.lang.Object
  extended by org.gjt.sp.jedit.EditPlugin
      extended by org.gjt.sp.jedit.EBPlugin
          extended by sidekick.SideKickPlugin
All Implemented Interfaces:
org.gjt.sp.jedit.EBComponent

public class SideKickPlugin
extends org.gjt.sp.jedit.EBPlugin

SideKick plugin core which tracks registered parsers.

Version:
$Id: SideKickPlugin.java 8789 2007-01-29 20:00:15Z kpouer $

Nested Class Summary
 
Nested classes/interfaces inherited from class org.gjt.sp.jedit.EditPlugin
org.gjt.sp.jedit.EditPlugin.Broken, org.gjt.sp.jedit.EditPlugin.Deferred
 
Field Summary
static java.lang.String DEFAULT
           
static java.lang.String NAME
          The name of the dockable
static java.lang.String NONE
           
static java.lang.String PARSE_COUNT
           
static java.lang.String PARSED_DATA_PROPERTY
           
static java.lang.String PARSER_PROPERTY
           
 
Constructor Summary
SideKickPlugin()
           
 
Method Summary
static void addWorkRequest(java.lang.Runnable run, boolean inAWT)
           
static SideKickParser getParser(java.lang.String name)
           
static SideKickParser getParserForBuffer(org.gjt.sp.jedit.Buffer buffer)
           
static SideKickParser getParserForMode(org.gjt.sp.jedit.Mode m)
          Returns the parser for the given mode.
static SideKickParser getParserForView(org.gjt.sp.jedit.View view)
           
 void handleMessage(org.gjt.sp.jedit.EBMessage msg)
           
static boolean isParsingBuffer(org.gjt.sp.jedit.Buffer buffer)
           
static void parse(org.gjt.sp.jedit.View view, boolean showParsingMessage)
          Immediately begins parsing the current buffer in a background thread.
static void setParserForBuffer(org.gjt.sp.jedit.Buffer buffer, java.lang.String parserName)
           
 void start()
           
 void stop()
           
 
Methods inherited from class org.gjt.sp.jedit.EditPlugin
createBrowserMenuItems, createMenuItems, createMenuItems, createOptionPanes, getClassName, getPluginHome, getPluginHome, getPluginHome, getPluginJAR, getResourceAsOutputStream, getResourceAsOutputStream, getResourceAsStream, getResourceAsStream, getResourcePath, getResourcePath
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final java.lang.String NAME
The name of the dockable

See Also:
Constant Field Values

PARSER_PROPERTY

public static final java.lang.String PARSER_PROPERTY
See Also:
Constant Field Values

PARSED_DATA_PROPERTY

public static final java.lang.String PARSED_DATA_PROPERTY
See Also:
Constant Field Values

PARSE_COUNT

public static final java.lang.String PARSE_COUNT
See Also:
Constant Field Values

NONE

public static final java.lang.String NONE
See Also:
Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT
See Also:
Constant Field Values
Constructor Detail

SideKickPlugin

public SideKickPlugin()
Method Detail

start

public void start()
Overrides:
start in class org.gjt.sp.jedit.EditPlugin

stop

public void stop()
Overrides:
stop in class org.gjt.sp.jedit.EditPlugin

handleMessage

public void handleMessage(org.gjt.sp.jedit.EBMessage msg)
Specified by:
handleMessage in interface org.gjt.sp.jedit.EBComponent
Overrides:
handleMessage in class org.gjt.sp.jedit.EBPlugin

getParserForMode

public static SideKickParser getParserForMode(org.gjt.sp.jedit.Mode m)
Returns the parser for the given mode.

Parameters:
m - the mode (it must not be null)
Returns:
the parser associated to this mode (or null if there is no parser)

getParser

public static SideKickParser getParser(java.lang.String name)
Parameters:
name - - the name of the parser, as defined in services.xml

getParserForView

public static SideKickParser getParserForView(org.gjt.sp.jedit.View view)

setParserForBuffer

public static void setParserForBuffer(org.gjt.sp.jedit.Buffer buffer,
                                      java.lang.String parserName)

getParserForBuffer

public static SideKickParser getParserForBuffer(org.gjt.sp.jedit.Buffer buffer)

parse

public static void parse(org.gjt.sp.jedit.View view,
                         boolean showParsingMessage)
Immediately begins parsing the current buffer in a background thread.

Parameters:
view - The view
showParsingMessage - Clear the tree and show a status message there?

addWorkRequest

public static void addWorkRequest(java.lang.Runnable run,
                                  boolean inAWT)

isParsingBuffer

public static boolean isParsingBuffer(org.gjt.sp.jedit.Buffer buffer)