Package com.structurizr.view
Class Configuration
java.lang.Object
com.structurizr.view.Configuration
public final class Configuration
extends java.lang.Object
Configuration associated with how information in the workspace is rendered.
-
Constructor Summary
Constructors Constructor Description Configuration()
-
Method Summary
Modifier and Type Method Description void
copyConfigurationFrom(Configuration configuration)
Branding
getBranding()
Gets the Branding object associated with this workspace.java.lang.String
getDefaultView()
Gets the key of the view that should be shown by default.MetadataSymbols
getMetadataSymbols()
Gets the type of symbols to use when rendering metadata.Styles
getStyles()
Gets the styles associated with this set of views.Terminology
getTerminology()
Gets the Terminology object associated with this workspace.java.lang.String
getTheme()
Deprecated.java.lang.String[]
getThemes()
Gets the URLs of the themes used to render views.ViewSortOrder
getViewSortOrder()
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
setTheme(java.lang.String url)
Sets the theme used to render views.void
setThemes(java.lang.String... themes)
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 public java.lang.String getTheme()Deprecated. -
setTheme
public void setTheme(java.lang.String url)Sets the theme used to render views.- Parameters:
url
- the URL of theme
-
getThemes
public java.lang.String[] getThemes()Gets the URLs of the themes used to render views.- Returns:
- an array of URLs
-
setThemes
public void setThemes(java.lang.String... themes)Sets the themes used to render views.- Parameters:
themes
- an array of URLs
-
getDefaultView
public java.lang.String 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
-