Search this API

y.view
Class LocalViewCreator.SourceAndTarget

java.lang.Object
  extended by y.view.LocalViewCreator
      extended by y.view.LocalViewCreator.AbstractLocalViewCreator
          extended by y.view.LocalViewCreator.SourceAndTarget
Enclosing class:
LocalViewCreator

public static class LocalViewCreator.SourceAndTarget
extends LocalViewCreator.AbstractLocalViewCreator

Local view creator that creates local views by simply displaying its collection of focused edges (and their target and source nodes).

 

Nested Class Summary
 
Nested classes/interfaces inherited from class y.view.LocalViewCreator
LocalViewCreator.AbstractLocalViewCreator, LocalViewCreator.AncestorGroups, LocalViewCreator.CommonParentGroup, LocalViewCreator.EdgeGroup, LocalViewCreator.FolderContents, LocalViewCreator.Neighborhood, LocalViewCreator.SourceAndTarget
 
Field Summary
 
Fields inherited from class y.view.LocalViewCreator.AbstractLocalViewCreator
ELEMENT_TYPE_EDGE, ELEMENT_TYPE_NODE
 
Constructor Summary
LocalViewCreator.SourceAndTarget(Graph2D model)
          Creates a new SourceAndTarget instance for the specified model graph.
LocalViewCreator.SourceAndTarget(Graph2D model, GraphCopier.CopyFactory factory)
          Creates a new SourceAndTarget instance for the specified model graph and copy factory.
LocalViewCreator.SourceAndTarget(Graph2D model, GraphCopier.CopyFactory factory, Graph2D view)
          Creates a new SourceAndTarget instance for the specified model graph, copy factory, and view graph.
 
Method Summary
protected  void buildViewGraph()
          Creates graph elements in the creator's view graph.
protected  NodeRealizer createViewRealizer(Node model, Node view)
          Creates and/or configures the realizer to display group nodes in the view graph whose corresponding model nodes are folder nodes.
 Graph2D getModel()
          Returns the model graph for which the creator may create local views.
 Edge getModelEdge(Edge view)
          Returns a edge in the creator's model graph that corresponds to the specified edge in the creator's view graph or null if there is no corresponding edge.
 Node getModelNode(Node view)
          Returns a node in the creator's model graph that corresponds to the specified node in the creator's view graph or null if there is no corresponding node.
 Edge getViewEdge(Edge model)
          Returns a edge in the creator's view graph that corresponds to the specified edge in the creator's model graph or null if there is no corresponding edge.
 Graph2D getViewGraph()
          Returns the view graph that is modified by the creator's updateViewGraph method.
 Node getViewNode(Node model)
          Returns a node in the creator's view graph that corresponds to the specified node in the creator's model graph or null if there is no corresponding node.
 boolean isHierarchyAware()
          Determines whether the real end node of an inter edge is shown or if the folder node is shown.
 void setHierarchyAware(boolean enabled)
          Specifies whether the real end node of an inter edge is shown or if the folder node is shown.
 
Methods inherited from class y.view.LocalViewCreator.AbstractLocalViewCreator
addFocusEdge, addFocusNode, addSelectionTrigger, clearFocusEdges, clearFocusNodes, createHoverTrigger, createSelectionTrigger, focusEdges, focusNodes, getElementType, getTriggerDelay, isFocusEdge, isFocusNode, isSingleFocus, removeFocusEdge, removeFocusNode, removeSelectionTrigger, setSingleFocus, setTriggerDelay
 
Methods inherited from class y.view.LocalViewCreator
createDefaultLayouter, getLayouter, layoutViewGraph, publishViewGraph, setLayouter, updateViewGraph
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LocalViewCreator.SourceAndTarget

public LocalViewCreator.SourceAndTarget(Graph2D model)
Creates a new SourceAndTarget instance for the specified model graph. Invoking this constructor is equivalent to:
new SourceAndTarget(model, model.getGraphCopyFactory(), (Graph2D) model.getGraphCopyFactory().createGraph());

Parameters:
model - the graph for which local views are to be created.

LocalViewCreator.SourceAndTarget

public LocalViewCreator.SourceAndTarget(Graph2D model,
                                        GraphCopier.CopyFactory factory)
Creates a new SourceAndTarget instance for the specified model graph and copy factory. Invoking this constructor is equivalent to:
new SourceAndTarget(model, factory, (Graph2D) factory.createGraph());

Note: The graph instances created by the specified factory have to be of type Graph2D or subclasses thereof. Moreover, the factory.

Parameters:
model - the graph for which local views are to be created.
factory - that CopyFactory that will be used to create graph elements in the creator's view graph.

LocalViewCreator.SourceAndTarget

public LocalViewCreator.SourceAndTarget(Graph2D model,
                                        GraphCopier.CopyFactory factory,
                                        Graph2D view)
Creates a new SourceAndTarget instance for the specified model graph, copy factory, and view graph.

Note: The specified factory has to be able to create graph elements in the specified view graph.

Parameters:
model - the graph for which local views are to be created.
factory - that CopyFactory that will be used to create graph elements in the creator's view graph.
view - the graph that will be modified by the creator.
Method Detail

isHierarchyAware

public boolean isHierarchyAware()
Determines whether the real end node of an inter edge is shown or if the folder node is shown.

By default, this property is set to false.

Returns:
true if the the real end nodes on both sides of a focused edge are shown in the local view and false otherwise.
See Also:
setHierarchyAware(boolean), HierarchyManager.isInterEdge(y.base.Edge)

setHierarchyAware

public void setHierarchyAware(boolean enabled)
Specifies whether the real end node of an inter edge is shown or if the folder node is shown.

By default, this property is set to false.

Parameters:
enabled - true if the real end nodes should be shown in the created local view and false otherwise.
See Also:
isHierarchyAware(), HierarchyManager.isInterEdge(y.base.Edge)

buildViewGraph

protected void buildViewGraph()
Description copied from class: LocalViewCreator
Creates graph elements in the creator's view graph. This method is also responsible for creating mappings between graph elements in the creator's model graph and the creator's view graph.

Specified by:
buildViewGraph in class LocalViewCreator
See Also:
LocalViewCreator.updateViewGraph()

createViewRealizer

protected NodeRealizer createViewRealizer(Node model,
                                          Node view)
Creates and/or configures the realizer to display group nodes in the view graph whose corresponding model nodes are folder nodes.

Parameters:
model - a folder node in creator's model graph.
view - a group node in the creator's view graph that is the representative of the specified model node for which a realizer should be created and/or configured.
Returns:
the view node's adjusted realizer.

getModel

public Graph2D getModel()
Description copied from class: LocalViewCreator
Returns the model graph for which the creator may create local views.

Specified by:
getModel in class LocalViewCreator
Returns:
the model graph for which the creator may create local views.

getViewGraph

public Graph2D getViewGraph()
Description copied from class: LocalViewCreator
Returns the view graph that is modified by the creator's updateViewGraph method.

Specified by:
getViewGraph in class LocalViewCreator
Returns:
the view graph that is modified by the creator's updateViewGraph method.
See Also:
LocalViewCreator.updateViewGraph()

getModelNode

public Node getModelNode(Node view)
Description copied from class: LocalViewCreator
Returns a node in the creator's model graph that corresponds to the specified node in the creator's view graph or null if there is no corresponding node.

Specified by:
getModelNode in class LocalViewCreator
Parameters:
view - a node in the creator's view graph.
Returns:
a node in the creator's model graph that corresponds to the specified node in the creator's view graph or null if there is no corresponding node.

getViewNode

public Node getViewNode(Node model)
Description copied from class: LocalViewCreator
Returns a node in the creator's view graph that corresponds to the specified node in the creator's model graph or null if there is no corresponding node.

Specified by:
getViewNode in class LocalViewCreator
Parameters:
model - a node in the creator's model graph.
Returns:
a node in the creator's view graph that corresponds to the specified node in the creator's model graph or null if there is no corresponding node.

getModelEdge

public Edge getModelEdge(Edge view)
Description copied from class: LocalViewCreator
Returns a edge in the creator's model graph that corresponds to the specified edge in the creator's view graph or null if there is no corresponding edge.

Specified by:
getModelEdge in class LocalViewCreator
Parameters:
view - a edge in the creator's view graph.
Returns:
a edge in the creator's model graph that corresponds to the specified edge in the creator's view graph or null if there is no corresponding edge.

getViewEdge

public Edge getViewEdge(Edge model)
Description copied from class: LocalViewCreator
Returns a edge in the creator's view graph that corresponds to the specified edge in the creator's model graph or null if there is no corresponding edge.

Specified by:
getViewEdge in class LocalViewCreator
Parameters:
model - a edge in the creator's model graph.
Returns:
a edge in the creator's view graph that corresponds to the specified edge in the creator's model graph or null if there is no corresponding edge.

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.