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
|
/*******************************************************************************
* Copyright (c) 2006, 2009 Wind River Systems and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.dsf.ui.viewmodel;
import org.eclipse.cdt.dsf.concurrent.ConfinedToDsfExecutor;
import org.eclipse.cdt.dsf.concurrent.DataRequestMonitor;
import org.eclipse.cdt.dsf.concurrent.RequestMonitor;
import org.eclipse.cdt.dsf.service.IDsfService;
import org.eclipse.cdt.dsf.ui.viewmodel.datamodel.AbstractDMVMProvider;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IChildrenCountUpdate;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IChildrenUpdate;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IElementContentProvider;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IHasChildrenUpdate;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IModelDelta;
/**
* View model nodes are configured with a view model provider to collectively
* define the layout of a view. Each layout node generates elements of type
* {@link IVMContext} which are then stored in the viewer.
*
* <p/>
* NOTE: This interface extends <code>IElementContentProvider</code> but it has
* slightly different parameter requirements. For the
* {@link IElementContentProvider#update(IChildrenUpdate[])} method, this class
* can accept an update where {@link IChildrenUpdate#getOffset()} and
* {@link IChildrenUpdate#getLength()} may return -1. In this case the
* implementation should return all available elements for the given parent.<br>
* Also the for the {@link IElementContentProvider#update(IHasChildrenUpdate[])} and
* {@link IElementContentProvider#update(IChildrenCountUpdate[])} methods, the
* implementation may return an error with an error code of {@link IDsfService#NOT_SUPPORTED}.
* In this case the caller of this update should call
* {@link IElementContentProvider#update(IChildrenUpdate[])}
* instead.
*
* @see AbstractDMVMProvider
* @see IElementContentProvider
*
* @since 1.0
*/
@ConfinedToDsfExecutor("")
public interface IVMNode extends IElementContentProvider
{
/**
* Retrieves the view model provider that this node is configured with.
*/
public IVMProvider getVMProvider();
/**
* Returns a set of IModelDelta delta flags that indicate how elements of
* this node (type) may be, or are, affected by the given event. If the
* implementation cannot make a definitive assessment synchronously, then it
* should provide the "worst case scenario" (all ways in which the elements
* <i>may</i> be affected). If a delta flag is not returned, it means for
* certain that elements of this node will not be affected in that way. That
* information allows us to optimize the delta creation.
*
* <p>
* A response of IModeDelta.CONTENT has a special meaning. If we return that
* flag, it means the <i>collection</i> of elements of our type are
* affected. It is not a statement on the elements themselves.
*
* @param event
* the event the caller is processing
* @return IModelDelta flags
* @see #buildDelta(Object, VMDelta, int, RequestMonitor)
* @see IModelDelta
*/
public int getDeltaFlags(Object event);
/**
* Builds model delta information based on the given event.
* <p>
* Model deltas, which are used to control the state of elements in the
* viewer, are generated by the layout nodes by recursively calling this
* method on all the nodes in the layout tree. Each node implements two
* methods: {@link #getDeltaFlags(Object)}, and <code>buildDelta()</code>. A
* parent node which is processing a <code>buildDelta</code> operation needs
* to determine which of its elements are affected by a given event, set
* appropriate flags on these elements, and then it needs to call its child
* nodes with those elements to give the child nodes a chance to add onto
* the delta.
* </p>
* <p>
* The <code>getDeltaFlags()</code> is a synchronous call which tells the
* parent node whether on not it needs to call us for a given child node,
* given the event it is processing. If a child node returns something other
* than IModelDelta.NO_CHANGE, then it is providing the set of flags that we
* <i>might</i> end up adding to the delta, but it doesn't mean we are
* obligated to or will.
* </p>
*
* @param event
* Event to process.
* @param parent
* Parent model delta node that this object should add delta data
* to.
* @param nodeOffset
* The offset of the first element in this node. This offset
* depends on the elements returned by the siblings of this
* layout node.
* @param requestMonitor
* Return token, which notifies the caller that the calculation
* is complete.
*/
public void buildDelta(Object event, VMDelta parent, int nodeOffset, RequestMonitor requestMonitor);
/**
* Retireves the view model elements for the given data model event. This method
* is optional and it allows the view model provider to optimize event processing
* by avoiding the need to retrieve all possible elements for the given node.
* </p>
* For example: If a threads node implementation is given a thread stopped event in
* this method, and the stopped event included a reference to the thread. Then
* the implementation should create a view model context for that thread and return it
* here.
*
* @param parentDelta The parent delta in the processing of this event.
* @param event The event to check for the data model object.
* @param Request monitor for the array of elements corresponding to the
* given event.
*/
public void getContextsForEvent(VMDelta parentDelta, Object event, DataRequestMonitor<IVMContext[]> rm);
/**
* Releases the resources held by this node.
*/
public void dispose();
}
|
