Statistics
| Revision:

root / trunk / libraries / libUIComponent / src / org / gvsig / gui / beans / listview / ListViewComponent.java @ 12623

History | View | Annotate | Download (17.7 KB)

1
/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
2
 *
3
 * Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.
4
 *
5
 * This program is free software; you can redistribute it and/or
6
 * modify it under the terms of the GNU General Public License
7
 * as published by the Free Software Foundation; either version 2
8
 * of the License, or (at your option) any later version.
9
 *
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 * GNU General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU General Public License
16
 * along with this program; if not, write to the Free Software
17
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.
18
 */
19
package org.gvsig.gui.beans.listview;
20

    
21
import java.awt.Color;
22
import java.awt.Dimension;
23
import java.awt.Graphics;
24
import java.awt.Graphics2D;
25
import java.awt.Image;
26
import java.awt.Point;
27
import java.awt.Rectangle;
28
import java.awt.event.ActionEvent;
29
import java.awt.event.ActionListener;
30
import java.awt.event.FocusEvent;
31
import java.awt.event.FocusListener;
32
import java.awt.event.InputEvent;
33
import java.awt.event.KeyEvent;
34
import java.awt.event.KeyListener;
35
import java.awt.event.MouseEvent;
36
import java.awt.event.MouseListener;
37
import java.awt.event.MouseMotionListener;
38
import java.util.ArrayList;
39
import java.util.Iterator;
40

    
41
import javax.swing.ButtonGroup;
42
import javax.swing.JComponent;
43
import javax.swing.JMenu;
44
import javax.swing.JPopupMenu;
45
import javax.swing.JRadioButtonMenuItem;
46
import javax.swing.JScrollPane;
47
import javax.swing.JTextField;
48
import javax.swing.JViewport;
49
import javax.swing.event.ListSelectionEvent;
50
import javax.swing.event.ListSelectionListener;
51

    
52
import org.gvsig.gui.beans.listview.painters.LargeIcon;
53
import org.gvsig.gui.beans.listview.painters.PaintList;
54
import org.gvsig.gui.beans.listview.painters.SmallIcon;
55
/**
56
 *
57
 * @version 28/06/2007
58
 * @author BorSanZa - Borja S?nchez Zamorano (borja.sanchez@iver.es)
59
 */
60
public class ListViewComponent extends JComponent implements MouseListener, MouseMotionListener, ActionListener, KeyListener, FocusListener {
61
        private static final long serialVersionUID = 6177600314634665863L;
62

    
63
        /**
64
         * Lista de los tipos de vista existentes
65
         */
66
        private ArrayList   painters       = new ArrayList();
67
        private ArrayList   paintersMenu   = new ArrayList();
68

    
69
        /**
70
         * Lista de items
71
         */
72
        private ArrayList   items          = new ArrayList();
73

    
74
        /**
75
         * Selecciona el tipo de vista
76
         */
77
        private int         view           = 0;
78

    
79
        /**
80
         * Booleano para saber si se permite la multiselecci?n
81
         */
82
        private boolean     multiSelect    = false;
83

    
84
        private Image       image          = null;
85
        private int         width          = 0;
86
        private int         height         = 0;
87
        private Graphics2D  widgetGraphics = null;
88
        private JMenu       jMenu          = null;
89
        private ButtonGroup buttonGroup    = null;
90
        private JPopupMenu  jPopupMenu     = null;
91

    
92
        private JTextField  jRenameEdit    = null;
93

    
94

    
95
        private int         itemEdited     = -1;
96
        private int         lastSelected   = -1;
97
        private int         cursorPos      = -1;
98

    
99

    
100
        private boolean     editable       = false;
101

    
102
        private ArrayList   actionCommandListeners = new ArrayList();
103

    
104

    
105
        /**
106
         * Construye un <code>ListViewComponent</code>
107
         *
108
         */
109
        public ListViewComponent() {
110
                setFocusable(true);
111

    
112
                initialize();
113
        }
114

    
115
        /**
116
         * Inicializa el <code>ListViewComponent</code>
117
         */
118
        private void initialize() {
119
                addListViewPainter(new PaintList(items));
120
                addListViewPainter(new SmallIcon(items));
121
                addListViewPainter(new LargeIcon(items));
122

    
123
                addKeyListener(this);
124
                addMouseListener(this);
125
                addMouseMotionListener(this);
126
        }
127

    
128
        /**
129
         * Obtiene que vista se esta usando en el componente
130
         * @return
131
         */
132
        public int getView() {
133
                return view;
134
        }
135

    
136
        /**
137
         * Define que vista es la que se va a usar
138
         * @param view
139
         */
140
        public void setView(int view) {
141
                this.view = view;
142
        }
143

    
144
        /**
145
         * Agrega una vista al componente
146
         * @param item
147
         */
148
        public void addListViewPainter(IListViewPainter item) {
149
                painters.add(item);
150

    
151
                JRadioButtonMenuItem jRadioButtonMenuItem = new JRadioButtonMenuItem();
152
                getButtonGroup().add(jRadioButtonMenuItem);
153

    
154
                jRadioButtonMenuItem.setText(item.getName());
155
                if (paintersMenu.size() == 0)
156
                        jRadioButtonMenuItem.setSelected(true);
157
                getJMenu().add(jRadioButtonMenuItem);
158

    
159
                jRadioButtonMenuItem.addActionListener(this);
160

    
161
                paintersMenu.add(jRadioButtonMenuItem);
162
        }
163

    
164
        /**
165
         * Agrega un item al componente
166
         * @param item
167
         */
168
        public void addItem(ListViewItem item) {
169
                addItem(item, false);
170
        }
171

    
172
        /**
173
         * Agrega un item al componente, si acceptRepeatNames es false no se aceptaran
174
         * nombres repetidos
175
         * @param item
176
         * @param acceptRepeatNames
177
         */
178
        public void addItem(ListViewItem item, boolean acceptRepeatNames) {
179
                items.add(item);
180
                if (!acceptRepeatNames)
181
                        changeName(item.getName(), items.size() - 1);
182
                repaint();
183
                viewItem(items.size() - 1);
184
        }
185

    
186
        /**
187
         * Agrega el item en la posicion especificada de la lista.
188
         * @param pos
189
         * @param item
190
         */
191
        public void addItem(int pos, ListViewItem item) {
192
                items.add(pos, item);
193
                changeName(item.getName(), pos);
194
                repaint();
195
                viewItem(pos);
196
        }
197

    
198
        /**
199
         * Agrega un item al componente
200
         * @param item
201
         */
202
        public void removeItem(int index) {
203
                items.remove(index);
204
                repaint();
205
        }
206

    
207
        /**
208
         * Borra todos los items seleccionados
209
         */
210
        public void removeSelecteds() {
211
                for (int i = (items.size()-1); i>=0; i--)
212
                        if (((ListViewItem) items.get(i)).isSelected())
213
                                items.remove(i);
214

    
215
                repaint();
216
        }
217

    
218
        /**
219
         * Devuelve un ArrayList con todos los items
220
         * @return
221
         */
222
        public ArrayList getItems() {
223
                return items;
224
        }
225

    
226
        private Graphics2D getWidgetGraphics() {
227
                getWidgetImage();
228
                return widgetGraphics;
229
        }
230

    
231
        private Image getWidgetImage() {
232
                int width2 = getVisibleRect().width;
233
                int height2 = getVisibleRect().height;
234
                if (width2 <= 0)
235
                        width2 = 1;
236
                if (height2 <= 0)
237
                        height2=1;
238

    
239
                if ((width != width2) || (height != height2)) {
240
                        image = createImage(width2, height2);
241
                        if (image == null)
242
                                return null;
243
                        widgetGraphics = (Graphics2D) image.getGraphics();
244
                }
245

    
246
                width = width2;
247
                height = height2;
248
                return image;
249
        }
250

    
251
        /**
252
         * Redibujar el componente en el graphics temporal
253
         */
254
        private void redrawBuffer() {
255
                getWidgetGraphics().translate(-getVisibleRect().x, -getVisibleRect().y);
256
                getWidgetGraphics().setColor(Color.white);
257
                getWidgetGraphics().fillRect(getVisibleRect().x, getVisibleRect().y, getVisibleRect().width, getVisibleRect().height);
258

    
259
                ((IListViewPainter) painters.get(view)).paint((Graphics2D) getWidgetGraphics(), getVisibleRect());
260
                getWidgetGraphics().translate(getVisibleRect().x, getVisibleRect().y);
261
        }
262

    
263
        public void paint(Graphics g) {
264

    
265
                redrawBuffer();
266

    
267
                if (image != null)
268
                        g.drawImage(image, getVisibleRect().x, getVisibleRect().y, this);
269

    
270
                Dimension size = getPreferredSize();
271
                Dimension aux = ((IListViewPainter) painters.get(view)).getPreferredSize();
272
                if (!size.equals(aux)) {
273
                        setPreferredSize(aux);
274
                        setSize(aux);
275
                }
276
        }
277

    
278
        public boolean isMultiSelect() {
279
                return multiSelect;
280
        }
281

    
282
        public void setMultiSelect(boolean multiSelect) {
283
                if (multiSelect == false) {
284
                        for (int i = 0; i<items.size(); i++)
285
                                ((ListViewItem) items.get(i)).setSelected(false);
286
                        if ((lastSelected != -1) && (lastSelected < items.size()))
287
                                ((ListViewItem) items.get(lastSelected)).setSelected(true);
288
                }
289

    
290
                this.multiSelect = multiSelect;
291
                repaint();
292
        }
293

    
294
        private int getItem(int x, int y) {
295
                Point point = new Point(x, y);
296
                Rectangle rectangle = null;
297
                for (int i = 0; i < items.size(); i++) {
298
                        rectangle = ((ListViewItem) items.get(i)).getItemRectangle();
299
                        if ((rectangle != null) && (rectangle.getBounds().contains(point)))
300
                                return i;
301
                }
302

    
303
                return -1;
304
        }
305

    
306
        /*
307
         * (non-Javadoc)
308
         * @see java.awt.event.MouseListener#mousePressed(java.awt.event.MouseEvent)
309
         */
310
        public void mousePressed(MouseEvent e) {
311
                requestFocus();
312

    
313
                try {
314
                        if ((e.getModifiers() & InputEvent.BUTTON1_MASK) != InputEvent.BUTTON1_MASK)
315
                                return;
316

    
317
                        cursorPos = getItem(e.getX(), e.getY());
318
                        if (cursorPos == -1)
319
                                return;
320

    
321
                        if (isMultiSelect()) {
322
                                if ((e.getModifiers() & InputEvent.SHIFT_MASK) == InputEvent.SHIFT_MASK) {
323
                                        int pos1 = cursorPos;
324
                                        int pos2 = lastSelected;
325
                                        if (pos2 < pos1) {
326
                                                pos1 = lastSelected;
327
                                                pos2 = cursorPos;
328
                                        }
329

    
330
                                        if ((e.getModifiers() & InputEvent.CTRL_MASK) != InputEvent.CTRL_MASK)
331
                                                for (int i = 0; i < items.size(); i++)
332
                                                        ((ListViewItem) items.get(i)).setSelected(false);
333

    
334
                                        for (int i = pos1; i <= pos2; i++)
335
                                                ((ListViewItem) items.get(i)).setSelected(true);
336
                                        return;
337
                                }
338

    
339
                                lastSelected = cursorPos;
340

    
341
                                if ((e.getModifiers() & InputEvent.CTRL_MASK) == InputEvent.CTRL_MASK) {
342
                                        ((ListViewItem) items.get(cursorPos)).setSelected(!((ListViewItem) items.get(cursorPos)).isSelected());
343
                                        return;
344
                                }
345

    
346
                                for (int i = 0; i < items.size(); i++)
347
                                        ((ListViewItem) items.get(i)).setSelected(false);
348

    
349
                                ((ListViewItem) items.get(cursorPos)).setSelected(true);
350
                        } else {
351
                                boolean selected = true;
352

    
353
                                lastSelected = cursorPos;
354

    
355
                                if ((e.getModifiers() & InputEvent.CTRL_MASK) == InputEvent.CTRL_MASK)
356
                                        selected = !((ListViewItem) items.get(cursorPos)).isSelected();
357

    
358
                                for (int i = 0; i < items.size(); i++)
359
                                        ((ListViewItem) items.get(i)).setSelected(false);
360

    
361
                                ((ListViewItem) items.get(cursorPos)).setSelected(selected);
362
                        }
363
                } finally {
364
                        repaint();
365
                }
366
        }
367

    
368
        /**
369
         * Establece que un item debe estar visible en la vista
370
         * @param pos
371
         */
372
        private void viewItem(int pos) {
373
                if (getParent() instanceof JViewport) {
374
                        JViewport jViewport = (JViewport) getParent();
375

    
376
                        if (jViewport.getParent() instanceof JScrollPane) {
377
                                ListViewItem lvi = ((ListViewItem) items.get(pos));
378
                                Rectangle rectangle = lvi.getItemRectangle();
379
                                if (rectangle == null)
380
                                        return;
381
                                rectangle.setLocation((int) rectangle.getX() - getVisibleRect().x, (int) rectangle.getY() - getVisibleRect().y);
382
                                jViewport.scrollRectToVisible(rectangle);
383
                        }
384
                }
385
        }
386

    
387
        public void mouseDragged(MouseEvent e) {
388
                if ((e.getModifiers() & InputEvent.BUTTON1_MASK) != InputEvent.BUTTON1_MASK)
389
                        return;
390

    
391
                if (isMultiSelect()) {
392
                        if ((e.getModifiers() & InputEvent.SHIFT_MASK) == InputEvent.SHIFT_MASK)
393
                                return;
394
                        if ((e.getModifiers() & InputEvent.CTRL_MASK) == InputEvent.CTRL_MASK)
395
                                return;
396
                }
397

    
398
                int itemSelected = getItem(e.getX(), e.getY());
399

    
400
                if (itemSelected == -1)
401
                        return;
402

    
403
                lastSelected = itemSelected;
404
                cursorPos = itemSelected;
405

    
406
                for (int i = 0; i<items.size(); i++)
407
                        ((ListViewItem) items.get(i)).setSelected(false);
408

    
409
                ((ListViewItem) items.get(itemSelected)).setSelected(true);
410

    
411
                repaint();
412

    
413
                viewItem(itemSelected);
414
        }
415

    
416
        private JPopupMenu getPopupMenu() {
417
                if (jPopupMenu == null) {
418
                        jPopupMenu = new JPopupMenu();
419
                        getJMenu().setText("View");
420

    
421
                        jPopupMenu.add(getJMenu());
422
                }
423
                return jPopupMenu;
424
        }
425

    
426
        public void mouseReleased(MouseEvent e) {
427
                if ((e.getModifiers() & InputEvent.BUTTON3_MASK) == InputEvent.BUTTON3_MASK)
428
                        getPopupMenu().show (this, e.getX (), e.getY () );
429

    
430
                if ((e.getModifiers() & InputEvent.BUTTON1_MASK) == InputEvent.BUTTON1_MASK) {
431
                        fireSelectionValueChanged(1, 1, false);
432
                }
433
        }
434

    
435
        public void mouseMoved(MouseEvent e) {
436
                int itemSelected = getItem(e.getX(), e.getY());
437

    
438
                if (itemSelected == -1) {
439
                        setToolTipText(null);
440
                        return;
441
                }
442
                if (((ListViewItem) items.get(itemSelected)).isShowTooltip())
443
                        setToolTipText(((ListViewItem) items.get(itemSelected)).getName());
444
                else
445
                        setToolTipText(null);
446
        }
447

    
448
        private ButtonGroup getButtonGroup() {
449
                if (buttonGroup == null)
450
                        buttonGroup = new ButtonGroup();
451
                return buttonGroup;
452
        }
453

    
454
        private JMenu getJMenu() {
455
                if (jMenu == null)
456
                        jMenu = new JMenu();
457
                return jMenu;
458
        }
459

    
460
        /*
461
         * (non-Javadoc)
462
         * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
463
         */
464
        public void actionPerformed(ActionEvent e) {
465
                int pos = paintersMenu.indexOf(e.getSource());
466
                view = pos;
467
                repaint();
468
        }
469

    
470
        /**
471
         * Returns an array of the values for the selected cells. The returned values
472
         * are sorted in increasing index order.
473
         *
474
         * @return the selected values or an empty list if nothing is selected
475
         */
476
        public ListViewItem[] getSelectedValues() {
477
                int cont = 0;
478
                for (int i = 0; i < items.size(); i++) {
479
                        if (((ListViewItem) items.get(i)).isSelected())
480
                                cont++;
481
                }
482
                ListViewItem[] values = new ListViewItem[cont];
483
                cont = 0;
484
                for (int i = 0; i < items.size(); i++) {
485
                        if (((ListViewItem) items.get(i)).isSelected()) {
486
                                values[cont] = (ListViewItem) items.get(i);
487
                                cont++;
488
                        }
489
                }
490

    
491
                return values;
492
        }
493

    
494
        /**
495
         * Returns the first selected index; returns -1 if there is no selected item.
496
         *
497
         * @return the value of <code>getMinSelectionIndex</code>
498
         */
499
        public int getSelectedIndex() {
500
                for (int i = 0; i < items.size(); i++) {
501
                        if (((ListViewItem) items.get(i)).isSelected())
502
                                return i;
503
                }
504
                return -1;
505
        }
506

    
507

    
508
        /**
509
         * Select the index value
510
         *
511
         * @return the value of <code>getMinSelectionIndex</code>
512
         */
513
        public void setSelectedIndex(int value) {
514
                for (int i = 0; i < items.size(); i++) {
515
                        ((ListViewItem) items.get(i)).setSelected(i == value);
516
                }
517
        }
518

    
519
        /**
520
         * Returns the first selected value, or <code>null</code> if the selection
521
         * is empty.
522
         *
523
         * @return the first selected value
524
         */
525
        public ListViewItem getSelectedValue() {
526
                for (int i = 0; i < items.size(); i++) {
527
                        if (((ListViewItem) items.get(i)).isSelected())
528
                                return (ListViewItem) items.get(i);
529
                }
530
                return null;
531
        }
532

    
533
        /**
534
         * Returns an array of all of the selected indices in increasing order.
535
         *
536
         * @return all of the selected indices, in increasing order
537
         */
538
        public int[] getSelectedIndices() {
539
                int cont = 0;
540
                for (int i = 0; i < items.size(); i++) {
541
                        if (((ListViewItem) items.get(i)).isSelected())
542
                                cont++;
543
                }
544
                int[] values = new int[cont];
545
                cont = 0;
546
                for (int i = 0; i < items.size(); i++) {
547
                        if (((ListViewItem) items.get(i)).isSelected()) {
548
                                values[cont] = i;
549
                                cont++;
550
                        }
551
                }
552

    
553
                return values;
554
        }
555

    
556
        /**
557
         * A?adir un listener a la lista de eventos
558
         * @param listener
559
         */
560
        public void addListSelectionListener(ListSelectionListener listener) {
561
                if (!actionCommandListeners.contains(listener))
562
                        actionCommandListeners.add(listener);
563
        }
564

    
565
        /**
566
         * Borrar un listener de la lista de eventos
567
         * @param listener
568
         */
569
        public void removeListSelectionListener(ListSelectionListener listener) {
570
                actionCommandListeners.remove(listener);
571
        }
572

    
573
        /**
574
         * Invocar a los eventos asociados al componente
575
         */
576
        private void fireSelectionValueChanged(int firstIndex, int lastIndex, boolean isAdjusting) {
577
                Iterator acIterator = actionCommandListeners.iterator();
578
                ListSelectionEvent e = null;
579
                while (acIterator.hasNext()) {
580
                        ListSelectionListener listener = (ListSelectionListener) acIterator.next();
581
                        if (e == null)
582
                                e = new ListSelectionEvent(this, firstIndex, lastIndex, isAdjusting);
583
                        listener.valueChanged(e);
584
                }
585
        }
586

    
587
        public void renameItem(int item) {
588
                if (!isEditable())
589
                        return;
590

    
591
                if ((item >= 0) && (item < items.size())) {
592
                        if (((ListViewItem) items.get(item)).isSelected()) {
593
                                Rectangle rectangle = ((ListViewItem) items.get(item)).getNameRectangle();
594

    
595
                                if (rectangle != null) {
596
                                        itemEdited = item;
597
                                        ((ListViewItem) items.get(itemEdited)).setSelected(false);
598
                                        repaint();
599
                                        this.setLayout(null);
600
                                        getJRenameEdit().setText(((ListViewItem) items.get(item)).getName());
601
                                        this.add(getJRenameEdit());
602
                                        getJRenameEdit().setBounds(rectangle);
603
                                        getJRenameEdit().addFocusListener(this);
604
                                        getJRenameEdit().addKeyListener(this);
605
                                        getJRenameEdit().requestFocus();
606
                                        getJRenameEdit().setSelectionStart(0);
607
                                        getJRenameEdit().setSelectionEnd(getJRenameEdit().getText().length());
608
                                }
609
                        }
610
                }
611
        }
612

    
613
        public JTextField getJRenameEdit() {
614
                if (jRenameEdit == null) {
615
                        jRenameEdit = new JTextField();
616
                }
617
                return jRenameEdit;
618
        }
619

    
620
        public void changeName(String newName, int pos) {
621
                if (newName.length() == 0)
622
                        return;
623
                String newNameAux = newName;
624
                boolean isItem;
625
                int newNumber = 0;
626
                do {
627
                        isItem = false;
628
                        for (int i = 0; i < items.size(); i++) {
629
                                if ((i != pos) && (((ListViewItem) items.get(i)).getName().equals(newNameAux))) {
630
                                        isItem = true;
631
                                        newNumber++;
632
                                        newNameAux = newName + "_" + newNumber;
633
                                        break;
634
                                }
635
                        }
636
                } while (isItem);
637
                ((ListViewItem) items.get(pos)).setName(newNameAux);
638
        }
639

    
640
        public void closeRenameEdit() {
641
                if (jRenameEdit == null)
642
                        return;
643

    
644
                if (itemEdited != -1) {
645
                        changeName(getJRenameEdit().getText(), itemEdited);
646

    
647
                        ((ListViewItem) items.get(cursorPos)).setSelected(true);
648
                        itemEdited = -1;
649
                        repaint();
650
                }
651
                this.remove(getJRenameEdit());
652
                jRenameEdit = null;
653
                this.requestFocus();
654
        }
655

    
656
        public void keyPressed(KeyEvent e) {
657
                if (e.getSource() == getJRenameEdit()) {
658
                        switch (e.getKeyCode()) {
659
                                case KeyEvent.VK_ESCAPE:
660
                                        getJRenameEdit().setText(((ListViewItem) items.get(itemEdited)).getName());
661
                                        closeRenameEdit();
662
                                        break;
663
                                case KeyEvent.VK_ENTER:
664
                                        closeRenameEdit();
665
                                        break;
666
                        }
667

    
668
                        return;
669
                }
670
                if (e.getSource() == this) {
671
                        if (e.getKeyCode() == KeyEvent.VK_F2) {
672
                                renameItem(cursorPos);
673
                        }
674
                }
675
        }
676

    
677
        public void focusLost(FocusEvent e) {
678
                closeRenameEdit();
679
        }
680

    
681
        public void mouseClicked(MouseEvent e) {
682
                if (e.getSource() == this)
683
                        // Si es doble click y hay alg?n elemento seleccionado en la lista lo eliminamos
684
                        if (e.getClickCount() == 2) {
685
                                renameItem(cursorPos);
686
                        }
687
        }
688

    
689
        /**
690
         * Devuelve si se puede cambiar el nombre de los items
691
         * @return
692
         */
693
        public boolean isEditable() {
694
                return editable;
695
        }
696

    
697
        /**
698
         * Define si se puede cambiar el nombre de los items
699
         * @param editable
700
         */
701
        public void setEditable(boolean editable) {
702
                this.editable = editable;
703
        }
704

    
705
        public void mouseEntered(MouseEvent e) {}
706
        public void mouseExited(MouseEvent e) {}
707
        public void keyReleased(KeyEvent e) {}
708
        public void keyTyped(KeyEvent e) {}
709
        public void focusGained(FocusEvent e) {}
710
}