Package com.nomagic.magicdraw.core.options

Class ProjectOptions

java.lang.Object
com.nomagic.magicdraw.uml.MDElementImpl
com.nomagic.magicdraw.core.options.ProjectOptions
All Implemented Interfaces:
BaseElement, MDElement, PropertyChangeListener, Serializable, Cloneable, Comparable, EventListener
@OpenApiAll public class ProjectOptions extends com.nomagic.magicdraw.uml.MDElementImpl implements Serializable, PropertyChangeListener
This class provides access and storage of project options. Most of the project options have convenience setters/getters.
See Also:

  • Field Details

    • OPTIONS_LOCK

      public static final String OPTIONS_LOCK
      Options lock event property name.
      See Also:

    • PROJECT_GENERAL_PROPERTIES

      public static final String PROJECT_GENERAL_PROPERTIES
      The name of the manager that contains user editable properties in Project options dialog.
      See Also:

    • PROJECT_INVISIBLE_PROPERTIES

      public static final String PROJECT_INVISIBLE_PROPERTIES
      The name of the manager of not visible properties in Project options dialog.
      See Also:

    • PERSONAL_INVISIBLE_PROPERTIES

      public static final String PERSONAL_INVISIBLE_PROPERTIES
      The name of the manager of not visible properties that affect only one user in multi-user environment.
      See Also:

    • PERSONAL_VISIBLE_PROPERTIES

      public static final String PERSONAL_VISIBLE_PROPERTIES
      The name of the manager of visible properties that affect only one user in multi-user environment
      See Also:

    • STYLE_USER_PROPERTIES

      public static final String STYLE_USER_PROPERTIES
      See Also:

    • STYLE_PERSONAL_PROPERTIES

      public static final String STYLE_PERSONAL_PROPERTIES
      See Also:

    • STYLE_DIAGRAM_PROPERTIES

      public static final String STYLE_DIAGRAM_PROPERTIES
      See Also:

    • STYLE_MODEL_ELEMENT_DEFAULTS

      public static final String STYLE_MODEL_ELEMENT_DEFAULTS
      See Also:

    • ACTIVE_VALIDATION_GROUP

      public static final String ACTIVE_VALIDATION_GROUP
      Real time validation group name
      See Also:

    • VALIDATION_GROUP

      public static final String VALIDATION_GROUP
      See Also:

    • PRE_COMMIT_VALIDATION_GROUP

      public static final String PRE_COMMIT_VALIDATION_GROUP
      See Also:

    • COMPOSITION_INSPECTION_GROUP

      public static final String COMPOSITION_INSPECTION_GROUP
      See Also:

    • DIAGRAM_ASPECTS_GROUP

      public static final String DIAGRAM_ASPECTS_GROUP
      See Also:

    • COMPLETE_DIAGRAMS

      public static final String COMPLETE_DIAGRAMS
      See Also:

    • EXPORT

      public static final String EXPORT
      See Also:

    • CREATE_AUTOMATICALLY

      public static final String CREATE_AUTOMATICALLY
      See Also:

    • DO_NOT_CREATE

      public static final String DO_NOT_CREATE
      See Also:

    • DIAGRAM_CONTEXT_MODES

      public static final List DIAGRAM_CONTEXT_MODES

    • COLLABORATION_GROUP

      public static final String COLLABORATION_GROUP
      Collaboration group name
      See Also:

    • ELEMENT_HIDING_GROUP

      public static final String ELEMENT_HIDING_GROUP
      Element hiding group name
      See Also:

    • LOCKING_GROUP

      public static final String LOCKING_GROUP
      Locking group name
      See Also:

    • DEPENDENCY_CHECKER_GROUP

      public static final String DEPENDENCY_CHECKER_GROUP
      Dependency checker group name.
      See Also:

    • QNAME_DISPLAY_STYLE_ABSOLUTE

      public static final String QNAME_DISPLAY_STYLE_ABSOLUTE
      Qualified is calculated using named elements up to the project root - "Data"
      See Also:

    • QNAME_DISPLAY_STYLE_RELATIVE

      public static final String QNAME_DISPLAY_STYLE_RELATIVE
      Qualified is calculated using named elements up to the nearest package with applied stereotype "ModelLibrary"
      See Also:

    • QNAME_DISPLAY_STYLE_MODEL_RELATIVE

      public static final String QNAME_DISPLAY_STYLE_MODEL_RELATIVE
      Qualified is calculated using named elements up to the nearest "Model" element
      See Also:

    • QNAME_DISPLAY_STYLE_MODEL_OR_LIBRARY_RELATIVE

      public static final String QNAME_DISPLAY_STYLE_MODEL_OR_LIBRARY_RELATIVE
      Qualified is calculated using named elements up to the nearest "Model" element or package with applied stereotype "ModelLibrary"
      See Also:

    • QNAME_DISPLAY_STYLE_OPTIONS

      public static final List QNAME_DISPLAY_STYLE_OPTIONS
      Collection of all possible qualified name display style modes.

    • LAYOUT_TEMPLATE_CREATION_MODE_USAGE

      public static final String LAYOUT_TEMPLATE_CREATION_MODE_USAGE
      See Also:

    • LAYOUT_TEMPLATE_CREATION_MODE_DEFINITION

      public static final String LAYOUT_TEMPLATE_CREATION_MODE_DEFINITION
      See Also:

    • LAYOUT_TEMPLATE_CREATION_MODES

      public static final List LAYOUT_TEMPLATE_CREATION_MODES

    • NUMBERING_GROUP

      public static final String NUMBERING_GROUP
      Numbering group name.
      See Also:

    • BROWSER_GROUP

      public static final String BROWSER_GROUP
      Browser group
      See Also:

    • DIAGRAMS_GROUP

      public static final String DIAGRAMS_GROUP
      Diagrams group name
      See Also:

    • GENERAL_GROUP

      public static final String GENERAL_GROUP
      General group name
      See Also:

    • UNIQUE_ELEMENT_NUMBER_PROJECT_SCOPE

      @Deprecated public static final String UNIQUE_ELEMENT_NUMBER_PROJECT_SCOPE
      Deprecated.
      option no longer exists
      See Also:

    • UNIQUE_ELEMENT_NUMBER_PACKAGE_SCOPE

      @Deprecated public static final String UNIQUE_ELEMENT_NUMBER_PACKAGE_SCOPE
      Deprecated.
      option no longer exists
      See Also:

    • UNIQUE_ELEMENT_NUMBER_SCOPE_OPTIONS

      @Deprecated public static final List UNIQUE_ELEMENT_NUMBER_SCOPE_OPTIONS
      Deprecated.
      options no longer exists

    • NO_TIPS

      @Deprecated public static final int NO_TIPS
      Deprecated.
      Tool tips style constant. No tooltip is displayed if mouse cursor is over PresentationElement in diagram.
      See Also:

    • NAME_TIPS

      @Deprecated public static final int NAME_TIPS
      Deprecated.
      Tool tips style constant. Name as tooltip is displayed if mouse cursor is over PresentationElement in diagram.
      See Also:

    • DOC_TIPS

      @Deprecated public static final int DOC_TIPS
      Deprecated.
      Tool tips style constant. Model element documentation as tooltip is displayed if mouse cursor is over PresentationElement in diagram.
      See Also:

    • INDEX_NONE

      public static final int INDEX_NONE
      See Also:

    • INDEX_COMMON

      public static final int INDEX_COMMON
      See Also:

    • INDEX_CUSTOM

      public static final int INDEX_CUSTOM
      See Also:

    • COMPOSITION_INSPECTION_SEVERITY_STANDARD

      public static final String COMPOSITION_INSPECTION_SEVERITY_STANDARD
      See Also:

    • COMPOSITION_INSPECTION_SEVERITY_ADVANCED

      public static final String COMPOSITION_INSPECTION_SEVERITY_ADVANCED
      See Also:

    • COMPOSITION_INSPECTION_SEVERITY_CHOICE

      public static final List<String> COMPOSITION_INSPECTION_SEVERITY_CHOICE

  • Constructor Details

    • ProjectOptions

      public ProjectOptions()
      Constructor. Creates project options with initialized defaults. Use this constructor when compatibility properties converting should be performed.

  • Method Details

    • remapGroupInUI

      public static void remapGroupInUI(Collection<String> groupsToRemap, Group newGroup)
      Remap properties group to a some other group in options UI
      Parameters:
      groupsToRemap - groups to remap
      newGroup - new group

    • getGroupRemap

      public static Map<Collection<String>,Group> getGroupRemap()

    • createDefaultProjectOptions

      public static ProjectOptions createDefaultProjectOptions(Project project)
      Create default options for a given project
      Parameters:
      project - project
      Returns:
      options with default settings

    • setProject

      public void setProject(Project project)
      Set project for the options.
      Parameters:
      project - project

    • setDefaults

      public void setDefaults()
      Sets default project options.

    • getStyle

      public Style getStyle()
      Gets style that holds two properties manager - one for visible and user editable properties, other for invisible project properties.
      Returns:
      project properties

    • setStyle

      public void setStyle(Style style)
      Sets style that holds two properties manager - one for visible and user editable properties, other for invisible project properties.
      Parameters:
      style - project properties

    • getPersonalOptionsStyle

      public Style getPersonalOptionsStyle()
      Gets personalOptionsStyle from the ProjectOptions. Personal options are GUI setting that are user specific in multiple user env.
      Returns:
      Style object

    • getDiagramViewStyle

      public Style getDiagramViewStyle()
      Gets diagramViewStyle from the ProjectOptions. Personal options are GUI setting that are user specific in multiple user env.
      Returns:
      Style object

    • getSymbolStyles

      public StyleManager getSymbolStyles()
      Gets symbol style manager.
      Returns:
      symbol style manager.

    • configureLoadedOptions

      public static void configureLoadedOptions(ProjectOptions options)

    • addModuleDirectory

      public void addModuleDirectory(String directory)
      Adds directory to project module directories.
      Parameters:
      directory - directory to add.

    • checkAndAddModuleDirectory

      public void checkAndAddModuleDirectory(String directory)
      Adds directory to project module directories if it was not added yet
      Parameters:
      directory - directory to add.

    • setModulesDirectories

      public void setModulesDirectories(Collection<String> collection)
      Sets project modules paths.
      Parameters:
      collection - collections of String objects specifying paths to module directories.

    • getModulesDirectories

      public List<String> getModulesDirectories(boolean resolvePathVariables)
      Returns modules paths.
      Parameters:
      resolvePathVariables - true if path variables must be resolved (real paths returned)
      Returns:
      list of String objects file paths to module dirs.

    • setTipsStyle

      @Deprecated public void setTipsStyle(int st)
      Deprecated.
      use setTooltipsStyle(TooltipsStyleChoice)
      Set tooltips style.
      Parameters:
      st - tips style constant.

    • getTipsStyle

      @Deprecated public int getTipsStyle()
      Deprecated.
      use getTooltipsStyle()
      Get tooltips style.
      Returns:
      tooltip style constant.

    • accept

      public void accept(Visitor v) throws Exception
      Description copied from interface: MDElement
      Method accepts visitor, and calls method visit<class name>(this) of visitor . See Visitor pattern for more details.
      Specified by:
      accept in interface MDElement
      Overrides:
      accept in class com.nomagic.magicdraw.uml.MDElementImpl
      Parameters:
      v - which visits this element.
      Throws:
      Exception

    • propertyChange

      public void propertyChange(PropertyChangeEvent evt)
      Listens for property change event.
      Specified by:
      propertyChange in interface PropertyChangeListener

    • updateBrowserAfterFilterChange

      public static void updateBrowserAfterFilterChange()
      Updates a Browser after the filtering was done through the GUI element.

      Method does save the state of trees and restores it before returning from a call.

    • updateBrowserAfterFilterChange

      public static void updateBrowserAfterFilterChange(Consumer<Browser> savedStateBrowserConsumer)
      Updates a Browser after the filtering was done through the GUI element.

      Method does save the state of trees and restores it before returning from a call.

      Parameters:
      savedStateBrowserConsumer - an implementation of Consumer that accepts a Browser whose state was already saved.

    • setBrowserItemsTypes

      public void setBrowserItemsTypes(@CheckForNull Collection v)
      Set types that are filtered (not shown) in browser.
      Parameters:
      v - collection of String objects short name of class type (something like ClassTypes.getShortName(Actor.class)).

    • getBrowserItemsTypes

      public Collection getBrowserItemsTypes()
      Gets types that are filtered (not shown) in browser.
      Returns:
      collection of String objects short name of class type (something like ClassTypes.getShortName(Actor.class)).

    • setBrowserVisible

      public void setBrowserVisible(boolean v)
      Set browser visibility flag

    • isBrowserVisible

      public boolean isBrowserVisible()
      Gets browser visibility flag

    • setChoosePackageLastSelection

      public void setChoosePackageLastSelection(Package pck)

    • getChoosePackageLastSelection

      @CheckForNull public Package getChoosePackageLastSelection()

    • setDisableHighlightSuspended

      public void setDisableHighlightSuspended(Collection<? extends BaseElement> elements)

    • getDisableHighlightSuspended

      public Set<BaseElement> getDisableHighlightSuspended()

    • getManager

      @CheckForNull public PropertyManager getManager(String name)
      Returns the manager for properties.
      Returns:
      property manager name.
      See Also:

    • getProperty

      @CheckForNull public Property getProperty(String manager, String id)
      Returns property

    • addProperty

      public void addProperty(String manager, Property p)
      Adds property

    • getRecentlyOpenedWindowsIDs

      public List<String> getRecentlyOpenedWindowsIDs()

    • setRecentlyOpenedWindowsIDs

      public void setRecentlyOpenedWindowsIDs(List<String> ids)

    • setBrowserLayout

      public void setBrowserLayout(@CheckForNull String rez)
      Parameters:
      rez - browser layout value

    • getBrowserLayout

      @CheckForNull public String getBrowserLayout()

    • setDiagramsLayout

      @Deprecated public void setDiagramsLayout(@CheckForNull String rez)
      Deprecated.
      use setEditorWindowsLayout(String)

    • setEditorWindowsLayout

      public void setEditorWindowsLayout(@CheckForNull String rez)

    • getDiagramsLayout

      @Deprecated @CheckForNull public String getDiagramsLayout()
      Deprecated.
      use getEditorWindowsLayout()

    • getEditorWindowsLayout

      @CheckForNull public String getEditorWindowsLayout()

    • setProjectNotificationByConditions

      public void setProjectNotificationByConditions(@CheckForNull String pluginID, @CheckForNull String notification)

    • getProjectNotificationsByConditions

      @CheckForNull public Map<String,String> getProjectNotificationsByConditions()

    • setRecentTypes

      public void setRecentTypes(@CheckForNull List<Classifier> recentMetaclasses)
      Sets last selected metaclass for type creation
      Parameters:
      recentMetaclasses - recent metaclasses

    • getRecentTypes

      public List<Classifier> getRecentTypes()
      Returns recent metaclasses for created types
      Returns:
      recent metaclass list

    • setLayoutBeforeFullScreen

      public void setLayoutBeforeFullScreen(@CheckForNull String rez)

    • setLayoutBeforeExitFullScreen

      public void setLayoutBeforeExitFullScreen(@CheckForNull String rez)

    • getLayoutBeforeFullScreen

      @CheckForNull public String getLayoutBeforeFullScreen()

    • getLayoutBeforeExitFullScreen

      @CheckForNull public String getLayoutBeforeExitFullScreen()

    • setExitFullScreenToolbarBounds

      public void setExitFullScreenToolbarBounds(@CheckForNull Rectangle bounds)
      Sets full screen toolbar bounds.
      Parameters:
      bounds - new bounds.

    • getExitFullScreenToolbarBounds

      @CheckForNull public Rectangle getExitFullScreenToolbarBounds()
      Getter for browser bounds.
      Returns:
      browser bounds.

    • getAdditionalBrowserTrees

      public List<String> getAdditionalBrowserTrees()

    • setAdditionalBrowserTrees

      public void setAdditionalBrowserTrees(Collection<String> trees)

    • getHiddenBrowserTrees

      public List<String> getHiddenBrowserTrees()

    • setHiddenBrowserTrees

      public void setHiddenBrowserTrees(Collection<String> trees)

    • addHiddenBrowserTree

      public void addHiddenBrowserTree(String treeID)

    • removeHiddenBrowserTree

      public void removeHiddenBrowserTree(String treeID)

    • setUseDiagramInfoCustomMode

      public void setUseDiagramInfoCustomMode(boolean value)

    • isUseDiagramInfoCustomMode

      public boolean isUseDiagramInfoCustomMode()

    • setExportedVersionChanged

      public void setExportedVersionChanged(boolean value)

    • isExportedVersionChanged

      public boolean isExportedVersionChanged()

    • setDiagramInfoCustomHTML

      public void setDiagramInfoCustomHTML(String value)

    • getDiagramInfoCustomHTML

      public String getDiagramInfoCustomHTML()

    • setDiagramInfoKeywords

      public void setDiagramInfoKeywords(Collection<String> keywords)

    • getDiagramInfoKeywords

      public List<String> getDiagramInfoKeywords()

    • setSecretProperty

      public void setSecretProperty(String key, @CheckForNull String value)
      Sets secret property (maps given key to given value) Secret properties are encrypted properties that are not available as plain text when project options are persisted to xml.
      Parameters:
      key - key for the property.
      value - value of the property.

    • getSecretProperty

      public String getSecretProperty(String key)
      Retrieves secret property value according given key. Secret properties are encrypted properties that are not available as plain text when project options are persisted to xml.
      Parameters:
      key - key of the property.
      Returns:
      property value.

    • setInvisibleProperties

      public void setInvisibleProperties(PropertyManager newManager)

    • setLastSelectedTransformationName

      public void setLastSelectedTransformationName(@CheckForNull String name)

    • getLastSelectedTransformationName

      @CheckForNull public String getLastSelectedTransformationName()

    • setTransformationDestination

      public void setTransformationDestination(@CheckForNull Package destination)

    • getTransformationDestination

      @CheckForNull public Package getTransformationDestination()

    • setLastSelectedTypeMapProfileName

      public void setLastSelectedTypeMapProfileName(@CheckForNull String name)

    • getLastSelectedTypeMapProfileName

      @CheckForNull public String getLastSelectedTypeMapProfileName()

    • setLastSelectedTypeMapProfileDirection

      public void setLastSelectedTypeMapProfileDirection(boolean forward)

    • getLastSelectedTypeMapProfileDirection

      public boolean getLastSelectedTypeMapProfileDirection()

    • setTransformationInPlace

      public void setTransformationInPlace(boolean inPlace)

    • isTransformationInPlace

      public boolean isTransformationInPlace()

    • setLastSelectedElement

      public void setLastSelectedElement(BaseElement element)

    • getLastSelectedElement

      @CheckForNull public BaseElement getLastSelectedElement()

    • setIndexMode

      public void setIndexMode(int status)

    • getIndexMode

      public int getIndexMode()

    • setIndexScopeAll

      public void setIndexScopeAll(boolean all)

    • isIndexScopeAll

      public boolean isIndexScopeAll()

    • setIndexScope

      public void setIndexScope(Package[] scope)

    • getIndexScope

      @CheckForNull public Package[] getIndexScope()

    • setIndexTypes

      public void setIndexTypes(Collection types)

    • getIndexTypes

      @CheckForNull public Collection getIndexTypes()

    • setLastDirectory

      @Deprecated public void setLastDirectory(String path)
      Deprecated.
      use ProjectSpecificLocationRegister to store and retrieve this information
      Sets the last used project related directory.
      Parameters:
      path - last dir path.

    • getReportExtensionIndex

      public int getReportExtensionIndex()

    • setReportExtensionIndex

      public void setReportExtensionIndex(int index)

    • getLastDirectory

      @Deprecated public String getLastDirectory()
      Deprecated.
      use ProjectSpecificLocationRegister to store and retrieve this information
      Returns the last used project related directory.
      Returns:
      the path

    • addInvisibleProperty

      public void addInvisibleProperty(Property property)
      Adds invisible property that affects all users in multi user environment.
      Parameters:
      property - property

    • getInvisibleProperty

      @CheckForNull public Property getInvisibleProperty(String id)
      Gets invisible property that affects all users in multi user environment.
      Parameters:
      id - property identifier
      Returns:
      invisible property

    • addPersonalVisibleProperty

      public void addPersonalVisibleProperty(Property property)
      Adds personal visible property that affects one user in multi user environment
      Parameters:
      property - property

    • getPersonalVisibleProperty

      @CheckForNull public Property getPersonalVisibleProperty(String id)
      Gets personal visible property that affects one user in multi user environment
      Parameters:
      id - property identifier
      Returns:
      personal visible property

    • addConfigurator

      public static void addConfigurator(ProjectOptionsConfigurator configurator)
      Add project options configurator
      Parameters:
      configurator - options configurator.

    • removeConfigurator

      public static void removeConfigurator(ProjectOptionsConfigurator configurator)
      Remove project options configurator
      Parameters:
      configurator - options configurator.

    • setModelElementStyle

      public void setModelElementStyle(Style modelElementStyle)
      Sets style for default property values for all uml entities.
      Parameters:
      modelElementStyle - style

    • applyModifiedModelElementStyle

      public void applyModifiedModelElementStyle(Style modelElementStyle)
      Applies user modified values to model element style
      Parameters:
      modelElementStyle - style to retrieve modified values from

    • getFullModelElementStyle

      public Style getFullModelElementStyle()
      Returns default model element values with modified values. Method is useful for full review of values.

      Does not return actual project model element style, used for review purposes.

      Returns:
      all modified values and all unchanged

    • getActualModelElementStyle

      public Style getActualModelElementStyle()
      Fast method. Returns default model element values.
      Returns:
      all modified values and some unmodified (unmodified values are not filtered)

    • getModifiedModelElementsStyle

      public Style getModifiedModelElementsStyle()
      Returns default model element values.
      Returns:
      all modified values, unchanged values are filtered

    • createDefaultModelElementStyle

      public Style createDefaultModelElementStyle()
      Returns default model element values.
      Returns:
      all default values, none of them are modified

    • showDotNotationForAssociations

      public boolean showDotNotationForAssociations()
      Gets the SHOW_DOT_NOTATION_FOR_ASSOCIATIONS property value
      Returns:
      value of SHOW_DOT_NOTATION_FOR_ASSOCIATIONS property or false if such property wasn't set.

    • setShowDotNotationForAssociations

      public void setShowDotNotationForAssociations(boolean value)
      Sets the SHOW_DOT_NOTATION_FOR_ASSOCIATIONS property value. If such property wasn't yet created, then creates one.
      Parameters:
      value - boolean property value

    • changeOwnershipForNavigability

      public boolean changeOwnershipForNavigability()
      Gets the CHANGE_OWNERSHIP_FOR_NAVIGABILITY property value
      Returns:
      value of CHANGE_OWNERSHIP_FOR_NAVIGABILITY property or false if such property wasn't set.

    • setChangeOwnershipForNavigability

      public void setChangeOwnershipForNavigability(boolean value)
      Sets the HOW_DOT_NOTATION_FOR_ASSOCIATIONS property value. If such property wasn't yet created, then creates one.
      Parameters:
      value - boolean property value

    • setBooleanProperty

      public void setBooleanProperty(boolean value, String manager, String id, @CheckForNull String group)

    • isDisplayAllActivityParameterNodesInDiagrams

      public boolean isDisplayAllActivityParameterNodesInDiagrams()
      Indicates if activity parameter nodes should be displayed in diagrams.
      Returns:
      true if activity parameter nodes should be displayed, false otherwise.

    • setDisplayAllActivityParameterNodesInDiagrams

      public void setDisplayAllActivityParameterNodesInDiagrams(boolean displayAllActivityParameterNodesInDiagrams)
      Sets whether to display activity parameter nodes in diagrams.
      Parameters:
      displayAllActivityParameterNodesInDiagrams - property value to set.

    • isDisplayAllPinsInDiagrams

      public boolean isDisplayAllPinsInDiagrams()

    • setDisplayAllPinsInDiagrams

      public void setDisplayAllPinsInDiagrams(boolean displayAllPinsInDiagrams)

    • isSeparateDecisionMergeAndJoinForkNotation

      public boolean isSeparateDecisionMergeAndJoinForkNotation()

    • setSeparateDecisionMergeAndJoinForkNotation

      public void setSeparateDecisionMergeAndJoinForkNotation(boolean separateDecisionMergeAndJoinForkNotation)

    • isAutoSynchronizeParametersAndArguments

      public boolean isAutoSynchronizeParametersAndArguments()
      Returns:
      true if parameters and arguments should be auto-synchronized.

    • isLayoutScenarioDiagram

      public boolean isLayoutScenarioDiagram()
      Returns:
      true if scenario diagram should be layouted each time it is opened.

    • setLayoutScenarioDiagram

      public void setLayoutScenarioDiagram(boolean value)
      Sets to layout scenario diagram.
      Parameters:
      value - value of the property.

    • setAutoSynchronizeParametersAndArguments

      public void setAutoSynchronizeParametersAndArguments(boolean value)
      Sets auto synchronize parameters and arguments property value.
      Parameters:
      value - - value of the property.

    • setGlobalPermission

      public void setGlobalPermission(boolean value)
      Sets package permission global property value.
      Parameters:
      value - - value of the property.

    • getQNameDisplayAbsolute

      @Deprecated public boolean getQNameDisplayAbsolute()
      Deprecated.
      use getQNameDisplayStyle() instead.
      Gets the QNAME_DISPLAY_STYLE property value.
      Returns:
      true if qualified name should be calculated starting from the project root, or false when qualified name should be calculated starting from the model library element.

    • getQNameDisplayStyle

      public String getQNameDisplayStyle()
      Gets the QNAME_DISPLAY_STYLE property value.
      Returns:
      string that is one of the #QNAME_DISPLAY_STYLE_OPTIONS collection elements item.

    • setQNameDisplayAbsolute

      @Deprecated public void setQNameDisplayAbsolute(boolean value)
      Deprecated.
      use setQNameDisplayStyle(String) instead.
      Sets the QNAME_DISPLAY_STYLE property value.
      Parameters:
      value - true if qualified name should be calculated starting from the project root, or false when qualified name should be calculated starting from the model library element.

    • setQNameDisplayStyle

      public void setQNameDisplayStyle(String newValue)
      Sets the QNAME_DISPLAY_STYLE property value.
      Parameters:
      newValue - one of the #QNAME_DISPLAY_STYLE_OPTIONS collection elements item, otherwise nothing happens - property remains unchanged.

    • getLayoutTemplateCreationMode

      public String getLayoutTemplateCreationMode()

    • setLayoutTemplateCreationMode

      public void setLayoutTemplateCreationMode(String newValue)

    • getTooltipsStyle

      public ProjectOptions.TooltipsStyleChoice getTooltipsStyle()
      Returns Tooltips Style property
      Returns:
      selected value

    • setTooltipsStyle

      public void setTooltipsStyle(ProjectOptions.TooltipsStyleChoice value)
      Sets Tooltips Style property
      Parameters:
      value - new value.

    • setIgnoredValidationResults

      public void setIgnoredValidationResults(@CheckForNull String[] ignoredPairs)

    • getIgnoredActiveSuites

      public Collection<Package> getIgnoredActiveSuites()

    • getIgnoredPassiveValidationSuites

      public Collection<Package> getIgnoredPassiveValidationSuites()

    • getIgnoredValidationRules

      public Collection<Constraint> getIgnoredValidationRules()
      Return collection of ignored constraints.
      Returns:
      collection of ignored constraints.

    • getIgnoredPassiveValidationRules

      public Collection<Constraint> getIgnoredPassiveValidationRules()
      Gets ignored passive validation rules
      Returns:
      ignored passive validation rules.

    • getIgnoredDuplicatedModules

      public Collection<String> getIgnoredDuplicatedModules()
      Returns:
      modules for which warning that they found in duplicated path is not shown.

    • setIgnoredDuplicatedModules

      public void setIgnoredDuplicatedModules(Collection<String> value)
      Parameters:
      value - modules for which warning that they found in duplicated path is not shown.

    • setIgnoredActiveSuites

      public void setIgnoredActiveSuites(@CheckForNull Package[] elements)

    • setIgnoredPassiveValidationSuites

      public void setIgnoredPassiveValidationSuites(@CheckForNull Package[] elements)

    • setIgnoredValidationRules

      public void setIgnoredValidationRules(@CheckForNull Constraint[] elements)

    • setIgnoredPassiveValidationRules

      public void setIgnoredPassiveValidationRules(@CheckForNull Constraint[] elements)

    • setPublicBranchSyncMode

      public void setPublicBranchSyncMode(SyncMode syncMode)
      Element hiding public branch synchronization mode. Project and user specific option.
      Parameters:
      syncMode - sync mode to set

    • getPublicBranchSyncMode

      @CheckForNull public SyncMode getPublicBranchSyncMode()
      Method to get element hiding feature public branch synchronization mode.
      Returns:
      returns current synchronization mode or null if mode is not applicable for this project

    • isLockFreeEditingEnabled

      public boolean isLockFreeEditingEnabled()
      Determines if lock free editing is enabled in the project
      Returns:
      true if enabled, false otherwise

    • isGlobalEditingEnabled

      public boolean isGlobalEditingEnabled()
      Determines if global package permission is set to Read-Write or Read-Only
      Returns:
      true if Read-Write, false if Read-Only

    • setLockFreeEditingEnabled

      public void setLockFreeEditingEnabled(boolean enabled)
      Enables or disables lock free editing
      Parameters:
      enabled - true to enable, false to disable

    • getActiveValidationScope

      public Collection<Element> getActiveValidationScope()

    • setActiveValidationScope

      public void setActiveValidationScope(@CheckForNull Element[] elements)

    • isFilterExcludesAuxiliaryResources

      public boolean isFilterExcludesAuxiliaryResources()

    • setFilterExcludesAuxiliaryResources

      public void setFilterExcludesAuxiliaryResources(boolean value)

    • setFilterHidesIrrelevantElements

      public void setFilterHidesIrrelevantElements(boolean value)

    • isFilterHidesIrrelevantElements

      public boolean isFilterHidesIrrelevantElements()

    • setFilterShowsImportedElements

      public void setFilterShowsImportedElements(boolean value)

    • isFilterShowsImportedElements

      public boolean isFilterShowsImportedElements()

    • setFilterEnabled

      public void setFilterEnabled(boolean value)

    • isFilterEnabled

      public boolean isFilterEnabled()

    • getFavoriteElements

      public List<Element> getFavoriteElements()

    • setFavoriteElements

      public void setFavoriteElements(List<Element> elements)

    • getFavoriteElementsProperty

      @CheckForNull public ElementListProperty getFavoriteElementsProperty()

    • setActiveValidationSeverity

      public void setActiveValidationSeverity(@CheckForNull EnumerationLiteral literal)

    • setPassiveValidationSeverity

      public void setPassiveValidationSeverity(@CheckForNull EnumerationLiteral literal)

    • getActiveValidationSeverity

      @CheckForNull public EnumerationLiteral getActiveValidationSeverity()

    • getPassiveValidationSeverity

      @CheckForNull public EnumerationLiteral getPassiveValidationSeverity()

    • setCompositionInspectionSeverity

      public void setCompositionInspectionSeverity(String severity)

    • getCompositionInspectionSeverity

      public String getCompositionInspectionSeverity()

    • setDetectIllegalModelReferences

      public void setDetectIllegalModelReferences(boolean isDetectIllegalReferences)

    • isDetectIllegalModelReferences

      public boolean isDetectIllegalModelReferences()

    • setValidationIgnoredOption

      public void setValidationIgnoredOption(@CheckForNull String value)

    • getValidationIgnoredOption

      @CheckForNull public String getValidationIgnoredOption()

    • setMarkInTreeAndDiagrams

      public void setMarkInTreeAndDiagrams(boolean mark)

    • isMarkInTreeAndDiagrams

      public boolean isMarkInTreeAndDiagrams()

    • setExcludeReadonlyElements

      public void setExcludeReadonlyElements(boolean exclude)

    • isExcludeElementsFromReadOnlyModules

      public boolean isExcludeElementsFromReadOnlyModules()

    • setValidateOnlyActiveDiagrams

      public void setValidateOnlyActiveDiagrams(boolean validateOnlyActiveDiagrams)

    • isValidateOnlyActiveDiagrams

      public boolean isValidateOnlyActiveDiagrams()

    • setValidateOnlyLocallyChangedElementsPreCommit

      public void setValidateOnlyLocallyChangedElementsPreCommit(boolean validateOnlyLocallyChangedElements)
      Sets value for the Validate Only Locally Changed Elements property in the pre-commit validation group.
      Parameters:
      validateOnlyLocallyChangedElements - new value

    • setExcludeElementsFromReadOnlyModulesPreCommit

      public void setExcludeElementsFromReadOnlyModulesPreCommit(boolean excludeFromUsedReadOnly)
      Sets value for the Exclude Elements from Used Read-Only Project property in the pre-commit validation group.
      Parameters:
      excludeFromUsedReadOnly - new value

    • isValidateOnlyLocallyChangedElementsPreCommit

      public boolean isValidateOnlyLocallyChangedElementsPreCommit()
      Gets value of the Validate Only Locally Changed Elements property in the pre-commit validation group.
      Returns:
      true if property exists and is set to true

    • isExcludeElementsFromReadOnlyModulesPreCommit

      public boolean isExcludeElementsFromReadOnlyModulesPreCommit()
      Gets value of the Exclude Elements from Used Read-Only Project property in the pre-commit validation group.
      Returns:
      true if property exists and is set to true

    • setPreCommitValidationSuites

      public void setPreCommitValidationSuites(@CheckForNull Package[] elements)
      Sets validation suites for pre-commit validation.
      Parameters:
      elements - suites

    • getPreCommitValidationSuites

      @CheckForNull public Collection<Package> getPreCommitValidationSuites()
      Gets pre-commit validation suites.
      Returns:
      suites or null, if the property does not exist

    • setPreCommitValidationExcludedScope

      public void setPreCommitValidationExcludedScope(@CheckForNull Element[] elements)
      Sets elements, excluded from pre-commit validation. Creates the property, if it does not yet exist.
      Parameters:
      elements - excluded elements

    • getPreCommitValidationExcludedScope

      public Collection<Element> getPreCommitValidationExcludedScope()
      Get elements, excluded from pre-commit validation.
      Returns:
      excluded scope

    • setMinimalSeverityProhibitingCommit

      public void setMinimalSeverityProhibitingCommit(@CheckForNull EnumerationLiteral literal)
      Set minimal severity which prohibits commit after pre-commit validation.
      Parameters:
      literal - new severity. Null value sets the highest level - None

    • getMinimalSeverityProhibitingCommit

      @CheckForNull public EnumerationLiteral getMinimalSeverityProhibitingCommit()
      Get minimal severity which prohibits commit after pre-commit validation.
      Returns:
      minimal severity or null, if such property does not exist

    • setMinimalSeverityProducingPreCommitWarning

      public void setMinimalSeverityProducingPreCommitWarning(@CheckForNull EnumerationLiteral literal)
      Sets minimal severity which produces warning after pre-commit validation.
      Parameters:
      literal - new severity. Null value sets the highest level - None

    • getMinimalSeverityProducingPreCommitWarning

      @CheckForNull public EnumerationLiteral getMinimalSeverityProducingPreCommitWarning()
      Gets minimal severity which produces warning after pre-commit validation.
      Returns:
      minimal severity or null, if such property does not exist

    • setLastSelectedModulePath

      public void setLastSelectedModulePath(@CheckForNull String path)
      Set last selected module path.
      Parameters:
      path - module path.

    • getLastSelectedModulePath

      @CheckForNull public String getLastSelectedModulePath()
      Get last selected module path.
      Returns:
      last module path.

    • setLocksFilterUsername

      public void setLocksFilterUsername(String userName)
      Sets Lock view filter user name
      Parameters:
      userName - name of user which was filtered in locks view.

    • getLocksFilterUsername

      public String getLocksFilterUsername()
      Returns user name of lock view filter.
      Returns:
      name of user which was filtered in locks view.

    • afterLoad

      public void afterLoad()

    • addToProjectSpellingIgnoreList

      public void addToProjectSpellingIgnoreList(String newTextToBeIgnored)

    • getProjectSpellingIgnoreList

      @CheckForNull public String[] getProjectSpellingIgnoreList()

    • isCheckForCyclicDependencies

      public boolean isCheckForCyclicDependencies()
      Returns whether check for cyclic dependencies must be performed.
      Returns:
      true if checking for cyclic properties must be performed, otherwise - false.

    • setCheckForCyclicDependencies

      public void setCheckForCyclicDependencies(boolean value)
      Sets check for cyclic dependencies property value.
      Parameters:
      value - new value.

    • getDependencySeverityLevel

      public DependencySeverityLevel getDependencySeverityLevel()
      Returns dependency checker severity level.
      Returns:
      true if checking for cyclic properties must be performed, otherwise - false.

    • setDependencySeverityLevel

      public void setDependencySeverityLevel(DependencySeverityLevel value)
      Sets check for cyclic dependencies property value.
      Parameters:
      value - new value.

    • getApplyPropertyImageProperty

      public ProjectOptions.ApplyPropertyImageChoice getApplyPropertyImageProperty()
      Returns Apply Property Image property
      Returns:
      selected value

    • setApplyPropertyImageProperty

      public void setApplyPropertyImageProperty(ProjectOptions.ApplyPropertyImageChoice value)
      Sets Apply Property Image property
      Parameters:
      value - new value.

    • getDiagramContextMode

      public String getDiagramContextMode()
      Returns diagram context mode for project
      Returns:
      diagram context mode

    • setDiagramContextMode

      public void setDiagramContextMode(String newValue)
      Sets diagram context mode for project
      Parameters:
      newValue - context mode

    • isIgnoreStandardProfiles

      public boolean isIgnoreStandardProfiles()
      Returns indication that standard profiles must be ignored in dependency checking.
      Returns:
      true if checking for cyclic properties must be performed, otherwise - false.

    • setIgnoreStandardProfiles

      public void setIgnoreStandardProfiles(boolean value)
      Sets ignore standard profiles in dependency checking property.
      Parameters:
      value - new value.

    • getProjectImpl

      public Project getProjectImpl()
      Overrides:
      getProjectImpl in class com.nomagic.magicdraw.uml.MDElementImpl

    • readEditorWindowOptions

      @NotApi public void readEditorWindowOptions(com.nomagic.magicdraw.ui.editorwindows.EditorWindowOptions options)
      Applies corresponding PropertyManager to the given options.
      Parameters:
      options - diagram view options

    • storeEditorWindowOptions

      @NotApi public void storeEditorWindowOptions(Collection<com.nomagic.magicdraw.ui.editorwindows.EditorWindowOptions> options, @CheckForNull String category)
      Remember not empty property managersof given options.
      Parameters:
      options - options

    • removeDiagramViewOptions

      @NotApi public void removeDiagramViewOptions(com.nomagic.magicdraw.uml.symbols.DiagramViewOptions options)
      Removes corresponding PropertyManager from project options.
      Parameters:
      options - options

    • getCommonProjectOptions

      @NotApi public com.nomagic.magicdraw.core.project.options.CommonProjectOptions getCommonProjectOptions()

    • setCommonProjectOptions

      @NotApi public void setCommonProjectOptions(com.nomagic.magicdraw.core.project.options.CommonProjectOptions commonProjectOptions)

    • getUserProjectOptions

      @NotApi public com.nomagic.magicdraw.core.project.options.UserProjectOptions getUserProjectOptions()

    • setUserProjectOptions

      @NotApi public void setUserProjectOptions(com.nomagic.magicdraw.core.project.options.UserProjectOptions userProjectOptions)

    • setAutoNumbering

      public void setAutoNumbering(boolean value)
      Set AutoNumbering option
      Parameters:
      value - true of autoNumber option is on

    • isAutoNumbering

      public boolean isAutoNumbering()
      Get the state of the autoNumber Option
      Returns:
      true if it is on

    • setDisplayNestedInstances

      public void setDisplayNestedInstances(boolean value)
      Set Display Nested instances option
      Parameters:
      value - true if to display nested instances, else false

    • isDisplayNestedInstances

      public boolean isDisplayNestedInstances()
      Get the state of the display nested instances property
      Returns:
      true if it is on

    • setDisplayElementNumberInBrowser

      public void setDisplayElementNumberInBrowser(boolean value)
      Set the value to display/hide autoIds in the Browser
      Parameters:
      value - true if autoIds are to be shown

    • setLockElementNumber

      public void setLockElementNumber(boolean value)
      Set the value to lock element number
      Parameters:
      value - true if lock numbers, else false

    • setCheckIdUniques

      public void setCheckIdUniques(boolean value)
      Set the value to check element id uniques in all id properties
      Parameters:
      value - true if to check id uniques, else false

    • setCheckElementNumberUniques

      public void setCheckElementNumberUniques(boolean value)
      Set the value to check element number uniques
      Parameters:
      value - true if to check id uniques, else false

    • isDisplayElementNumberInBrowser

      public boolean isDisplayElementNumberInBrowser()
      Get the value of display/hide autoId in the Browser
      Returns:
      true if the autoId is shown

    • isLockedElementNumber

      public boolean isLockedElementNumber()
      Get the value of number lock.
      Returns:
      true if locked, else false

    • isCheckIdUniques

      public boolean isCheckIdUniques()
      Get the value to check element id uniques in all id properties
      Returns:
      true if to check uniques, else false

    • isCheckElementNumberUniques

      public boolean isCheckElementNumberUniques()
      Get the value to check element id uniques in all id properties
      Returns:
      true if to check uniques, else false

    • getUniqueElementNumberScope

      public Collection<Element> getUniqueElementNumberScope()
      Get the Packages where autoIds are to be unique
      Returns:
      a list of Packages

    • setUniqueElementNumberScope

      public void setUniqueElementNumberScope(@CheckForNull Element[] elements)
      Set the Packages where AutoIds are to be unique
      Parameters:
      elements - the Packages

    • setUseI18NTextInDiagrams

      public void setUseI18NTextInDiagrams(boolean value)
      Set useI18N property for painting a text in diagrams
      Parameters:
      value - value

    • isUseI18NTextInDiagrams

      public boolean isUseI18NTextInDiagrams()
      Returns:
      use useI18N property for painting a text in diagrams

    • getLastSelectedXpdlImportLocation

      @CheckForNull public String getLastSelectedXpdlImportLocation()
      The directory last accessed for XPDL import
      Returns:
      location

    • setXpdlImportLocation

      public void setXpdlImportLocation(String importLocation)

    • getFavoriteHyperlinks

      public List<String> getFavoriteHyperlinks()
      Get favorite hyperlinks.
      Returns:
      URLs of hyperlinks.

    • setFavoriteHyperlinks

      public void setFavoriteHyperlinks(List<String> urls)
      Set favorite hyperlinks.
      Parameters:
      urls - URLs of hyperlinks.

    • setUnlockedElementRemovalInfo

      public void setUnlockedElementRemovalInfo(@CheckForNull Map<String,String> unlockedElementRemovalInfo)

    • getUnlockedElementRemovalInfo

      @CheckForNull public Map<String,String> getUnlockedElementRemovalInfo()

    • isUseDiagramsAspects

      public boolean isUseDiagramsAspects()

    • setUseDiagramsAspects

      public void setUseDiagramsAspects(boolean use)

    • isSuspendAutoResizingOfShapes

      public boolean isSuspendAutoResizingOfShapes()

    • setSuspendAutoResizingOfShapes

      public void setSuspendAutoResizingOfShapes(boolean suspend)

    • isSuspendAutoDisplayingOfLabels

      public boolean isSuspendAutoDisplayingOfLabels()

    • setSuspendAutoDisplayingOfLabels

      public void setSuspendAutoDisplayingOfLabels(boolean suspend)

    • isHighlightSuspended

      public boolean isHighlightSuspended()

    • setHighlightSuspended

      public void setHighlightSuspended(boolean highlight)

    • getTimeLimitToBuild

      @CheckForNull public Integer getTimeLimitToBuild()

    • setTimeLimitToBuild

      public void setTimeLimitToBuild(@CheckForNull Integer timeLimitToBuild)

    • getImageHeightLimit

      @CheckForNull public Integer getImageHeightLimit()

    • setImageHeightLimit

      public void setImageHeightLimit(@CheckForNull Integer imageHeightLimit)

    • getImageWidthLimit

      @CheckForNull public Integer getImageWidthLimit()

    • setImageWidthLimit

      public void setImageWidthLimit(@CheckForNull Integer imageWidthLimit)

    • getExportPrefWhenLimitsExceeded

      public ProjectOptions.ExportPreferenceWhenLimitsExceeded getExportPrefWhenLimitsExceeded()

    • setExportPrefWhenLimitsExceeded

      public void setExportPrefWhenLimitsExceeded(ProjectOptions.ExportPreferenceWhenLimitsExceeded value)

    • getIgnoredDiagramAspects

      public Collection<Stereotype> getIgnoredDiagramAspects()
      Gets ignored diagram aspects
      Returns:
      ignored diagram aspects

    • setIgnoredDiagramAspects

      public void setIgnoredDiagramAspects(@CheckForNull Stereotype[] aspects)

    • setAutomaticTypeCreationMode

      public void setAutomaticTypeCreationMode(boolean val)
      Sets automatic type creation property value.
      Parameters:
      val - - automatic type creation property value

    • isAutomaticTypeCreationMode

      public boolean isAutomaticTypeCreationMode()
      Gets automatic type creation property value.
      Returns:
      automatic type creation layout property value.

    • setAutomaticBehaviorCreationMode

      public void setAutomaticBehaviorCreationMode(boolean val)
      Sets automatic behavior creation property value.
      Parameters:
      val - - automatic behavior creation property value

    • isAutomaticBehaviorCreationMode

      public boolean isAutomaticBehaviorCreationMode()
      Gets automatic behavior creation property value.
      Returns:
      automatic behavior creation layout property value.

    • getDecimalPlaces

      @CheckForNull public Integer getDecimalPlaces()
      Decimal places property to render the number (double/float) property in table and specification
      Returns:
      decimal places or null if decimal places rendering is off

    • setDecimalPlaces

      public void setDecimalPlaces(@CheckForNull Integer decimalPlaces)
      Sets decimal places option value
      Parameters:
      decimalPlaces - option, null indicates option off