Package com.structurizr.view
Class Configuration
java.lang.Object
com.structurizr.view.Configuration
- All Implemented Interfaces:
PropertyHolder
Configuration associated with how information in the workspace is rendered.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addProperty
(String name, String value) Adds a name-value pair property.void
Adds a theme.void
copyConfigurationFrom
(Configuration configuration) Gets the Branding object associated with this workspace.Gets the key of the view that should be shown by default.Gets the type of symbols to use when rendering metadata.Gets the collection of name-value property pairs, as a Map.Gets the styles associated with this set of views.Gets the Terminology object associated with this workspace.getTheme()
Deprecated.String[]
Gets the URLs of the themes used to render views.Gets the sort order used when displaying the list of views.void
setDefaultView
(View view) Sets the view that should be shown by default.void
setMetadataSymbols
(MetadataSymbols metadataSymbols) Sets the type of symbols to use when rendering metadata.void
Sets the themes used to render views.void
setViewSortOrder
(ViewSortOrder viewSortOrder) Sets the sort order used when displaying the list of views.
-
Constructor Details
-
Configuration
public Configuration()
-
-
Method Details
-
getStyles
Gets the styles associated with this set of views.- Returns:
- a Styles object
-
getTheme
Deprecated. -
getThemes
Gets the URLs of the themes used to render views.- Returns:
- an array of URLs
-
setThemes
Sets the themes used to render views.- Parameters:
themes
- an array of URLs
-
addTheme
Adds a theme.- Parameters:
url
- the URL of the theme to be added
-
getDefaultView
Gets the key of the view that should be shown by default.- Returns:
- the key, as a String (or null if not specified)
-
setDefaultView
Sets the view that should be shown by default.- Parameters:
view
- a View object
-
copyConfigurationFrom
-
getBranding
Gets the Branding object associated with this workspace.- Returns:
- a Branding object
-
getTerminology
Gets the Terminology object associated with this workspace.- Returns:
- a Terminology object
-
getMetadataSymbols
Gets the type of symbols to use when rendering metadata.- Returns:
- a MetadataSymbols enum value
-
setMetadataSymbols
Sets the type of symbols to use when rendering metadata.- Parameters:
metadataSymbols
- a MetadataSymbols enum value
-
getViewSortOrder
Gets the sort order used when displaying the list of views.- Returns:
- a ViewSortOrder enum
-
setViewSortOrder
Sets the sort order used when displaying the list of views.- Parameters:
viewSortOrder
- a ViewSortOrder enum
-
getProperties
Gets the collection of name-value property pairs, as a Map.- Specified by:
getProperties
in interfacePropertyHolder
- Returns:
- a Map (String, String) (empty if there are no properties)
-
addProperty
Adds a name-value pair property.- Specified by:
addProperty
in interfacePropertyHolder
- Parameters:
name
- the name of the propertyvalue
- the value of the property
-