weka.gui.scripting

Class SyntaxDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.DefaultStyledDocument

weka.gui.scripting.SyntaxDocument

All Implemented Interfaces:

java.io.Serializable, javax.swing.text.Document, javax.swing.text.StyledDocument

public class SyntaxDocument
extends javax.swing.text.DefaultStyledDocument

Highlights syntax in a DefaultStyledDocument. Allows any number of keywords to be formatted in any number of user-defined styles.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyntaxDocument.ATTR_TYPE The attribute type.

Nested classes/interfaces inherited from class javax.swing.text.DefaultStyledDocument

javax.swing.text.DefaultStyledDocument.AttributeUndoableEdit, javax.swing.text.DefaultStyledDocument.ElementBuffer, javax.swing.text.DefaultStyledDocument.ElementSpec, javax.swing.text.DefaultStyledDocument.SectionElement

Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument

javax.swing.text.AbstractDocument.AbstractElement, javax.swing.text.AbstractDocument.AttributeContext, javax.swing.text.AbstractDocument.BranchElement, javax.swing.text.AbstractDocument.Content, javax.swing.text.AbstractDocument.DefaultDocumentEvent, javax.swing.text.AbstractDocument.ElementEdit, javax.swing.text.AbstractDocument.LeafElement

Field Summary

Fields

Modifier and Type	Field and Description
static javax.swing.text.SimpleAttributeSet	DEFAULT_COMMENT the attribute set for comments.
static java.lang.String	DEFAULT_FONT_FAMILY the font family.
static int	DEFAULT_FONT_SIZE the font size.
static javax.swing.text.SimpleAttributeSet	DEFAULT_KEYWORD the attribute set for keywords.
static javax.swing.text.SimpleAttributeSet	DEFAULT_NORMAL the attribute set for normal code.
static javax.swing.text.SimpleAttributeSet	DEFAULT_STRING the attribute set for strings.
protected boolean	m_AddMatchingEndBlocks whether to add matching brackets.
protected java.awt.Color	m_BackgroundColor the background color.
protected java.lang.String	m_BlockEnd the end of a block.
protected java.lang.String	m_BlockStart the start of a block.
protected boolean	m_CaseSensitive whether keywords are case-sensitive.
protected java.lang.String	m_Delimiters the delimiters.
protected java.lang.String	m_FontName the font name.
protected int	m_FontSize the font size.
protected java.lang.String	m_Indentation the number of spaces used for indentation.
protected boolean	m_InsideMultiLineComment whether we're currently in a multi-line comment.
protected java.util.HashMap<java.lang.String,javax.swing.text.MutableAttributeSet>	m_Keywords the keywords.
protected boolean	m_MultiLineComment whether multi-line comments are enabled.
protected java.lang.String	m_MultiLineCommentEnd the multi-line comment end.
protected java.lang.String	m_MultiLineCommentStart the multi-line comment start.
protected java.lang.String	m_QuoteDelimiters the quote delimiter.
protected java.lang.String	m_QuoteEscape the quote escape.
protected javax.swing.text.Element	m_RootElement the root element.
protected javax.swing.text.DefaultStyledDocument	m_Self the document.
protected java.lang.String	m_SingleLineCommentStart the single-line comment start.
protected boolean	m_UseBlanks whether to use blanks instead of tabs.
static int	MAX_TABS the maximum number of tabs.
protected static long	serialVersionUID for serialization.

Fields inherited from class javax.swing.text.DefaultStyledDocument

buffer, BUFFER_SIZE_DEFAULT

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

Constructors

Constructor and Description
SyntaxDocument(java.util.Properties props) Initializes the document.

Method Summary

Modifier and Type	Method and Description
void	addKeyword(java.lang.String keyword, javax.swing.text.MutableAttributeSet attr) Associates a keyword with a particular formatting style.
void	addKeywords(java.lang.String[] keywords, javax.swing.text.MutableAttributeSet attr) Associates the keywords with a particular formatting style.
protected java.lang.String	addMatchingBlockEnd(int offset) Adds the matching block end.
protected void	applyHighlighting(java.lang.String content, int line) Parse the line to determine the appropriate highlighting.
protected void	checkForTokens(java.lang.String content, int startOffset, int endOffset) Parse the line for tokens to highlight.
protected void	commentLinesAfter(java.lang.String content, int line) Highlight comment lines to matching end delimiter.
protected boolean	commentLinesBefore(java.lang.String content, int line) Highlight lines when a multi line comment is still 'open' (ie. matching end delimiter has not yet been encountered).
protected boolean	endingMultiLineComment(java.lang.String content, int startOffset, int endOffset) Does this line contain the end delimiter of a multi-line comment.
java.lang.String	escapeQuote(java.lang.String quoteDelimiter) Escapes the quote delimiter.
boolean	getAddMatchingEndBlocks() Returns whether matching block ends are inserted or not.
java.awt.Color	getBackgroundColor() Returns the background color.
java.lang.String	getBlockEnd() Returns the end of a block.
java.lang.String	getBlockStart() Returns the start of a block.
boolean	getCaseSensitive() Returns whether blanks are used instead of tabs.
java.lang.String	getDelimiters() Returns the delimiter characters to use.
java.lang.String	getFontName() gets the current font family.
int	getFontSize() gets the current font size.
int	getIndentationSize() Returns the number of blanks used for indentation.
javax.swing.text.MutableAttributeSet	getKeywordFormatting(java.lang.String keyword) Gets the formatting for a keyword.
protected java.lang.String	getLine(java.lang.String content, int offset) Returns the line.
boolean	getMultiLineComment() Returns whether multi-line comments are enabled.
java.lang.String	getMultiLineCommentEnd() Returns the end of a multi-line comment.
java.lang.String	getMultiLineCommentStart() Returns the string that is the start of a multi-line comment.
protected int	getOtherToken(java.lang.String content, int startOffset, int endOffset) Searches for a keyword token.
java.lang.String	getQuoteDelimiters() Returns the quote delimiter characters to use.
java.lang.String	getQuoteEscape() Returns the character for escaping a quote delimiter.
protected int	getQuoteToken(java.lang.String content, int startOffset, int endOffset) Searches for a quote token.
java.lang.String	getSingleLineCommentStart() Retrusn the single line comment start string.
boolean	getUseBlanks() Returns whether blanks are used instead of tabs.
protected void	highlightLinesAfter(java.lang.String content, int line) Highlight lines to start or end delimiter.
protected int	indexOf(java.lang.String content, java.lang.String needle, int offset) Assume the needle will the found at the start/end of the line.
void	insertString(int offset, java.lang.String str, javax.swing.text.AttributeSet a) Override to apply syntax highlighting after the document has been updated.
boolean	isDelimiter(java.lang.String character) Checks whether the character is a delimiter.
protected boolean	isMultiLineComment() We have found a start delimiter and are still searching for the end delimiter.
boolean	isQuoteDelimiter(java.lang.String character) Checks whether the character is quote delimiter.
protected int	lastIndexOf(java.lang.String content, java.lang.String needle, int offset) Assume the needle will the found at the start/end of the line.
void	processChangedLines(int offset, int length) Determine how many lines have been changed, then apply highlighting to each line.
void	remove(int offset, int length) Applies syntax highlighting after the document has been updated.
void	removeKeyword(java.lang.String keyword) Removes an association between a keyword with a particular formatting style.
void	setAddMatchingEndBlocks(boolean value) Sets whether matching block ends are inserted or not.
static void	setAttributeColor(javax.swing.text.MutableAttributeSet attr, java.awt.Color c) Sets the foreground (font) color of the specified attribute.
void	setAttributeColor(SyntaxDocument.ATTR_TYPE attr, java.awt.Color c) Sets the foreground (font) color of the specified attribute.
static void	setAttributeFont(javax.swing.text.MutableAttributeSet attr, java.awt.Font f) Sets the font of the specified attribute.
void	setAttributeFont(SyntaxDocument.ATTR_TYPE attr, int style) Sets the font of the specified attribute.
void	setBackgroundColor(java.awt.Color value) Sets the background color.
void	setBlockEnd(java.lang.String value) Sets the string that is the end of a block.
void	setBlockStart(java.lang.String value) Sets the string that is the start of a block.
void	setCaseSensitive(boolean value) Sets whether the keywords are case-sensitive or not.
void	setDelimiters(java.lang.String value) Sets the delimiter characters to use.
void	setFontName(java.lang.String fontName) sets the current font family (affects all built-in styles).
void	setFontSize(int fontSize) sets the current font size (affects all built-in styles).
void	setIndentationSize(int value) Sets the number of blanks to use for indentation.
protected void	setInsideMultiLineComment(boolean value) Sets whether we're currently within a multi-line comment or not.
void	setMultiLineComment(boolean value) Sets whether to enable multi-line comments.
void	setMultiLineCommentEnd(java.lang.String value) Sets the string that is the end of a multi-line comment.
void	setMultiLineCommentStart(java.lang.String value) Sets the string that is the start of a multi-line comment.
void	setQuoteDelimiters(java.lang.String value) Sets the quote delimiter characters to use.
void	setQuoteEscape(java.lang.String value) Sets the character to use for escaping a quote character.
void	setSingleLineCommentStart(java.lang.String value) Sets the string that is the start of a single-line comment.
void	setTabs(int charactersPerTab) sets the number of characters per tab.
protected void	setup(java.util.Properties props) Sets up the document according to the properties.
void	setUseBlanks(boolean value) Sets whether to use blanks instead of tabs.
protected boolean	startingMultiLineComment(java.lang.String content, int startOffset, int endOffset) Does this line contain the start of a multi-line comment.

Methods inherited from class javax.swing.text.DefaultStyledDocument

addDocumentListener, addStyle, create, createDefaultRoot, getBackground, getCharacterElement, getDefaultRootElement, getFont, getForeground, getLogicalStyle, getParagraphElement, getStyle, getStyleNames, insert, insertUpdate, removeDocumentListener, removeElement, removeStyle, removeUpdate, setCharacterAttributes, setLogicalStyle, setParagraphAttributes, styleChanged

Methods inherited from class javax.swing.text.AbstractDocument

addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, postRemoveUpdate, putProperty, readLock, readUnlock, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.text.Document

addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, putProperty, removeUndoableEditListener, render

Field Detail

serialVersionUID

protected static final long serialVersionUID

for serialization.

See Also:

Constant Field Values

MAX_TABS

public static final int MAX_TABS

the maximum number of tabs.

See Also:

Constant Field Values

DEFAULT_FONT_FAMILY

public static final java.lang.String DEFAULT_FONT_FAMILY

the font family.

See Also:

Constant Field Values

DEFAULT_FONT_SIZE

public static final int DEFAULT_FONT_SIZE

the font size.

See Also:

Constant Field Values

DEFAULT_NORMAL

public static final javax.swing.text.SimpleAttributeSet DEFAULT_NORMAL

the attribute set for normal code.

DEFAULT_COMMENT

public static final javax.swing.text.SimpleAttributeSet DEFAULT_COMMENT

the attribute set for comments.

DEFAULT_STRING

public static final javax.swing.text.SimpleAttributeSet DEFAULT_STRING

the attribute set for strings.

DEFAULT_KEYWORD

public static final javax.swing.text.SimpleAttributeSet DEFAULT_KEYWORD

the attribute set for keywords.

m_Self

protected javax.swing.text.DefaultStyledDocument m_Self

the document.

m_RootElement

protected javax.swing.text.Element m_RootElement

the root element.

m_InsideMultiLineComment

protected boolean m_InsideMultiLineComment

whether we're currently in a multi-line comment.

m_Keywords

protected java.util.HashMap<java.lang.String,javax.swing.text.MutableAttributeSet> m_Keywords

the keywords.

m_Delimiters

protected java.lang.String m_Delimiters

the delimiters.

m_QuoteDelimiters

protected java.lang.String m_QuoteDelimiters

the quote delimiter.

m_QuoteEscape

protected java.lang.String m_QuoteEscape

the quote escape.

m_MultiLineCommentStart

protected java.lang.String m_MultiLineCommentStart

the multi-line comment start.

m_MultiLineCommentEnd

protected java.lang.String m_MultiLineCommentEnd

the multi-line comment end.

m_SingleLineCommentStart

protected java.lang.String m_SingleLineCommentStart

the single-line comment start.

m_BlockStart

protected java.lang.String m_BlockStart

the start of a block.

m_BlockEnd

protected java.lang.String m_BlockEnd

the end of a block.

m_FontSize

protected int m_FontSize

the font size.

m_FontName

protected java.lang.String m_FontName

the font name.

m_BackgroundColor

protected java.awt.Color m_BackgroundColor

the background color.

m_Indentation

protected java.lang.String m_Indentation

the number of spaces used for indentation.

m_AddMatchingEndBlocks

protected boolean m_AddMatchingEndBlocks

whether to add matching brackets.

m_UseBlanks

protected boolean m_UseBlanks

whether to use blanks instead of tabs.

m_MultiLineComment

protected boolean m_MultiLineComment

whether multi-line comments are enabled.

m_CaseSensitive

protected boolean m_CaseSensitive

whether keywords are case-sensitive.

Constructor Detail

SyntaxDocument

public SyntaxDocument(java.util.Properties props)

Initializes the document.

Parameters:

props - the properties to obtain the setup from

Method Detail

setup

protected void setup(java.util.Properties props)

Sets up the document according to the properties.

Parameters:

props - the properties to use

setAttributeFont

public void setAttributeFont(SyntaxDocument.ATTR_TYPE attr,
                             int style)

Sets the font of the specified attribute.

Parameters:

attr - the attribute to apply this font to (normal, comment, string)

style - font style (Font.BOLD, Font.ITALIC, Font.PLAIN)

setAttributeFont

public static void setAttributeFont(javax.swing.text.MutableAttributeSet attr,
                                    java.awt.Font f)

Sets the font of the specified attribute.

Parameters:

attr - attribute to apply this font to

f - the font to use

setAttributeColor

public void setAttributeColor(SyntaxDocument.ATTR_TYPE attr,
                              java.awt.Color c)

Sets the foreground (font) color of the specified attribute.

Parameters:

attr - the attribute to apply this font to (normal, comment, string)

c - the color to use

setAttributeColor

public static void setAttributeColor(javax.swing.text.MutableAttributeSet attr,
                                     java.awt.Color c)

Sets the foreground (font) color of the specified attribute.

Parameters:

attr - attribute to apply this color to

c - the color to use

addKeywords

public void addKeywords(java.lang.String[] keywords,
                        javax.swing.text.MutableAttributeSet attr)

Associates the keywords with a particular formatting style.

Parameters:

keywords - the tokens or words to format

attr - how to format the keywords

addKeyword

public void addKeyword(java.lang.String keyword,
                       javax.swing.text.MutableAttributeSet attr)

Associates a keyword with a particular formatting style.

Parameters:

keyword - the token or word to format

attr - how to format keyword

getKeywordFormatting

public javax.swing.text.MutableAttributeSet getKeywordFormatting(java.lang.String keyword)

Gets the formatting for a keyword.

Parameters:

keyword - the token or word to stop formatting

Returns:

how keyword is formatted, or null if no formatting is applied to it

removeKeyword

public void removeKeyword(java.lang.String keyword)

Removes an association between a keyword with a particular formatting style.

Parameters:

keyword - the token or word to stop formatting

setTabs

public void setTabs(int charactersPerTab)

sets the number of characters per tab.

Parameters:

charactersPerTab - the characters per tab

insertString

public void insertString(int offset,
                         java.lang.String str,
                         javax.swing.text.AttributeSet a)
                  throws javax.swing.text.BadLocationException

Override to apply syntax highlighting after the document has been updated.

Specified by:

insertString in interface javax.swing.text.Document

Overrides:

insertString in class javax.swing.text.AbstractDocument

Parameters:

offset - the offset

str - the string to insert

a - the attribute set, can be null

Throws:

javax.swing.text.BadLocationException - if offset is invalid

remove

public void remove(int offset,
                   int length)
            throws javax.swing.text.BadLocationException

Applies syntax highlighting after the document has been updated.

Specified by:

remove in interface javax.swing.text.Document

Overrides:

remove in class javax.swing.text.AbstractDocument

Parameters:

offset - the offset of the deletion

length - the length of the deletion

Throws:

javax.swing.text.BadLocationException - if offsets are invalid

processChangedLines

public void processChangedLines(int offset,
                                int length)
                         throws javax.swing.text.BadLocationException

Determine how many lines have been changed, then apply highlighting to each line.

Parameters:

offset - the offset of the changed lines

length - the length of the change

Throws:

javax.swing.text.BadLocationException - if offset is invalid

commentLinesBefore

protected boolean commentLinesBefore(java.lang.String content,
                                     int line)

Highlight lines when a multi line comment is still 'open' (ie. matching end delimiter has not yet been encountered).

Parameters:

content - the content to check

line - the line number

Returns:

true if there are comment lines before

commentLinesAfter

protected void commentLinesAfter(java.lang.String content,
                                 int line)

Highlight comment lines to matching end delimiter.

Parameters:

content - the content to parse

line - the line number

highlightLinesAfter

protected void highlightLinesAfter(java.lang.String content,
                                   int line)
                            throws javax.swing.text.BadLocationException

Highlight lines to start or end delimiter.

Parameters:

content - the content to parse

line - the line number

Throws:

javax.swing.text.BadLocationException - if offsets are wrong

applyHighlighting

protected void applyHighlighting(java.lang.String content,
                                 int line)
                          throws javax.swing.text.BadLocationException

Parse the line to determine the appropriate highlighting.

Parameters:

content - the content to parse

line - the line number

Throws:

javax.swing.text.BadLocationException - if offsets are invalid

startingMultiLineComment

protected boolean startingMultiLineComment(java.lang.String content,
                                           int startOffset,
                                           int endOffset)
                                    throws javax.swing.text.BadLocationException

Does this line contain the start of a multi-line comment.

Parameters:

content - the content to search

startOffset - the start of the search

endOffset - the end of the search

Returns:

true if it contains the start delimiter

Throws:

javax.swing.text.BadLocationException - if offsets are invalid

endingMultiLineComment

protected boolean endingMultiLineComment(java.lang.String content,
                                         int startOffset,
                                         int endOffset)
                                  throws javax.swing.text.BadLocationException

Does this line contain the end delimiter of a multi-line comment.

Parameters:

content - the content to search

startOffset - the start of the search

endOffset - the end of the search

Returns:

true if the line contains the end delimiter

Throws:

javax.swing.text.BadLocationException - if offsets are invalid

isMultiLineComment

protected boolean isMultiLineComment()

We have found a start delimiter and are still searching for the end delimiter.

Returns:

true if currently within a multi-line comment

setInsideMultiLineComment

protected void setInsideMultiLineComment(boolean value)

Sets whether we're currently within a multi-line comment or not.

Parameters:

value - true if currently within a multi-line comment

checkForTokens

protected void checkForTokens(java.lang.String content,
                              int startOffset,
                              int endOffset)

Parse the line for tokens to highlight.

Parameters:

content - the content to parse

startOffset - the start position

endOffset - the end position

getQuoteToken

protected int getQuoteToken(java.lang.String content,
                            int startOffset,
                            int endOffset)

Searches for a quote token.

Parameters:

content - the content to search

startOffset - the start of the search

endOffset - the end of the search

Returns:

the new position

getOtherToken

protected int getOtherToken(java.lang.String content,
                            int startOffset,
                            int endOffset)

Searches for a keyword token.

Parameters:

content - the content to search in

startOffset - the position to start the search fromm

endOffset - the position to end the search

Returns:

the new position

indexOf

protected int indexOf(java.lang.String content,
                      java.lang.String needle,
                      int offset)

Assume the needle will the found at the start/end of the line.

Parameters:

content - the content to search

needle - the string to look for

offset - the offset to start at

Returns:

the index

lastIndexOf

protected int lastIndexOf(java.lang.String content,
                          java.lang.String needle,
                          int offset)

Assume the needle will the found at the start/end of the line.

Parameters:

content - the content search

needle - what to look for

offset - the offset to start

Returns:

the index

getLine

protected java.lang.String getLine(java.lang.String content,
                                   int offset)

Returns the line.

Parameters:

content - the content

offset - the offset to start at

Returns:

the line

isDelimiter

public boolean isDelimiter(java.lang.String character)

Checks whether the character is a delimiter.

Parameters:

character - the character to check

Returns:

true if a delimiter

isQuoteDelimiter

public boolean isQuoteDelimiter(java.lang.String character)

Checks whether the character is quote delimiter.

Parameters:

character - the character to check

Returns:

true if a quote delimiter

escapeQuote

public java.lang.String escapeQuote(java.lang.String quoteDelimiter)

Escapes the quote delimiter.

Parameters:

quoteDelimiter - the string to escape

Returns:

the escaped string

addMatchingBlockEnd

protected java.lang.String addMatchingBlockEnd(int offset)
                                        throws javax.swing.text.BadLocationException

Adds the matching block end.

Parameters:

offset - the offset

Returns:

the string after adding the matching block end

Throws:

javax.swing.text.BadLocationException - if the offset is invalid

getFontSize

public int getFontSize()

gets the current font size.

Returns:

the font size

setFontSize

public void setFontSize(int fontSize)

sets the current font size (affects all built-in styles).

Parameters:

fontSize - the size

getFontName

public java.lang.String getFontName()

gets the current font family.

Returns:

the font name

setFontName

public void setFontName(java.lang.String fontName)

sets the current font family (affects all built-in styles).

Parameters:

fontName - the font name

setIndentationSize

public void setIndentationSize(int value)

Sets the number of blanks to use for indentation.

Parameters:

value - the number of blanks

getIndentationSize

public int getIndentationSize()

Returns the number of blanks used for indentation.

Returns:

the number of blanks

setDelimiters

public void setDelimiters(java.lang.String value)

Sets the delimiter characters to use.

Parameters:

value - the characters

getDelimiters

public java.lang.String getDelimiters()

Returns the delimiter characters to use.

Returns:

the characters

setQuoteDelimiters

public void setQuoteDelimiters(java.lang.String value)

Sets the quote delimiter characters to use.

Parameters:

value - the characters

getQuoteDelimiters

public java.lang.String getQuoteDelimiters()

Returns the quote delimiter characters to use.

Returns:

the characters

setQuoteEscape

public void setQuoteEscape(java.lang.String value)

Sets the character to use for escaping a quote character.

Parameters:

value - the character

getQuoteEscape

public java.lang.String getQuoteEscape()

Returns the character for escaping a quote delimiter.

Returns:

the character

setSingleLineCommentStart

public void setSingleLineCommentStart(java.lang.String value)

Sets the string that is the start of a single-line comment.

Parameters:

value - the string

getSingleLineCommentStart

public java.lang.String getSingleLineCommentStart()

Retrusn the single line comment start string.

Returns:

the start string

setMultiLineCommentStart

public void setMultiLineCommentStart(java.lang.String value)

Sets the string that is the start of a multi-line comment.

Parameters:

value - the string

getMultiLineCommentStart

public java.lang.String getMultiLineCommentStart()

Returns the string that is the start of a multi-line comment.

Returns:

the string

setMultiLineCommentEnd

public void setMultiLineCommentEnd(java.lang.String value)

Sets the string that is the end of a multi-line comment.

Parameters:

value - the string

getMultiLineCommentEnd

public java.lang.String getMultiLineCommentEnd()

Returns the end of a multi-line comment.

Returns:

the end string

setBlockStart

public void setBlockStart(java.lang.String value)

Sets the string that is the start of a block.

Parameters:

value - the string

getBlockStart

public java.lang.String getBlockStart()

Returns the start of a block.

Returns:

the end string

setBlockEnd

public void setBlockEnd(java.lang.String value)

Sets the string that is the end of a block.

Parameters:

value - the string

getBlockEnd

public java.lang.String getBlockEnd()

Returns the end of a block.

Returns:

the end string

setAddMatchingEndBlocks

public void setAddMatchingEndBlocks(boolean value)

Sets whether matching block ends are inserted or not.

Parameters:

value - if true then matching block ends are inserted

getAddMatchingEndBlocks

public boolean getAddMatchingEndBlocks()

Returns whether matching block ends are inserted or not.

Returns:

true if matching block ends are inserted

setUseBlanks

public void setUseBlanks(boolean value)

Sets whether to use blanks instead of tabs.

Parameters:

value - if true then blanks are used instead of tabs

getUseBlanks

public boolean getUseBlanks()

Returns whether blanks are used instead of tabs.

Returns:

true if blanks are used instead of tabs

setBackgroundColor

public void setBackgroundColor(java.awt.Color value)

Sets the background color.

Parameters:

value - the background color

getBackgroundColor

public java.awt.Color getBackgroundColor()

Returns the background color.

Returns:

the background color

setMultiLineComment

public void setMultiLineComment(boolean value)

Sets whether to enable multi-line comments.

Parameters:

value - if true then multi-line comments are enabled

getMultiLineComment

public boolean getMultiLineComment()

Returns whether multi-line comments are enabled.

Returns:

true if multi-line comments are enabled

setCaseSensitive

public void setCaseSensitive(boolean value)

Sets whether the keywords are case-sensitive or not.

Parameters:

value - if true then keywords are treated case-sensitive

getCaseSensitive

public boolean getCaseSensitive()

Returns whether blanks are used instead of tabs.

Returns:

true if keywords are case-sensitive