도구 및 도구 상자 사용자 지정

아티클
05/19/2015

사용자가 모델에 추가할 수 있도록 할 요소에 대해 도구 상자 항목을 정의해야 합니다. 도구에는 요소 도구와 연결 도구의 두 가지 종류가 있습니다. 사용자는 생성된 디자이너에서 요소 도구를 선택해 도형을 다이어그램으로 끌고 연결 도구를 선택해 도형 간에 링크를 그릴 수 있습니다. 일반적으로 요소 도구를 사용하면 도메인 클래스 인스턴스를 모델에 추가할 수 있으며 연결 도구를 사용하면 도메인 관계 인스턴스를 추가할 수 있습니다.

항목 내용

도구 상자를 정의하는 방법
요소 도구 사용자 지정
도구에서 요소 그룹 만들기
연결 도구 사용자 지정

도구 상자를 정의하는 방법

DSL 탐색기에서 편집기 노드와 그 아래의 노드를 확장합니다. 일반적으로는 다음과 같은 계층 구조가 표시됩니다.

Editor
     Toobox Tabs
        MyDsl          //a tab
           Tools
               ExampleElement      // an element tool
               ExampleRelationship // a connection tool

DSL 탐색기의 이 부분에서 다음 작업을 수행할 수 있습니다.

새 탭 만들기. 탭은 도구 상자의 섹션 제목을 정의합니다.
새 도구 만들기
도구 복사/붙여넣기
도구를 목록에서 위/아래로 이동
탭과 도구 삭제

중요

DSL 탐색기에서 항목을 추가하거나 붙여넣으려면 새 노드의 상위 부모를 마우스 오른쪽 단추로 클릭합니다.예를 들어 도구를 추가하려면 도구 노드가 아닌 탭을 마우스 오른쪽 단추로 클릭합니다.탭을 추가하려면 편집기 노드를 마우스 오른쪽 단추로 클릭합니다.

모든 도구의 도구 상자 아이콘 속성은 16x16 비트맵 파일을 참조합니다. 이러한 파일은 대개 Dsl\Resources 폴더에 저장되어 있습니다.

요소 도구의 클래스 속성은 구체적인 도메인 클래스를 참조합니다. 도구는 기본적으로 이 클래스의 인스턴스를 만듭니다. 그러나 도구가 요소 그룹이나 다른 형식의 요소를 만들도록 코드를 작성할 수 있습니다.

연결 도구의 연결 작성기 속성은 도구가 연결할 수 있는 요소의 형식과 요소 간에 만드는 관계를 정의하는 연결 작성기를 참조합니다. 연결 작성기는 DSL 탐색기의 노드로 정의되며 도메인 관계를 정의할 때 자동으로 만들어지지만 연결 작성기를 사용자 지정하는 코드를 작성할 수 있습니다.

도구 상자에 도구를 추가하려면

요소 도구는 일반적으로 도형 클래스를 만들고 도메인 클래스에 매핑한 후 만듭니다.

연결선 도구는 대개 연결선 클래스를 만들고 참조 관계에 매핑한 후 만듭니다.
DSL 탐색기에서 편집기 노드와 도구 상자 탭 노드를 확장합니다.

도구 상자 탭 노드를 마우스 오른쪽 단추로 클릭하고 새 요소 도구 추가 또는 새 연결 도구 추가를 클릭합니다.
도구 상자 아이콘 속성이 16x16 비트맵을 참조하도록 설정합니다.

새 아이콘을 정의하려면 솔루션 탐색기에서 Dsl\Resources 폴더에 비트맵 파일을 만듭니다. 이 파일에는 빌드 작업 = 콘텐츠, 출력 디렉토리에 복사 = 복사 안 함 속성 값이 포함되어야 합니다.
요소 도구의 경우: 도형에 매핑되는 명확한 도메인 클래스를 참조하도록 도구의 Class 속성을 설정합니다.

연결선 도구의 경우: 도구의 연결 작성기 속성을 드롭다운 목록에서 제공되는 항목 중 하나로 설정합니다. 연결 작성기는 연결선을 도메인 관계에 매핑하면 자동으로 만들어집니다. 최근에 연결선을 만든 경우에는 보통 연결된 연결 작성기를 선택합니다.
DSL을 테스트하려면 F5 키나 Ctrl+F5를 누르고 Visual Studio의 실험 인스턴스에서 샘플 모델 파일을 엽니다. 도구 상자에 새 도구가 표시되어야 합니다. 해당 도구를 다이어그램으로 끌어 새 요소가 만들어지는지 확인합니다.

도구가 표시되지 않으면 실험 Visual Studio를 중지합니다. 그런 다음 Windows 시작 메뉴에서 Microsoft Visual Studio 2010 실험적 인스턴스 다시 설정을 실행합니다. Visual Studio 빌드 메뉴에서 솔루션 다시 빌드를 클릭합니다. 그런 후에 DSL을 다시 테스트합니다.

요소 도구 사용자 지정

도구는 기본적으로 지정한 클래스의 단일 인스턴스를 만들지만 두 가지 방법을 통해 이 기본 옵션을 변경할 수 있습니다.

다른 클래스에 대해 요소 병합 지시문을 정의하여 해당 클래스가 이 클래스의 새 인스턴스를 수락하고 새 요소를 만들 때 추가 링크를 만들 수 있도록 설정합니다. 예를 들어 사용자가 다른 요소에 주석을 놓아 두 요소 간에 참조 링크를 만들도록 허용할 수 있습니다.

이러한 사용자 지정은 사용자가 요소를 붙여넣거나 끌어서 놓을 때 수행되는 작업에도 영향을 줍니다.

자세한 내용은 Customizing Element Creation and Movement을 참조하십시오.
요소 그룹을 만들 수 있도록 도구를 사용자 지정하는 코드를 작성합니다. 그러면 도구가 재정의 가능한 ToolboxHelper.cs의 메서드를 통해 초기화됩니다. 자세한 내용은 도구에서 요소 그룹 만들기를 참조하세요.

도구에서 요소 그룹 만들기

각 요소 도구는 만들어야 하는 요소의 프로토타입을 포함합니다. 기본적으로 각 요소 도구는 단일 요소를 만들지만 도구 하나로 관련 개체 그룹을 만들 수도 있습니다. 이렇게 하려면 관련 항목이 포함된 ElementGroupPrototype을 사용하여 도구를 초기화합니다.

다음 예제는 Transistor 형식이 포함된 DSL에서 가져온 것입니다. 각 Transistor에는 명명된 Terminal 세 개가 있습니다. Transistor용 요소 도구는 모델 요소 4개와 관계 링크 3개가 포함된 프로토타입을 저장합니다. 사용자가 도구를 다이어그램으로 끌면 프로토타입이 인스턴스화되어 모델 루트에 연결됩니다.

이 코드는 Dsl\GeneratedCode\ToolboxHelper.cs에 정의된 메서드를 재정의합니다.

프로그램 코드를 사용하여 모델을 사용자 지정하는 방법은 Navigating and Updating a Model in Program Code를 참조하세요.

using Microsoft.VisualStudio.Modeling;
using Microsoft.VisualStudio.Modeling.Diagrams;

  public partial class CircuitsToolboxHelper
  {
    /// <summary>
    /// Toolbox initialization, called for each element tool on the toolbox.
    /// This version deals with each Component subtype separately.
    /// </summary>
    /// <param name="store"></param>
    /// <param name="domainClassId">Identifies the domain class this tool should instantiate.</param>
    /// <returns>prototype of the object or group of objects to be created by tool</returns>
    protected override ElementGroupPrototype CreateElementToolPrototype(Store store, Guid domainClassId)
    {
        if (domainClassId == Transistor.DomainClassId)
        {
            Transistor transistor = new Transistor(store);

            transistor.Base = new ComponentTerminal(store);
            transistor.Collector = new ComponentTerminal(store);
            transistor.Emitter = new ComponentTerminal(store);

            transistor.Base.Name = "base";
            transistor.Collector.Name = "collector";
            transistor.Emitter.Name = "emitter";

            // Create an ElementGroup for the Toolbox.
            ElementGroup elementGroup = new ElementGroup(store.DefaultPartition);
            elementGroup.AddGraph(transistor, true);
            // AddGraph includes the embedded parts

            return elementGroup.CreatePrototype();
        }
        else
        {
            return base.CreateElementToolPrototype(store, domainClassId);
}  }    }

연결 도구 사용자 지정

일반적으로는 새 연결선 클래스를 만들 때 요소 도구를 만듭니다. 두 도구의 형식을 통해 관계 형식을 결정하도록 허용하여 도구 하나를 재정의할 수도 있습니다. 예를 들어 사용자 간 관계와 사용자 대 지역 관계를 모두 만들 수 있는 연결 도구 하나를 정의할 수 있습니다.

연결 도구는 연결 작성기를 호출합니다. 연결 작성기를 통해 사용자가 생성된 디자이너에서 요소를 연결할 수 있는 방법을 지정합니다. 연결 작성기는 연결 가능한 요소 및 해당 요소 간에 작성되는 링크의 종류를 지정합니다.

도메인 클래스 간에 참조 관계를 만들면 연결 작성기가 자동으로 만들어집니다. 연결 도구를 매핑할 때 이 연결 작성기를 사용할 수 있습니다. 연결 도구를 만드는 방법에 대한 자세한 내용은 도구 및 도구 상자 사용자 지정을 참조하세요.

기본 연결 작성기가 다른 소스 및 대상 형식 범위를 처리하고 다른 관계 형식을 만들도록 수정할 수 있습니다.

또한 연결 작성기에 대해 사용자 지정 코드를 작성하여 연결의 소스 및 대상 클래스를 지정하고 설정할 연결 형식을 정의하며 연결 작성과 관련된 기타 작업을 수행할 수 있습니다.

연결 작성기의 구조

연결 작성기는 도메인 관계와 소스/대상 요소를 지정하는 링크 연결 지시문을 하나 이상 포함합니다. 예를 들어 작업 흐름 솔루션 템플릿의 경우 DSL 탐색기에서 CommentReferencesSubjectsBuilder를 확인할 수 있습니다. 이 연결 작성기는 CommentReferencesSubjects 도메인 관계에 매핑되는 링크 연결 지시문 CommentReferencesSubjects를 하나 포함합니다. 이 링크 연결 지시문은 Comment 도메인 클래스를 가리키는 소스 역할 지시문과 FlowElement 도메인 클래스를 가리키는 대상 역할 지시문을 포함합니다.

연결 작성기를 사용하여 소스 및 대상 역할 제한

연결 작성기를 사용하여 지정된 도메인 관계의 소스 역할 또는 대상 역할에서 특정 클래스의 발생을 제한할 수 있습니다. 다른 도메인 클래스에 대한 도메인 관계가 포함된 기본 도메인 클래스가 있는데 기본 클래스의 모든 파생된 클래스가 해당 관계에서 같은 역할을 포함하지 않도록 지정하려는 경우를 예로 들 수 있습니다. 작업 흐름 솔루션에는 추상 도메인 클래스 FlowElement에서 직접적으로 상속되는 구체적인 도메인 클래스 4개((StartPoint, EndPoint, MergeBranch, Synchronization)와 FlowElement에서 간접적으로 상속되는 구체적인 도메인 클래스 2개(Task, ObjectInState)가 있습니다. 또한 소스 역할과 대상 역할에서 모두 FlowElement 도메인 클래스를 가져오는 Flow 참조 관계도 있습니다. 그러나 EndPoint 도메인 클래스 인스턴스는 Flow 관계 인스턴스의 소스일 수 없으며 ShartPoint 클래스 인스턴스는 Flow 관계 인스턴스의 대상일 수 없습니다. FlowBuilder 연결 작성기에는 소스 역할을 할 수 있는 도메인 클래스(Task, MergeBranch, StartPoint, Synchronization)와 대상 역할을 할 수 있는 도메인 클래스(MergeBranch, Endpoint, Synchronization)를 지정하는 Flow라는 링크 연결 지시문이 있습니다.

여러 링크 연결 지시문이 포함된 연결 작성기

연결 작성기에 링크 연결 지시문을 두 개 이상 추가할 수 있습니다. 이렇게 하면 도메인 모델의 일부 복잡한 요소를 사용자로부터 숨기고 도구 상자를 단순하게 유지할 수 있습니다. 서로 다른 여러 도메인 관계에 대한 링크 연결 지시문을 단일 연결 작성기에 추가할 수 있습니다. 그러나 대략적으로 비슷한 기능을 수행하는 도메인 관계는 결합해야 합니다.

작업 흐름 솔루션에서는 Flow 연결 도구를 사용하여 Flow 및 ObjectFlow 도메인 관계 인스턴스를 그립니다. FlowBuilder 연결 작성기에는 앞에서 설명한 Flow 링크 연결 지시문뿐 아니라 ObjectFlow라는 링크 연결 지시문 두 개도 포함되어 있습니다. 이러한 지시문은 ObjectInState 도메인 클래스 인스턴스 간이나 ObjectInState 인스턴스에서 Task 인스턴스로는 ObjectFlow 관계 인스턴스를 그릴 수 있지만 두 Task 인스턴스 간이나 Task 인스턴스에서 ObjectInState 인스턴스로는 그릴 수 없음을 지정합니다. 그러나 두 Task 인스턴스 간에 Flow 관계 인스턴스를 그릴 수는 있습니다. 작업 흐름 솔루션을 컴파일하고 실행하면 ObjectInState 인스턴스에서 Task 인스턴스로 Flow를 그리는 경우 ObjectFlow 인스턴스가 만들어지는 반면 두 Task 인스턴스 간에 Flow를 그리는 경우에는 Flow 인스턴스가 만들어짐을 확인할 수 있습니다.

연결 작성기용 사용자 지정 코드

사용자 인터페이스에는 연결 작성기의 여러 사용자 지정 형식을 정의하는 4개 확인란이 있습니다.

소스 또는 대상 역할 지시문에 대한 Custom accept 확인란
소스 또는 대상 역할 지시문에 대한 Custom connect 확인란
연결 지시문에 대한 Uses custom connect 확인란
연결 작성기의 Is Custom 속성

이러한 사용자 지정을 수행하려면 프로그램 코드를 입력해야 합니다. 입력해야 하는 코드를 확인하려면 위의 확인란 중 하나를 선택하고 모든 템플릿 변환을 클릭한 후에 솔루션을 빌드합니다. 그러면 오류 보고서가 표시됩니다. 오류 보고서를 두 번 클릭하면 추가해야 하는 코드를 설명하는 주석이 표시됩니다.

참고

사용자 지정 코드를 추가하려면 GeneratedCode 폴더의 코드 파일이 아닌 별도의 코드 파일에 부분 클래스 정의를 만듭니다.작업 내용 손실을 방지하려면 생성된 코드 파일을 편집해서는 안 됩니다.자세한 내용은 Overriding and Extending the Generated Classes을 참조하십시오.

사용자 지정 연결 코드 만들기

각 링크 연결 지시문에서 소스 역할 지시문 탭은 끌기를 시작할 수 있는 형식을 정의합니다. 마찬가지로 대상 역할 지시문 탭은 끌기 대상으로 지정할 수 있는 형식을 정의합니다. 각 형식에 대해 Custom Accept 플래그를 지정한 다음 추가 코드를 입력하여 해당 링크 연결 지시문에 대해 연결을 허용할지 여부를 추가로 지정할 수 있습니다.

연결 설정 시 수행되는 작업도 사용자 지정할 수 있습니다. 예를 들어 특정 클래스에서/클래스로 끌기가 수행되는 경우만 사용자 지정하거나 단일 링크 연결 지시문이 적용되는 모든 경우를 사용자 지정하거나 전체 FlowBuilder 연결 작성기를 사용자 지정할 수 있습니다. 이러한 각 옵션에 대해 사용자 지정 플래그를 적절한 수준으로 설정할 수 있습니다. 모든 템플릿을 변환하고 솔루션 빌드를 시도하는 경우 오류 메시지에 생성된 코드의 주석이 표시됩니다. 이러한 주석을 통해 입력해야 하는 코드를 확인할 수 있습니다.

구성 요소 다이어그램 샘플에서는 Connection 도메인 관계의 연결 작성기가 사용자 지정되어 포트 간에 설정할 수 있는 연결을 제한합니다. 다음 그림에서는 OutPort 요소에서 InPort 요소로만 연결할 수 있지만 각 요소를 서로 중첩할 수 있음을 보여줍니다.

중첩된 구성 요소에서 OutPort로의 연결

연결 작성기

따라서 중첩된 구성 요소에서 OutPort로의 연결이 가능하도록 지정할 수 있습니다. 이러한 연결을 지정하려면 다음 그림에 나와 있는 것처럼 DSL 세부 정보 창에서 InPort 형식에 대해 Uses Custom Accept를 소스 역할로 설정하고 OutPort 형식을 대상 역할로 설정합니다.

DSL 탐색기의 링크 연결 지시문

연결 작성기 이미지

DSL 세부 정보 창의 링크 연결 지시문

ConnectionBuilder_4b

그런 다음 ConnectionBuilder 클래스에서 메서드를 입력해야 합니다.

  public partial class ConnectionBuilder
  {
    /// <summary>
    /// OK if this component has children
    /// </summary>
    private static bool CanAcceptInPortAsSource(InPort candidate)
    {
       return candidate.Component.Children.Count > 0;
    }

    /// <summary>
    /// Only if source is on parent of target.
    /// </summary>
    private static bool CanAcceptInPortAndInPortAsSourceAndTarget                (InPort sourceInPort, InPort targetInPort)
    {
      return sourceInPort.Component == targetInPort.Component.Parent;
    }
// And similar for OutPorts…

프로그램 코드를 사용하여 모델을 사용자 지정하는 방법은 Navigating and Updating a Model in Program Code를 참조하세요.

예를 들어 비슷한 코드를 통해 사용자가 부모-자식 링크를 포함하는 루프를 만들지 못하도록 지정할 수 있습니다. 이러한 제한은 사용자가 어떤 경우에도 위반할 수 없으므로 '하드' 제한으로 간주됩니다. 사용자가 저장할 수 없는 잘못된 구성을 만들어 일시적으로 건너뛸 수 있는 '소프트' 유효성 검사를 만들 수도 있습니다.

적절한 연결 작성기 정의 사례

개념적으로 관련이 있는 경우에만 단일 연결 작성기가 여러 관계 형식을 만들도록 정의해야 합니다. 작업 흐름 샘플에서는 같은 작성기를 사용하여 작업 간에 그리고 작업과 개체 간에 흐름을 만듭니다. 그러나 같은 작성기를 사용해 주석과 작업 간에 관계를 만들면 관계를 혼동할 수도 있습니다.

여러 관계 형식에 대해 연결 작성기 하나를 정의하는 경우에는 연결 작성기가 같은 소스 및 대상 개체 쌍의 형식 두 개 이상과 일치하지 않도록 해야 합니다. 이렇게 하지 않으면 결과를 예측할 수가 없습니다.

사용자 지정 코드를 사용하면 '하드' 제약 조건을 적용할 수 있지만 이 경우 사용자가 일시적으로 잘못된 연결을 설정할 수 있어야 하는지를 고려해야 합니다. 사용자가 일시적으로 잘못된 연결을 설정할 수 있어야 하는 경우에는 사용자가 변경 내용을 저장할 때까지 연결 유효성을 검사하지 않도록 제약 조건을 수정할 수 있습니다.