StyleManager (GINsim 3.0.0b-SNAPSHOT API)

java.lang.Object
- org.ginsim.core.graph.view.style.StyleManager<V,E>

Type Parameters:

V - The type of Vertices

E - The type of Edges
```
public class StyleManager<V,E extends Edge<V>>
extends Object
```
Store and handle styles for a Graph.

Author:

Aurelien Naldi

Constructor Summary

Constructors
Constructor and Description
`StyleManager(Graph<V,E> g, GraphBackend<V,E> backend, GraphFactory factory)` Create a style manager, defining default styles.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EdgeStyle<V,E>`	`addEdgeStyle()` Create a new edge style.
`NodeStyle<V>`	`addNodeStyle()` Create a new node style.
`void`	`applyEdgeStyle(Collection<E> edges, EdgeStyle<V,E> style)` Apply a style to a group of edges.
`void`	`applyEdgeStyle(E edge, EdgeStyle<V,E> style)` Apply a style to a single edge.
`void`	`applyNodeStyle(Collection<V> nodes, NodeStyle<V> style)` Apply a style to a group of nodes.
`void`	`applyNodeStyle(V node, NodeStyle<V> style)` Apply a style to a single node.
`void`	`clearEdgeRouting(E selected)`
`void`	`deleteStyle(Style style)`
`EdgeStyle<V,E>`	`getDefaultEdgeStyle()` Retrieve the default style for edges
`NodeStyle<V>`	`getDefaultNodeStyle()` Retrieve the default style for nodes
`EdgeAnchor`	`getEdgeAnchor(E edge)`
`boolean`	`getEdgeCurved(E edge)`
`EdgeStyle<V,E>`	`getEdgeStyle(String name)` Retrieve an edge style based on its name.
`List<EdgeStyle<V,E>>`	`getEdgeStyles()` Get the list of all edge styles
`NodeStyle<V>`	`getNodeStyle(String name)` Retrieve a node style based on its name.
`List<NodeStyle<V>>`	`getNodeStyles()` Get the list of all node styles
`StyleProvider`	`getStyleProvider()` Retrieve the current style provider.
`EdgeStyle`	`getUsedEdgeStyle(E edge)` Get the edge style stored in the graph.
`NodeStyle<V>`	`getUsedNodeStyle(V node)` Get the node style stored in the graph.
`EdgeStyle`	`getViewEdgeStyle(E edge)` Get the edge style used for the view.
`NodeStyle<V>`	`getViewNodeStyle(V node)` Get the node style used for the view.
`EdgeStyle`	`guessEdgeStyle(String qName, Attributes attributes)` Find an edge style corresponding to the desired attributes.
`NodeStyle`	`guessNodeStyle(String qName, Attributes attributes)` Find a node style corresponding to the desired attributes.
`boolean`	`isCompatMode()` Check if the styles are disabled (for backward compatibility when saving).
`void`	`parseStyle(String qName, Attributes attributes)`
`void`	`renameStyle(Style style, String newname)`
`void`	`setCompatMode(boolean b)` Enable or disable styles.
`void`	`setEdgeAnchor(E edge, EdgeAnchor anchor)`
`void`	`setEdgeCurved(E edge, boolean curved)`
`void`	`setStyleProvider(StyleProvider<V,E> provider)` Define the style provider, it will override graph's style until it is removed.
`void`	`styles2ginml(XMLWriter writer)` Save all styles to GINML
`void`	`stylesUpdated()` Called when all styling has been modified, it will refresh the view.
`void`	`styleUpdated(Style style)` Called when a style has been modified, it will refresh the view.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StyleManager
```
public StyleManager(Graph<V,E> g,
                    GraphBackend<V,E> backend,
                    GraphFactory factory)
```
    Create a style manager, defining default styles.
    
    Parameters:
    
    g - the graph to manage
    
    backend - the graph backend in which the data is stored
    
    backend - factory the factory providing the default styles
- Method Detail
  - isCompatMode
```
public boolean isCompatMode()
```
    Check if the styles are disabled (for backward compatibility when saving).
    
    Returns:
    
    true if styles should not be used.
  - setCompatMode
```
public void setCompatMode(boolean b)
```
    Enable or disable styles.
    
    Parameters:
    
    b -
  - getDefaultNodeStyle
```
public NodeStyle<V> getDefaultNodeStyle()
```
    Retrieve the default style for nodes
    
    Returns:
    
    the default style for nodes
  - getDefaultEdgeStyle
```
public EdgeStyle<V,E> getDefaultEdgeStyle()
```
    Retrieve the default style for edges
    
    Returns:
    
    the default style for edges
  - styles2ginml
```
public void styles2ginml(XMLWriter writer)
                  throws IOException
```
    Save all styles to GINML
    
    Parameters:
    
    writer -
    
    Throws:
    
    IOException
  - parseStyle
```
public void parseStyle(String qName,
                       Attributes attributes)
```
  - addNodeStyle
```
public NodeStyle<V> addNodeStyle()
```
    Create a new node style.
    
    Returns:
    
    the new style
  - addEdgeStyle
```
public EdgeStyle<V,E> addEdgeStyle()
```
    Create a new edge style.
    
    Returns:
    
    the new style
  - getNodeStyle
```
public NodeStyle<V> getNodeStyle(String name)
```
    Retrieve a node style based on its name. Note that this is not the regular way to retrieve a style, and should only be used by the parser.
    
    Parameters:
    
    name -
    
    Returns:
    
    the corresponding style, or null if not found/default
  - getEdgeStyle
```
public EdgeStyle<V,E> getEdgeStyle(String name)
```
    Retrieve an edge style based on its name. Note that this is not the regular way to retrieve a style, and should only be used by the parser.
    
    Parameters:
    
    name -
    
    Returns:
    
    the corresponding style, or null if not found/default
  - getEdgeCurved
```
public boolean getEdgeCurved(E edge)
```
  - setEdgeCurved
```
public void setEdgeCurved(E edge,
                          boolean curved)
```
  - getEdgeAnchor
```
public EdgeAnchor getEdgeAnchor(E edge)
```
  - setEdgeAnchor
```
public void setEdgeAnchor(E edge,
                          EdgeAnchor anchor)
```
  - clearEdgeRouting
```
public void clearEdgeRouting(E selected)
```
  - guessNodeStyle
```
public NodeStyle guessNodeStyle(String qName,
                                Attributes attributes)
```
    Find a node style corresponding to the desired attributes. If needed, a new style will be created. Note that this is not the regular way to retrieve a style, it should only used when parsing old models (without styles) to assign the same style to elements with similar attributes.
    
    Parameters:
    
    qName -
    
    attributes -
    
    Returns:
    
    a matching style (can be a new one)
  - guessEdgeStyle
```
public EdgeStyle guessEdgeStyle(String qName,
                                Attributes attributes)
```
    Find an edge style corresponding to the desired attributes. If needed, a new style will be created. Note that this is not the regular way to retrieve a style, it should only used when parsing old models (without styles) to assign the same style to elements with similar attributes.
    
    Parameters:
    
    qName -
    
    attributes -
    
    Returns:
    
    a matching style (can be a new one)
  - getNodeStyles
```
public List<NodeStyle<V>> getNodeStyles()
```
    Get the list of all node styles
    
    Returns:
    
    the list of node styles
  - getEdgeStyles
```
public List<EdgeStyle<V,E>> getEdgeStyles()
```
    Get the list of all edge styles
    
    Returns:
    
    the list of edge styles
  - getViewNodeStyle
```
public NodeStyle<V> getViewNodeStyle(V node)
```
    Get the node style used for the view. The returned style can be the core one or a style provided by a StyleProvider.
    
    Parameters:
    
    node -
    
    Returns:
    
    the style for this node.
  - getUsedNodeStyle
```
public NodeStyle<V> getUsedNodeStyle(V node)
```
    Get the node style stored in the graph. The returned style ignores the presence of a StyleProvider.
    
    Parameters:
    
    node -
    
    Returns:
    
    the style for this node.
  - getViewEdgeStyle
```
public EdgeStyle getViewEdgeStyle(E edge)
```
    Get the edge style used for the view. The returned style can be the core one or a style provided by a StyleProvider.
    
    Parameters:
    
    edge -
    
    Returns:
    
    the style for this edge.
  - getUsedEdgeStyle
```
public EdgeStyle getUsedEdgeStyle(E edge)
```
    Get the edge style stored in the graph. The returned style ignores the presence of a StyleProvider.
    
    Parameters:
    
    edge -
    
    Returns:
    
    the style for this edge.
  - applyNodeStyle
```
public void applyNodeStyle(Collection<V> nodes,
                           NodeStyle<V> style)
```
    Apply a style to a group of nodes.
    
    Parameters:
    
    nodes -
    
    style -
  - applyNodeStyle
```
public void applyNodeStyle(V node,
                           NodeStyle<V> style)
```
    Apply a style to a single node.
    
    Parameters:
    
    node -
    
    style -
  - applyEdgeStyle
```
public void applyEdgeStyle(Collection<E> edges,
                           EdgeStyle<V,E> style)
```
    Apply a style to a group of edges.
    
    Parameters:
    
    edges -
    
    style -
  - applyEdgeStyle
```
public void applyEdgeStyle(E edge,
                           EdgeStyle<V,E> style)
```
    Apply a style to a single edge.
    
    Parameters:
    
    edge -
    
    style -
  - stylesUpdated
```
public void stylesUpdated()
```
    Called when all styling has been modified, it will refresh the view.
  - styleUpdated
```
public void styleUpdated(Style style)
```
    Called when a style has been modified, it will refresh the view. Currently it just forwards call to stylesUpdated()
    
    Parameters:
    
    style - the updated style
  - setStyleProvider
```
public void setStyleProvider(StyleProvider<V,E> provider)
```
    Define the style provider, it will override graph's style until it is removed.
    
    Parameters:
    
    provider - the provider to use or null to remove it
  - getStyleProvider
```
public StyleProvider getStyleProvider()
```
    Retrieve the current style provider.
    
    Returns:
    
    the style provider (null by default)
  - renameStyle
```
public void renameStyle(Style style,
                        String newname)
```
  - deleteStyle
```
public void deleteStyle(Style style)
```

Class StyleManager<V,E extends Edge<V>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StyleManager

Method Detail

isCompatMode

setCompatMode

getDefaultNodeStyle

getDefaultEdgeStyle

styles2ginml

parseStyle

addNodeStyle

addEdgeStyle

getNodeStyle

getEdgeStyle

getEdgeCurved

setEdgeCurved

getEdgeAnchor

setEdgeAnchor

clearEdgeRouting

guessNodeStyle

guessEdgeStyle

getNodeStyles

getEdgeStyles

getViewNodeStyle

getUsedNodeStyle

getViewEdgeStyle

getUsedEdgeStyle

applyNodeStyle

applyNodeStyle

applyEdgeStyle

applyEdgeStyle

stylesUpdated

styleUpdated

setStyleProvider

getStyleProvider

renameStyle

deleteStyle