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.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()
Gets the URL of the theme 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
setTheme(java.lang.String url)
Sets the theme 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
public java.lang.String getTheme()Gets the URL of the theme used to render views.- Returns:
- the URL of the theme
-
setTheme
public void setTheme(java.lang.String url)Sets the theme used to render views.- Parameters:
url
- the URL of theme
-
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
-
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
-