Package org.fife.ui.rsyntaxtextarea
Class ErrorStrip.MarkedOccurrenceNotice
- java.lang.Object
-
- org.fife.ui.rsyntaxtextarea.ErrorStrip.MarkedOccurrenceNotice
-
- All Implemented Interfaces:
java.lang.Comparable<ParserNotice>
,ParserNotice
- Enclosing class:
- ErrorStrip
private class ErrorStrip.MarkedOccurrenceNotice extends java.lang.Object implements ParserNotice
A notice that wraps a "marked occurrence" instance.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.fife.ui.rsyntaxtextarea.parser.ParserNotice
ParserNotice.Level
-
-
Field Summary
Fields Modifier and Type Field Description private java.awt.Color
color
private DocumentRange
range
-
Constructor Summary
Constructors Constructor Description MarkedOccurrenceNotice(DocumentRange range, java.awt.Color color)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(ParserNotice other)
boolean
containsPosition(int pos)
Returns whether this parser notice contains the specified location in the document.boolean
equals(java.lang.Object o)
java.awt.Color
getColor()
Returns the color to use when painting this notice.boolean
getKnowsOffsetAndLength()
Returns whether this parser notice has offset and length information (as opposed to just what line number to mark).int
getLength()
Returns the length of the code the message is concerned with.ParserNotice.Level
getLevel()
Returns the level of this notice.int
getLine()
Returns the line number the notice is about.java.lang.String
getMessage()
Returns the message from the parser.int
getOffset()
Returns the offset of the code the message is concerned with.Parser
getParser()
Returns the parser that created this message.boolean
getShowInEditor()
Whether a squiggle underline should be drawn in the editor for this notice.java.lang.String
getToolTipText()
Returns the tool tip text to display for this notice.int
hashCode()
-
-
-
Field Detail
-
range
private DocumentRange range
-
color
private java.awt.Color color
-
-
Constructor Detail
-
MarkedOccurrenceNotice
MarkedOccurrenceNotice(DocumentRange range, java.awt.Color color)
-
-
Method Detail
-
compareTo
public int compareTo(ParserNotice other)
- Specified by:
compareTo
in interfacejava.lang.Comparable<ParserNotice>
-
containsPosition
public boolean containsPosition(int pos)
Description copied from interface:ParserNotice
Returns whether this parser notice contains the specified location in the document.- Specified by:
containsPosition
in interfaceParserNotice
- Parameters:
pos
- The position in the document.- Returns:
- Whether the position is contained. This will always return
false
ifParserNotice.getOffset()
returns-1
.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
getColor
public java.awt.Color getColor()
Description copied from interface:ParserNotice
Returns the color to use when painting this notice.- Specified by:
getColor
in interfaceParserNotice
- Returns:
- The color.
-
getKnowsOffsetAndLength
public boolean getKnowsOffsetAndLength()
Description copied from interface:ParserNotice
Returns whether this parser notice has offset and length information (as opposed to just what line number to mark).- Specified by:
getKnowsOffsetAndLength
in interfaceParserNotice
- Returns:
- Whether the offset and length of the notice are specified.
- See Also:
ParserNotice.getLine()
,ParserNotice.getOffset()
,ParserNotice.getLength()
-
getLength
public int getLength()
Description copied from interface:ParserNotice
Returns the length of the code the message is concerned with.- Specified by:
getLength
in interfaceParserNotice
- Returns:
- The length of the code the message is concerned with, or
-1
if unknown. - See Also:
ParserNotice.getOffset()
,ParserNotice.getLine()
-
getLevel
public ParserNotice.Level getLevel()
Description copied from interface:ParserNotice
Returns the level of this notice.- Specified by:
getLevel
in interfaceParserNotice
- Returns:
- A value from the
ParserNotice.Level
enumeration.
-
getLine
public int getLine()
Description copied from interface:ParserNotice
Returns the line number the notice is about.- Specified by:
getLine
in interfaceParserNotice
- Returns:
- The line number.
-
getMessage
public java.lang.String getMessage()
Description copied from interface:ParserNotice
Returns the message from the parser.- Specified by:
getMessage
in interfaceParserNotice
- Returns:
- The message from the parser.
-
getOffset
public int getOffset()
Description copied from interface:ParserNotice
Returns the offset of the code the message is concerned with.- Specified by:
getOffset
in interfaceParserNotice
- Returns:
- The offset, or
-1
if unknown. - See Also:
ParserNotice.getLength()
,ParserNotice.getLine()
-
getParser
public Parser getParser()
Description copied from interface:ParserNotice
Returns the parser that created this message.- Specified by:
getParser
in interfaceParserNotice
- Returns:
- The parser.
-
getShowInEditor
public boolean getShowInEditor()
Description copied from interface:ParserNotice
Whether a squiggle underline should be drawn in the editor for this notice.- Specified by:
getShowInEditor
in interfaceParserNotice
- Returns:
- Whether a squiggle underline should be drawn.
-
getToolTipText
public java.lang.String getToolTipText()
Description copied from interface:ParserNotice
Returns the tool tip text to display for this notice.- Specified by:
getToolTipText
in interfaceParserNotice
- Returns:
- The tool tip text. If none has been explicitly set, this
method returns the same text as
ParserNotice.getMessage()
.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-