org.omegat.gui.editor

Class EditorController

java.lang.Object

org.omegat.gui.editor.EditorController

All Implemented Interfaces:

IEditor

public class EditorController
extends java.lang.Object
implements IEditor

Class for control all editor operations. You can find good description of java text editor working at http://java.sun.com/products/jfc/tsc/articles/text/overview/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EditorController.HasMultipleTranslations Class for checking if alternative translation exist.

Nested classes/interfaces inherited from interface org.omegat.gui.editor.IEditor

IEditor.CaretPosition, IEditor.CHANGE_CASE_TO

Field Summary

Fields

Modifier and Type	Field and Description
protected int	displayedEntryIndex Current active segment in current file, if there are segments in file (can be fale if filter active!)
protected int	displayedFileIndex Current displayed file.
protected EditorTextArea3	editor Editor instance.
protected int	firstLoaded
protected java.awt.Font	font
protected int	lastLoaded
protected javax.swing.Timer	lazyLoadTimer
protected SegmentBuilder[]	m_docSegList Currently displayed segments info.
protected MarkerController	markerController Class for process marks for editor.
protected MainWindow	mw
protected int	previousDisplayedFileIndex Current displayed file.
protected EditorSettings	settings
protected boolean	sourceLangIsRTL
protected boolean	targetLangIsRTL

Constructor Summary

Constructors

Constructor and Description
EditorController(MainWindow mainWindow)

Method Summary

Modifier and Type	Method and Description
void	activateEntry() Activate entry for edit.
void	activateEntry(IEditor.CaretPosition pos) Activates the current entry (if available) by displaying source text and embedding displayed text in markers.
void	changeCase(IEditor.CHANGE_CASE_TO toWhat) Change case of the selected text or if none is selected, of the current word.
void	commitAndDeactivate() Commits the translation.
void	commitAndLeave() Commits the translation and leave entry activated.
protected void	deactivateWithoutCommit() Deactivate active translation without save.
AlphabeticalMarkers	getAlphabeticalMarkers()
IAutoCompleter	getAutoCompleter() Access the AutoCompleter
SourceTextEntry	getCurrentEntry() Get current active entry.
int	getCurrentEntryNumber() Get current active entry number.
java.lang.String	getCurrentFile() Get relative path (under source) of the source file currently open in the editor.
int	getCurrentPositionInEntryTranslation() Returns current caret position in the editable translation.
SegmentBuilder	getCurrentSegmentBuilder()
java.lang.String	getCurrentTargetFile() Get the relative path (under target) of the target file corresponding to the current source file (per IEditor.getCurrentFile()).
java.lang.String	getCurrentTranslation() Returns current translation or null.
IEditorFilter	getFilter() Gets a filter for this editor, or null if filter doesn't applied.
Document3.ORIENTATION	getOrientation() returns the orientation of the document (so we can decide what way of tag colouring we need; if that has been fixed in an other way, this method can be removed again.).
int	getPositionInEntryTranslation(int pos) Returns the relative caret position in the editable translation for a given absolute index into the overall editor document.
protected int	getSegmentIndexAtLocation(int location)
java.lang.String	getSelectedText() Get currently selected text.
EditorSettings	getSettings() Get settings instance.
void	gotoEntry(int entryNum) Goto entry with specified number.
void	gotoEntry(int entryNum, IEditor.CaretPosition pos) Goto entry with specified number, and restore caret to specified position.
void	gotoEntry(java.lang.String srcString, EntryKey key) Goto entry based on a string and entry key.
void	gotoEntryAfterFix(int entryNum, java.lang.String fixedSource) Goto entry with specified number while avoiding clobbering the tag fixes.
void	gotoFile(int fileIndex) Goto first entry in specified file.
void	gotoHistoryBack() Go to previous segment from history.
void	gotoHistoryForward() Go to next segment from history.
protected boolean	goToSegmentAtLocation(int location) Go to segment at specified location.
void	insertTag(java.lang.String tag) Inserts tag at the cursor position, probably with adding bidi control chars.
void	insertText(java.lang.String text) Inserts text at the cursor position.
void	insertTextAndMark(java.lang.String text) Inserts text at the cursor position and mark as to be changed by the translator, i.e, background of segment should be marked Must be called only from UI thread.
protected void	loadDocument() Displays the Preferences.EDITOR_INITIAL_SEGMENT_LOAD_COUNT segments surrounding the entry with index displayedEntryIndex.
void	markActiveEntrySource(SourceTextEntry requiredActiveEntry, java.util.List<Mark> marks, java.lang.String markerClassName) All plugins can call this method for mark something in active entry.
void	nextEntry() Move to next entry.
void	nextEntryWithNote() Finds the next entry with a non-empty note.
void	nextTranslatedEntry() Finds the next translated entry in the document.
void	nextUniqueEntry() Find the next unique entry.
void	nextUntranslatedEntry() Finds the next untranslated entry in the document.
void	prevEntry() Move to previous entry.
void	prevEntryWithNote() Finds the previous entry with a non-empty note.
void	redo() Redo editing.
void	refreshEntries(java.util.Set<java.lang.Integer> entryNumbers) Refresh some entries.
void	refreshView(boolean doCommit)
void	refreshViewAfterFix(java.util.List<java.lang.Integer> fixedEntries) Refresh the current editor view while avoiding clobbering any tag fixes.
void	registerEmptyTranslation() Register as empty.
void	registerIdenticalTranslation() Register translation to be identical to source.
void	registerPopupMenuConstructors(int priority, IPopupMenuConstructor constructor) Register constructor of popup menu.
void	registerUntranslated() Register untranslated.
void	remarkOneMarker(java.lang.String markerClassName) Calls specified marker for reprocess all entries.
void	removeFilter() Removes the current filter.
void	replaceEditText(java.lang.String text) Replaces the entire edit area with a given text.
void	replaceEditTextAndMark(java.lang.String text) Inserts text at the cursor position and mark as to be changed by the translator, i.e, background of segment should be marked Must be called only from UI thread.
void	replacePartOfText(java.lang.String text, int start, int end)
void	requestFocus() Set current focus to editor.
void	setAlternateTranslationForCurrentEntry(boolean alternate) Set default/alternate translation for current entry.
void	setCaretPosition(IEditor.CaretPosition pos)
void	setFilter(IEditorFilter filter) Sets a filter to this editor.
void	showStat() Calculate statistic for file, request statistic for project and display in status bar.
protected void	toggleOrientation() Toggle component orientation: LTR, RTL, language dependent.
void	undo() Undo editing.
void	windowDeactivated() Perform any necessary actions for window deactivation.

Methods inherited from class java.lang.Object

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

Field Detail

editor

protected final EditorTextArea3 editor

Editor instance.

markerController

protected MarkerController markerController

Class for process marks for editor.

mw

protected final MainWindow mw

m_docSegList

protected SegmentBuilder[] m_docSegList

Currently displayed segments info.

firstLoaded

protected int firstLoaded

lastLoaded

protected int lastLoaded

lazyLoadTimer

protected javax.swing.Timer lazyLoadTimer

displayedFileIndex

protected int displayedFileIndex

Current displayed file.

previousDisplayedFileIndex

protected int previousDisplayedFileIndex

Current displayed file.

displayedEntryIndex

protected int displayedEntryIndex

Current active segment in current file, if there are segments in file (can be fale if filter active!)

settings

protected final EditorSettings settings

font

protected java.awt.Font font

sourceLangIsRTL

protected boolean sourceLangIsRTL

targetLangIsRTL

protected boolean targetLangIsRTL

Constructor Detail

EditorController

public EditorController(MainWindow mainWindow)

Method Detail

toggleOrientation

protected void toggleOrientation()

Toggle component orientation: LTR, RTL, language dependent.

getOrientation

public Document3.ORIENTATION getOrientation()

returns the orientation of the document (so we can decide what way of tag colouring we need; if that has been fixed in an other way, this method can be removed again.).

Returns:

requestFocus

public void requestFocus()

Set current focus to editor.

Specified by:

requestFocus in interface IEditor

getCurrentEntry

public SourceTextEntry getCurrentEntry()

Get current active entry. Can be called from any thread.

Specified by:

getCurrentEntry in interface IEditor

getCurrentSegmentBuilder

public SegmentBuilder getCurrentSegmentBuilder()

getCurrentFile

public java.lang.String getCurrentFile()

Get relative path (under source) of the source file currently open in the editor.

Can be called from any thread.

Specified by:

getCurrentFile in interface IEditor

getCurrentTargetFile

public java.lang.String getCurrentTargetFile()

Description copied from interface: IEditor

Get the relative path (under target) of the target file corresponding to the current source file (per IEditor.getCurrentFile()). This file is what is created upon doing Create Target Documents, but it may not exist yet.

Can be called from any thread.

Specified by:

getCurrentTargetFile in interface IEditor

loadDocument

protected void loadDocument()

Displays the Preferences.EDITOR_INITIAL_SEGMENT_LOAD_COUNT segments surrounding the entry with index displayedEntryIndex.

activateEntry

public void activateEntry()

Description copied from interface: IEditor

Activate entry for edit. Must be called only from UI thread. Will position cursor at the start of segment

Specified by:

activateEntry in interface IEditor

activateEntry

public void activateEntry(IEditor.CaretPosition pos)

Activates the current entry (if available) by displaying source text and embedding displayed text in markers.

Also moves document focus to current entry, and makes sure fuzzy info displayed if available.

showStat

public void showStat()

Calculate statistic for file, request statistic for project and display in status bar.

goToSegmentAtLocation

protected boolean goToSegmentAtLocation(int location)

Go to segment at specified location.

Parameters:

location - location

Returns:

true if segment changed, false if location inside current segment

getSegmentIndexAtLocation

protected int getSegmentIndexAtLocation(int location)

refreshEntries

public void refreshEntries(java.util.Set<java.lang.Integer> entryNumbers)

Refresh some entries. Usually after external translation changes replacement.

commitAndDeactivate

public void commitAndDeactivate()

Commits the translation. Reads current entry text and commit it to memory if it's changed. Also clears out segment markers while we're at it.

Since 1.6: Translation equal to source may be validated as OK translation if appropriate option is set in Workflow options dialog.

All displayed segments with the same source text updated also.

Specified by:

commitAndDeactivate in interface IEditor

deactivateWithoutCommit

protected void deactivateWithoutCommit()

Deactivate active translation without save. Required on project close postprocessing, for example.

commitAndLeave

public void commitAndLeave()

Commits the translation and leave entry activated. Translation will be saved. Must be called only from UI thread.

Specified by:

commitAndLeave in interface IEditor

nextEntry

public void nextEntry()

Description copied from interface: IEditor

Move to next entry. Must be called only from UI thread.

Specified by:

nextEntry in interface IEditor

prevEntry

public void prevEntry()

Description copied from interface: IEditor

Move to previous entry. Must be called only from UI thread.

Specified by:

prevEntry in interface IEditor

nextUntranslatedEntry

public void nextUntranslatedEntry()

Finds the next untranslated entry in the document.

Specified by:

nextUntranslatedEntry in interface IEditor

nextTranslatedEntry

public void nextTranslatedEntry()

Finds the next translated entry in the document.

Specified by:

nextTranslatedEntry in interface IEditor

nextEntryWithNote

public void nextEntryWithNote()

Finds the next entry with a non-empty note.

Specified by:

nextEntryWithNote in interface IEditor

prevEntryWithNote

public void prevEntryWithNote()

Finds the previous entry with a non-empty note.

Specified by:

prevEntryWithNote in interface IEditor

nextUniqueEntry

public void nextUniqueEntry()

Find the next unique entry.

Specified by:

nextUniqueEntry in interface IEditor

getCurrentEntryNumber

public int getCurrentEntryNumber()

Get current active entry number. Can be called from any thread.

Specified by:

getCurrentEntryNumber in interface IEditor

gotoFile

public void gotoFile(int fileIndex)

Goto first entry in specified file.

Specified by:

gotoFile in interface IEditor

Parameters:

fileIndex - file index in project

gotoEntry

public void gotoEntry(int entryNum)

Goto entry with specified number. Convenience method for IEditor.gotoEntry(int, CaretPosition) where the caret position will be the start of the entry.

Specified by:

gotoEntry in interface IEditor

Parameters:

entryNum - entry number, starts from 1 Must be called only from UI thread.

gotoEntry

public void gotoEntry(int entryNum,
                      IEditor.CaretPosition pos)

Description copied from interface: IEditor

Goto entry with specified number, and restore caret to specified position.

Specified by:

gotoEntry in interface IEditor

Parameters:

entryNum - entry number, starts from 1 Must be called only from UI thread.

gotoEntry

public void gotoEntry(java.lang.String srcString,
                      EntryKey key)

Description copied from interface: IEditor

Goto entry based on a string and entry key.

Specified by:

gotoEntry in interface IEditor

Parameters:

srcString - entry source string

key - entry key (can be null) Must be called only from UI thread.

gotoEntryAfterFix

public void gotoEntryAfterFix(int entryNum,
                              java.lang.String fixedSource)

Description copied from interface: IEditor

Goto entry with specified number while avoiding clobbering the tag fixes.

Specified by:

gotoEntryAfterFix in interface IEditor

Parameters:

entryNum - entry number, starts from 1

fixedSource - The source of the entry that was fixed Must be called only from UI thread.

refreshViewAfterFix

public void refreshViewAfterFix(java.util.List<java.lang.Integer> fixedEntries)

Description copied from interface: IEditor

Refresh the current editor view while avoiding clobbering any tag fixes.

Specified by:

refreshViewAfterFix in interface IEditor

Parameters:

fixedEntries - A list of all entries that were altered Must be called only from UI thread.

refreshView

public void refreshView(boolean doCommit)

Specified by:

refreshView in interface IEditor

changeCase

public void changeCase(IEditor.CHANGE_CASE_TO toWhat)

Change case of the selected text or if none is selected, of the current word.

Specified by:

changeCase in interface IEditor

Parameters:

toWhat - : lower, title, upper or cycle

replaceEditText

public void replaceEditText(java.lang.String text)

Replaces the entire edit area with a given text. Must be called only from UI thread.

Specified by:

replaceEditText in interface IEditor

replacePartOfText

public void replacePartOfText(java.lang.String text,
                              int start,
                              int end)

replaceEditTextAndMark

public void replaceEditTextAndMark(java.lang.String text)

Inserts text at the cursor position and mark as to be changed by the translator, i.e, background of segment should be marked Must be called only from UI thread.

Specified by:

replaceEditTextAndMark in interface IEditor

getCurrentTranslation

public java.lang.String getCurrentTranslation()

Description copied from interface: IEditor

Returns current translation or null.

Specified by:

getCurrentTranslation in interface IEditor

getCurrentPositionInEntryTranslation

public int getCurrentPositionInEntryTranslation()

Returns current caret position in the editable translation.

getPositionInEntryTranslation

public int getPositionInEntryTranslation(int pos)

Returns the relative caret position in the editable translation for a given absolute index into the overall editor document.

setCaretPosition

public void setCaretPosition(IEditor.CaretPosition pos)

insertText

public void insertText(java.lang.String text)

Inserts text at the cursor position. Must be called only from UI thread.

Specified by:

insertText in interface IEditor

insertTextAndMark

public void insertTextAndMark(java.lang.String text)

Inserts text at the cursor position and mark as to be changed by the translator, i.e, background of segment should be marked Must be called only from UI thread.

Specified by:

insertTextAndMark in interface IEditor

Parameters:

text - The text to insert

insertTag

public void insertTag(java.lang.String tag)

Description copied from interface: IEditor

Inserts tag at the cursor position, probably with adding bidi control chars. Must be called only from UI thread.

Specified by:

insertTag in interface IEditor

gotoHistoryBack

public void gotoHistoryBack()

Go to previous segment from history. Must be called only from UI thread.

Specified by:

gotoHistoryBack in interface IEditor

gotoHistoryForward

public void gotoHistoryForward()

Go to next segment from history. Must be called only from UI thread.

Specified by:

gotoHistoryForward in interface IEditor

getSettings

public EditorSettings getSettings()

Get settings instance.

Specified by:

getSettings in interface IEditor

Returns:

interface for read and change editor settings Can be called from any thread.

undo

public void undo()

Undo editing. Must be called only from UI thread.

Specified by:

undo in interface IEditor

redo

public void redo()

Redo editing. Must be called only from UI thread.

Specified by:

redo in interface IEditor

getSelectedText

public java.lang.String getSelectedText()

Get currently selected text.

Specified by:

getSelectedText in interface IEditor

Returns:

selected text Must be called only from UI thread.

remarkOneMarker

public void remarkOneMarker(java.lang.String markerClassName)

Calls specified marker for reprocess all entries.

Specified by:

remarkOneMarker in interface IEditor

markActiveEntrySource

public void markActiveEntrySource(SourceTextEntry requiredActiveEntry,
                                  java.util.List<Mark> marks,
                                  java.lang.String markerClassName)

All plugins can call this method for mark something in active entry.

Specified by:

markActiveEntrySource in interface IEditor

Parameters:

requiredActiveEntry - entry which should be active. If user moved to other entry, then marks will be skipped

marks - list of marks

markerClassName - marker's class name

registerPopupMenuConstructors

public void registerPopupMenuConstructors(int priority,
                                          IPopupMenuConstructor constructor)

Description copied from interface: IEditor

Register constructor of popup menu.

Specified by:

registerPopupMenuConstructors in interface IEditor

Parameters:

priority - priority of process order

constructor - constructor instance

getFilter

public IEditorFilter getFilter()

Description copied from interface: IEditor

Gets a filter for this editor, or null if filter doesn't applied.

Specified by:

getFilter in interface IEditor

setFilter

public void setFilter(IEditorFilter filter)

Sets a filter to this editor. The filter causes only the selected entries to be shown in the editor. Document is reloaded to immediately have the filter being effective.

Specified by:

setFilter in interface IEditor

Parameters:

filter - Filter instance

removeFilter

public void removeFilter()

Removes the current filter. Document is reloaded if appropriate to immediately remove the filter;

Specified by:

removeFilter in interface IEditor

setAlternateTranslationForCurrentEntry

public void setAlternateTranslationForCurrentEntry(boolean alternate)

Set default/alternate translation for current entry.

Specified by:

setAlternateTranslationForCurrentEntry in interface IEditor

registerUntranslated

public void registerUntranslated()

Description copied from interface: IEditor

Register untranslated.

Specified by:

registerUntranslated in interface IEditor

registerEmptyTranslation

public void registerEmptyTranslation()

Description copied from interface: IEditor

Register as empty.

Specified by:

registerEmptyTranslation in interface IEditor

registerIdenticalTranslation

public void registerIdenticalTranslation()

Description copied from interface: IEditor

Register translation to be identical to source.

Specified by:

registerIdenticalTranslation in interface IEditor

windowDeactivated

public void windowDeactivated()

Description copied from interface: IEditor

Perform any necessary actions for window deactivation.

Specified by:

windowDeactivated in interface IEditor

getAlphabeticalMarkers

public AlphabeticalMarkers getAlphabeticalMarkers()

getAutoCompleter

public IAutoCompleter getAutoCompleter()

Description copied from interface: IEditor

Access the AutoCompleter

Specified by:

getAutoCompleter in interface IEditor