|
1 /* |
|
2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 * Monitor for source files |
|
17 * |
|
18 */ |
|
19 package com.nokia.tracebuilder.source; |
|
20 |
|
21 /** |
|
22 * Monitor for source files |
|
23 * |
|
24 */ |
|
25 public interface SourceDocumentMonitor extends |
|
26 Iterable<SourceDocumentInterface> { |
|
27 |
|
28 /** |
|
29 * Gets a document factory, which is shared between all documents created |
|
30 * into this monitor |
|
31 * |
|
32 * @return the factory |
|
33 */ |
|
34 public SourceDocumentFactory getFactory(); |
|
35 |
|
36 /** |
|
37 * Starts the monitor |
|
38 * |
|
39 * @param processor |
|
40 * document processor callback |
|
41 */ |
|
42 public void startMonitor(SourceDocumentProcessor processor); |
|
43 |
|
44 /** |
|
45 * Stops the monitor |
|
46 */ |
|
47 public void stopMonitor(); |
|
48 |
|
49 /** |
|
50 * Gets the currently active source |
|
51 * |
|
52 * @return the source |
|
53 */ |
|
54 public SourceDocumentInterface getSelectedSource(); |
|
55 |
|
56 /** |
|
57 * Gets the current selection from given source |
|
58 * |
|
59 * @param props |
|
60 * the source |
|
61 * @return the selection |
|
62 */ |
|
63 public OffsetLength getSelection(SourceDocumentInterface props); |
|
64 |
|
65 /** |
|
66 * Sets focus to currently selected source |
|
67 */ |
|
68 public void setFocus(); |
|
69 |
|
70 /** |
|
71 * Checks if source can be edited |
|
72 * |
|
73 * @param selectedSource |
|
74 * the source |
|
75 * @return true if can be edited, false if read-only |
|
76 */ |
|
77 public boolean isSourceEditable(SourceDocumentInterface selectedSource); |
|
78 |
|
79 } |