]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.utils.ui/src/org/simantics/utils/ui/widgets/TrackedStyledText.java
Fixed all line endings of the repository
[simantics/platform.git] / bundles / org.simantics.utils.ui / src / org / simantics / utils / ui / widgets / TrackedStyledText.java
index 58452f9b6c93e579829bd57048843de5c6c1ad91..864c6840209e0fe9d69ded1683f3d3ff49ea763f 100644 (file)
-/*******************************************************************************\r
- * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
- * in Industry THTH ry.\r
- * All rights reserved. This program and the accompanying materials\r
- * are made available under the terms of the Eclipse Public License v1.0\r
- * which accompanies this distribution, and is available at\r
- * http://www.eclipse.org/legal/epl-v10.html\r
- *\r
- * Contributors:\r
- *     VTT Technical Research Centre of Finland - initial API and implementation\r
- *******************************************************************************/\r
-package org.simantics.utils.ui.widgets;\r
-\r
-import org.eclipse.core.runtime.Assert;\r
-import org.eclipse.core.runtime.ListenerList;\r
-import org.eclipse.jface.dialogs.IInputValidator;\r
-import org.eclipse.jface.resource.ColorDescriptor;\r
-import org.eclipse.jface.resource.JFaceResources;\r
-import org.eclipse.jface.resource.LocalResourceManager;\r
-import org.eclipse.jface.resource.ResourceManager;\r
-import org.eclipse.swt.SWT;\r
-import org.eclipse.swt.custom.CaretEvent;\r
-import org.eclipse.swt.custom.CaretListener;\r
-import org.eclipse.swt.custom.StyledText;\r
-import org.eclipse.swt.events.DisposeEvent;\r
-import org.eclipse.swt.events.DisposeListener;\r
-import org.eclipse.swt.events.FocusEvent;\r
-import org.eclipse.swt.events.FocusListener;\r
-import org.eclipse.swt.events.KeyEvent;\r
-import org.eclipse.swt.events.KeyListener;\r
-import org.eclipse.swt.events.ModifyEvent;\r
-import org.eclipse.swt.events.ModifyListener;\r
-import org.eclipse.swt.events.MouseEvent;\r
-import org.eclipse.swt.events.MouseListener;\r
-import org.eclipse.swt.events.MouseTrackListener;\r
-import org.eclipse.swt.graphics.Color;\r
-import org.eclipse.swt.graphics.RGB;\r
-import org.eclipse.swt.widgets.Composite;\r
-\r
-/**\r
- * This is a TrackedTest SWT Text-widget 'decorator'.\r
- * \r
- * The widget has 2 main states: editing and inactive.\r
- * \r
- * It implements the necessary listeners to achieve the text widget behaviour\r
- * needed by Simantics. User notification about modifications is provided via\r
- * {@link TrackedModifyListener}.\r
- * \r
- * Examples:\r
- * \r
- * <pre>\r
- * // #1: create new Text internally, use TrackedModifylistener\r
- * TrackedText trackedText = new TrackedText(parentComposite, style);\r
- * trackedText.addModifyListener(new TrackedModifyListener() {\r
- *     public void modifyText(TrackedModifyEvent e) {\r
- *         // text was modified, do something.\r
- *     }\r
- * });\r
- * \r
- * // #2: create new Text internally, define the colors for text states.\r
- * TrackedText trackedText = new TrackedText(text, &lt;instance of ITrackedColorProvider&gt;);\r
- * </pre>\r
- * \r
- * @author Tuukka Lehtonen\r
- */\r
-public class TrackedStyledText {\r
-    private static final int      EDITING                 = 1 << 0;\r
-    private static final int      MODIFIED_DURING_EDITING = 1 << 1;\r
-\r
-    /**\r
-     * Used to tell whether or not a mouseDown has occurred after a focusGained\r
-     * event to be able to select the whole text field when it is pressed for\r
-     * the first time while the widget holds focus.\r
-     */\r
-    private static final int      MOUSE_DOWN_FIRST_TIME   = 1 << 2;\r
-    private static final int      MOUSE_INSIDE_CONTROL    = 1 << 3;\r
-\r
-    private int                   state;\r
-\r
-    private int                   caretPositionBeforeEdit;\r
-\r
-    private String                textBeforeEdit;\r
-\r
-    private final StyledText                  text;\r
-\r
-    private CompositeListener     listener;\r
-\r
-    private ListenerList          caretListeners;\r
-\r
-    private ListenerList          modifyListeners;\r
-\r
-    private IInputValidator       validator;\r
-\r
-    private ITrackedColorProvider colorProvider;\r
-\r
-    private ResourceManager       resourceManager;\r
-\r
-    private class DefaultColorProvider implements ITrackedColorProvider {\r
-        private final ColorDescriptor highlightColor = ColorDescriptor.createFrom(new RGB(254, 255, 197));\r
-        private final ColorDescriptor inactiveColor = ColorDescriptor.createFrom(new RGB(245, 246, 190));\r
-        private final ColorDescriptor invalidInputColor = ColorDescriptor.createFrom(new RGB(255, 128, 128));\r
-\r
-        @Override\r
-        public Color getEditingBackground() {\r
-            return null;\r
-        }\r
-\r
-        @Override\r
-        public Color getHoverBackground() {\r
-            return resourceManager.createColor(highlightColor);\r
-        }\r
-\r
-        @Override\r
-        public Color getInactiveBackground() {\r
-            return resourceManager.createColor(inactiveColor);\r
-        }\r
-\r
-        @Override\r
-        public Color getInvalidBackground() {\r
-            return resourceManager.createColor(invalidInputColor);\r
-        }\r
-    };\r
-\r
-    /**\r
-     * A composite of many UI listeners for creating the functionality of this\r
-     * class.\r
-     */\r
-    private class CompositeListener\r
-    implements ModifyListener, DisposeListener, KeyListener, MouseTrackListener,\r
-    MouseListener, FocusListener, CaretListener\r
-    {\r
-        // Keyboard/editing events come in the following order:\r
-        //   1. keyPressed\r
-        //   2. verifyText\r
-        //   3. modifyText\r
-        //   4. keyReleased\r
-\r
-        public void modifyText(ModifyEvent e) {\r
-            //System.out.println("modifyText: " + e);\r
-            setModified(true);\r
-\r
-            String valid = isTextValid();\r
-            if (valid != null) {\r
-                setBackground(colorProvider.getInvalidBackground());\r
-            } else {\r
-                if (isEditing())\r
-                    setBackground(colorProvider.getEditingBackground());\r
-                else\r
-                    setBackground(colorProvider.getInactiveBackground());\r
-            }\r
-        }\r
-\r
-        public void widgetDisposed(DisposeEvent e) {\r
-            getWidget().removeModifyListener(this);\r
-        }\r
-\r
-        private boolean isMultiLine() {\r
-            return (text.getStyle() & SWT.MULTI) != 0;\r
-        }\r
-\r
-        private boolean hasMultiLineCommitModifier(KeyEvent e) {\r
-            return (e.stateMask & SWT.CTRL) != 0;\r
-        }\r
-\r
-        public void keyPressed(KeyEvent e) {\r
-            //System.out.println("keyPressed: " + e);\r
-            if (!isEditing()) {\r
-                // ESC, ENTER & keypad ENTER must not start editing\r
-                if (e.keyCode == SWT.ESC)\r
-                    return;\r
-\r
-                if (!isMultiLine()) {\r
-                    if (e.keyCode == SWT.F2 || e.keyCode == SWT.CR || e.keyCode == SWT.KEYPAD_CR) {\r
-                        startEdit(true);\r
-                    } else if (e.character != '\0') {\r
-                        startEdit(false);\r
-                    }\r
-                } else {\r
-                    // In multi-line mode, TAB must not start editing!\r
-                    if (e.keyCode == SWT.F2) {\r
-                        startEdit(true);\r
-                    } else if (e.keyCode == SWT.CR || e.keyCode == SWT.KEYPAD_CR) {\r
-                        if (hasMultiLineCommitModifier(e)) {\r
-                            e.doit = false;\r
-                        } else {\r
-                            startEdit(false);\r
-                        }\r
-                    } else if (e.keyCode == SWT.TAB) {\r
-                        text.traverse(((e.stateMask & SWT.SHIFT) != 0) ? SWT.TRAVERSE_TAB_PREVIOUS : SWT.TRAVERSE_TAB_NEXT);\r
-                        e.doit = false;\r
-                    } else if (e.character != '\0') {\r
-                        startEdit(false);\r
-                    }\r
-                }\r
-            } else {\r
-                // ESC reverts any changes made during this edit\r
-                if (e.keyCode == SWT.ESC) {\r
-                    revertEdit();\r
-                }\r
-                if (!isMultiLine()) {\r
-                    if (e.keyCode == SWT.CR || e.keyCode == SWT.KEYPAD_CR) {\r
-                        applyEdit();\r
-                    }\r
-                } else {\r
-                    if (e.keyCode == SWT.CR || e.keyCode == SWT.KEYPAD_CR) {\r
-                        if (hasMultiLineCommitModifier(e)) {\r
-                            applyEdit();\r
-                            e.doit = false;\r
-                        }\r
-                    }\r
-                }\r
-            }\r
-        }\r
-\r
-        public void keyReleased(KeyEvent e) {\r
-            //System.out.println("keyReleased: " + e);\r
-        }\r
-\r
-        public void mouseEnter(MouseEvent e) {\r
-            //System.out.println("mouseEnter");\r
-            if (!isEditing()) {\r
-                setBackground(colorProvider.getHoverBackground());\r
-            }\r
-            setMouseInsideControl(true);\r
-        }\r
-\r
-        public void mouseExit(MouseEvent e) {\r
-            //System.out.println("mouseExit");\r
-            if (!isEditing()) {\r
-                setBackground(colorProvider.getInactiveBackground());\r
-            }\r
-            setMouseInsideControl(false);\r
-        }\r
-\r
-        public void mouseHover(MouseEvent e) {\r
-            //System.out.println("mouseHover");\r
-            setMouseInsideControl(true);\r
-        }\r
-\r
-        public void mouseDoubleClick(MouseEvent e) {\r
-            //System.out.println("mouseDoubleClick: " + e);\r
-            if (e.button == 1) {\r
-                getWidget().selectAll();\r
-            }\r
-        }\r
-\r
-        public void mouseDown(MouseEvent e) {\r
-            //System.out.println("mouseDown: " + e);\r
-            if (!isEditing()) {\r
-                // In reality we should never get here, since focusGained\r
-                // always comes before mouseDown, but let's keep this\r
-                // fallback just to be safe.\r
-                if (e.button == 1) {\r
-                    startEdit(false);\r
-                }\r
-            } else {\r
-                if (e.button == 1 && (state & MOUSE_DOWN_FIRST_TIME) != 0) {\r
-                    getWidget().selectAll();\r
-                    state &= ~MOUSE_DOWN_FIRST_TIME;\r
-                }\r
-            }\r
-        }\r
-\r
-        public void mouseUp(MouseEvent e) {\r
-        }\r
-\r
-        public void focusGained(FocusEvent e) {\r
-            //System.out.println("focusGained");\r
-            if (!isEditing()) {\r
-                if (!isMultiLine()) {\r
-                    // Always start edit on single line texts when focus is gained\r
-                    startEdit(true);\r
-                }\r
-            }\r
-        }\r
-\r
-        public void focusLost(FocusEvent e) {\r
-            //System.out.println("focusLost");\r
-            if (isEditing()) {\r
-                applyEdit();\r
-            }\r
-        }\r
-\r
-               @Override\r
-               public void caretMoved(CaretEvent event) {\r
-                       fireCaretListeners();\r
-               }\r
-    }\r
-\r
-    public TrackedStyledText(StyledText text) {\r
-        Assert.isNotNull(text);\r
-        this.state = 0;\r
-        this.text = text;\r
-        this.resourceManager = new LocalResourceManager(JFaceResources.getResources(), text);\r
-        this.colorProvider = new DefaultColorProvider();\r
-\r
-        initialize();\r
-    }\r
-\r
-    public TrackedStyledText(Composite parent, int style) {\r
-        this.state = 0;\r
-        this.text = new StyledText(parent, style);\r
-        this.resourceManager = new LocalResourceManager(JFaceResources.getResources(), text);\r
-        this.colorProvider = new DefaultColorProvider();\r
-\r
-        initialize();\r
-    }\r
-\r
-    public TrackedStyledText(StyledText text, ITrackedColorProvider colorProvider) {\r
-        Assert.isNotNull(text, "text must not be null");\r
-        Assert.isNotNull(colorProvider, "colorProvider must not be null");\r
-        this.state = 0;\r
-        this.text = text;\r
-        this.colorProvider = colorProvider;\r
-\r
-        initialize();\r
-    }\r
-\r
-    public TrackedStyledText(Composite parent, int style, ITrackedColorProvider colorProvider) {\r
-        Assert.isNotNull(colorProvider, "colorProvider must not be null");\r
-        this.state = 0;\r
-        this.text = new StyledText(parent, style);\r
-        this.colorProvider = colorProvider;\r
-\r
-        initialize();\r
-    }\r
-\r
-    /**\r
-     * Common initialization. Assumes that text is already created.\r
-     */\r
-    private void initialize() {\r
-        Assert.isNotNull(text);\r
-\r
-        text.setBackground(colorProvider.getInactiveBackground());\r
-        text.setDoubleClickEnabled(false);\r
-\r
-        listener = new CompositeListener();\r
-\r
-        text.addModifyListener(listener);\r
-        text.addDisposeListener(listener);\r
-        text.addKeyListener(listener);\r
-        text.addMouseTrackListener(listener);\r
-        text.addMouseListener(listener);\r
-        text.addFocusListener(listener);\r
-        text.addCaretListener(listener);\r
-    }\r
-\r
-    private void startEdit(boolean selectAll) {\r
-        if (isEditing()) {\r
-            // Print some debug incase we end are in an invalid state\r
-            System.out.println("TrackedText: BUG: startEdit called when in editing state");\r
-        }\r
-        System.out.println("start edit: selectall=" + selectAll + ", text=" + text.getText() + ", caretpos=" + caretPositionBeforeEdit);\r
-\r
-        // Backup text-field data for reverting purposes\r
-        caretPositionBeforeEdit = text.getCaretOffset();\r
-        textBeforeEdit = text.getText();\r
-\r
-        // Signal editing state\r
-        setBackground(colorProvider.getEditingBackground());\r
-\r
-        if (selectAll) {\r
-            text.selectAll();\r
-        }\r
-        state |= EDITING | MOUSE_DOWN_FIRST_TIME;\r
-    }\r
-\r
-    private void applyEdit() {\r
-       System.err.println("apply edit");\r
-        try {\r
-            if (isTextValid() != null) {\r
-                text.setText(textBeforeEdit);\r
-            } else if (isModified() && !text.getText().equals(textBeforeEdit)) {\r
-                //System.out.println("apply");\r
-                if (modifyListeners != null) {\r
-                    TrackedModifyEvent event = new TrackedModifyEvent(text, text.getText());\r
-                    for (Object o : modifyListeners.getListeners()) {\r
-                        ((TrackedModifyListener) o).modifyText(event);\r
-                    }\r
-                }\r
-            }\r
-        } finally {\r
-            endEdit();\r
-        }\r
-    }\r
-    \r
-    private void fireCaretListeners() {\r
-        if (caretListeners != null) {\r
-            for (Object o : caretListeners.getListeners()) {\r
-                ((TrackedCaretListener) o).caretOrSelectionChanged();\r
-            }\r
-        }\r
-    }\r
-\r
-    private void endEdit() {\r
-       System.err.println("endedit");\r
-        if (!isEditing()) {\r
-            // Print some debug incase we end are in an invalid state\r
-            //ExceptionUtils.logError(new Exception("BUG: endEdit called when not in editing state"));\r
-            System.out.println();\r
-        }\r
-        setBackground(isMouseInsideControl() ? colorProvider.getHoverBackground() : colorProvider.getInactiveBackground());\r
-        //System.out.println("endEdit: " + text.getText() + ", caret: " + text.getCaretLocation() + ", selection: " + text.getSelection());\r
-        // Always move the caret to the end of the string\r
-        //text.setSelection(text.getCharCount());\r
-        state &= ~(EDITING | MOUSE_DOWN_FIRST_TIME);\r
-        setModified(false);\r
-    }\r
-\r
-    private void revertEdit() {\r
-        if (!isEditing()) {\r
-            // Print some debug incase we end are in an invalid state\r
-            //ExceptionUtils.logError(new Exception("BUG: revertEdit called when not in editing state"));\r
-            System.out.println("BUG: revertEdit called when not in editing state");\r
-        }\r
-        text.setText(textBeforeEdit);\r
-        text.setSelection(caretPositionBeforeEdit);\r
-        setBackground(isMouseInsideControl() ? colorProvider.getHoverBackground() : colorProvider.getInactiveBackground());\r
-        state &= ~(EDITING | MOUSE_DOWN_FIRST_TIME);\r
-        setModified(false);\r
-    }\r
-\r
-    public boolean isEditing() {\r
-        return (state & EDITING) != 0;\r
-    }\r
-\r
-    private void setModified(boolean modified) {\r
-        if (modified) {\r
-            state |= MODIFIED_DURING_EDITING;\r
-        } else {\r
-            state &= ~MODIFIED_DURING_EDITING;\r
-        }\r
-    }\r
-\r
-    private boolean isMouseInsideControl() {\r
-        return (state & MOUSE_INSIDE_CONTROL) != 0;\r
-    }\r
-\r
-    private void setMouseInsideControl(boolean inside) {\r
-        if (inside)\r
-            state |= MOUSE_INSIDE_CONTROL;\r
-        else\r
-            state &= ~MOUSE_INSIDE_CONTROL;\r
-    }\r
-\r
-    public boolean isModified() {\r
-        return (state & MODIFIED_DURING_EDITING) != 0;\r
-    }\r
-\r
-    public void setEditable(boolean editable) {\r
-        if (editable) {\r
-            text.setEditable(true);\r
-            setBackground(isMouseInsideControl() ? colorProvider.getHoverBackground() : colorProvider.getInactiveBackground());\r
-        } else {\r
-            text.setEditable(false);\r
-            text.setBackground(null);\r
-        }\r
-    }\r
-\r
-    public void setText(String text) {\r
-        this.text.setText(text);\r
-    }\r
-\r
-    public void setTextWithoutNotify(String text) {\r
-        this.text.removeModifyListener(listener);\r
-        setText(text);\r
-        this.text.addModifyListener(listener);\r
-    }\r
-\r
-    public StyledText getWidget() {\r
-        return text;\r
-    }\r
-\r
-    public synchronized void addModifyListener(TrackedModifyListener listener) {\r
-        if (modifyListeners == null) {\r
-            modifyListeners = new ListenerList(ListenerList.IDENTITY);\r
-        }\r
-        modifyListeners.add(listener);\r
-    }\r
-\r
-    public synchronized void addCaretListener(TrackedCaretListener listener) {\r
-        if (caretListeners == null) {\r
-            caretListeners = new ListenerList(ListenerList.IDENTITY);\r
-        }\r
-        caretListeners.add(listener);\r
-    }\r
-\r
-    public synchronized void removeModifyListener(TrackedModifyListener listener) {\r
-        if (modifyListeners == null)\r
-            return;\r
-        modifyListeners.remove(listener);\r
-    }\r
-\r
-    public synchronized void removeCaretListener(TrackedCaretListener listener) {\r
-        if (caretListeners == null)\r
-            return;\r
-        caretListeners.remove(listener);\r
-    }\r
-\r
-    public void setInputValidator(IInputValidator validator) {\r
-        if (validator != this.validator) {\r
-            this.validator = validator;\r
-        }\r
-    }\r
-\r
-    private String isTextValid() {\r
-        if (validator != null) {\r
-            return validator.isValid(getWidget().getText());\r
-        }\r
-        return null;\r
-    }\r
-\r
-    public void setColorProvider(ITrackedColorProvider provider) {\r
-        Assert.isNotNull(provider);\r
-        this.colorProvider = provider;\r
-    }\r
-\r
-    private void setBackground(Color background) {\r
-        if (!text.getEditable()) {\r
-            // Do not alter background when the widget is not editable.\r
-            return;\r
-        }\r
-        text.setBackground(background);\r
-    }\r
-\r
-}\r
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.utils.ui.widgets;
+
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.ListenerList;
+import org.eclipse.jface.dialogs.IInputValidator;
+import org.eclipse.jface.resource.ColorDescriptor;
+import org.eclipse.jface.resource.JFaceResources;
+import org.eclipse.jface.resource.LocalResourceManager;
+import org.eclipse.jface.resource.ResourceManager;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.custom.CaretEvent;
+import org.eclipse.swt.custom.CaretListener;
+import org.eclipse.swt.custom.StyledText;
+import org.eclipse.swt.events.DisposeEvent;
+import org.eclipse.swt.events.DisposeListener;
+import org.eclipse.swt.events.FocusEvent;
+import org.eclipse.swt.events.FocusListener;
+import org.eclipse.swt.events.KeyEvent;
+import org.eclipse.swt.events.KeyListener;
+import org.eclipse.swt.events.ModifyEvent;
+import org.eclipse.swt.events.ModifyListener;
+import org.eclipse.swt.events.MouseEvent;
+import org.eclipse.swt.events.MouseListener;
+import org.eclipse.swt.events.MouseTrackListener;
+import org.eclipse.swt.graphics.Color;
+import org.eclipse.swt.graphics.RGB;
+import org.eclipse.swt.widgets.Composite;
+
+/**
+ * This is a TrackedTest SWT Text-widget 'decorator'.
+ * 
+ * The widget has 2 main states: editing and inactive.
+ * 
+ * It implements the necessary listeners to achieve the text widget behaviour
+ * needed by Simantics. User notification about modifications is provided via
+ * {@link TrackedModifyListener}.
+ * 
+ * Examples:
+ * 
+ * <pre>
+ * // #1: create new Text internally, use TrackedModifylistener
+ * TrackedText trackedText = new TrackedText(parentComposite, style);
+ * trackedText.addModifyListener(new TrackedModifyListener() {
+ *     public void modifyText(TrackedModifyEvent e) {
+ *         // text was modified, do something.
+ *     }
+ * });
+ * 
+ * // #2: create new Text internally, define the colors for text states.
+ * TrackedText trackedText = new TrackedText(text, &lt;instance of ITrackedColorProvider&gt;);
+ * </pre>
+ * 
+ * @author Tuukka Lehtonen
+ */
+public class TrackedStyledText {
+    private static final int      EDITING                 = 1 << 0;
+    private static final int      MODIFIED_DURING_EDITING = 1 << 1;
+
+    /**
+     * Used to tell whether or not a mouseDown has occurred after a focusGained
+     * event to be able to select the whole text field when it is pressed for
+     * the first time while the widget holds focus.
+     */
+    private static final int      MOUSE_DOWN_FIRST_TIME   = 1 << 2;
+    private static final int      MOUSE_INSIDE_CONTROL    = 1 << 3;
+
+    private int                   state;
+
+    private int                   caretPositionBeforeEdit;
+
+    private String                textBeforeEdit;
+
+    private final StyledText                  text;
+
+    private CompositeListener     listener;
+
+    private ListenerList          caretListeners;
+
+    private ListenerList          modifyListeners;
+
+    private IInputValidator       validator;
+
+    private ITrackedColorProvider colorProvider;
+
+    private ResourceManager       resourceManager;
+
+    private class DefaultColorProvider implements ITrackedColorProvider {
+        private final ColorDescriptor highlightColor = ColorDescriptor.createFrom(new RGB(254, 255, 197));
+        private final ColorDescriptor inactiveColor = ColorDescriptor.createFrom(new RGB(245, 246, 190));
+        private final ColorDescriptor invalidInputColor = ColorDescriptor.createFrom(new RGB(255, 128, 128));
+
+        @Override
+        public Color getEditingBackground() {
+            return null;
+        }
+
+        @Override
+        public Color getHoverBackground() {
+            return resourceManager.createColor(highlightColor);
+        }
+
+        @Override
+        public Color getInactiveBackground() {
+            return resourceManager.createColor(inactiveColor);
+        }
+
+        @Override
+        public Color getInvalidBackground() {
+            return resourceManager.createColor(invalidInputColor);
+        }
+    };
+
+    /**
+     * A composite of many UI listeners for creating the functionality of this
+     * class.
+     */
+    private class CompositeListener
+    implements ModifyListener, DisposeListener, KeyListener, MouseTrackListener,
+    MouseListener, FocusListener, CaretListener
+    {
+        // Keyboard/editing events come in the following order:
+        //   1. keyPressed
+        //   2. verifyText
+        //   3. modifyText
+        //   4. keyReleased
+
+        public void modifyText(ModifyEvent e) {
+            //System.out.println("modifyText: " + e);
+            setModified(true);
+
+            String valid = isTextValid();
+            if (valid != null) {
+                setBackground(colorProvider.getInvalidBackground());
+            } else {
+                if (isEditing())
+                    setBackground(colorProvider.getEditingBackground());
+                else
+                    setBackground(colorProvider.getInactiveBackground());
+            }
+        }
+
+        public void widgetDisposed(DisposeEvent e) {
+            getWidget().removeModifyListener(this);
+        }
+
+        private boolean isMultiLine() {
+            return (text.getStyle() & SWT.MULTI) != 0;
+        }
+
+        private boolean hasMultiLineCommitModifier(KeyEvent e) {
+            return (e.stateMask & SWT.CTRL) != 0;
+        }
+
+        public void keyPressed(KeyEvent e) {
+            //System.out.println("keyPressed: " + e);
+            if (!isEditing()) {
+                // ESC, ENTER & keypad ENTER must not start editing
+                if (e.keyCode == SWT.ESC)
+                    return;
+
+                if (!isMultiLine()) {
+                    if (e.keyCode == SWT.F2 || e.keyCode == SWT.CR || e.keyCode == SWT.KEYPAD_CR) {
+                        startEdit(true);
+                    } else if (e.character != '\0') {
+                        startEdit(false);
+                    }
+                } else {
+                    // In multi-line mode, TAB must not start editing!
+                    if (e.keyCode == SWT.F2) {
+                        startEdit(true);
+                    } else if (e.keyCode == SWT.CR || e.keyCode == SWT.KEYPAD_CR) {
+                        if (hasMultiLineCommitModifier(e)) {
+                            e.doit = false;
+                        } else {
+                            startEdit(false);
+                        }
+                    } else if (e.keyCode == SWT.TAB) {
+                        text.traverse(((e.stateMask & SWT.SHIFT) != 0) ? SWT.TRAVERSE_TAB_PREVIOUS : SWT.TRAVERSE_TAB_NEXT);
+                        e.doit = false;
+                    } else if (e.character != '\0') {
+                        startEdit(false);
+                    }
+                }
+            } else {
+                // ESC reverts any changes made during this edit
+                if (e.keyCode == SWT.ESC) {
+                    revertEdit();
+                }
+                if (!isMultiLine()) {
+                    if (e.keyCode == SWT.CR || e.keyCode == SWT.KEYPAD_CR) {
+                        applyEdit();
+                    }
+                } else {
+                    if (e.keyCode == SWT.CR || e.keyCode == SWT.KEYPAD_CR) {
+                        if (hasMultiLineCommitModifier(e)) {
+                            applyEdit();
+                            e.doit = false;
+                        }
+                    }
+                }
+            }
+        }
+
+        public void keyReleased(KeyEvent e) {
+            //System.out.println("keyReleased: " + e);
+        }
+
+        public void mouseEnter(MouseEvent e) {
+            //System.out.println("mouseEnter");
+            if (!isEditing()) {
+                setBackground(colorProvider.getHoverBackground());
+            }
+            setMouseInsideControl(true);
+        }
+
+        public void mouseExit(MouseEvent e) {
+            //System.out.println("mouseExit");
+            if (!isEditing()) {
+                setBackground(colorProvider.getInactiveBackground());
+            }
+            setMouseInsideControl(false);
+        }
+
+        public void mouseHover(MouseEvent e) {
+            //System.out.println("mouseHover");
+            setMouseInsideControl(true);
+        }
+
+        public void mouseDoubleClick(MouseEvent e) {
+            //System.out.println("mouseDoubleClick: " + e);
+            if (e.button == 1) {
+                getWidget().selectAll();
+            }
+        }
+
+        public void mouseDown(MouseEvent e) {
+            //System.out.println("mouseDown: " + e);
+            if (!isEditing()) {
+                // In reality we should never get here, since focusGained
+                // always comes before mouseDown, but let's keep this
+                // fallback just to be safe.
+                if (e.button == 1) {
+                    startEdit(false);
+                }
+            } else {
+                if (e.button == 1 && (state & MOUSE_DOWN_FIRST_TIME) != 0) {
+                    getWidget().selectAll();
+                    state &= ~MOUSE_DOWN_FIRST_TIME;
+                }
+            }
+        }
+
+        public void mouseUp(MouseEvent e) {
+        }
+
+        public void focusGained(FocusEvent e) {
+            //System.out.println("focusGained");
+            if (!isEditing()) {
+                if (!isMultiLine()) {
+                    // Always start edit on single line texts when focus is gained
+                    startEdit(true);
+                }
+            }
+        }
+
+        public void focusLost(FocusEvent e) {
+            //System.out.println("focusLost");
+            if (isEditing()) {
+                applyEdit();
+            }
+        }
+
+               @Override
+               public void caretMoved(CaretEvent event) {
+                       fireCaretListeners();
+               }
+    }
+
+    public TrackedStyledText(StyledText text) {
+        Assert.isNotNull(text);
+        this.state = 0;
+        this.text = text;
+        this.resourceManager = new LocalResourceManager(JFaceResources.getResources(), text);
+        this.colorProvider = new DefaultColorProvider();
+
+        initialize();
+    }
+
+    public TrackedStyledText(Composite parent, int style) {
+        this.state = 0;
+        this.text = new StyledText(parent, style);
+        this.resourceManager = new LocalResourceManager(JFaceResources.getResources(), text);
+        this.colorProvider = new DefaultColorProvider();
+
+        initialize();
+    }
+
+    public TrackedStyledText(StyledText text, ITrackedColorProvider colorProvider) {
+        Assert.isNotNull(text, "text must not be null");
+        Assert.isNotNull(colorProvider, "colorProvider must not be null");
+        this.state = 0;
+        this.text = text;
+        this.colorProvider = colorProvider;
+
+        initialize();
+    }
+
+    public TrackedStyledText(Composite parent, int style, ITrackedColorProvider colorProvider) {
+        Assert.isNotNull(colorProvider, "colorProvider must not be null");
+        this.state = 0;
+        this.text = new StyledText(parent, style);
+        this.colorProvider = colorProvider;
+
+        initialize();
+    }
+
+    /**
+     * Common initialization. Assumes that text is already created.
+     */
+    private void initialize() {
+        Assert.isNotNull(text);
+
+        text.setBackground(colorProvider.getInactiveBackground());
+        text.setDoubleClickEnabled(false);
+
+        listener = new CompositeListener();
+
+        text.addModifyListener(listener);
+        text.addDisposeListener(listener);
+        text.addKeyListener(listener);
+        text.addMouseTrackListener(listener);
+        text.addMouseListener(listener);
+        text.addFocusListener(listener);
+        text.addCaretListener(listener);
+    }
+
+    private void startEdit(boolean selectAll) {
+        if (isEditing()) {
+            // Print some debug incase we end are in an invalid state
+            System.out.println("TrackedText: BUG: startEdit called when in editing state");
+        }
+        System.out.println("start edit: selectall=" + selectAll + ", text=" + text.getText() + ", caretpos=" + caretPositionBeforeEdit);
+
+        // Backup text-field data for reverting purposes
+        caretPositionBeforeEdit = text.getCaretOffset();
+        textBeforeEdit = text.getText();
+
+        // Signal editing state
+        setBackground(colorProvider.getEditingBackground());
+
+        if (selectAll) {
+            text.selectAll();
+        }
+        state |= EDITING | MOUSE_DOWN_FIRST_TIME;
+    }
+
+    private void applyEdit() {
+       System.err.println("apply edit");
+        try {
+            if (isTextValid() != null) {
+                text.setText(textBeforeEdit);
+            } else if (isModified() && !text.getText().equals(textBeforeEdit)) {
+                //System.out.println("apply");
+                if (modifyListeners != null) {
+                    TrackedModifyEvent event = new TrackedModifyEvent(text, text.getText());
+                    for (Object o : modifyListeners.getListeners()) {
+                        ((TrackedModifyListener) o).modifyText(event);
+                    }
+                }
+            }
+        } finally {
+            endEdit();
+        }
+    }
+    
+    private void fireCaretListeners() {
+        if (caretListeners != null) {
+            for (Object o : caretListeners.getListeners()) {
+                ((TrackedCaretListener) o).caretOrSelectionChanged();
+            }
+        }
+    }
+
+    private void endEdit() {
+       System.err.println("endedit");
+        if (!isEditing()) {
+            // Print some debug incase we end are in an invalid state
+            //ExceptionUtils.logError(new Exception("BUG: endEdit called when not in editing state"));
+            System.out.println();
+        }
+        setBackground(isMouseInsideControl() ? colorProvider.getHoverBackground() : colorProvider.getInactiveBackground());
+        //System.out.println("endEdit: " + text.getText() + ", caret: " + text.getCaretLocation() + ", selection: " + text.getSelection());
+        // Always move the caret to the end of the string
+        //text.setSelection(text.getCharCount());
+        state &= ~(EDITING | MOUSE_DOWN_FIRST_TIME);
+        setModified(false);
+    }
+
+    private void revertEdit() {
+        if (!isEditing()) {
+            // Print some debug incase we end are in an invalid state
+            //ExceptionUtils.logError(new Exception("BUG: revertEdit called when not in editing state"));
+            System.out.println("BUG: revertEdit called when not in editing state");
+        }
+        text.setText(textBeforeEdit);
+        text.setSelection(caretPositionBeforeEdit);
+        setBackground(isMouseInsideControl() ? colorProvider.getHoverBackground() : colorProvider.getInactiveBackground());
+        state &= ~(EDITING | MOUSE_DOWN_FIRST_TIME);
+        setModified(false);
+    }
+
+    public boolean isEditing() {
+        return (state & EDITING) != 0;
+    }
+
+    private void setModified(boolean modified) {
+        if (modified) {
+            state |= MODIFIED_DURING_EDITING;
+        } else {
+            state &= ~MODIFIED_DURING_EDITING;
+        }
+    }
+
+    private boolean isMouseInsideControl() {
+        return (state & MOUSE_INSIDE_CONTROL) != 0;
+    }
+
+    private void setMouseInsideControl(boolean inside) {
+        if (inside)
+            state |= MOUSE_INSIDE_CONTROL;
+        else
+            state &= ~MOUSE_INSIDE_CONTROL;
+    }
+
+    public boolean isModified() {
+        return (state & MODIFIED_DURING_EDITING) != 0;
+    }
+
+    public void setEditable(boolean editable) {
+        if (editable) {
+            text.setEditable(true);
+            setBackground(isMouseInsideControl() ? colorProvider.getHoverBackground() : colorProvider.getInactiveBackground());
+        } else {
+            text.setEditable(false);
+            text.setBackground(null);
+        }
+    }
+
+    public void setText(String text) {
+        this.text.setText(text);
+    }
+
+    public void setTextWithoutNotify(String text) {
+        this.text.removeModifyListener(listener);
+        setText(text);
+        this.text.addModifyListener(listener);
+    }
+
+    public StyledText getWidget() {
+        return text;
+    }
+
+    public synchronized void addModifyListener(TrackedModifyListener listener) {
+        if (modifyListeners == null) {
+            modifyListeners = new ListenerList(ListenerList.IDENTITY);
+        }
+        modifyListeners.add(listener);
+    }
+
+    public synchronized void addCaretListener(TrackedCaretListener listener) {
+        if (caretListeners == null) {
+            caretListeners = new ListenerList(ListenerList.IDENTITY);
+        }
+        caretListeners.add(listener);
+    }
+
+    public synchronized void removeModifyListener(TrackedModifyListener listener) {
+        if (modifyListeners == null)
+            return;
+        modifyListeners.remove(listener);
+    }
+
+    public synchronized void removeCaretListener(TrackedCaretListener listener) {
+        if (caretListeners == null)
+            return;
+        caretListeners.remove(listener);
+    }
+
+    public void setInputValidator(IInputValidator validator) {
+        if (validator != this.validator) {
+            this.validator = validator;
+        }
+    }
+
+    private String isTextValid() {
+        if (validator != null) {
+            return validator.isValid(getWidget().getText());
+        }
+        return null;
+    }
+
+    public void setColorProvider(ITrackedColorProvider provider) {
+        Assert.isNotNull(provider);
+        this.colorProvider = provider;
+    }
+
+    private void setBackground(Color background) {
+        if (!text.getEditable()) {
+            // Do not alter background when the widget is not editable.
+            return;
+        }
+        text.setBackground(background);
+    }
+
+}