aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/plugin/spellcheck/ChatAttachments.java
blob: b7f5b34d16401ea137d402fdd25114da0c1e5c29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 * 
 * Distributable under LGPL license. See terms of license at gnu.org.
 */
package net.java.sip.communicator.plugin.spellcheck;

import java.awt.event.*;
import java.util.*;

import javax.swing.*;
import javax.swing.event.*;
import javax.swing.text.*;

import net.java.sip.communicator.service.gui.*;
import net.java.sip.communicator.service.gui.event.*;
import net.java.sip.communicator.service.resources.*;
import net.java.sip.communicator.util.*;

import org.dts.spell.dictionary.*;

/**
 * Wrapper for handling the multiple listeners associated with chats for the
 * spell checker.
 * 
 * @author Damian Johnson
 * @author Purvesh Sahoo
 */
class ChatAttachments
{
    private static final Logger logger = Logger
        .getLogger(ChatAttachments.class);

    private static final ImageIcon ADD_WORD_ICON = Resources
        .getImage(Resources.ADD_WORD_ICON);

    public final Chat chat;

    private final DocUnderliner docListener; // The red-squibble drawing code

    private final CaretListener caretListener;

    private final ChatMenuListener menuListener;

    private boolean isEnabled = true;

    private SpellDictionary dict;

    private boolean isAttached = false;

    private final ResourceManagementService resources = Resources
        .getResources();
    
    private SpellCheckerConfigDialog dialog;

    public ChatAttachments(Chat chat, final SpellDictionary dict)
    {
        this.chat = chat;
        this.dict = dict;

        this.docListener = new DocUnderliner(chat.getHighlighter())
        {
            boolean getFormatting(String word)
            {
                try
                {
                    return !ChatAttachments.this.dict.isCorrect(word);
                }
                catch (NullPointerException exc)
                {
                    // thrown by spell checker API if problem occurs
                    logger.error(
                        "Spell checker dictionary failed to be accessed", exc);
                    return false;
                }
            }

            int getCaretPosition()
            {
                return ChatAttachments.this.chat.getCaretPosition();
            }

            void promptRepaint()
            {
                ChatAttachments.this.chat.promptRepaint();
            }
        };

        this.caretListener = this.docListener.getEndChecker();

        this.menuListener = new ChatMenuListener()
        {

            public List<JMenuItem> getMenuElements(final Chat chat,
                MouseEvent event)
            {

                if (isEnabled && event.getSource() instanceof JTextComponent)
                {
                    JTextComponent comp = (JTextComponent) event.getSource();
                    int index = comp.viewToModel(event.getPoint());
                    try
                    {
                        String compText =
                            comp.getDocument().getText(0,
                                comp.getDocument().getLength());

                        if (index != -1 && compText.length() != 0)
                        {

                            return getCorrections(Word.getWord(
                                comp.getDocument().getText(0,
                                    comp.getDocument().getLength()), index,
                                false));

                        }

                    }
                    catch (BadLocationException e)
                    {
                        // TODO Auto-generated catch block
                        e.printStackTrace();
                    }
                }

                JMenuItem spellCheck =
                    new JMenuItem(
                        resources.getI18NString("plugin.spellcheck.MENU"));

                ArrayList<JMenuItem> spellCheckItem =
                    new ArrayList<JMenuItem>();
                spellCheckItem.add(spellCheck);
                spellCheck.addActionListener(new ActionListener()
                {

                    public void actionPerformed(ActionEvent e)
                    {
                        if(dialog != null) {
                            dialog.dispose();
                        }
                        dialog =
                            new SpellCheckerConfigDialog(chat, null, dict);
                        dialog.setVisible(true);
                    }
                });

                return spellCheckItem;
            }
        };
    }

    /**
     * Attaches spell checker capabilities the associated chat.
     */
    synchronized void attachListeners()
    {
        if (!this.isAttached)
        {
            this.chat.addChatEditorDocumentListener(this.docListener);
            this.chat.addChatEditorCaretListener(this.caretListener);
            this.chat.addChatEditorMenuListener(this.menuListener);

        }
    }

    /**
     * Removes spell checker listeners from the associated chat.
     */
    synchronized void detachListeners()
    {
        if (this.isAttached)
        {
            this.chat.removeChatEditorDocumentListener(this.docListener);
            this.chat.removeChatEditorCaretListener(this.caretListener);
            this.chat.removeChatEditorMenuListener(this.menuListener);

        }
    }

    boolean isEnabled()
    {
        return this.isEnabled;
    }

    void setEnabled(boolean enable)
    {
        synchronized (this.dict)
        {
            this.isEnabled = enable;
            this.docListener.setEnabled(enable, this.chat.getMessage());
        }
    }

    void setDictionary(SpellDictionary dict)
    {
        synchronized (this.dict)
        {
            this.dict = dict;
            this.docListener.reset(this.chat.getMessage());
        }
    }

    // provides popup menu entries (mostly separated for readability)
    private List<JMenuItem> getCorrections(final Word clickedWord)
    {
        ArrayList<JMenuItem> correctionEntries = new ArrayList<JMenuItem>();

        synchronized (this.dict)
        {
            if (!this.dict.isCorrect(clickedWord.getText()))
            {
                List<String> corrections =
                    this.dict.getSuggestions(clickedWord.getText());
                for (String correction : corrections)
                {
                    JMenuItem newEntry = new JMenuItem(correction);
                    newEntry.addActionListener(new CorrectionListener(
                        clickedWord, correction));
                    correctionEntries.add(newEntry);

                }

                // entry to add word
                JMenuItem addWord = new JMenuItem("Add Word", ADD_WORD_ICON);
                addWord.addActionListener(new ActionListener()
                {
                    public void actionPerformed(ActionEvent event)
                    {
                        try
                        {
                            dict.addWord(clickedWord.getText());

                            // clears underline
                            docListener.format(clickedWord);
                            chat.promptRepaint();
                        }
                        catch (SpellDictionaryException exc)
                        {
                            String msg =
                                "Unable to add word to personal dictionary";
                            logger.error(msg, exc);
                        }
                    }
                });
                correctionEntries.add(addWord);

            }
            
            JMenuItem spellCheck =
                new JMenuItem(
                    resources.getI18NString("plugin.spellcheck.MENU"));
            correctionEntries.add(spellCheck);
            spellCheck.addActionListener(new ActionListener()
            {

                public void actionPerformed(ActionEvent e)
                {
                    if(dialog != null) {
                        dialog.dispose();
                    }

                    dialog =
                        new SpellCheckerConfigDialog(chat, clickedWord,
                            dict);
                    dialog.setVisible(true);
                }
            });

        }
        return correctionEntries;

    }

    // Applies corrections from popup menu to chat
    private class CorrectionListener
        implements ActionListener
    {
        private final Word clickedWord;

        private final String correction;

        public CorrectionListener(Word clickedWord, String correction)
        {
            this.clickedWord = clickedWord;
            this.correction = correction;
        }

        public void actionPerformed(ActionEvent event)
        {
            StringBuffer newMessage = new StringBuffer(chat.getMessage());

            int endIndex =
                this.clickedWord.getStart()
                    + this.clickedWord.getText().length();
            newMessage.replace(this.clickedWord.getStart(), endIndex,
                this.correction);
            chat.setMessage(newMessage.toString());
        }
    }
}