public final class PipelinedViewerUpdate extends Object
PipelinedViewerUpdate
as the input and return type from intercept
methods on IPipelinedTreeContentProvider
.
Clients should use the viewer update to describe how the request from the
upstream extension (see IPipelinedTreeContentProvider
for more
information on upstream extensions) should be reshaped when applied
to the tree. A request from an upstream extension to refresh a given element
could result in multiple refresh requests from downstream extensions.
Therefore, the refresh targets are modeled as a set.
Initially, this set will contain the original element that was passed to the refresh requests. Clients may squash the refresh by clearing the set, change the original target by removing the current element and adding a new target, or expand the refresh by adding more elements to the set.
A pipelined extension may receive a PipelinedViewerUpdate
as the
result of a call to StructuredViewer.refresh()
-methods or
ColumnViewer.update(Object, String[])
-methods. The
properties
field is only applicable for update()
calls and the updateLabels
field is only applicable for
refresh()
calls.
Constructor and Description |
---|
PipelinedViewerUpdate() |
Modifier and Type | Method and Description |
---|---|
String[] |
getProperties(Object aTarget)
Properties allow optimization for
update calls. |
Set |
getRefreshTargets() |
boolean |
isUpdateLabels() |
void |
setProperties(Object aTarget,
String[] theProperties)
Properties allow optimization for
update calls. |
void |
setUpdateLabels(boolean toUpdateLabels) |
public final String[] getProperties(Object aTarget)
update
calls.aTarget
- The target which may have specific properties associated with
it for an optimized refresh.public final void setProperties(Object aTarget, String[] theProperties)
update
calls.aTarget
- The target of the properties.theProperties
- The properties to pass along to the update
call.ColumnViewer.update(Object, String[])
public final Set getRefreshTargets()
public final boolean isUpdateLabels()
refresh
.public final void setUpdateLabels(boolean toUpdateLabels)
toUpdateLabels
- True indicates that calls to refresh
should
force the update of the labels in addition to refreshing the
structure.
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.