public class DefaultRefreshBehavior
extends java.lang.Object
DiagramBehavior
behavior extension
that controls the refresh behavior of the Graphiti diagram editor. Clients
may subclass to change the behavior; use
DiagramBehavior.createRefreshBehavior()
to return the instance that
shall be used.DiagramBehavior
.Constructor and Description |
---|
DefaultRefreshBehavior(DiagramBehavior diagramBehavior)
Creates a new standard refresh behaviour for a Graphiti diagram editor.
|
Modifier and Type | Method and Description |
---|---|
void |
handleAutoUpdateAtReset()
Handles the auto update at rest of the editor (the editor performs a
reload of the EMF resources because e.g.
|
void |
handleAutoUpdateAtStartup()
Handles the auto update at startup of the editor and is called by the
Graphiti
DiagramBehavior when the input is set (
DiagramBehavior#setInput(org.eclipse.ui.IEditorInput) ). |
void |
initRefresh()
Initializes the performance cache and is called by the Graphiti framework
before a refresh is triggered.
|
void |
internalRefreshEditPart(org.eclipse.gef.EditPart editPart)
Internal refresh of a given
EditPart . |
boolean |
isAutoRefresh()
Returns if auto refresh is enabled or not.
|
boolean |
isMultipleRefreshSupressionActive()
Returns if multiple refreshes shall be omitted and a bundled refresh
should happen instead.
|
void |
refresh()
Does the refresh of the editor, so that the UI reflects the current state
of the Graphiti pictograms model.
|
void |
refreshRenderingDecorators(PictogramElement pe)
Refreshes all rendering decorators for the given
PictogramElement
as defined in
IToolBehaviorProvider.getDecorators(PictogramElement) . |
void |
setAutoRefresh(boolean autoRefresh)
Auto refresh can be enabled or disabled with this function.In case it is
enabled the editor will automatically react on EMF resource changes.
|
boolean |
shouldRefresh(java.lang.Object obj)
Checks the performance cache if a refresh shall be triggered for the
given object.
|
public DefaultRefreshBehavior(DiagramBehavior diagramBehavior)
DiagramBehavior
is closely linked to this instance (1:1
relation) and both instances will have a common lifecycle.diagramEditor
- The associated DiagramBehavior
.public void initRefresh()
public void handleAutoUpdateAtStartup()
DiagramBehavior
when the input is set (
DiagramBehavior#setInput(org.eclipse.ui.IEditorInput)
). The
default implementation checks the desired behavior as defined in
IDiagramTypeProvider.isAutoUpdateAtStartup()
and calls
#autoUpdate(Diagram, IDiagramTypeProvider)
in case an update
shall be done.public void handleAutoUpdateAtReset()
DiagramBehavior
after the Diagram
has been reloaded. The
default implementation checks the desired behavior as defined in
IDiagramTypeProvider.isAutoUpdateAtReset()
and calls
#autoUpdate(Diagram, IDiagramTypeProvider)
in case an update
shall be done.public void refresh()
public void refreshRenderingDecorators(PictogramElement pe)
PictogramElement
as defined in
IToolBehaviorProvider.getDecorators(PictogramElement)
.pe
- the PictogramElement
to refresh the decorators forpublic void internalRefreshEditPart(org.eclipse.gef.EditPart editPart)
EditPart
.editPart
- the edit part to refreshpublic boolean isAutoRefresh()
By default the auto refresh is turned on so this method returns
true
.
public void setAutoRefresh(boolean autoRefresh)
By default the auto refresh is turned on.
autoRefresh
- the new value of auto refreshpublic boolean isMultipleRefreshSupressionActive()
Figure
s.
The default implementation simply returns true
. Note:
returning false here might have large performance implications, so use
this option only with extra care!
public boolean shouldRefresh(java.lang.Object obj)