Package com.nomagic.magicdraw.dependencymatrix.persistence

Class MatrixSettings

java.lang.Object
com.nomagic.magicdraw.dependencymatrix.persistence.MatrixSettings
@OpenApiAll public class MatrixSettings extends Object
Matrix settings source. All settings are loaded from Dependency Matrix diagram component and visible through edit specification dialog

  • Constructor Details

    • MatrixSettings

      public MatrixSettings(Element matrixElement)
      Loads matrix settings for this element
      Parameters:
      matrixElement - matrix diagram element

  • Method Details

    • getColumnTextDirection

      public MatrixSettings.TextDirection getColumnTextDirection()
      Column text direction property
      Returns:
      text direction property

    • setColumnTextDirection

      public void setColumnTextDirection(MatrixSettings.TextDirection direction)
      Column text direction property
      Parameters:
      direction - text direction property

    • setShowInnerDependencies

      public void setShowInnerDependencies(boolean showInnerDependencies)
      Show inner dependencies property
      Parameters:
      showInnerDependencies - Show inner dependencies property

    • isShowInnerDependencies

      public boolean isShowInnerDependencies()
      Show inner dependencies property
      Returns:
      Show inner dependencies property

    • setShowElementsOption

      public void setShowElementsOption(MatrixSettings.RelationOption option)
      Show Elements property
      Parameters:
      option - Show Elements property

    • getShowElementsOption

      public MatrixSettings.RelationOption getShowElementsOption()
      Show Elements property
      Returns:
      Show Elements property

    • setColumnHeaderHeight

      public void setColumnHeaderHeight(int height)
      Column header height property
      Parameters:
      height - Column header height property

    • getColumnHeaderHeight

      @CheckForNull public Integer getColumnHeaderHeight()
      Column header height property
      Returns:
      Column header height property

    • setRowHeaderWidth

      public void setRowHeaderWidth(Integer width)
      Row header width property
      Parameters:
      width - Row header width property

    • getRowHeaderWidth

      @CheckForNull public Integer getRowHeaderWidth()
      Row header width property
      Returns:
      Row header width property

    • setDirection

      public void setDirection(MatrixSettings.Direction direction)
      Dependency direction property
      Parameters:
      direction - Dependency direction property

    • getDirection

      public MatrixSettings.Direction getDirection()
      Dependency direction property
      Returns:
      Dependency direction property

    • isEditable

      public boolean isEditable()
      Is dependency matrix elements may be changed
      Returns:
      Is matrix element editable

    • getDependencyCriteria

      public List<String> getDependencyCriteria()
      Dependency criteria property
      Returns:
      Dependency criteria property

    • setDependencyCriteria

      public void setDependencyCriteria(List<String> dependencyCriteria)
      Dependency criteria property
      Parameters:
      dependencyCriteria - Dependency criteria property

    • getMatrixElement

      public Element getMatrixElement()
      Dependency matrix element
      Returns:
      Dependency matrix diagram element

    • setSuppressCriteriaArea

      public void setSuppressCriteriaArea(boolean suppress)
      Suppress criteria area property
      Parameters:
      suppress - Suppress criteria area property

    • isCriteriaAreaSuppressed

      public boolean isCriteriaAreaSuppressed()
      Suppress criteria area property
      Returns:
      Suppress criteria area property

    • isLegendEnabled

      public boolean isLegendEnabled()

    • getLegendLocation

      public MatrixSettings.LegendLocation getLegendLocation()

    • setColumnOwnerDisplayMode

      public void setColumnOwnerDisplayMode(MatrixSettings.OwnerDisplayMode displayType)
      Column owner display mode property
      Parameters:
      displayType - Column owner display mode property

    • getColumnOwnerDisplayMode

      public MatrixSettings.OwnerDisplayMode getColumnOwnerDisplayMode()
      Column owner display mode property
      Returns:
      Column owner display mode property

    • setRowOwnerDisplayMode

      public void setRowOwnerDisplayMode(MatrixSettings.OwnerDisplayMode displayType)
      Row owner display mode property
      Parameters:
      displayType - Row owner display mode property

    • getRowOwnerDisplayMode

      public MatrixSettings.OwnerDisplayMode getRowOwnerDisplayMode()
      Row owner display mode property
      Returns:
      Row owner display mode property

    • getRowCollapsedNodes

      public List<String> getRowCollapsedNodes()
      Collapsed row nodes property
      Returns:
      Collapsed row nodes property

    • setRowCollapsedNodes

      public void setRowCollapsedNodes(List<String> rowCollapsedNodes)
      Collapsed row nodes property
      Parameters:
      rowCollapsedNodes - Collapsed row nodes property

    • getColumnCollapsedNodes

      public List<String> getColumnCollapsedNodes()
      Collapsed column nodes property
      Returns:
      Collapsed column nodes property

    • setColumnCollapsedNodes

      public void setColumnCollapsedNodes(List<String> columnCollapsedNodes)
      Collapsed column nodes property
      Parameters:
      columnCollapsedNodes - Collapsed column nodes property

    • getDescriptionAreaText

      @CheckForNull public String getDescriptionAreaText()
      Description area property
      Returns:
      Description area property

    • setDescriptionArea

      public void setDescriptionArea(@CheckForNull String descriptionArea)
      Description area property
      Parameters:
      descriptionArea - Description area property

    • setHideTypes

      public void setHideTypes(boolean hideTypes)
      Hide Types property
      Parameters:
      hideTypes - Hide Types property

    • areTypesHidden

      public boolean areTypesHidden()
      Hide Types property
      Returns:
      Hide Types property

    • setHideScope

      public void setHideScope(boolean hideScope)
      Scope Hidden property
      Parameters:
      hideScope - Scope Hidden property

    • isScopeHidden

      public boolean isScopeHidden()
      Scope Hidden property
      Returns:
      Scope Hidden property

    • setHideDependencyCriteria

      public void setHideDependencyCriteria(boolean hideCriteria)
      Hide dependency criteria property
      Parameters:
      hideCriteria - hide dependency criteria property

    • isDependencyCriteriaHidden

      public boolean isDependencyCriteriaHidden()
      Hide dependency criteria property
      Returns:
      hide dependency criteria property

    • setRowSortingMode

      public void setRowSortingMode(MatrixSettings.SortingMode sortingMode)
      Row sorting mode property
      Parameters:
      sortingMode - Row sorting mode property

    • setRowSortingMode

      public void setRowSortingMode(MatrixSettings.SortingMode sortingMode, boolean handleOrderTag)
      Row sorting mode property
      Parameters:
      sortingMode - Row sorting mode property
      handleOrderTag - if true, and the provided sorting mode is not Custom, clears the rowCustomOrder tag

    • clearRowCustomOrder

      public void clearRowCustomOrder()

    • getRowSortingMode

      public MatrixSettings.SortingMode getRowSortingMode()
      Row sorting mode property
      Returns:
      Row sorting mode property

    • setColumnSortingMode

      public void setColumnSortingMode(MatrixSettings.SortingMode sortingMode)
      Column sorting mode property
      Parameters:
      sortingMode - Column sorting mode property

    • setColumnSortingMode

      public void setColumnSortingMode(MatrixSettings.SortingMode sortingMode, boolean handleOrderTag)
      Column sorting mode property. If the mode is not Custom, cleans up the columnCustomOrder
      Parameters:
      sortingMode - Column sorting mode property
      handleOrderTag - if true, and the provided sorting mode is not Custom, clears the columnCustomOrder tag

    • clearColumnCustomOrder

      public void clearColumnCustomOrder()

    • getColumnSortingMode

      public MatrixSettings.SortingMode getColumnSortingMode()
      Column sorting mode property
      Returns:
      Column sorting mode property

    • setReadOnly

      public void setReadOnly(boolean readOnly)
      Read Only property
      Parameters:
      readOnly - Read Only property

    • isReadOnly

      public boolean isReadOnly()
      Read Only property
      Returns:
      Read Only property

    • setTakeWholeModelAsScope

      public void setTakeWholeModelAsScope(boolean wholeModelAsScope)
      Whole model as scope property
      Parameters:
      wholeModelAsScope - Whole model as scope property

    • isWholeModelTakenAsScope

      public boolean isWholeModelTakenAsScope()
      Whole model as scope property
      Returns:
      Whole model as scope property

    • getColumnCustomOrder

      @CheckForNull public String getColumnCustomOrder()
      Column custom order property
      Returns:
      Column custom order property

    • setColumnCustomOrder

      public void setColumnCustomOrder(@CheckForNull String columnCustomSortedElements)
      Column custom order property
      Parameters:
      columnCustomSortedElements - Column custom order property

    • getRowCustomOrder

      @CheckForNull public String getRowCustomOrder()
      Row Custom Order property
      Returns:
      Row custom order property

    • setRowCustomOrder

      public void setRowCustomOrder(@CheckForNull String rowCustomSortedElements)
      Row Custom Order property
      Parameters:
      rowCustomSortedElements - Row custom order property