Package com.structurizr.view

Class Configuration

java.lang.Object
com.structurizr.view.Configuration
All Implemented Interfaces:
PropertyHolder
public final class Configuration extends Object implements PropertyHolder
Configuration associated with how information in the workspace is rendered.

  • Constructor Details

    • Configuration

      public Configuration()

  • Method Details

    • getStyles

      public Styles getStyles()
      Gets the styles associated with this set of views.
      Returns:
      a Styles object

    • getTheme

      @Deprecated public String getTheme()
      Deprecated.

    • getThemes

      public String[] getThemes()
      Gets the URLs of the themes used to render views.
      Returns:
      an array of URLs

    • setThemes

      public void setThemes(String... themes)
      Sets the themes used to render views.
      Parameters:
      themes - an array of URLs

    • addTheme

      public void addTheme(String url)
      Adds a theme.
      Parameters:
      url - the URL of the theme to be added

    • getDefaultView

      public 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

      public void setDefaultView(View view)
      Sets the view that should be shown by default.
      Parameters:
      view - a View object

    • copyConfigurationFrom

      public void copyConfigurationFrom(Configuration configuration)

    • getBranding

      public Branding getBranding()
      Gets the Branding object associated with this workspace.
      Returns:
      a Branding object

    • getTerminology

      public Terminology getTerminology()
      Gets the Terminology object associated with this workspace.
      Returns:
      a Terminology object

    • getMetadataSymbols

      public MetadataSymbols getMetadataSymbols()
      Gets the type of symbols to use when rendering metadata.
      Returns:
      a MetadataSymbols enum value

    • setMetadataSymbols

      public void setMetadataSymbols(MetadataSymbols metadataSymbols)
      Sets the type of symbols to use when rendering metadata.
      Parameters:
      metadataSymbols - a MetadataSymbols enum value

    • getViewSortOrder

      public ViewSortOrder getViewSortOrder()
      Gets the sort order used when displaying the list of views.
      Returns:
      a ViewSortOrder enum

    • setViewSortOrder

      public void setViewSortOrder(ViewSortOrder viewSortOrder)
      Sets the sort order used when displaying the list of views.
      Parameters:
      viewSortOrder - a ViewSortOrder enum

    • getProperties

      public Map<String,String> getProperties()
      Gets the collection of name-value property pairs associated with this workspace, as a Map.
      Specified by:
      getProperties in interface PropertyHolder
      Returns:
      a Map (String, String) (empty if there are no properties)

    • addProperty

      public void addProperty(String name, String value)
      Adds a name-value pair property to this workspace.
      Specified by:
      addProperty in interface PropertyHolder
      Parameters:
      name - the name of the property
      value - the value of the property