Interface RepositoryConfiguration
public interface RepositoryConfiguration
A configuration for a repository, describing the settings,
model types, symbol types etc. that are available to the user.
Note that the current implementation only works for "core" types,
so plug-ins should not use this to determine whether their
model types, symbol types etc. should be included.
-
Method Summary
Modifier and TypeMethodDescriptionReturns the type ID:s of the available edge types.Returns the type ID:s of the available model types.Returns the type ID:s of the available symbol types.getAvailableSymbolTypes
(String modelType) Returns the type ID:s of the available symbol types per model type.getDefaultEdgeType
(String fromType, String toType) Returns the default edge type between two symbols, will return null if there is no recommended edges.getDefaultFrameSize
(String symbolVariant) Returns the default frame size of a symbol variant.Returns the default label font.int
Returns the default label size.getDefaultSize
(String symbolVariant) Returns the default size of a symbol variant.Returns the default settings for swimlane models.getDefaultVariant
(String symbolType) Returns the default variant for a symbol type.getDisabledVariants
(String symbolType) Returns any disabled variants for a symbol type.int
Returns the grid size used in the model editor.getMethodSupport
(ModelType inModelType, SymbolType sourceType, MethodSupport.Direction direction) Returns the preferred outputs (quickdraw) that are specified in the configuration.Returns the preferred distance to new symbols places by quickdraw.Returns the preferred distance to new symbols places by pattern (fill).getRecommendedEdgeTypes
(String fromType, String toType) Returns the recommended edge types between two symbol types.boolean
Returns true if center-center relations are enabled.boolean
Returns true if the user can choose which fonts to use for descriptions.boolean
Returns true if the user can choose which fonts to use for documents.boolean
Returns true if responsible for documents is enabled.boolean
Returns true if only the recommended edge types are allowed.boolean
Returns true if editing of locked revisions is enabled.boolean
isFrameSizeEditable
(String symbolVariant) Returns true if the frame size of a symbol variant is editable.boolean
Returns true if the grid must always be enabled so that objects snap to it.boolean
Returns true if the user can choose which fonts to use for labels in the model editor.boolean
Returns true if languages can be created/edited.boolean
Returns true if layers are enabled.boolean
Returns true if lists/custom relations can be created/edited.boolean
Returns true if there has to be alternative ID:s on models.boolean
Returns true if alternative ID:s can be used for models and symbols.boolean
Returns true if revisions are enabled.boolean
isSizeEditable
(String symbolVariant) Returns true if the size of a symbol variant is editable.boolean
Returns true if swimlane settings can be edited.boolean
Returns true if there has to be alternative ID:s on symbol.
-
Method Details
-
isReferenceIDEnabled
boolean isReferenceIDEnabled()Returns true if alternative ID:s can be used for models and symbols.- Returns:
- true if alternative ID:s can be used for models and symbols.
-
isModelReferenceIDForced
boolean isModelReferenceIDForced()Returns true if there has to be alternative ID:s on models.- Returns:
- true if there has to be alternative ID:s on models.
-
isSymbolReferenceIDForced
boolean isSymbolReferenceIDForced()Returns true if there has to be alternative ID:s on symbol.- Returns:
- true if there has to be alternative ID:s on symbol.
-
isRevisionsEnabled
boolean isRevisionsEnabled()Returns true if revisions are enabled.- Returns:
- true if revisions are enabled.
-
isEditLockedRevisionsEnabled
boolean isEditLockedRevisionsEnabled()Returns true if editing of locked revisions is enabled. -
isCenterCenterRelationsEnabled
boolean isCenterCenterRelationsEnabled()Returns true if center-center relations are enabled.- Returns:
- true if center-center relations are enabled.
-
isDocumentResponsibleEnabled
boolean isDocumentResponsibleEnabled()Returns true if responsible for documents is enabled.- Returns:
- true if responsible for documents is enabled.
-
isLanguagesEnabled
boolean isLanguagesEnabled()Returns true if languages can be created/edited.- Returns:
- true if languages can be created/edited.
-
isListsEnabled
boolean isListsEnabled()Returns true if lists/custom relations can be created/edited.- Returns:
- true if lists/custom relations can be created/edited.
-
getGridSize
int getGridSize()Returns the grid size used in the model editor.- Returns:
- the grid size used in the model editor.
-
isGridForced
boolean isGridForced()Returns true if the grid must always be enabled so that objects snap to it.- Returns:
- true if the grid must always be enabled so that objects snap to it.
-
isLayersEnabled
boolean isLayersEnabled()Returns true if layers are enabled.- Returns:
- true if layers are enabled.
-
getDefaultLabelFontName
String getDefaultLabelFontName()Returns the default label font.- Returns:
- the default label font.
-
getDefaultLabelFontSize
int getDefaultLabelFontSize()Returns the default label size.- Returns:
- the default label size.
-
isLabelFontsEditable
boolean isLabelFontsEditable()Returns true if the user can choose which fonts to use for labels in the model editor.- Returns:
- true if the user can choose which fonts to use for labels in the model editor.
-
isDescriptionFontsEditable
boolean isDescriptionFontsEditable()Returns true if the user can choose which fonts to use for descriptions.- Returns:
- true if the user can choose which fonts to use for descriptions.
-
isDocumentFontsEditable
boolean isDocumentFontsEditable()Returns true if the user can choose which fonts to use for documents.- Returns:
- true if the user can choose which fonts to use for documents.
-
getAvailableModelTypes
Returns the type ID:s of the available model types.- Returns:
- the type ID:s of the available model types.
-
getAvailableSymbolTypes
Returns the type ID:s of the available symbol types.- Returns:
- the type ID:s of the available symbol types.
-
getAvailableSymbolTypes
Returns the type ID:s of the available symbol types per model type.- Parameters:
modelType
- The model type id.- Returns:
- the type ID:s of the available symbol types per model type.
-
getAvailableEdgeTypes
Returns the type ID:s of the available edge types.- Returns:
- the type ID:s of the available edge types.
-
getRecommendedEdgeTypes
Returns the recommended edge types between two symbol types.- Parameters:
fromType
- The from type id.toType
- The to type id.- Returns:
- the recommended edge types between two symbol types.
-
getDefaultEdgeType
Returns the default edge type between two symbols, will return null if there is no recommended edges.- Parameters:
fromType
- The from type id.toType
- The to type id.- Returns:
- the default edge type between two symbols, will return null if there is no recommended edges.
-
isEdgeRecommendationsForced
boolean isEdgeRecommendationsForced()Returns true if only the recommended edge types are allowed.- Returns:
- true if only the recommended edge types are allowed.
-
getDefaultSize
Returns the default size of a symbol variant.- Parameters:
symbolVariant
- The symbol variant id.- Returns:
- the default size of a symbol variant.
-
isSizeEditable
Returns true if the size of a symbol variant is editable.- Parameters:
symbolVariant
- The symbol variant id.- Returns:
- true if the size of a symbol variant is editable.
-
getDefaultFrameSize
Returns the default frame size of a symbol variant.- Parameters:
symbolVariant
- The symbol variant id.- Returns:
- the default frame size of a symbol variant.
-
isFrameSizeEditable
Returns true if the frame size of a symbol variant is editable.- Parameters:
symbolVariant
- The symbol variant id.- Returns:
- true if the frame size of a symbol variant is editable.
-
getDefaultVariant
Returns the default variant for a symbol type.- Parameters:
symbolType
- The symbol type id.- Returns:
- the default variant for a symbol type.
-
getDisabledVariants
Returns any disabled variants for a symbol type.- Parameters:
symbolType
- The symbol type id.- Returns:
- any disabled variants for a symbol type.
-
isSwimlaneSettingsEditable
boolean isSwimlaneSettingsEditable()Returns true if swimlane settings can be edited.- Returns:
- true if swimlane settings can be edited.
-
getDefaultSwimlaneSettings
Map<String,Map<String, getDefaultSwimlaneSettings()EdgeTypeWithDirection>> Returns the default settings for swimlane models.- Returns:
- the default settings for swimlane models.
-
getMethodSupport
List<PreferredOutput> getMethodSupport(ModelType inModelType, SymbolType sourceType, MethodSupport.Direction direction) Returns the preferred outputs (quickdraw) that are specified in the configuration.- Parameters:
inModelType
- The model type id.sourceType
- The symbol type id.direction
- The direction.- Returns:
- the preferred outputs (quickdraw) that are specified in the configuration.
-
getMethodSupportGap
Insets getMethodSupportGap()Returns the preferred distance to new symbols places by quickdraw.- Returns:
- the preferred distance to new symbols places by quickdraw.
-
getPatternGap
Insets getPatternGap()Returns the preferred distance to new symbols places by pattern (fill).- Returns:
- the preferred distance to new symbols places by pattern (fill).
-