Package com.structurizr.view
Class CustomView
java.lang.Object
com.structurizr.view.View
com.structurizr.view.ModelView
com.structurizr.view.CustomView
- All Implemented Interfaces:
PropertyHolder
,AnimatedView
Represents a custom view, containing custom elements.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.add
(Relationship relationship) Adds a specific relationship to this view.void
Adds all custom elements to this view.void
addAnimation
(CustomElement... elements) Adds an animation step, with the specified elements.void
Adds the default set of elements to this view.protected boolean
canBeRemoved
(Element element) protected void
checkElementCanBeAdded
(Element element) getModel()
Gets the model that this view belongs to.getName()
Gets the (computed) name of this view.void
remove
(CustomElement customElement) Removes the given custom element from this view.Methods inherited from class com.structurizr.view.ModelView
addElement, addNearestNeighbours, addRelationship, disableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, enableAutomaticLayout, getAutomaticLayout, getDimensions, getElements, getElementView, getMergeFromRemote, 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. -
getModel
Gets the model that this view belongs to. -
checkElementCanBeAdded
- Specified by:
checkElementCanBeAdded
in classModelView
-
canBeRemoved
- Specified by:
canBeRemoved
in classModelView
-
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
- Specified by:
getAnimations
in interfaceAnimatedView
-
add
Adds the given custom element to this view, including relationships to/from that custom element.- Parameters:
customElement
- the CustomElement to add
-
add
Adds the given custom element to this view.- Parameters:
customElement
- the CustomElement to addaddRelationships
- whether to add relationships to/from the custom element
-
remove
Removes the given custom element from this view.- Parameters:
customElement
- the CustomElement to add
-
addDefaultElements
public void addDefaultElements()Adds the default set of elements to this view. -
addAllCustomElements
public void addAllCustomElements()Adds all custom elements to this view.
-