Added new Option "Wrap PHPdocs and comments at print margin"
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / viewsupport / ProblemTableViewer.java
1 /*******************************************************************************
2  * Copyright (c) 2000, 2004 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials 
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  * 
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package net.sourceforge.phpdt.internal.ui.viewsupport;
13
14 import java.util.ArrayList;
15
16 import net.sourceforge.phpdt.ui.IWorkingCopyProvider;
17 import net.sourceforge.phpdt.ui.ProblemsLabelDecorator.ProblemsLabelChangedEvent;
18
19 import org.eclipse.core.resources.IResource;
20 import org.eclipse.jface.viewers.IBaseLabelProvider;
21 import org.eclipse.jface.viewers.LabelProviderChangedEvent;
22 import org.eclipse.jface.viewers.TableViewer;
23 import org.eclipse.swt.widgets.Composite;
24 import org.eclipse.swt.widgets.Item;
25 import org.eclipse.swt.widgets.Table;
26 import org.eclipse.swt.widgets.Widget;
27
28 /**
29  * Extends a  TableViewer to allow more performance when showing error ticks.
30  * A <code>ProblemItemMapper</code> is contained that maps all items in
31  * the tree to underlying resource
32  */
33 public class ProblemTableViewer extends TableViewer {
34
35         protected ResourceToItemsMapper fResourceToItemsMapper;
36
37         /**
38          * Constructor for ProblemTableViewer.
39          * @param parent
40          */
41         public ProblemTableViewer(Composite parent) {
42                 super(parent);
43                 initMapper();
44         }
45
46         /**
47          * Constructor for ProblemTableViewer.
48          * @param parent
49          * @param style
50          */
51         public ProblemTableViewer(Composite parent, int style) {
52                 super(parent, style);
53                 initMapper();
54         }
55
56         /**
57          * Constructor for ProblemTableViewer.
58          * @param table
59          */
60         public ProblemTableViewer(Table table) {
61                 super(table);
62                 initMapper();
63         }
64
65         private void initMapper() {
66                 fResourceToItemsMapper= new ResourceToItemsMapper(this);
67         }
68         
69         /*
70          * @see StructuredViewer#mapElement(Object, Widget)
71          */
72         protected void mapElement(Object element, Widget item) {
73                 super.mapElement(element, item);
74                 if (item instanceof Item) {
75                         fResourceToItemsMapper.addToMap(element, (Item) item);
76                 }
77         }
78
79         /*
80          * @see StructuredViewer#unmapElement(Object, Widget)
81          */
82         protected void unmapElement(Object element, Widget item) {
83                 if (item instanceof Item) {
84                         fResourceToItemsMapper.removeFromMap(element, (Item) item);
85                 }               
86                 super.unmapElement(element, item);
87         }
88
89         /*
90          * @see StructuredViewer#unmapAllElements()
91          */
92         protected void unmapAllElements() {
93                 fResourceToItemsMapper.clearMap();
94                 super.unmapAllElements();
95         }
96         
97         /*
98          * @see ContentViewer#handleLabelProviderChanged(LabelProviderChangedEvent)
99          */
100         protected void handleLabelProviderChanged(LabelProviderChangedEvent event) {
101                 if (event instanceof ProblemsLabelChangedEvent) {
102                         ProblemsLabelChangedEvent e= (ProblemsLabelChangedEvent) event;
103                         if (!e.isMarkerChange() && canIgnoreChangesFromAnnotionModel()) {
104                                 return;
105                         }
106                 }
107                 
108                 Object[] changed= event.getElements();
109                 if (changed != null && !fResourceToItemsMapper.isEmpty()) {
110                         ArrayList others= new ArrayList(changed.length);
111                         for (int i= 0; i < changed.length; i++) {
112                                 Object curr= changed[i];
113                                 if (curr instanceof IResource) {
114                                         fResourceToItemsMapper.resourceChanged((IResource) curr);
115                                 } else {
116                                         others.add(curr);
117                                 }
118                         }
119                         if (others.isEmpty()) {
120                                 return;
121                         }
122                         event= new LabelProviderChangedEvent((IBaseLabelProvider) event.getSource(), others.toArray());
123                 }
124                 super.handleLabelProviderChanged(event);
125         }
126         
127         /**
128          * Answers whether this viewer can ignore label provider changes resulting from
129          * marker changes in annotation models
130          */
131         private boolean canIgnoreChangesFromAnnotionModel() {
132                 Object contentProvider= getContentProvider();
133                 return contentProvider instanceof IWorkingCopyProvider && !((IWorkingCopyProvider)contentProvider).providesWorkingCopies();
134         }
135 }