org.fife.ui.rsyntaxtextarea.parser
Class AbstractParser

java.lang.Object
  extended by org.fife.ui.rsyntaxtextarea.parser.AbstractParser
All Implemented Interfaces:
Parser
Direct Known Subclasses:
TaskTagParser, XmlParser

public abstract class AbstractParser
extends java.lang.Object
implements Parser

A base class for Parser implementations. Most Parsers should be able to extend this class.

Version:
1.0
Author:
Robert Futrell

Constructor Summary
protected AbstractParser()
          Constructor.
 
Method Summary
 ExtendedHyperlinkListener getHyperlinkListener()
          Returns the listener for hyperlink events from FocusableTips, or null if none.
 java.net.URL getImageBase()
          Returns null.
 boolean isEnabled()
          Returns whether this parser is enabled.
 void setEnabled(boolean enabled)
          Toggles whether this parser is enabled.
 void setHyperlinkListener(ExtendedHyperlinkListener listener)
          Returns the listener for this parser.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.fife.ui.rsyntaxtextarea.parser.Parser
parse
 

Constructor Detail

AbstractParser

protected AbstractParser()
Constructor.

Method Detail

getHyperlinkListener

public ExtendedHyperlinkListener getHyperlinkListener()
Returns the listener for hyperlink events from FocusableTips, or null if none.

Specified by:
getHyperlinkListener in interface Parser
Returns:
The listener.

getImageBase

public java.net.URL getImageBase()
Returns null. Parsers that wish to show images in their tool tips should override this method to return the image base URL.

Specified by:
getImageBase in interface Parser
Returns:
null always.

isEnabled

public boolean isEnabled()
Returns whether this parser is enabled. If this returns false, it will not be run.

Specified by:
isEnabled in interface Parser
Returns:
Whether this parser is enabled.

setEnabled

public void setEnabled(boolean enabled)
Toggles whether this parser is enabled.

Parameters:
enabled - Whether this parser is enabled.
See Also:
isEnabled()

setHyperlinkListener

public void setHyperlinkListener(ExtendedHyperlinkListener listener)
Returns the listener for this parser.

Parameters:
listener - The new listener.
See Also:
getHyperlinkListener()