Package org.eclipse.zest.core.viewers
Class GraphViewer
- All Implemented Interfaces:
IInputProvider,IInputSelectionProvider,IPostSelectionProvider,ISelectionProvider
This view is used to represent a static graph. Static graphs can be layed
out, but do not continually update their layout locations.
- @noextend
- This class is not intended to be subclassed by clients.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.jface.viewers.StructuredViewer
StructuredViewer.ColorAndFontCollector, StructuredViewer.ColorAndFontCollectorWithProviders -
Field Summary
FieldsFields inherited from class org.eclipse.jface.viewers.Viewer
WIDGET_DATA_KEY -
Constructor Summary
ConstructorsConstructorDescriptionGraphViewer(Composite composite, int style) Initializes the viewer.GraphViewer(Graph graph) Initializes the viewer. -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidApplys the current layout to the viewerfindGraphItem(Object element) Finds the graph widget item for a given user model item.Object[]protected org.eclipse.zest.core.viewers.internal.IStylingGraphModelFactoryReturns the factory used to create the model.protected LayoutAlgorithmGets the current layout algorithm.Object[]intgetStyle()Gets the styles for this structuredViewerprotected org.eclipse.zest.core.viewers.internal.ZoomManagerReturns a ZoomManager that zooming can be done on.protected voidhookControl(Control control) protected voidinputChanged(Object input, Object oldInput) voidNOTE: If a layout algorithm is set in the receiver, layout is performed after the refresh.voidNOTE: If a layout algorithm is set in the receiver, layout is performed after the refresh.voidvoidvoidsetConnectionStyle(int connectionStyle) Sets the default style for connections in this graph.voidsetContentProvider(IContentProvider contentProvider) voidsetControl(Graph graphModel) voidsetLayoutAlgorithm(LayoutAlgorithm algorithm) Equivalent to setLayoutAlgorithm(algorithm, false).voidsetLayoutAlgorithm(LayoutAlgorithm algorithm, boolean runLayout) Sets the layout algorithm to use for this viewer.voidsetNodeStyle(int nodeStyle) Sets the default style for nodes in this graph.protected voidsetSelectionToWidget(List l, boolean reveal) voidvoidNOTE: If a layout algorithm is set in the receiver, layout is performed after the update.voidNOTE: If a layout algorithm is set in the receiver, layout is performed after the update.Methods inherited from class org.eclipse.zest.core.viewers.AbstractStructuredGraphViewer
addConstraintAdapter, addGraphModelConnection, addGraphModelContainer, addGraphModelNode, addGraphModelNode, addNode, addRelationship, addRelationship, createConnectionObject, createNodeObject, doFindInputItem, doFindItem, doUpdateItem, filterVisuals, findItems, getConnectionsArray, getConnectionStyle, getConstraintAdapters, getGraphModelConnection, getGraphModelNode, getGraphStyle, getNodesArray, getNodesMap, getNodeStyle, getRawChildren, getSelectionFromWidget, getWidgetSelection, internalRefresh, removeGraphModelConnection, removeGraphModelNode, removeNode, removeRelationshipMethods inherited from class org.eclipse.zest.core.viewers.AbstractZoomableViewer
zoomToMethods inherited from class org.eclipse.jface.viewers.StructuredViewer
addDoubleClickListener, addDragSupport, addDropSupport, addFilter, addOpenListener, addPostSelectionChangedListener, assertContentProviderType, assertElementsNotNull, associate, buildLabel, disassociate, equals, filter, findItem, findItems, fireDoubleClick, fireOpen, firePostSelectionChanged, getColorAndFontCollector, getComparator, getComparer, getFilteredChildren, getFilters, getItem, getRoot, getSelection, getSortedChildren, getSorter, getStructuredSelection, handleDispose, handleDoubleSelect, handleInvalidSelection, handleLabelProviderChanged, handleOpen, handlePostSelect, handleSelect, hasFilters, internalRefresh, internalUpdate, mapElement, needsRefilter, preservingSelection, refresh, refresh, refreshItem, removeDoubleClickListener, removeFilter, removeOpenListener, removePostSelectionChangedListener, resetFilters, setComparator, setComparer, setFilters, setInput, setLabelProvider, setSelection, setSelectionToWidget, setSorter, setUseHashlookup, testFindItem, testFindItems, unmapAllElements, unmapElement, unmapElement, updateItem, updateSelection, usingElementMapMethods inherited from class org.eclipse.jface.viewers.ContentViewer
getContentProvider, getInput, getLabelProvider, labelProviderChangedMethods inherited from class org.eclipse.jface.viewers.Viewer
addHelpListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, scrollDown, scrollUp, setData, setSelectionMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.jface.viewers.ISelectionProvider
getSelection, setSelection
-
Field Details
-
graph
-
-
Constructor Details
-
GraphViewer
Initializes the viewer.- Parameters:
composite- The parent composite.style- The style for the viewer and the related Graph.- See Also:
-
GraphViewer
Initializes the viewer.- Parameters:
graph- The initial graph widget- Since:
- 1.14
-
-
Method Details
-
setControl
-
hookControl
- Overrides:
hookControlin classStructuredViewer
-
inputChanged
- Overrides:
inputChangedin classAbstractStructuredGraphViewer
-
getStyle
public int getStyle()Gets the styles for this structuredViewer -
getGraphControl
- Overrides:
getGraphControlin classAbstractStructuredGraphViewer
-
setLayoutAlgorithm
Sets the layout algorithm to use for this viewer.- Specified by:
setLayoutAlgorithmin classAbstractStructuredGraphViewer- Parameters:
algorithm- the algorithm to layout the nodesrunLayout- if the layout should be run
-
setLayoutAlgorithm
Description copied from class:AbstractStructuredGraphViewerEquivalent to setLayoutAlgorithm(algorithm, false).- Overrides:
setLayoutAlgorithmin classAbstractStructuredGraphViewer- Parameters:
algorithm-
-
setNodeStyle
public void setNodeStyle(int nodeStyle) Description copied from class:AbstractStructuredGraphViewerSets the default style for nodes in this graph. Note: if an input is set on the viewer, a ZestException will be thrown.- Overrides:
setNodeStylein classAbstractStructuredGraphViewer- Parameters:
nodeStyle- the style for the nodes.- See Also:
-
setContentProvider
- Overrides:
setContentProviderin classStructuredViewer
-
findGraphItem
Finds the graph widget item for a given user model item. Note: This method returns an internal interface (GraphItem). You should be able to cast this to either a IGraphModelNode or IGraphModelConnection (which are also internal). These are internal because this API is not stable. If use this method (to access internal nodes and edges), your code may not compile between versions.- Parameters:
element- The user model node.- Returns:
- An IGraphItem. This should be either a IGraphModelNode or IGraphModelConnection
-
applyLayout
public void applyLayout()Applys the current layout to the viewer- Specified by:
applyLayoutin classAbstractStructuredGraphViewer
-
setSelectionToWidget
- Overrides:
setSelectionToWidgetin classAbstractStructuredGraphViewer
-
getControl
- Specified by:
getControlin classViewer
-
getNodeElements
- Overrides:
getNodeElementsin classAbstractStructuredGraphViewer
-
getConnectionElements
- Overrides:
getConnectionElementsin classAbstractStructuredGraphViewer
-
reveal
- Overrides:
revealin classAbstractStructuredGraphViewer
-
setConnectionStyle
public void setConnectionStyle(int connectionStyle) Description copied from class:AbstractStructuredGraphViewerSets the default style for connections in this graph. Note: if an input is set on the viewer, a ZestException will be thrown.- Overrides:
setConnectionStylein classAbstractStructuredGraphViewer- Parameters:
connectionStyle- the style for the connections.- See Also:
-
unReveal
- Overrides:
unRevealin classAbstractStructuredGraphViewer
-
addSelectionChangedListener
- Specified by:
addSelectionChangedListenerin interfaceISelectionProvider- Overrides:
addSelectionChangedListenerin classViewer
-
removeSelectionChangedListener
- Specified by:
removeSelectionChangedListenerin interfaceISelectionProvider- Overrides:
removeSelectionChangedListenerin classViewer
-
refresh
NOTE: If a layout algorithm is set in the receiver, layout is performed after the refresh.- Overrides:
refreshin classStructuredViewer
-
refresh
NOTE: If a layout algorithm is set in the receiver, layout is performed after the refresh.- Overrides:
refreshin classStructuredViewer
-
update
NOTE: If a layout algorithm is set in the receiver, layout is performed after the update.- Overrides:
updatein classStructuredViewer
-
update
NOTE: If a layout algorithm is set in the receiver, layout is performed after the update.- Overrides:
updatein classStructuredViewer
-
getZoomManager
protected org.eclipse.zest.core.viewers.internal.ZoomManager getZoomManager()Description copied from class:AbstractZoomableViewerReturns a ZoomManager that zooming can be done on. May return null if none is available.- Specified by:
getZoomManagerin classAbstractZoomableViewer- Returns:
- a ZoomManager that zooming can be done on.
-
getFactory
protected org.eclipse.zest.core.viewers.internal.IStylingGraphModelFactory getFactory()Description copied from class:AbstractStructuredGraphViewerReturns the factory used to create the model. This must not be called before the content provider is set.- Specified by:
getFactoryin classAbstractStructuredGraphViewer
-
getLayoutAlgorithm
Description copied from class:AbstractStructuredGraphViewerGets the current layout algorithm.- Specified by:
getLayoutAlgorithmin classAbstractStructuredGraphViewer- Returns:
- the current layout algorithm.
-