java.lang.Object
- com.nomagic.magicdraw.dependencymatrix.persistence.MatrixSettings

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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MatrixSettings.Direction`	Dependency filter and default edit direction setting enum
`static class`	`MatrixSettings.LegendLocation`
`static class`	`MatrixSettings.OwnerDisplayMode`	Dependency Matrix group tree display modes
`static class`	`MatrixSettings.RelationOption`	Show relationships option enum
`static class`	`MatrixSettings.SortingMode`	sort mode enum
`static class`	`MatrixSettings.TextDirection`	Column elements text direction

Constructor Summary

Constructors
Constructor Description

MatrixSettings(Element matrixElement)
Loads matrix settings for this element

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`areTypesHidden()`	Hide Types property
`void`	`clearColumnCustomOrder()`
`void`	`clearRowCustomOrder()`
`java.util.List<java.lang.String>`	`getColumnCollapsedNodes()`	Collapsed column nodes property
`java.lang.String`	`getColumnCustomOrder()`	Column custom order property
`java.lang.Integer`	`getColumnHeaderHeight()`	Column header height property
`MatrixSettings.OwnerDisplayMode`	`getColumnOwnerDisplayMode()`	Column owner display mode property
`MatrixSettings.SortingMode`	`getColumnSortingMode()`	Column sorting mode property
`MatrixSettings.TextDirection`	`getColumnTextDirection()`	Column text direction property
`java.util.List<java.lang.String>`	`getDependencyCriteria()`	Dependency criteria property
`java.lang.String`	`getDescriptionAreaText()`	Description area property
`MatrixSettings.Direction`	`getDirection()`	Dependency direction property
`MatrixSettings.LegendLocation`	`getLegendLocation()`
`Element`	`getMatrixElement()`	Dependency matrix element
`java.util.List<java.lang.String>`	`getRowCollapsedNodes()`	Collapsed row nodes property
`java.lang.String`	`getRowCustomOrder()`	Row Custom Order property
`java.lang.Integer`	`getRowHeaderWidth()`	Row header width property
`MatrixSettings.OwnerDisplayMode`	`getRowOwnerDisplayMode()`	Row owner display mode property
`MatrixSettings.SortingMode`	`getRowSortingMode()`	Row sorting mode property
`MatrixSettings.RelationOption`	`getShowElementsOption()`	Show Elements property
`boolean`	`isCriteriaAreaSuppressed()`	Suppress criteria area property
`boolean`	`isDependencyCriteriaHidden()`	Hide dependency criteria property
`boolean`	`isEditable()`	Is dependency matrix elements may be changed
`boolean`	`isLegendEnabled()`
`boolean`	`isReadOnly()`	Read Only property
`boolean`	`isScopeHidden()`	Scope Hidden property
`boolean`	`isShowInnerDependencies()`	Show inner dependencies property
`boolean`	`isWholeModelTakenAsScope()`	Whole model as scope property
`void`	`setColumnCollapsedNodes(java.util.List<java.lang.String> columnCollapsedNodes)`	Collapsed column nodes property
`void`	`setColumnCustomOrder(java.lang.String columnCustomSortedElements)`	Column custom order property
`void`	`setColumnHeaderHeight(int height)`	Column header height property
`void`	`setColumnOwnerDisplayMode(MatrixSettings.OwnerDisplayMode displayType)`	Column owner display mode property
`void`	`setColumnSortingMode(MatrixSettings.SortingMode sortingMode)`	Column sorting mode property
`void`	`setColumnSortingMode(MatrixSettings.SortingMode sortingMode, boolean handleOrderTag)`	Column sorting mode property.
`void`	`setColumnTextDirection(MatrixSettings.TextDirection direction)`	Column text direction property
`void`	`setDependencyCriteria(java.util.List<java.lang.String> dependencyCriteria)`	Dependency criteria property
`void`	`setDescriptionArea(java.lang.String descriptionArea)`	Description area property
`void`	`setDirection(MatrixSettings.Direction direction)`	Dependency direction property
`void`	`setHideDependencyCriteria(boolean hideCriteria)`	Hide dependency criteria property
`void`	`setHideScope(boolean hideScope)`	Scope Hidden property
`void`	`setHideTypes(boolean hideTypes)`	Hide Types property
`void`	`setReadOnly(boolean readOnly)`	Read Only property
`void`	`setRowCollapsedNodes(java.util.List<java.lang.String> rowCollapsedNodes)`	Collapsed row nodes property
`void`	`setRowCustomOrder(java.lang.String rowCustomSortedElements)`	Row Custom Order property
`void`	`setRowHeaderWidth(java.lang.Integer width)`	Row header width property
`void`	`setRowOwnerDisplayMode(MatrixSettings.OwnerDisplayMode displayType)`	Row owner display mode property
`void`	`setRowSortingMode(MatrixSettings.SortingMode sortingMode)`	Row sorting mode property
`void`	`setRowSortingMode(MatrixSettings.SortingMode sortingMode, boolean handleOrderTag)`	Row sorting mode property
`void`	`setShowElementsOption(MatrixSettings.RelationOption option)`	Show Elements property
`void`	`setShowInnerDependencies(boolean showInnerDependencies)`	Show inner dependencies property
`void`	`setSuppressCriteriaArea(boolean suppress)`	Suppress criteria area property
`void`	`setTakeWholeModelAsScope(boolean wholeModelAsScope)`	Whole model as scope property

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MatrixSettings
```
public MatrixSettings(Element matrixElement)
```
    Loads matrix settings for this element
    
    Parameters:
    
    matrixElement - matrix diagram element
- Method Detail
  - 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 java.lang.Integer getColumnHeaderHeight()
```
    Column header height property
    
    Returns:
    
    Column header height property
  - setRowHeaderWidth
```
public void setRowHeaderWidth(java.lang.Integer width)
```
    Row header width property
    
    Parameters:
    
    width - Row header width property
  - getRowHeaderWidth
```
@CheckForNull
public java.lang.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 java.util.List<java.lang.String> getDependencyCriteria()
```
    Dependency criteria property
    
    Returns:
    
    Dependency criteria property
  - setDependencyCriteria
```
public void setDependencyCriteria(java.util.List<java.lang.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 java.util.List<java.lang.String> getRowCollapsedNodes()
```
    Collapsed row nodes property
    
    Returns:
    
    Collapsed row nodes property
  - setRowCollapsedNodes
```
public void setRowCollapsedNodes(java.util.List<java.lang.String> rowCollapsedNodes)
```
    Collapsed row nodes property
    
    Parameters:
    
    rowCollapsedNodes - Collapsed row nodes property
  - getColumnCollapsedNodes
```
public java.util.List<java.lang.String> getColumnCollapsedNodes()
```
    Collapsed column nodes property
    
    Returns:
    
    Collapsed column nodes property
  - setColumnCollapsedNodes
```
public void setColumnCollapsedNodes(java.util.List<java.lang.String> columnCollapsedNodes)
```
    Collapsed column nodes property
    
    Parameters:
    
    columnCollapsedNodes - Collapsed column nodes property
  - getDescriptionAreaText
```
@CheckForNull
public java.lang.String getDescriptionAreaText()
```
    Description area property
    
    Returns:
    
    Description area property
  - setDescriptionArea
```
public void setDescriptionArea(@CheckForNull
                               java.lang.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 java.lang.String getColumnCustomOrder()
```
    Column custom order property
    
    Returns:
    
    Column custom order property
  - setColumnCustomOrder
```
public void setColumnCustomOrder(@CheckForNull
                                 java.lang.String columnCustomSortedElements)
```
    Column custom order property
    
    Parameters:
    
    columnCustomSortedElements - Column custom order property
  - getRowCustomOrder
```
@CheckForNull
public java.lang.String getRowCustomOrder()
```
    Row Custom Order property
    
    Returns:
    
    Row custom order property
  - setRowCustomOrder
```
public void setRowCustomOrder(@CheckForNull
                              java.lang.String rowCustomSortedElements)
```
    Row Custom Order property
    
    Parameters:
    
    rowCustomSortedElements - Row custom order property

Class MatrixSettings

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MatrixSettings

Method Detail

getColumnTextDirection

setColumnTextDirection

setShowInnerDependencies

isShowInnerDependencies

setShowElementsOption

getShowElementsOption

setColumnHeaderHeight

getColumnHeaderHeight

setRowHeaderWidth

getRowHeaderWidth

setDirection

getDirection

isEditable

getDependencyCriteria

setDependencyCriteria

getMatrixElement

setSuppressCriteriaArea

isCriteriaAreaSuppressed

isLegendEnabled

getLegendLocation

setColumnOwnerDisplayMode

getColumnOwnerDisplayMode

setRowOwnerDisplayMode

getRowOwnerDisplayMode

getRowCollapsedNodes

setRowCollapsedNodes

getColumnCollapsedNodes

setColumnCollapsedNodes

getDescriptionAreaText

setDescriptionArea

setHideTypes

areTypesHidden

setHideScope

isScopeHidden

setHideDependencyCriteria

isDependencyCriteriaHidden

setRowSortingMode

setRowSortingMode

clearRowCustomOrder

getRowSortingMode

setColumnSortingMode

setColumnSortingMode

clearColumnCustomOrder

getColumnSortingMode

setReadOnly

isReadOnly

setTakeWholeModelAsScope

isWholeModelTakenAsScope

getColumnCustomOrder

setColumnCustomOrder

getRowCustomOrder

setRowCustomOrder