プレゼンテーションモデル

例：実行例（ビューがPMを参照）（C＃）

これは、プレゼンテーションモデルを使用してC＃で開発された実行例のバージョンです。

図3：アルバムウィンドウ。

ドメインモデルから外側に向かって、基本的なレイアウトについて説明します。ドメインはこの例の焦点ではないため、非常に面白くありません。これは本質的に、アルバムのデータを保持する単一のテーブルを持つデータセットです。次に、いくつかのテストアルバムを設定するためのコードを示します。厳密に型指定されたデータセットを使用しています。

public static DsAlbum AlbumDataSet() {
  DsAlbum result = new DsAlbum();
  result.Albums.AddAlbumsRow(1, "HQ", "Roy Harper", false, null);
  result.Albums.AddAlbumsRow(2, "The Rough Dancer and Cyclical Night", "Astor Piazzola", false, null);
  result.Albums.AddAlbumsRow(3, "The Black Light", "Calexico", false, null);
  result.Albums.AddAlbumsRow(4, "Symphony No.5", "CBSO", true, "Sibelius" );
  result.AcceptChanges();
  return result;
}

プレゼンテーションモデルはこのデータセットをラップし、データにアクセスするためのプロパティを提供します。ウィンドウの単一インスタンスに対応する、テーブル全体のプレゼンテーションモデルの単一インスタンスがあります。プレゼンテーションモデルにはデータセットのフィールドがあり、現在どのアルバムが選択されているかも追跡します。

クラス PmodAlbum...

  public PmodAlbum(DsAlbum albums) {
    this._data = albums; 
    _selectedAlbumNumber = 0;
  }
  private DsAlbum _data;
  private int _selectedAlbumNumber;

PmodAlbum は、データセット内のデータにアクセスするためのプロパティを提供します。基本的に、フォームが表示する必要がある情報の各ビットに対してプロパティを提供します。データセットから直接取得される値の場合、このプロパティは非常に単純です。

クラス PmodAlbum...

  public String Title {
    get {return SelectedAlbum.Title;}
    set {SelectedAlbum.Title = value;}
  }
  public String Artist {
    get {return SelectedAlbum.Artist;}
    set {SelectedAlbum.Artist = value;}     
  }
  public bool IsClassical {
    get {return SelectedAlbum.IsClassical;}
    set {SelectedAlbum.IsClassical = value;}            
  }
  public String Composer {
    get {
      return (SelectedAlbum.IsComposerNull()) ? "" : SelectedAlbum.Composer;
    }
    set {
      if (IsClassical) SelectedAlbum.Composer = value;
    }                 
  }
  public DsAlbum.AlbumsRow SelectedAlbum {
    get {return Data.Albums[SelectedAlbumNumber];}
  }

ウィンドウのタイトルはアルバムのタイトルに基づいています。これは別のプロパティを介して提供します。

クラス PmodAlbum...

  public String FormTitle 
  {
    get {return "Album: " + Title;}
  }

作曲家フィールドを有効にする必要があるかどうかを確認するためのプロパティがあります。

クラス PmodAlbum...

  public bool IsComposerFieldEnabled {
    get {return IsClassical;}
  }

これは、パブリックな IsClassical プロパティへの呼び出しに過ぎません。フォームがこれを直接呼び出さないのはなぜか疑問に思うかもしれませんが、これはプレゼンテーションモデルが提供するカプセル化の本質です。PmodAlbum は、そのフィールドを有効にするためのロジックを決定します。それが単にプロパティに基づいているという事実は、プレゼンテーションモデルには知られていますが、ビューには知られていません。

適用ボタンとキャンセルボタンは、データが変更された場合にのみ有効にする必要があります。データセットはこの情報を記録するため、データセットのその行の状態を確認することでこれを提供できます。

クラス PmodAlbum...

  public bool IsApplyEnabled {
    get {return HasRowChanged;}
  }
  public bool IsCancelEnabled {
    get {return HasRowChanged;}
  }
  public bool HasRowChanged {
    get {return SelectedAlbum.RowState == DataRowState.Modified;}
  }

ビューのリストボックスには、アルバムタイトルのリストが表示されます。PmodAlbum はこのリストを提供します。

クラス PmodAlbum...

  public String[] AlbumList {
    get {
      String[] result = new String[Data.Albums.Rows.Count];
      for (int i = 0; i < result.Length; i++)
        result[i] = Data.Albums[i].Title;
      return result;
    }
  }

これで、PmodAlbum がビューに提示するインターフェースの説明は終わりです。次に、ビューとプレゼンテーションモデル間の同期をどのように行うかを見ていきます。同期メソッドをビューに配置し、粗粒度の同期を使用しています。まず、ビューの状態をプレゼンテーションモデルにプッシュするメソッドがあります。

クラス FrmAlbum...

  private void SaveToPmod() {
    model.Artist = txtArtist.Text;
    model.Title = txtTitle.Text;
    model.IsClassical = chkClassical.Checked;
    model.Composer = txtComposer.Text;
  }

このメソッドは非常に単純で、ビューの変更可能な部分をプレゼンテーションモデルに割り当てるだけです。load メソッドはもう少し複雑です。

クラス FrmAlbum...

  private void LoadFromPmod() {
    if (NotLoadingView) {
      _isLoadingView = true;
      lstAlbums.DataSource = model.AlbumList;
      lstAlbums.SelectedIndex = model.SelectedAlbumNumber;
      txtArtist.Text = model.Artist;
      txtTitle.Text = model.Title;
      this.Text = model.FormTitle;
      chkClassical.Checked = model.IsClassical;
      txtComposer.Enabled = model.IsComposerFieldEnabled;
      txtComposer.Text = model.Composer;
      btnApply.Enabled = model.IsApplyEnabled;
      btnCancel.Enabled = model.IsCancelEnabled;
      _isLoadingView = false;
    }
  }
  private bool _isLoadingView = false;
  private bool NotLoadingView {
    get {return !_isLoadingView;}
  }

private void SyncWithPmod() {
  if (NotLoadingView) {
    SaveToPmod();
    LoadFromPmod();
  }
}

ここでの問題は、同期によってフォームのフィールドが更新され、同期がトリガーされるため、無限再帰を回避することです...フラグを使用してこれを防ぎます。

これらの同期メソッドが配置されたら、次の手順は、コントロールのイベントハンドラーで適切な同期ビットを呼び出すだけです。ほとんどの場合、これは簡単で、データが変更されたときに SyncWithPmod を呼び出すだけです。

クラス FrmAlbum...

  private void txtTitle_TextChanged(object sender, System.EventArgs e){
    SyncWithPmod();
  }

より複雑なケースもあります。ユーザーがリスト内の新しいアイテムをクリックすると、新しいアルバムに移動してそのデータを表示する必要があります。

クラス FrmAlbum...

  private void lstAlbums_SelectedIndexChanged(object sender, System.EventArgs e){
    if (NotLoadingView) {
      model.SelectedAlbumNumber = lstAlbums.SelectedIndex;  
      LoadFromPmod();
    }
  }

クラス PmodAlbum...

  public int SelectedAlbumNumber {
    get {return _selectedAlbumNumber;}
    set {
      if (_selectedAlbumNumber != value) {
        Cancel();
        _selectedAlbumNumber = value;
      }
    }
  }

リストをクリックすると、このメソッドは変更を破棄することに注意してください。例を単純にするために、このひどい使いやすさを行いました。フォームは、変更が失われないように、少なくとも確認ボックスを表示する必要があります。

適用ボタンとキャンセルボタンは、プレゼンテーションモデルに何をすべきかを委任します。

クラス FrmAlbum...

  private void btnApply_Click(object sender, System.EventArgs e)    {
    model.Apply();
    LoadFromPmod();
  }
  private void btnCancel_Click(object sender, System.EventArgs e){
    model.Cancel();
    LoadFromPmod();
  }

クラス PmodAlbum...

  public void Apply ()    {
    SelectedAlbum.AcceptChanges();
  }
  public void Cancel() {
    SelectedAlbum.RejectChanges();
  }

ほとんどの動作をプレゼンテーションモデルに移動できますが、ビューにはまだある程度のインテリジェンスが残っています。プレゼンテーションモデルのテストの側面をより良く機能させるためには、もっと移動できると良いでしょう。プレゼンテーションモデルがビューについてより多くを知ることになるという犠牲を払って、同期ロジックをそこに移動することで、プレゼンテーションモデルにさらに移動することができます。

例：データバインディングテーブルの例（C＃）

.NET framework でプレゼンテーションモデルを初めて見たとき、データバインディングはプレゼンテーションモデルを簡単に動作させるための優れたテクノロジーを提供しているように見えました。これまでのところ、現在のバージョンのデータバインディングの制限により、最終的には到達するであろう場所から後退しています。データバインディングが非常にうまく機能する分野の1つは読み取り専用データであるため、これと、テーブルがプレゼンテーションモデルの設計にどのように適合するかを示す例を次に示します。

図4：ロックアルバムが強調表示されたアルバムのリスト。

これは単なるアルバムのリストです。追加の動作は、各ロックアルバムの行がコーンシルク色で着色されることです。

他の例とは少し異なるデータセットを使用しています。テストデータのコードを次に示します。

public static AlbumList AlbumGridDataSet() 
{
  AlbumList result = new AlbumList();
  result.Albums.AddAlbumsRow(1, "HQ", "Roy Harper", "Rock");
  result.Albums.AddAlbumsRow(2, "Lemonade and Buns", "Kila", "Celtic");
  result.Albums.AddAlbumsRow(3, "Stormcock", "Roy Harper", "Rock");
  result.Albums.AddAlbumsRow(4, "Zero Hour", "Astor Piazzola", "Tango");
  result.Albums.AddAlbumsRow(5, "The Rough Dancer and Cyclical Night", "Astor Piazzola", "Tango");
  result.Albums.AddAlbumsRow(6, "The Black Light", "Calexico", "Rock");
  result.Albums.AddAlbumsRow(7, "Spoke", "Calexico", "Rock");
  result.Albums.AddAlbumsRow(8, "Electrica", "Daniela Mercury", "Brazil");
  result.Albums.AddAlbumsRow(9, "Feijao com Arroz", "Daniela Mercury", "Brazil");     
  result.Albums.AddAlbumsRow(10, "Sol da Libertade", "Daniela Mercury", "Brazil");  
  Console.WriteLine(result);
  return result;
}

この場合のプレゼンテーションモデルは、内部データセットをプロパティとして公開します。これにより、フォームはデータセット内のセルに直接データをバインドできます。

private AlbumList _dsAlbums;
internal AlbumList DsAlbums {
  get {return _dsAlbums;}
}

強調表示をサポートするために、プレゼンテーションモデルはテーブルにインデックスを付ける追加のメソッドを提供します。

internal Color RowColor(int row) {
  return (Albums[row].genre.Equals("Rock")) ? Color.Cornsilk : Color.White;
}
private AlbumList.AlbumsDataTable Albums {
  get {return DsAlbums.Albums;}
}

このメソッドは単純な例のメソッドに似ていますが、テーブルデータのメソッドはテーブルの一部を選択するためにセル座標を必要とする点が異なります。この場合、必要なのは行番号だけですが、一般的には行番号と列番号が必要になる場合があります。

ここから、Visual Studioに付属の標準データバインディング機能を使用できます。テーブルセルをデータセット内のデータ、およびプレゼンテーションモデルのデータに簡単にバインドできます。

色の動作をさせるのは少し複雑です。これは例の主な目的から少し外れていますが、標準の WinForms テーブルコントロールで行ごとの強調表示を行う方法がないため、全体が複雑になります。一般的に、このニーズに対する答えは、サードパーティのコントロールを購入することですが、私はそれをするには安すぎます。好奇心旺盛な方のために、私が行ったことをここに示します（このアイデアは、主に http://www.syncfusion.com/FAQ/WinForms/ から引用されています）。今後、WinForms の内部構造に精通していることを前提としています。

基本的に、色の強調表示動作を追加する DataGridTextBoxColumn のサブクラスを作成しました。動作を処理するデリゲートを渡すことで、新しい動作をリンクします。

クラス ColorableDataGridTextBoxColumn...

  public ColorableDataGridTextBoxColumn (ColorGetter getcolorRowCol, DataGridTextBoxColumn original)
  {
    _delGetColor = getcolorRowCol;
    copyFrom(original);
  }
  public delegate Color ColorGetter(int row);
  private ColorGetter _delGetColor;

コンストラクターは、元の DataGridTextBoxColumn とデリゲートを受け取ります。ここで本当にやりたいことは、デコレータパターンを使用してオリジナルをラップすることですが、WinForms の多くのクラスと同様に、オリジナルはすべて封印されています。そのため、代わりに、オリジナルのすべてのプロパティをサブクラスにコピーします。読み取りまたは書き込みできない重要なプロパティがある場合は、これは機能しません。今のところここではうまくいくようです。

クラス ColorableDataGridTextBoxColumn...

  void copyFrom (DataGridTextBoxColumn original) {
    PropertyInfo[] props = original.GetType().GetProperties();
    foreach (PropertyInfo p in props) {
      if (p.CanWrite && p.CanRead)
        p.SetValue(this, p.GetValue(original, null), null) ;
    }
  }

幸いなことに、paint メソッドは仮想です（そうでなければ、まったく新しいデータグリッドが必要になります）。これを使用して、デリゲートを使用して適切な背景色を挿入できます。

クラス ColorableDataGridTextBoxColumn...

  protected override void Paint(System.Drawing.Graphics g, System.Drawing.Rectangle bounds, 
    System.Windows.Forms.CurrencyManager source, int rowNum, 
    System.Drawing.Brush backBrush, System.Drawing.Brush foreBrush, 
    bool alignToRight)
  {
    base.Paint(g, bounds, source, rowNum, new SolidBrush(_delGetColor(rowNum)), foreBrush, alignToRight);
  }

この新しいテーブルを配置するには、フォームにコントロールが構築された後、ページの読み込み時にデータテーブルの列を置き換えます。

クラス FrmAlbums...

  private void FrmAlbums_Load(object sender, System.EventArgs e){
    bindData();
    replaceColumnStyles();
  }
  private void replaceColumnStyles() {
    ColorableDataGridTextBoxColumn.ReplaceColumnStyles(dgsAlbums, 
      new ColorableDataGridTextBoxColumn.ColorGetter(model.RowColor));
  }

クラス ColorableDataGridTextBoxColumn...

  public static void ReplaceColumnStyles(DataGridTableStyle grid, ColorGetter del) {
    for (int i = 0; i < grid.GridColumnStyles.Count; i++) {
      DataGridTextBoxColumn old = (DataGridTextBoxColumn) grid.GridColumnStyles[0];
      grid.GridColumnStyles.RemoveAt(0);
      grid.GridColumnStyles.Add(new ColorableDataGridTextBoxColumn(del, old));
    }
  }

動作しますが、私が望むよりもはるかに厄介であることを認めます。実際にこれを行う場合は、サードパーティのコントロールを検討する必要があります。ただし、本番システムでこれを行ったことがあり、正常に機能しました。