public class DotProperties
extends java.lang.Object
DotProperties
class contains all properties which are supported
by the DotImport
, i.e. they are set on the resulting Graph
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EDGE_ID
Specifies the identifier of an edge.
|
static java.lang.String |
EDGE_LABEL
Specifies the label of an edge.
|
static java.lang.String |
EDGE_STYLE
Specifies the rendering style of an edge, i.e. if it is solid, dashed,
dotted, etc.
|
static java.lang.String |
EDGE_STYLE_DASHDOT
This
EDGE_STYLE value specifies that the edge is rendered
alternately dashed and dotted ("-."). |
static java.lang.String |
EDGE_STYLE_DASHDOTDOT
This
EDGE_STYLE value specifies that the edge is rendered
alternately dashed and dotted ("-.."). |
static java.lang.String |
EDGE_STYLE_DASHED
This
EDGE_STYLE value specifies that the edge is rendered
dashed. |
static java.lang.String |
EDGE_STYLE_DEFAULT
Defines the default value for the
EDGE_STYLE property, which is
EDGE_STYLE_SOLID . |
static java.lang.String |
EDGE_STYLE_DOTTED
This
EDGE_STYLE value specifies that the edge is rendered
dotted. |
static java.lang.String |
EDGE_STYLE_SOLID
This
EDGE_STYLE value specifies that the edge is rendered solid. |
static java.util.Set<java.lang.String> |
EDGE_STYLE_VALUES
Defines all possible values for the
EDGE_STYLE property. |
static java.lang.String |
GRAPH_LAYOUT
Specifies the layout algorithm which shall be used to layout the graph.
|
static java.lang.String |
GRAPH_LAYOUT_CIRCO
This
GRAPH_LAYOUT value specifies that the "circo" layout
algorithm is to be used for laying out the graph. |
static java.lang.String |
GRAPH_LAYOUT_DEFAULT
Defines the default value for the
GRAPH_LAYOUT property, which
is GRAPH_LAYOUT_DOT . |
static java.lang.String |
GRAPH_LAYOUT_DOT
This
GRAPH_LAYOUT value specifies that the "dot" layout
algorithm is to be used for laying out the graph. |
static java.lang.String |
GRAPH_LAYOUT_FDP
This
GRAPH_LAYOUT value specifies that the "fdp" layout
algorithm is to be used for laying out the graph. |
static java.lang.String |
GRAPH_LAYOUT_GRID
This
GRAPH_LAYOUT value specifies that the "grid" layout
algorithm is to be used for laying out the graph. |
static java.lang.String |
GRAPH_LAYOUT_NEATO
This
GRAPH_LAYOUT value specifies that the "neato" layout
algorithm is to be used for laying out the graph. |
static java.lang.String |
GRAPH_LAYOUT_OSAGE
This
GRAPH_LAYOUT value specifies that the "osage" layout
algorithm is to be used for laying out the graph. |
static java.lang.String |
GRAPH_LAYOUT_SFDP
This
GRAPH_LAYOUT value specifies that the "sfdp" layout
algorithm is to be used for laying out the graph. |
static java.lang.String |
GRAPH_LAYOUT_TWOPI
This
GRAPH_LAYOUT value specifies that the "twopi" layout
algorithm is to be used for laying out the graph. |
static java.util.Set<java.lang.String> |
GRAPH_LAYOUT_VALUES
Defines all possible values for the
GRAPH_LAYOUT property. |
static java.lang.String |
GRAPH_RANKDIR
Specifies the rankdir property which is passed to the layout algorithm
which is used for laying out the graph.
|
static java.lang.String |
GRAPH_RANKDIR_DEFAULT
Defines the default value for the
GRAPH_RANKDIR property. |
static java.lang.String |
GRAPH_RANKDIR_LR
This
GRAPH_RANKDIR value specifies that the graph is to be laid
out horizontally from left to right. |
static java.lang.String |
GRAPH_RANKDIR_TD
This
GRAPH_RANKDIR value specifies that the graph is to be laid
out vertically from top to bottom. |
static java.util.Set<java.lang.String> |
GRAPH_RANKDIR_VALUES
Defines all possible values for the
GRAPH_RANKDIR property. |
static java.lang.String |
GRAPH_TYPE
Specifies the graph type.
|
static java.lang.String |
GRAPH_TYPE_DEFAULT
Defines the default value for
GRAPH_TYPE , which is
GRAPH_TYPE_UNDIRECTED . |
static java.lang.String |
GRAPH_TYPE_DIRECTED
This
GRAPH_TYPE value specifies that the edges within the graph
are directed. |
static java.lang.String |
GRAPH_TYPE_UNDIRECTED
This
GRAPH_TYPE value specifies that the edges within the graph
are undirected. |
static java.util.Set<java.lang.String> |
GRAPH_TYPE_VALUES
Defines all possible values for the
GRAPH_TYPE property. |
static java.lang.String |
NODE_ID
Specifies the identifier of a node.
|
static java.lang.String |
NODE_LABEL
Specifies the label of a node.
|
Constructor and Description |
---|
DotProperties() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
getId(org.eclipse.gef4.graph.Edge edge)
Returns the value of the
EDGE_ID property of the given
Edge . |
static java.lang.String |
getId(org.eclipse.gef4.graph.Node node)
Returns the value of the
NODE_ID property of the given
Node . |
static java.lang.String |
getLabel(org.eclipse.gef4.graph.Edge edge)
Returns the value of the
EDGE_LABEL property of the given
Edge . |
static java.lang.String |
getLabel(org.eclipse.gef4.graph.Node node)
Returns the value of the
NODE_LABEL property of the given
Node . |
static java.lang.String |
getLayout(org.eclipse.gef4.graph.Graph graph)
Returns the value of the
GRAPH_LAYOUT property of the given
Graph . |
static java.lang.String |
getRankdir(org.eclipse.gef4.graph.Graph graph)
Returns the value of the
GRAPH_RANKDIR property of the given
Graph . |
static java.lang.String |
getStyle(org.eclipse.gef4.graph.Edge edge)
Returns the value of the
EDGE_STYLE property of the given
Edge . |
static java.lang.String |
getType(org.eclipse.gef4.graph.Graph graph)
Returns the value of the
GRAPH_TYPE property of the given
Graph . |
static void |
setId(org.eclipse.gef4.graph.Edge edge,
java.lang.String id)
Sets the
EDGE_ID property of the given Edge to the given
id value. |
static void |
setId(org.eclipse.gef4.graph.Node node,
java.lang.String id)
Sets the
NODE_ID property of the given Node to the given
id value. |
static void |
setLabel(org.eclipse.gef4.graph.Edge edge,
java.lang.String label)
Sets the
EDGE_LABEL property of the given Edge to the
given label value. |
static void |
setLabel(org.eclipse.gef4.graph.Node node,
java.lang.String label)
Sets the
NODE_LABEL property of the given Node to the
given label value. |
static void |
setLayout(org.eclipse.gef4.graph.Graph graph,
java.lang.String layout)
Sets the
GRAPH_LAYOUT property of the given Graph to the
given layout value. |
static void |
setRankdir(org.eclipse.gef4.graph.Graph graph,
java.lang.String rankdir)
Sets the
GRAPH_RANKDIR property of the given Graph to
the given rankdir value. |
static void |
setStyle(org.eclipse.gef4.graph.Edge edge,
java.lang.String style)
Sets the
EDGE_STYLE property of the given Edge to the
given style value. |
static void |
setType(org.eclipse.gef4.graph.Graph graph,
java.lang.String type)
Sets the
GRAPH_TYPE property of the given Graph to the
given type value. |
public static final java.lang.String NODE_ID
public static final java.lang.String NODE_LABEL
public static final java.lang.String EDGE_ID
public static final java.lang.String EDGE_LABEL
public static final java.lang.String EDGE_STYLE
EDGE_STYLE_VALUES
.
The default value is defined by EDGE_STYLE_DEFAULT
.public static final java.lang.String EDGE_STYLE_DASHED
EDGE_STYLE
value specifies that the edge is rendered
dashed.public static final java.lang.String EDGE_STYLE_DOTTED
EDGE_STYLE
value specifies that the edge is rendered
dotted.public static final java.lang.String EDGE_STYLE_SOLID
EDGE_STYLE
value specifies that the edge is rendered solid.public static final java.lang.String EDGE_STYLE_DASHDOT
EDGE_STYLE
value specifies that the edge is rendered
alternately dashed and dotted ("-.").public static final java.lang.String EDGE_STYLE_DASHDOTDOT
EDGE_STYLE
value specifies that the edge is rendered
alternately dashed and dotted ("-..").public static final java.util.Set<java.lang.String> EDGE_STYLE_VALUES
EDGE_STYLE
property.public static final java.lang.String EDGE_STYLE_DEFAULT
EDGE_STYLE
property, which is
EDGE_STYLE_SOLID
.public static final java.lang.String GRAPH_TYPE
GRAPH_TYPE_VALUES
. The default value is defined by
GRAPH_TYPE_DEFAULT
.public static final java.lang.String GRAPH_TYPE_DIRECTED
GRAPH_TYPE
value specifies that the edges within the graph
are directed.public static final java.lang.String GRAPH_TYPE_UNDIRECTED
GRAPH_TYPE
value specifies that the edges within the graph
are undirected.public static final java.util.Set<java.lang.String> GRAPH_TYPE_VALUES
GRAPH_TYPE
property.public static final java.lang.String GRAPH_TYPE_DEFAULT
GRAPH_TYPE
, which is
GRAPH_TYPE_UNDIRECTED
.public static final java.lang.String GRAPH_LAYOUT
GRAPH_LAYOUT_VALUES
. The default
value is defined by GRAPH_LAYOUT_DEFAULT
.public static final java.lang.String GRAPH_LAYOUT_DOT
GRAPH_LAYOUT
value specifies that the "dot" layout
algorithm is to be used for laying out the graph.public static final java.lang.String GRAPH_LAYOUT_OSAGE
GRAPH_LAYOUT
value specifies that the "osage" layout
algorithm is to be used for laying out the graph.public static final java.lang.String GRAPH_LAYOUT_GRID
GRAPH_LAYOUT
value specifies that the "grid" layout
algorithm is to be used for laying out the graph.public static final java.lang.String GRAPH_LAYOUT_TWOPI
GRAPH_LAYOUT
value specifies that the "twopi" layout
algorithm is to be used for laying out the graph.public static final java.lang.String GRAPH_LAYOUT_CIRCO
GRAPH_LAYOUT
value specifies that the "circo" layout
algorithm is to be used for laying out the graph.public static final java.lang.String GRAPH_LAYOUT_NEATO
GRAPH_LAYOUT
value specifies that the "neato" layout
algorithm is to be used for laying out the graph.public static final java.lang.String GRAPH_LAYOUT_FDP
GRAPH_LAYOUT
value specifies that the "fdp" layout
algorithm is to be used for laying out the graph.public static final java.lang.String GRAPH_LAYOUT_SFDP
GRAPH_LAYOUT
value specifies that the "sfdp" layout
algorithm is to be used for laying out the graph.public static final java.util.Set<java.lang.String> GRAPH_LAYOUT_VALUES
GRAPH_LAYOUT
property.public static final java.lang.String GRAPH_LAYOUT_DEFAULT
GRAPH_LAYOUT
property, which
is GRAPH_LAYOUT_DOT
.public static final java.lang.String GRAPH_RANKDIR
GRAPH_RANKDIR_VALUES
. The default value is defined by
GRAPH_RANKDIR_DEFAULT
.public static final java.lang.String GRAPH_RANKDIR_LR
GRAPH_RANKDIR
value specifies that the graph is to be laid
out horizontally from left to right.public static final java.lang.String GRAPH_RANKDIR_TD
GRAPH_RANKDIR
value specifies that the graph is to be laid
out vertically from top to bottom.public static final java.util.Set<java.lang.String> GRAPH_RANKDIR_VALUES
GRAPH_RANKDIR
property.public static final java.lang.String GRAPH_RANKDIR_DEFAULT
GRAPH_RANKDIR
property.public static java.lang.String getLayout(org.eclipse.gef4.graph.Graph graph)
GRAPH_LAYOUT
property of the given
Graph
.graph
- The Graph
for which to return the value of the
GRAPH_LAYOUT
property.GRAPH_LAYOUT
property of the given
Graph
.public static void setLayout(org.eclipse.gef4.graph.Graph graph, java.lang.String layout)
GRAPH_LAYOUT
property of the given Graph
to the
given layout value.graph
- The Graph
for which to change the value of the
GRAPH_LAYOUT
property.layout
- The new value for the GRAPH_LAYOUT
property.java.lang.IllegalArgumentException
- when the given layout value is not supported, i.e. not
contained within GRAPH_LAYOUT_VALUES
.public static java.lang.String getType(org.eclipse.gef4.graph.Graph graph)
GRAPH_TYPE
property of the given
Graph
.graph
- The Graph
for which to return the value of the
GRAPH_TYPE
property.GRAPH_TYPE
property of the given
Graph
.public static void setType(org.eclipse.gef4.graph.Graph graph, java.lang.String type)
GRAPH_TYPE
property of the given Graph
to the
given type value.graph
- The Graph
for which to change the value of the
GRAPH_TYPE
property.type
- The new value for the GRAPH_TYPE
property.java.lang.IllegalArgumentException
- when the given type value is not supported, i.e. not
contained within GRAPH_TYPE_VALUES
.public static java.lang.String getRankdir(org.eclipse.gef4.graph.Graph graph)
GRAPH_RANKDIR
property of the given
Graph
.graph
- The Graph
for which to return the value of the
GRAPH_RANKDIR
property.GRAPH_RANKDIR
property of the given
Graph
.public static void setRankdir(org.eclipse.gef4.graph.Graph graph, java.lang.String rankdir)
GRAPH_RANKDIR
property of the given Graph
to
the given rankdir value.graph
- The Graph
for which to change the value of the
GRAPH_RANKDIR
property.rankdir
- The new value for the GRAPH_RANKDIR
property.java.lang.IllegalArgumentException
- when the given rankdir value is not supported, i.e.
not contained within GRAPH_RANKDIR_VALUES
.public static java.lang.String getLabel(org.eclipse.gef4.graph.Node node)
NODE_LABEL
property of the given
Node
.node
- The Node
for which to return the value of the
NODE_LABEL
property.NODE_LABEL
property of the given
Node
.public static void setLabel(org.eclipse.gef4.graph.Node node, java.lang.String label)
NODE_LABEL
property of the given Node
to the
given label value.node
- The Node
for which to change the value of the
NODE_LABEL
property.label
- The new value for the NODE_LABEL
property.public static java.lang.String getId(org.eclipse.gef4.graph.Node node)
NODE_ID
property of the given
Node
.public static void setId(org.eclipse.gef4.graph.Node node, java.lang.String id)
NODE_ID
property of the given Node
to the given
id value.public static java.lang.String getLabel(org.eclipse.gef4.graph.Edge edge)
EDGE_LABEL
property of the given
Edge
.edge
- The Edge
for which to return the value of the
EDGE_LABEL
property.EDGE_LABEL
property of the given
Edge
.public static void setLabel(org.eclipse.gef4.graph.Edge edge, java.lang.String label)
EDGE_LABEL
property of the given Edge
to the
given label value.edge
- The Edge
for which to change the value of the
EDGE_LABEL
property.label
- The new value for the EDGE_LABEL
property.public static java.lang.String getStyle(org.eclipse.gef4.graph.Edge edge)
EDGE_STYLE
property of the given
Edge
.edge
- The Edge
for which to return the value of the
EDGE_STYLE
property.EDGE_STYLE
property of the given
Edge
.public static void setStyle(org.eclipse.gef4.graph.Edge edge, java.lang.String style)
EDGE_STYLE
property of the given Edge
to the
given style value.edge
- The Edge
for which to change the value of the
EDGE_STYLE
property.style
- The new value for the EDGE_STYLE
property.java.lang.IllegalArgumentException
- when the given style value is not supported, i.e. not
contained within EDGE_STYLE_VALUES
.public static java.lang.String getId(org.eclipse.gef4.graph.Edge edge)
EDGE_ID
property of the given
Edge
.Copyright (c) 2014 itemis AG and others. All rights reserved.