Package org.eclipse.zest.core.widgets
Class GraphNode
java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Item
org.eclipse.zest.core.widgets.GraphItem
org.eclipse.zest.core.widgets.GraphNode
- Direct Known Subclasses:
CGraphNode
,GraphContainer
Simple node class which has the following properties: color, size, location,
and a label. It also has a list of connections and anchors.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Graph
static final int
static final int
protected int
protected Object
The internal node.protected IFigure
protected IContainer
protected Dimension
Fields inherited from class org.eclipse.zest.core.widgets.GraphItem
CONNECTION, CONTAINER, GRAPH, NODE
-
Constructor Summary
ConstructorsConstructorDescriptionGraphNode
(IContainer graphModel, int style) GraphNode
(IContainer graphModel, int style, Object data) Deprecated, for removal: This API element is subject to removal in a future version.GraphNode
(IContainer graphModel, int style, String text) Deprecated, for removal: This API element is subject to removal in a future version.Since Zest 2.0, useGraphNode(IContainer, int)
andsetText(String)
GraphNode
(IContainer graphModel, int style, String text, Object data) Deprecated, for removal: This API element is subject to removal in a future version.Since Zest 2.0, useGraphNode(IContainer, int, IFigure)
andsetText(String)
GraphNode
(IContainer graphModel, int style, String text, Image image) Deprecated, for removal: This API element is subject to removal in a future version.GraphNode
(IContainer graphModel, int style, String text, Image image, Object data) Deprecated, for removal: This API element is subject to removal in a future version.GraphNode
(IContainer graphModel, int style, IFigure data) -
Method Summary
Modifier and TypeMethodDescriptionboolean
protected IFigure
void
dispose()
protected IFigure
fishEye
(boolean enable, boolean animate) Get the background colour for this node.Returns if the nodes adjacent to this node will be highlighted when this node is selected.int
getFont()
Get the foreground colour for this nodeGets the graphModel that this node is contained inprotected Rectangle
Get the highlight colour for this nodeint
Gets the graph item type.org.eclipse.zest.core.widgets.InternalNodeLayout
Deprecated, for removal: This API element is subject to removal in a future version.Not used in Zest 2.x.Returns a copy of the node's location.Returns the figure of the whole node.int
getSize()
Returns a copy of the node's size.List
<? extends GraphConnection> Returns a new list of the source connections (GraphModelConnection objects).int
getStyle()
List
<? extends GraphConnection> Returns a new list of the target connections (GraphModelConnection objects).Gets the current tooltip for this node.void
Highlights the node changing the background color and border color.protected void
protected void
initModel
(IContainer parent, String text, Image image) boolean
boolean
returns true if node is highlighted, false otherwiseboolean
boolean
Determines if this node has a fixed size or if it is packed to the size of its contents.boolean
Get the visibility of this item.protected void
void
Permanently sets the background color (unhighlighted).void
Sets the border color.void
Sets the highlighted border color.void
setBorderWidth
(int width) void
setCacheLabel
(boolean cacheLabel) void
void
Set the foreground colour for this nodevoid
setHideNodeHelper
(HideNodeHelper hideNodeHelper) void
Set the highlight colour for this nodevoid
void
setLocation
(double x, double y) Sets the current location for this node.void
setModelFigure
(IFigure figure) void
setNodeStyle
(int nodeStyle) void
setSize
(double width, double height) void
void
setTooltip
(IFigure tooltip) Sets the tooltip on this node.void
setVisible
(boolean visible) Set the visibility of this item.toString()
A simple toString that we can use for debuggingvoid
Restores the nodes original background color and border width.protected void
updateFigureForModel
(IFigure currentFigure) Methods inherited from class org.eclipse.zest.core.widgets.GraphItem
checkStyle
Methods inherited from class org.eclipse.swt.widgets.Item
checkSubclass, getImage, getText
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, addTypedListener, checkWidget, getData, getData, getDisplay, getListeners, getTypedListeners, isAutoDirection, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, removeListener, removeTypedListener, reskin, setData, setData
-
Field Details
-
HIGHLIGHT_NONE
public static final int HIGHLIGHT_NONE- See Also:
-
HIGHLIGHT_ON
public static final int HIGHLIGHT_ON- See Also:
-
size
-
graph
-
parent
-
internalNode
The internal node. -
highlighted
protected int highlighted -
nodeFigure
-
-
Constructor Details
-
GraphNode
-
GraphNode
@Deprecated(since="1.12", forRemoval=true) public GraphNode(IContainer graphModel, int style, Object data) Deprecated, for removal: This API element is subject to removal in a future version.Since Zest 2.0, useGraphNode(IContainer, int, IFigure)
instead. -
GraphNode
- Since:
- 1.14
-
GraphNode
@Deprecated(since="1.12", forRemoval=true) public GraphNode(IContainer graphModel, int style, String text) Deprecated, for removal: This API element is subject to removal in a future version.Since Zest 2.0, useGraphNode(IContainer, int)
andsetText(String)
-
GraphNode
@Deprecated(since="1.12", forRemoval=true) public GraphNode(IContainer graphModel, int style, String text, Object data) Deprecated, for removal: This API element is subject to removal in a future version.Since Zest 2.0, useGraphNode(IContainer, int, IFigure)
andsetText(String)
-
GraphNode
@Deprecated(since="1.12", forRemoval=true) public GraphNode(IContainer graphModel, int style, String text, Image image) Deprecated, for removal: This API element is subject to removal in a future version. -
GraphNode
@Deprecated(since="1.12", forRemoval=true) public GraphNode(IContainer graphModel, int style, String text, Image image, Object data) Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
initFigure
protected void initFigure() -
initModel
-
toString
A simple toString that we can use for debugging -
getLayoutEntity
Deprecated, for removal: This API element is subject to removal in a future version.Not used in Zest 2.x. This class will be removed in a future release.- @nooverride
- This method is not intended to be re-implemented or extended by clients.
- @noreference
- This method is not intended to be referenced by clients.
-
dispose
public void dispose() -
isDisposed
public boolean isDisposed()- Overrides:
isDisposed
in classWidget
-
isSizeFixed
public boolean isSizeFixed()Determines if this node has a fixed size or if it is packed to the size of its contents. To set a node to pack, set its size (-1, -1) -
getSourceConnections
Returns a new list of the source connections (GraphModelConnection objects).- Returns:
- List a new list of GraphModelConnect objects
-
getTargetConnections
Returns a new list of the target connections (GraphModelConnection objects).- Returns:
- List a new list of GraphModelConnect objects
-
getLocation
Returns a copy of the node's location.- Returns:
- Point
-
isSelected
public boolean isSelected() -
setLocation
public void setLocation(double x, double y) Sets the current location for this node. -
getSize
Returns a copy of the node's size.- Returns:
- Dimension
-
getForegroundColor
Get the foreground colour for this node -
setForegroundColor
Set the foreground colour for this node -
getBackgroundColor
Get the background colour for this node. This is the color the node will be if it is not currently highlighted. This color is meaningless if a custom figure has been set. -
setBackgroundColor
Permanently sets the background color (unhighlighted). This color has no effect if a custom figure has been set.- Parameters:
c
-
-
setTooltip
Sets the tooltip on this node. This tooltip will display if the mouse hovers over the node. Setting the tooltip has no effect if a custom figure has been set. -
getTooltip
Gets the current tooltip for this node. The tooltip returned is meaningless if a custom figure has been set. -
setBorderColor
Sets the border color.- Parameters:
c
- the border color.
-
setBorderHighlightColor
Sets the highlighted border color.- Parameters:
c
- the highlighted border color.
-
getHighlightColor
Get the highlight colour for this node -
setHighlightColor
Set the highlight colour for this node -
highlight
public void highlight()Highlights the node changing the background color and border color. The source and destination connections are also highlighted, and the adjacent nodes are highlighted too in a different color. -
unhighlight
public void unhighlight()Restores the nodes original background color and border width.- Specified by:
unhighlight
in classGraphItem
-
refreshLocation
protected void refreshLocation() -
getBorderColor
Returns if the nodes adjacent to this node will be highlighted when this node is selected.- Returns:
- GraphModelNode
-
getBorderWidth
public int getBorderWidth() -
setBorderWidth
public void setBorderWidth(int width) -
getFont
-
setFont
-
setText
-
setImage
-
getGraphModel
Gets the graphModel that this node is contained in- Specified by:
getGraphModel
in classGraphItem
- Returns:
- The graph model that this node is contained in
-
getNodeStyle
public int getNodeStyle()- Returns:
- the nodeStyle
-
setNodeStyle
public void setNodeStyle(int nodeStyle) - Parameters:
nodeStyle
- the nodeStyle to set
-
setSize
public void setSize(double width, double height) -
getBorderHighlightColor
-
cacheLabel
public boolean cacheLabel() -
setCacheLabel
public void setCacheLabel(boolean cacheLabel) -
getNodeFigure
Returns the figure of the whole node.- Returns:
- nodeFigure
-
setVisible
public void setVisible(boolean visible) Description copied from class:GraphItem
Set the visibility of this item.- Specified by:
setVisible
in classGraphItem
- Parameters:
visible
- whether or not this item is visible.
-
setModelFigure
- Since:
- 1.8
-
getModelFigure
- Since:
- 1.8
-
setHideNodeHelper
- Since:
- 1.8
-
getHideNodeHelper
- Since:
- 1.8
-
getStyle
public int getStyle() -
getHideContainerBounds
- Since:
- 1.8
-
fishEye
-
isHighlighted
public boolean isHighlighted()returns true if node is highlighted, false otherwise- Overrides:
isHighlighted
in classGraphItem
- Returns:
- state of highlight
- Since:
- 1.9
-
updateFigureForModel
-
createFigureForModel
-
isVisible
public boolean isVisible()Description copied from class:GraphItem
Get the visibility of this item. -
getItemType
public int getItemType()Description copied from class:GraphItem
Gets the graph item type. The item type is one of: GRAPH, NODE or CONNECTION- Specified by:
getItemType
in classGraphItem
-
getLayout
public org.eclipse.zest.core.widgets.InternalNodeLayout getLayout()- @noreference
- This method is not intended to be referenced by clients.
-
GraphNode(IContainer, int, IFigure)
instead.