Package com.structurizr.view

Class StaticView

java.lang.Object

com.structurizr.view.View

com.structurizr.view.ModelView

com.structurizr.view.StaticView

All Implemented Interfaces:

PropertyHolder

Direct Known Subclasses:

ComponentView, ContainerView, SystemContextView, SystemLandscapeView

public abstract class StaticView
extends ModelView

The superclass for all static views (system landscape, system context, container and component views).

Method Summary

Modifier and Type	Method	Description
void	add(CustomElement customElement)	Adds the given custom element to this view, including relationships to/from that custom element.
void	add(CustomElement customElement, boolean addRelationships)	Adds the given custom element to this view.
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.
List<Animation>	getAnimations()
void	remove(CustomElement customElement)	Removes the given custom element from this view.
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.
final void	removeElementsWithTag(String tag)	Removes all Elements that have the given tag from this view.
final void	removeRelationshipsWithTag(String tag)	Removes all Relationships that have the given tag from this view.

Methods inherited from class com.structurizr.view.ModelView

addElement, addNearestNeighbours, addRelationship, canBeRemoved, checkElementCanBeAdded, 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, getName, getOrder, getProperties, getTitle, setDescription, setTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

public void add(@Nonnull
 SoftwareSystem softwareSystem)

Adds the given software system to this view, including relationships to/from that software system.

Parameters:

softwareSystem - the SoftwareSystem to add

add

public void add(@Nonnull
 SoftwareSystem softwareSystem,
 boolean addRelationships)

Adds the given software system to this view.

Parameters:

softwareSystem - the SoftwareSystem to add

addRelationships - whether to add relationships to/from the software system

remove

public void remove(@Nonnull
 SoftwareSystem softwareSystem)

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

public void add(@Nonnull
 Person person)

Adds the given person to this view, including relationships to/from that person.

Parameters:

person - the Person to add

add

public void add(@Nonnull
 Person person,
 boolean addRelationships)

Adds the given person to this view.

Parameters:

person - the Person to add

addRelationships - whether to add relationships to/from the person

remove

public void remove(@Nonnull
 Person person)

Removes the given person from this view.

Parameters:

person - the Person to add

add

public RelationshipView add(@Nonnull
 Relationship relationship)

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

public abstract void addNearestNeighbours(@Nonnull
 Element element)

Adds all of the permitted elements, which are directly connected to the specified element, to this view.

Parameters:

element - an Element

removeElementsThatAreUnreachableFrom

public void removeElementsThatAreUnreachableFrom(Element element)

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
 String tag)

Removes all Elements that have the given tag from this view.

Parameters:

tag - a tag

removeRelationshipsWithTag

public final void removeRelationshipsWithTag(@Nonnull
 String tag)

Removes all Relationships that have the given tag from this view.

Parameters:

tag - a tag

addAnimation

public void addAnimation(Element... elements)

Adds an animation step, with the specified elements.

Parameters:

elements - the elements that should be shown in the animation step

getAnimations

public List<Animation> getAnimations()

add

public void add(@Nonnull
 CustomElement customElement)

Adds the given custom element to this view, including relationships to/from that custom element.

Parameters:

customElement - the CustomElement to add

add

public void add(@Nonnull
 CustomElement customElement,
 boolean addRelationships)

Adds the given custom element to this view.

Parameters:

customElement - the CustomElement to add

addRelationships - whether to add relationships to/from the custom element

remove

public void remove(@Nonnull
 CustomElement customElement)

Removes the given custom element from this view.

Parameters:

customElement - the CustomElement to add