org.omegat.gui.editor.mark

Class AbstractMarker

java.lang.Object

org.omegat.gui.editor.mark.AbstractMarker

All Implemented Interfaces:

IMarker

Direct Known Subclasses:

BidiMarkers, NBSPMarker, RemoveTagMarker, WhitespaceMarkerFactory.LFMarker, WhitespaceMarkerFactory.SpaceMarker, WhitespaceMarkerFactory.TabMarker

public abstract class AbstractMarker
extends java.lang.Object
implements IMarker

Abstract marker class that marks source and target text according to some 'pattern' and paints them according to some 'PAINTER' and 'ATTRIBUTES' (all of them defined by implementing classes)

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.text.AttributeSet	attributes
protected javax.swing.text.Highlighter.HighlightPainter	painter
protected java.util.regex.Pattern	pattern Regexp for mark.
protected int	patternChar char for mark.
protected java.lang.String	toolTip

Constructor Summary

Constructors

Constructor and Description
AbstractMarker()

Method Summary

Modifier and Type	Method and Description
java.util.List<Mark>	getMarksForEntry(SourceTextEntry ste, java.lang.String sourceText, java.lang.String translationText, boolean isActive) Calculate marks for specific entry.
protected void	initDrawers(boolean isSource, boolean isActive) Marker can override this method for define different PAINTER, ATTRIBUTES and PATTERN, based on source/translation, active/inactive and other.
protected abstract boolean	isEnabled() Is the marker enabled?

Methods inherited from class java.lang.Object

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

Field Detail

painter

protected javax.swing.text.Highlighter.HighlightPainter painter

toolTip

protected java.lang.String toolTip

attributes

protected javax.swing.text.AttributeSet attributes

pattern

protected java.util.regex.Pattern pattern

Regexp for mark.

patternChar

protected int patternChar

char for mark.

Constructor Detail

AbstractMarker

public AbstractMarker()
               throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

isEnabled

protected abstract boolean isEnabled()

Is the marker enabled?

Returns:

true when enabled (markers are painted). false when disabled (no markers painted)

getMarksForEntry

public java.util.List<Mark> getMarksForEntry(SourceTextEntry ste,
                                             java.lang.String sourceText,
                                             java.lang.String translationText,
                                             boolean isActive)
                                      throws java.lang.Exception

Description copied from interface: IMarker

Calculate marks for specific entry.

Method will be called NOT in Swing thread.

Note to implementers: Both sourceText and translationText might be null!

Specified by:

getMarksForEntry in interface IMarker

sourceText - might be null!

translationText - might be null!

isActive - is this an active segment in the document?

Returns:

null if nothing changed, or list of new marks. Empty list must be returned if marks shouldn't be displayed

Throws:

java.lang.Exception

initDrawers

protected void initDrawers(boolean isSource,
                           boolean isActive)

Marker can override this method for define different PAINTER, ATTRIBUTES and PATTERN, based on source/translation, active/inactive and other.