Package com.structurizr.view

Class SystemLandscapeView

java.lang.Object
com.structurizr.view.View
com.structurizr.view.ModelView
com.structurizr.view.StaticView
com.structurizr.view.SystemLandscapeView
All Implemented Interfaces:
PropertyHolder
public final class SystemLandscapeView extends StaticView
Represents a System Landscape view that sits "above" the C4 model, showing the software systems and people in a given environment.

  • Method Details

    • getName

      public String getName()
      Gets the (computed) name of this view.
      Specified by:
      getName in class View
      Returns:
      the name, as a String

    • getModel

      public Model getModel()
      Gets the model that this view belongs to.
      Overrides:
      getModel in class ModelView
      Returns:
      a Model object

    • addDefaultElements

      public void addDefaultElements()
      Adds the default set of elements to this view.
      Specified by:
      addDefaultElements in class StaticView

    • addAllElements

      public void addAllElements()
      Adds all software systems and all people to this view.
      Specified by:
      addAllElements in class StaticView

    • addNearestNeighbours

      public void addNearestNeighbours(@Nonnull Element element)
      Adds all software systems and people that are directly connected to the specified element.
      Specified by:
      addNearestNeighbours in class StaticView
      Parameters:
      element - an Element

    • isEnterpriseBoundaryVisible

      @Deprecated public boolean isEnterpriseBoundaryVisible()
      Deprecated.
      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

      @Deprecated public void setEnterpriseBoundaryVisible(boolean enterpriseBoundaryVisible)
      Deprecated.
      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

      protected void checkElementCanBeAdded(Element element)
      Specified by:
      checkElementCanBeAdded in class ModelView

    • canBeRemoved

      protected boolean canBeRemoved(Element element)
      Specified by:
      canBeRemoved in class ModelView