Package com.structurizr.view
Class StaticView
java.lang.Object
com.structurizr.view.View
com.structurizr.view.StaticView
- Direct Known Subclasses:
ComponentView
,ContainerView
,SystemContextView
,SystemLandscapeView
public abstract class StaticView extends View
The superclass for all static views (system landscape, system context, container and component views).
-
Method Summary
Modifier and Type Method Description void
add(Person person)
Adds the given person to this view, including relationships to/from that person.void
add(Person person, boolean addRelationships)
Adds the given person to this view.RelationshipView
add(Relationship relationship)
Adds a specific relationship to this view.void
add(SoftwareSystem softwareSystem)
Adds the given software system to this view, including relationships to/from that software system.void
add(SoftwareSystem softwareSystem, boolean addRelationships)
Adds the given software system to this view.abstract void
addAllElements()
Adds all of the permitted elements to this view.void
addAllPeople()
Adds all people in the model to this view.void
addAllSoftwareSystems()
Adds all software systems in the model to this view.void
addAnimation(Element... elements)
Adds an animation step, with the specified elements.abstract void
addDefaultElements()
Adds the default set of elements to this view.abstract void
addNearestNeighbours(Element element)
Adds all of the permitted elements, which are directly connected to the specified element, to this view.protected <T extends Element>
voidaddNearestNeighbours(Element element, java.lang.Class<T> typeOfElement)
java.util.List<Animation>
getAnimations()
void
remove(Person person)
Removes the given person from this view.void
remove(SoftwareSystem softwareSystem)
Removes the given software system from this view.void
removeElementsThatAreUnreachableFrom(Element element)
Removes all elements that cannot be reached by traversing the graph of relationships starting with the specified element.void
removeElementsWithTag(java.lang.String tag)
Removes allElement
s that have the given tag from this view.void
removeRelationshipsWithTag(java.lang.String tag)
Removes allRelationship
s that have the given tag from this view.Methods inherited from class com.structurizr.view.View
add, add, addElement, addRelationship, canBeRemoved, checkElementCanBeAdded, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDescription, getDimensions, getElements, getElementView, getKey, getModel, getName, getPaperSize, getRelationships, getRelationshipView, getSoftwareSystem, getSoftwareSystemId, getTitle, getViewSet, isElementInView, remove, remove, removeElement, removeElementsWithNoRelationships, removeRelationshipsNotConnectedToElement, setDescription, setDimensions, setLayoutMergeStrategy, setPaperSize, setTitle
-
Method Details
-
addDefaultElements
public abstract void addDefaultElements()Adds the default set of elements to this view. -
addAllSoftwareSystems
public void addAllSoftwareSystems()Adds all software systems in the model to this view. -
add
Adds the given software system to this view, including relationships to/from that software system.- Parameters:
softwareSystem
- the SoftwareSystem to add
-
add
Adds the given software system to this view.- Parameters:
softwareSystem
- the SoftwareSystem to addaddRelationships
- whether to add relationships to/from the software system
-
remove
Removes the given software system from this view.- Parameters:
softwareSystem
- the SoftwareSystem to remove
-
addAllPeople
public void addAllPeople()Adds all people in the model to this view. -
add
Adds the given person to this view, including relationships to/from that person.- Parameters:
person
- the Person to add
-
add
Adds the given person to this view.- Parameters:
person
- the Person to addaddRelationships
- whether to add relationships to/from the person
-
remove
Removes the given person from this view.- Parameters:
person
- the Person to add
-
add
Adds a specific relationship to this view.- Parameters:
relationship
- the Relationship to be added- Returns:
- a RelationshipView object representing the relationship added
-
addAllElements
public abstract void addAllElements()Adds all of the permitted elements to this view. -
addNearestNeighbours
Adds all of the permitted elements, which are directly connected to the specified element, to this view.- Parameters:
element
- an Element
-
addNearestNeighbours
-
removeElementsThatAreUnreachableFrom
Removes all elements that cannot be reached by traversing the graph of relationships starting with the specified element.- Parameters:
element
- the starting element
-
removeElementsWithTag
public final void removeElementsWithTag(@Nonnull java.lang.String tag)Removes allElement
s that have the given tag from this view.- Parameters:
tag
- a tag
-
removeRelationshipsWithTag
public final void removeRelationshipsWithTag(@Nonnull java.lang.String tag)Removes allRelationship
s that have the given tag from this view.- Parameters:
tag
- a tag
-
addAnimation
Adds an animation step, with the specified elements.- Parameters:
elements
- the elements that should be shown in the animation step
-
getAnimations
-