org.omegat.gui.editor

Class Document3

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.DefaultStyledDocument

org.omegat.gui.editor.Document3

All Implemented Interfaces:

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

public class Document3
extends javax.swing.text.DefaultStyledDocument

We need to redefine some standard document behavior.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document3.ORIENTATION

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
protected EditorController	controller
protected boolean	textBeingComposed Flag to indicate that text is currently being composed (should not be considered to have been input yet) by an IME.
protected boolean	trustedChangesInProgress Flag for check internal changes of content, which should be always acceptable.

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
Document3(EditorController controller)

Method Summary

Modifier and Type	Method and Description
protected int	getTranslationEnd() Calculate the position of the end of the current translation
int	getTranslationStart() Calculate the position of the start of the current translation
protected void	setAlignment(int beginOffset, int endOffset, boolean isRightAlignment) Set alignment for specified part of text.

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, insertString, postRemoveUpdate, putProperty, readLock, readUnlock, remove, 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, insertString, putProperty, remove, removeUndoableEditListener, render

Field Detail

controller

protected final EditorController controller

trustedChangesInProgress

protected boolean trustedChangesInProgress

Flag for check internal changes of content, which should be always acceptable.

Note that there is a concurrency bug with the AquaCaret class (part of the OS X native LAF) whereby insertion into the Document while the doc is visible can cause the caret to try to update itself while the doc internals are inconsistent, leading to exceptions whenever any visual update of the Editor is performed (the Editor becomes unusable).

This bug is very old (reported as early as February 2006) and appears to not have been addressed even in December 2015 in Java 1.8.0_66), though it is very hard to reproduce (it appears to be a concurrency issue that only manifests itself under certain circumstances).

There is a chance that the "real" bug is in the way we are manipulating the JEditorPane and/or the underlying document, but it is unclear what the correct solution would be.

As a workaround, when setting this flag to true, if the changes are to include insertions or deletions of text in the document, you must also disable the editor's caret updates temporarily (e.g. with StaticUIUtils#setCaretUpdateEnabled()). After the document changes are complete and you have set this flag back to false, caret update can be re-enabled.

See Also:

Initial ticket, Later, more specific ticket

textBeingComposed

protected boolean textBeingComposed

Flag to indicate that text is currently being composed (should not be considered to have been input yet) by an IME.

Constructor Detail

Document3

public Document3(EditorController controller)

Method Detail

getTranslationStart

public int getTranslationStart()

Calculate the position of the start of the current translation

getTranslationEnd

protected int getTranslationEnd()

Calculate the position of the end of the current translation

setAlignment

protected void setAlignment(int beginOffset,
                            int endOffset,
                            boolean isRightAlignment)

Set alignment for specified part of text.

Parameters:

beginOffset - begin offset

endOffset - end offset

isRightAlignment - false - left alignment, true - right alignment