Package com.structurizr.view
Class CustomView
java.lang.Object
com.structurizr.view.View
com.structurizr.view.CustomView
public final class CustomView extends View
Represents a custom view, containing custom elements.
-
Method Summary
Modifier and Type Method Description RelationshipView
add(Relationship relationship)
Adds a specific relationship to this view.void
addAllCustomElements()
Adds all custom elements to this view.void
addAnimation(CustomElement... elements)
Adds an animation step, with the specified elements.void
addDefaultElements()
Adds the default set of elements to this view.protected boolean
canBeRemoved(Element element)
protected void
checkElementCanBeAdded(Element element)
java.util.List<Animation>
getAnimations()
Model
getModel()
Gets the model that this view belongs to.java.lang.String
getName()
Gets the (computed) name of this view.Methods inherited from class com.structurizr.view.View
add, add, addElement, addRelationship, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDescription, getDimensions, getElements, getElementView, getKey, getPaperSize, getRelationships, getRelationshipView, getSoftwareSystem, getSoftwareSystemId, getTitle, getViewSet, isElementInView, remove, remove, removeElement, removeElementsWithNoRelationships, removeRelationshipsNotConnectedToElement, setDescription, setDimensions, setLayoutMergeStrategy, setPaperSize, setTitle
-
Method Details
-
getName
public java.lang.String getName()Gets the (computed) name of this view. -
getModel
Gets the model that this view belongs to. -
checkElementCanBeAdded
- Specified by:
checkElementCanBeAdded
in classView
-
canBeRemoved
- Specified by:
canBeRemoved
in classView
-
add
Adds a specific relationship to this view.- Parameters:
relationship
- the Relationship to be added- Returns:
- a RelationshipView object representing the relationship added
-
addAnimation
Adds an animation step, with the specified elements.- Parameters:
elements
- the elements that should be shown in the animation step
-
getAnimations
-
addDefaultElements
public void addDefaultElements()Adds the default set of elements to this view. -
addAllCustomElements
public void addAllCustomElements()Adds all custom elements to this view.
-