|
Added
Link Here
|
| 1 |
/******************************************************************************* |
| 2 |
* Copyright (c) 2004, 2012 BREDEX GmbH. |
| 3 |
* All rights reserved. This program and the accompanying materials |
| 4 |
* are made available under the terms of the Eclipse Public License v1.0 |
| 5 |
* which accompanies this distribution, and is available at |
| 6 |
* http://www.eclipse.org/legal/epl-v10.html |
| 7 |
* |
| 8 |
* Contributors: |
| 9 |
* BREDEX GmbH - initial API and implementation and/or initial documentation |
| 10 |
*******************************************************************************/ |
| 11 |
package org.eclipse.jubula.client.ui.rcp.controllers; |
| 12 |
|
| 13 |
import java.util.ArrayList; |
| 14 |
import java.util.LinkedList; |
| 15 |
import java.util.List; |
| 16 |
import org.eclipse.jubula.client.ui.constants.Constants; |
| 17 |
import org.eclipse.jubula.client.ui.editors.TestResultViewer; |
| 18 |
import org.eclipse.jubula.client.ui.rcp.Plugin; |
| 19 |
import org.eclipse.jubula.client.ui.rcp.events.GuiEventDispatcher; |
| 20 |
import org.eclipse.jubula.client.ui.rcp.events.GuiEventDispatcher.ClientStatus; |
| 21 |
import org.eclipse.jubula.client.ui.rcp.events.GuiEventDispatcher.IClientStatusListener; |
| 22 |
import org.eclipse.jubula.client.ui.rcp.sourceprovider.TestResultSourceProvider; |
| 23 |
import org.eclipse.jubula.client.ui.rcp.views.TestResultTreeView; |
| 24 |
import org.eclipse.ui.IEditorPart; |
| 25 |
import org.eclipse.ui.IPartListener; |
| 26 |
import org.eclipse.ui.IPerspectiveDescriptor; |
| 27 |
import org.eclipse.ui.IViewPart; |
| 28 |
import org.eclipse.ui.IViewReference; |
| 29 |
import org.eclipse.ui.IWorkbenchPage; |
| 30 |
import org.eclipse.ui.IWorkbenchPart; |
| 31 |
import org.eclipse.ui.part.ViewPart; |
| 32 |
import org.eclipse.ui.part.WorkbenchPart; |
| 33 |
|
| 34 |
/** |
| 35 |
* @author BREDEX GmbH |
| 36 |
*/ |
| 37 |
public class TestResultPartsTracker implements IClientStatusListener { |
| 38 |
|
| 39 |
/** |
| 40 |
* the current perspective descriptor of the active page |
| 41 |
*/ |
| 42 |
private static IPerspectiveDescriptor currPesrpDescriptor; |
| 43 |
|
| 44 |
/** |
| 45 |
* singleton instance |
| 46 |
*/ |
| 47 |
private static TestResultPartsTracker instance = null; |
| 48 |
|
| 49 |
/** |
| 50 |
* the list of open test result viewers |
| 51 |
*/ |
| 52 |
private List<TestResultViewer> m_trViewers = |
| 53 |
new ArrayList<TestResultViewer>(); |
| 54 |
|
| 55 |
/** |
| 56 |
* state is false is Test Result Tree View is hidden |
| 57 |
* the value of this member is used to define if GoToNext/Previous Error Buttons should be disabled |
| 58 |
* currently it is impossible easy to check if the part (view/editor) |
| 59 |
* was hidden by other editor, because no list of stacked editors exist (only of staked views); |
| 60 |
* state of TestResultViewer is regarded as "may be hidden" when (this behaviour is defined |
| 61 |
* in methods of PartListenerToTrackTRParts and other methods of TestResultPartsTracker): |
| 62 |
* - editor other then TestResultViewer was activated ; |
| 63 |
* - on Perspective change; |
| 64 |
* - when TestResultViewer was closed; |
| 65 |
*/ |
| 66 |
private boolean m_isTRTreeViewHidden = true; |
| 67 |
|
| 68 |
/** |
| 69 |
*it is not currently tracked if the TestResultViewer |
| 70 |
*is hidden or visible, and when it might be hidden |
| 71 |
*GoToErrorButtons should be disabled |
| 72 |
*/ |
| 73 |
private boolean m_trViewerMayBeHidden = true; |
| 74 |
|
| 75 |
/** |
| 76 |
* the ordered by activation time list of open test result viewers and test result view |
| 77 |
*/ |
| 78 |
private List<WorkbenchPart> m_trParts = |
| 79 |
new LinkedList<WorkbenchPart>(); |
| 80 |
|
| 81 |
/** |
| 82 |
* the test result tree view |
| 83 |
*/ |
| 84 |
private TestResultTreeView m_trTreeView = null; |
| 85 |
|
| 86 |
/** |
| 87 |
* the source provider |
| 88 |
*/ |
| 89 |
private TestResultSourceProvider m_provider = null; |
| 90 |
|
| 91 |
|
| 92 |
/** |
| 93 |
* private Constructor |
| 94 |
*/ |
| 95 |
private TestResultPartsTracker() { |
| 96 |
GuiEventDispatcher.getInstance() |
| 97 |
.addClientStatusListener(this); |
| 98 |
} |
| 99 |
|
| 100 |
/** |
| 101 |
* sets the value of the current perspective descriptor of the active page |
| 102 |
* @param pDescr the value to set |
| 103 |
*/ |
| 104 |
private static void setCurrentPesrpective(IPerspectiveDescriptor pDescr) { |
| 105 |
currPesrpDescriptor = pDescr; |
| 106 |
} |
| 107 |
|
| 108 |
/** |
| 109 |
*@return the value of the current perspective descriptor of the active page |
| 110 |
*/ |
| 111 |
private static IPerspectiveDescriptor getCurrentPesrpective() { |
| 112 |
return currPesrpDescriptor; |
| 113 |
} |
| 114 |
|
| 115 |
/** |
| 116 |
* @param page the page for which state of Test Result Tree View is tracked and handled |
| 117 |
*/ |
| 118 |
private void handleTestResultTreeViewInitialState(IWorkbenchPage page) { |
| 119 |
for (IViewReference viewRef : page.getViewReferences()) { |
| 120 |
if (viewRef.getId().equals(Constants.TESTRE_ID)) { |
| 121 |
addTRTreeView((TestResultTreeView)viewRef.getPart(true)); |
| 122 |
setTRTreeViewHiddenStateTo(true); |
| 123 |
} |
| 124 |
} |
| 125 |
} |
| 126 |
|
| 127 |
/** |
| 128 |
* @author BREDEX The PartListener for tracking the state of Parts to view Test Result |
| 129 |
* (TestResultViewer or TestResultTreeView) |
| 130 |
*/ |
| 131 |
private class PartListenerToTrackTRParts implements IPartListener { |
| 132 |
/** {@inheritDoc} */ |
| 133 |
public void partActivated(IWorkbenchPart part) { |
| 134 |
handlePerspectiveChange(); |
| 135 |
if (part instanceof TestResultTreeView) { |
| 136 |
setTRTreeViewHiddenStateTo(false); |
| 137 |
} |
| 138 |
if (part instanceof IEditorPart) { |
| 139 |
setTRViewerMayBeHiddenStateTo( |
| 140 |
!(part instanceof TestResultViewer)); |
| 141 |
} |
| 142 |
} |
| 143 |
|
| 144 |
/** {@inheritDoc} */ |
| 145 |
public void partOpened(IWorkbenchPart part) { |
| 146 |
if (partIsTestResultPart(part)) { |
| 147 |
changeTRPartHiddenStateTo(part, false); |
| 148 |
if (part instanceof TestResultTreeView) { |
| 149 |
addTRTreeView((TestResultTreeView)part); |
| 150 |
} else { |
| 151 |
addTRViewer((TestResultViewer)part); |
| 152 |
} |
| 153 |
} |
| 154 |
} |
| 155 |
|
| 156 |
/** {@inheritDoc} */ |
| 157 |
public void partDeactivated(IWorkbenchPart part) { |
| 158 |
//do nothing |
| 159 |
} |
| 160 |
|
| 161 |
/** {@inheritDoc} */ |
| 162 |
public void partClosed(IWorkbenchPart part) { |
| 163 |
if (partIsTestResultPart(part)) { |
| 164 |
if (part instanceof TestResultTreeView) { |
| 165 |
removeTRTreeView((TestResultTreeView)part); |
| 166 |
} else { |
| 167 |
removeTRViewer((TestResultViewer)part); |
| 168 |
} |
| 169 |
changeTRPartHiddenStateTo(part, true); |
| 170 |
} |
| 171 |
} |
| 172 |
|
| 173 |
/** {@inheritDoc} */ |
| 174 |
public void partBroughtToTop(IWorkbenchPart part) { |
| 175 |
if (part instanceof TestResultTreeView) { |
| 176 |
setTRTreeViewHiddenStateTo(false); |
| 177 |
} |
| 178 |
if (!((part instanceof TestResultTreeView) |
| 179 |
|| (part instanceof TestResultViewer))) { |
| 180 |
if (part instanceof IViewPart) { |
| 181 |
IWorkbenchPage actPage = Plugin.getActivePage(); |
| 182 |
if (actPage != null) { |
| 183 |
IViewPart[] stackedViews = |
| 184 |
actPage.getViewStack((ViewPart)part); |
| 185 |
for (IViewPart iViewPart : stackedViews) { |
| 186 |
if (iViewPart instanceof TestResultTreeView) { |
| 187 |
setTRTreeViewHiddenStateTo(true); |
| 188 |
} |
| 189 |
} |
| 190 |
} |
| 191 |
} |
| 192 |
} |
| 193 |
} |
| 194 |
|
| 195 |
/** |
| 196 |
* @param part the part for which hidden state will be changed |
| 197 |
* @param state the new value of the part hidden state |
| 198 |
*/ |
| 199 |
private void changeTRPartHiddenStateTo(IWorkbenchPart part, |
| 200 |
boolean state) { |
| 201 |
if (part instanceof TestResultTreeView) { |
| 202 |
setTRTreeViewHiddenStateTo(state); |
| 203 |
} else { |
| 204 |
setTRViewerMayBeHiddenStateTo(state); |
| 205 |
} |
| 206 |
} |
| 207 |
|
| 208 |
/** |
| 209 |
* @param part the part to check |
| 210 |
* @return true if the part is the one to view test results |
| 211 |
* (TestResultTreeView or TestResultViewer) |
| 212 |
*/ |
| 213 |
private boolean partIsTestResultPart(IWorkbenchPart part) { |
| 214 |
return (part instanceof TestResultTreeView) |
| 215 |
|| (part instanceof TestResultViewer); |
| 216 |
} |
| 217 |
|
| 218 |
/** |
| 219 |
* handle availability of GoToErrorButtons on change of the current perspective |
| 220 |
*/ |
| 221 |
private void handlePerspectiveChange() { |
| 222 |
IWorkbenchPage actPage = Plugin.getActivePage(); |
| 223 |
if (actPage != null) { |
| 224 |
if (!actPage.getPerspective().equals(getCurrentPesrpective())) { |
| 225 |
setTRViewerMayBeHiddenStateTo(true); |
| 226 |
setTRTreeViewHiddenStateTo(true); |
| 227 |
setCurrentPesrpective(actPage.getPerspective()); |
| 228 |
} |
| 229 |
} |
| 230 |
} |
| 231 |
|
| 232 |
|
| 233 |
} |
| 234 |
|
| 235 |
/** |
| 236 |
* get single instance |
| 237 |
* |
| 238 |
* @return single instance of ImportFileBP |
| 239 |
*/ |
| 240 |
public static TestResultPartsTracker getInstance() { |
| 241 |
if (instance == null) { |
| 242 |
instance = new TestResultPartsTracker(); |
| 243 |
} |
| 244 |
return instance; |
| 245 |
} |
| 246 |
|
| 247 |
/** |
| 248 |
* Add a test result viewer to this tracker. |
| 249 |
* @param testResultViewer The test result viewer to add. |
| 250 |
*/ |
| 251 |
public void addTRViewer(TestResultViewer testResultViewer) { |
| 252 |
if (testResultViewer != null) { |
| 253 |
m_trViewers.add(testResultViewer); |
| 254 |
m_trParts.add(testResultViewer); |
| 255 |
m_trViewerMayBeHidden = false; |
| 256 |
fireStateChanged(); |
| 257 |
} |
| 258 |
} |
| 259 |
|
| 260 |
/** |
| 261 |
* Add a test result tree view to this tracker. |
| 262 |
* @param testResultTreeView The test result tree view to add. |
| 263 |
*/ |
| 264 |
public void addTRTreeView(TestResultTreeView testResultTreeView) { |
| 265 |
if (testResultTreeView != null) { |
| 266 |
m_trTreeView = testResultTreeView; |
| 267 |
m_trParts.add(testResultTreeView); |
| 268 |
m_isTRTreeViewHidden = false; |
| 269 |
fireStateChanged(); |
| 270 |
} |
| 271 |
} |
| 272 |
|
| 273 |
/** |
| 274 |
* @param provider the provider to set |
| 275 |
*/ |
| 276 |
public void setProvider(TestResultSourceProvider provider) { |
| 277 |
m_provider = provider; |
| 278 |
} |
| 279 |
|
| 280 |
/** |
| 281 |
* set m_isTRTreeViewHidden to true or false |
| 282 |
* @param state the state to what of m_isTRTreeViewHidden will be set |
| 283 |
*/ |
| 284 |
public void setTRTreeViewHiddenStateTo(boolean state) { |
| 285 |
m_isTRTreeViewHidden = state; |
| 286 |
fireStateChanged(); |
| 287 |
} |
| 288 |
|
| 289 |
/** |
| 290 |
* set m_isTRTreeViewHidden to true or false |
| 291 |
* @param state the state to what of m_isTRTreeViewHidden will be set |
| 292 |
*/ |
| 293 |
public void setTRViewerMayBeHiddenStateTo(boolean state) { |
| 294 |
m_trViewerMayBeHidden = state; |
| 295 |
fireStateChanged(); |
| 296 |
} |
| 297 |
|
| 298 |
/** |
| 299 |
* @return the currently open instances of the Test Result Viewer editor |
| 300 |
*/ |
| 301 |
public List<TestResultViewer> getOpenTRViewers() { |
| 302 |
List<TestResultViewer> trvs = new ArrayList<TestResultViewer>(); |
| 303 |
for (TestResultViewer trv : m_trViewers) { |
| 304 |
trvs.add(trv); |
| 305 |
} |
| 306 |
return trvs; |
| 307 |
} |
| 308 |
|
| 309 |
/** |
| 310 |
* @return the list of open parts to view test result |
| 311 |
* (test result tree view or test result viewers) |
| 312 |
* ordered by their activation |
| 313 |
*/ |
| 314 |
public List<WorkbenchPart> getTRParts() { |
| 315 |
List<WorkbenchPart> trParts = new LinkedList<WorkbenchPart>(); |
| 316 |
for (WorkbenchPart trv : m_trParts) { |
| 317 |
trParts.add(trv); |
| 318 |
} |
| 319 |
return trParts; |
| 320 |
} |
| 321 |
|
| 322 |
/** |
| 323 |
* @return the currently open instance of the Test Result Tree View |
| 324 |
*/ |
| 325 |
public TestResultTreeView getTRTreeView() { |
| 326 |
return m_trTreeView; |
| 327 |
} |
| 328 |
|
| 329 |
/** |
| 330 |
* @return the value of m_isTRTreeViewHidden (true if Test Result Tree View is hidden) |
| 331 |
*/ |
| 332 |
public boolean isTRTreeViewHidden() { |
| 333 |
return m_isTRTreeViewHidden; |
| 334 |
} |
| 335 |
|
| 336 |
/** |
| 337 |
* @return the value of m_areButtonsDisabled |
| 338 |
*/ |
| 339 |
public boolean mayTRViewerBeHidden() { |
| 340 |
return m_trViewerMayBeHidden; |
| 341 |
} |
| 342 |
|
| 343 |
/** |
| 344 |
* Remove a test result tree view from this tracker. |
| 345 |
* @param testResultViewer The test result tree view to remove. |
| 346 |
*/ |
| 347 |
public void removeTRViewer(TestResultViewer testResultViewer) { |
| 348 |
m_trViewers.remove(testResultViewer); |
| 349 |
m_trParts.remove(testResultViewer); |
| 350 |
fireStateChanged(); |
| 351 |
} |
| 352 |
|
| 353 |
/** |
| 354 |
* Remove a test result tree view from this tracker. |
| 355 |
* @param testResultTreeView The test result tree view to remove. |
| 356 |
*/ |
| 357 |
public void removeTRTreeView(TestResultTreeView testResultTreeView) { |
| 358 |
m_trParts.remove(testResultTreeView); |
| 359 |
m_trTreeView = null; |
| 360 |
fireStateChanged(); |
| 361 |
} |
| 362 |
|
| 363 |
/** |
| 364 |
* fire data changed events |
| 365 |
*/ |
| 366 |
private void fireStateChanged() { |
| 367 |
if (m_provider != null) { |
| 368 |
m_provider.externalFireSourceChanged(); |
| 369 |
} |
| 370 |
} |
| 371 |
|
| 372 |
/** {@inheritDoc} */ |
| 373 |
public void handleClientStateChanged(ClientStatus status) { |
| 374 |
if (status.equals(ClientStatus.RUNNING)) { |
| 375 |
IWorkbenchPage actPage = Plugin.getActivePage(); |
| 376 |
if (actPage != null) { |
| 377 |
actPage.addPartListener(new PartListenerToTrackTRParts()); |
| 378 |
setCurrentPesrpective(actPage.getPerspective()); |
| 379 |
handleTestResultTreeViewInitialState(actPage); |
| 380 |
} |
| 381 |
} |
| 382 |
} |
| 383 |
} |
