Package com.structurizr.view
Class SystemContextView
java.lang.Object
com.structurizr.view.View
com.structurizr.view.ModelView
com.structurizr.view.StaticView
com.structurizr.view.SystemContextView
- All Implemented Interfaces:
PropertyHolder
Represents the System Context view from the C4 model, showing how a software system fits into its environment,
in terms of the users (people) and other software system dependencies.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds all software systems and all people.void
Adds the default set of elements to this view.void
addNearestNeighbours
(Element element) Adds all software systems and people that are directly connected to the specified element.protected boolean
canBeRemoved
(Element element) protected void
checkElementCanBeAdded
(Element element) getName()
Gets the (computed) name of this view.boolean
Determines whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.void
setEnterpriseBoundaryVisible
(boolean enterpriseBoundaryVisible) Sets whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.Methods inherited from class com.structurizr.view.StaticView
add, add, add, add, add, add, add, addAllPeople, addAllSoftwareSystems, addAnimation, getAnimations, remove, remove, remove, removeElementsThatAreUnreachableFrom, removeElementsWithTag, removeRelationshipsWithTag
Methods inherited from class com.structurizr.view.ModelView
addElement, addNearestNeighbours, addRelationship, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDimensions, getElements, getElementView, getMergeFromRemote, getModel, getPaperSize, getRelationships, getRelationshipView, getSoftwareSystem, getSoftwareSystemId, getViewSet, isElementInView, remove, removeElement, removeElementsWithNoRelationships, removeRelationshipsNotConnectedToElement, setDimensions, setLayoutMergeStrategy, setMergeFromRemote, setPaperSize
Methods inherited from class com.structurizr.view.View
addProperty, getDescription, getKey, getOrder, getProperties, getTitle, setDescription, setTitle
-
Method Details
-
getName
Gets the (computed) name of this view. -
addDefaultElements
public void addDefaultElements()Adds the default set of elements to this view.- Specified by:
addDefaultElements
in classStaticView
-
addAllElements
public void addAllElements()Adds all software systems and all people.- Specified by:
addAllElements
in classStaticView
-
addNearestNeighbours
Adds all software systems and people that are directly connected to the specified element.- Specified by:
addNearestNeighbours
in classStaticView
- Parameters:
element
- an Element
-
isEnterpriseBoundaryVisible
public boolean isEnterpriseBoundaryVisible()Determines whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.- Returns:
- true if the enterprise boundary is visible, false otherwise
-
setEnterpriseBoundaryVisible
public void setEnterpriseBoundaryVisible(boolean enterpriseBoundaryVisible) Sets whether the enterprise boundary (to differentiate "internal" elements from "external" elements") should be visible on the resulting diagram.- Parameters:
enterpriseBoundaryVisible
- true if the enterprise boundary should be visible, false otherwise
-
checkElementCanBeAdded
- Specified by:
checkElementCanBeAdded
in classModelView
-
canBeRemoved
- Specified by:
canBeRemoved
in classModelView
-