Class AbstractParser

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

public abstract class AbstractParser extends Object implements Parser
A base class for Parser implementations. Most Parsers should be able to extend this class.
Version:
1.0
  • Field Details

    • enabled

      private boolean enabled
      Whether this parser is enabled. If this is false, then this parser will not be run.
    • linkListener

      private ExtendedHyperlinkListener linkListener
      Listens for events from FocusableTips generated from this parser's notices.
  • Constructor Details

    • AbstractParser

      protected AbstractParser()
      Constructor.
  • Method Details

    • getHyperlinkListener

      public ExtendedHyperlinkListener getHyperlinkListener()
      Description copied from interface: Parser
      Returns the listener for hyperlink events from FocusableTips, or null if none.
      Specified by:
      getHyperlinkListener in interface Parser
      Returns:
      The listener.
    • getImageBase

      public 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()
      Description copied from interface: Parser
      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:
    • setHyperlinkListener

      public void setHyperlinkListener(ExtendedHyperlinkListener listener)
      Returns the listener for this parser.
      Parameters:
      listener - The new listener.
      See Also: