org.dts.spell.swing

Class ErrorMarker

java.lang.Object

org.dts.spell.swing.ErrorMarker

public class ErrorMarker
extends Object

This class has all the error marks (the red lines) for a JTextComponent. If all the marks are removed and isAutoQuit() is true (by default is false) the ErrorMarker call quitTextComponent().

Author:

DreamTangerine

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_ERROR_PROPERTY
static String	FIRST_ERROR_PROPERTY
static String	FULL_PROPERTY
static String	LAST_ERROR_PROPERTY
static String	NEXT_ERROR_PROPERTY
static String	PREVIOUS_ERROR_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String name, PropertyChangeListener listener)
static ErrorMarker	get()
static ErrorMarker	get(JTextComponent textComp)
static ErrorMarker	get(JTextComponent textComp, boolean selectError)
List<org.dts.spell.ErrorInfo>	getAllErrorInfo()
org.dts.spell.ErrorInfo	getCurrentError()
int	getErrorCount()
org.dts.spell.ErrorInfo	getErrorInfo(int position)
Color	getErrorMarkColor()
org.dts.spell.ErrorInfo	getFirstError()
org.dts.spell.ErrorInfo	getLastError()
org.dts.spell.ErrorInfo	getNextError()
org.dts.spell.ErrorInfo	getPreviousError()
PropertyChangeListener[]	getPropertyChangeListeners()
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName)
JTextComponent	getTextComponent()
boolean	hasError(int position)
boolean	isActive()
boolean	isAutoQuit()
boolean	isFull()
boolean	isSelectError()
Object	markError(int start, int end, org.dts.spell.ErrorInfo info)
Object	markError(int start, int end, org.dts.spell.ErrorInfo info, boolean scroll)
void	quitTextComponent()
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String name, PropertyChangeListener listener)
void	setAutoQuit(boolean auto)
void	setErrorMarkColor(Color color)
void	setSelectError(boolean selectError)
void	setTextComponent(JTextComponent textComp)
String	toString()
void	unMarkAllErrors()
void	unMarkError(Object tag)
void	unMarkRange(int begin, int end)

Methods inherited from class java.lang.Object

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

Field Detail

FULL_PROPERTY

public static final String FULL_PROPERTY

See Also:

Constant Field Values

FIRST_ERROR_PROPERTY

public static final String FIRST_ERROR_PROPERTY

See Also:

Constant Field Values

LAST_ERROR_PROPERTY

public static final String LAST_ERROR_PROPERTY

See Also:

Constant Field Values

CURRENT_ERROR_PROPERTY

public static final String CURRENT_ERROR_PROPERTY

See Also:

Constant Field Values

PREVIOUS_ERROR_PROPERTY

public static final String PREVIOUS_ERROR_PROPERTY

See Also:

Constant Field Values

NEXT_ERROR_PROPERTY

public static final String NEXT_ERROR_PROPERTY

See Also:

Constant Field Values

Method Detail

get

public static ErrorMarker get()

get

public static ErrorMarker get(JTextComponent textComp)

get

public static ErrorMarker get(JTextComponent textComp,
                              boolean selectError)

isActive

public boolean isActive()

setErrorMarkColor

public void setErrorMarkColor(Color color)

getErrorMarkColor

public Color getErrorMarkColor()

isSelectError

public boolean isSelectError()

Returns:

Returns the selectError.

setSelectError

public void setSelectError(boolean selectError)

Parameters:

selectError - The selectError to set.

setTextComponent

public void setTextComponent(JTextComponent textComp)

getTextComponent

public JTextComponent getTextComponent()

quitTextComponent

public void quitTextComponent()

hasError

public boolean hasError(int position)

getErrorInfo

public org.dts.spell.ErrorInfo getErrorInfo(int position)

markError

public Object markError(int start,
                        int end,
                        org.dts.spell.ErrorInfo info,
                        boolean scroll)
                 throws BadLocationException

Throws:

BadLocationException

markError

public Object markError(int start,
                        int end,
                        org.dts.spell.ErrorInfo info)
                 throws BadLocationException

Throws:

BadLocationException

unMarkError

public void unMarkError(Object tag)

unMarkRange

public void unMarkRange(int begin,
                        int end)

unMarkAllErrors

public void unMarkAllErrors()

isAutoQuit

public boolean isAutoQuit()

setAutoQuit

public void setAutoQuit(boolean auto)

getAllErrorInfo

public List<org.dts.spell.ErrorInfo> getAllErrorInfo()

getErrorCount

public int getErrorCount()

isFull

public boolean isFull()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(String name,
                                      PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(String name,
                                         PropertyChangeListener listener)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)

getFirstError

public org.dts.spell.ErrorInfo getFirstError()

getLastError

public org.dts.spell.ErrorInfo getLastError()

getCurrentError

public org.dts.spell.ErrorInfo getCurrentError()

getPreviousError

public org.dts.spell.ErrorInfo getPreviousError()

getNextError

public org.dts.spell.ErrorInfo getNextError()

toString

public String toString()

Overrides:

toString in class Object