UI コンポーネント クラスの構造

UI コンポーネント クラスには、いくつかの必須部分と、いくつかのオプション部分があります。

UI コンポーネント クラスの最初の行では、matlab.ui.componentcontainer.ComponentContainerクラスをスーパークラスとして指定します。たとえば、ColorSelectorというクラスの最初の行は次のようになります。

classdefColorSelector < matlab.ui.componentcontainer.ComponentContainer

スーパークラスの指定に加えて、以下のコンポーネントをユーザー クラス定義に含めます。いくつかのコンポーネントは必須で、他のコンポーネントは推奨またはオプションです。

コンストラクター メソッド

コンストラクターはComponentContainer基底クラスから継承されるため、ユーザー クラスにコンストラクター メソッドを作成する必要はありません。継承されたコンストラクターは、オプションの入力引数 (親コンテナーと、UI コンポーネントにプロパティを設定するための任意数の名前と値のペアの引数) を受け入れます。たとえば、パブリック プロパティValueおよびValueChangedFcnをもつColorSelectorというクラスを定義する場合、次のコードを使用してユーザー クラスのインスタンスを作成できます。

f = uifigure; c = ColorSelector(f,'Value',[1 1 0],'ValueChangedFcn',@(o,e)disp('Changed'))

別の構文または別の動作をもつコンストラクターを指定する場合は、カスタム コンストラクター メソッドを定義できます。カスタム コンストラクターの例は、チャート クラスのコンストラクターの作成を参照してください。

パブリックおよびプライベートのプロパティ ブロック

ユーザー クラスのプロパティを、少なくとも 2 つのブロック間で分割します。

パブリック ブロックに収められるプロパティは、ユーザーの指定する入力値を保存します。たとえば、ユーザーがカラー値を選択できる UI コンポーネントでは、パブリック プロパティにカラー値が保存されている可能性があります。プロパティの名前と値のペアの引数は暗黙的なコンストラクター メソッドのオプション入力であるため、パブリック プロパティを既定値に初期化する方法が推奨されます。

プライベート ブロックに収められるプロパティには、保存するすべての計算値に加えて、UI コンポーネントを構成する基となるグラフィックス オブジェクトが保存されます。最終的に、ユーザー クラスはパブリック プロパティ内のデータを使用して、基となるオブジェクトを構成します。プライベート ブロックにTransient属性とNonCopyable属性を設定することで、ユーザーが UI コンポーネントのインスタンスのコピーや保存をする場合に、冗長な情報が保存されることを回避します。

たとえば、次に示すのは、ユーザーがカラー値を選択できる UI コンポーネントのプロパティ ブロックです。パブリック プロパティ ブロックには、ユーザーが制御できる値としてカラー値が保存されています。プライベート プロパティ ブロックには、グリッド レイアウト マネージャー、ボタン、編集フィールドの各オブジェクトが保存されています。

propertiesValue {validateattributes(Value, ... {'double'},{'<=',1,'>=',0,'size',[1 3]})} = [1 0 0];endproperties（access =私有，瞬态，不可复制）网格matlab.ui.container.gridlayout按钮matlab.ui.control.control.button editfield matlab.ui.ui.control.control.editfieldend

イベント ブロック

オプションとして、UI コンポーネントが発生させるイベント用に 3 番目のブロックを追加することができます。

HasCallbackProperty属性を指定することにより、ブロック内に各イベントのパブリック プロパティを作成します。そのパブリック プロパティには、イベントが発生すると実行される、ユーザー指定のコールバックが保存されます。パブリック プロパティの名前は、イベント名に文字Fcnを追加したものとなります。たとえば、ユーザーがカラー値を選択できる UI コンポーネントがイベントValueChangedを定義するならば、これによって、対応するパブリック プロパティValueChangedFcnが生成されます。notifyメソッドを使用してイベントを発生させ、プロパティ内のコールバックを実行します。

たとえば、ユーザーがカラー値を選択できる UI コンポーネントに対するイベント ブロックは、次のようになります。

events(HasCallbackProperty, NotifyAccess = protected) ValueChangedend

functionGetColorFromuser(obj) c = uisetcolor(obj.Value);if(isscalar(c) && (c == 0))return;end% Update the Value propertyoldValue = obj.Value; obj.Value = c;% Execute user callbacks and listenersnotify(obj,'ValueChanged');end

f = uifigure; c = ColorSelector(f,'ValueChangedFcn',@(o,e)disp('Changed'))

setup メソッド

クラスにsetupメソッドを定義します。setupメソッドは、MATLAB が UI コンポーネント オブジェクトを作成するときに一度実行されます。名前と値のペアの引数としてコンストラクター メソッドに渡されたプロパティ値は、このメソッドの実行後に割り当てられます。

次の場合にsetupメソッドを使用します。

自分の UI コンポーネント クラスのみがsetupメソッドを実行できることを確実にするため、定義は保護されたブロック内で行います。

ほとんどの UI オブジェクト作成関数には、親を指定するためのオプションの入力引数があります。クラス メソッド内からこれらの関数を呼び出す際には、ターゲットの親を指定しなければなりません。setupメソッドは、設定されている UI コンポーネント オブジェクトのインスタンスを表す 1 つの引数を取ります。この引数を使用して、setupメソッド内からオブジェクト作成関数を呼び出す際のターゲットの親として、UI コンポーネントを指定します。

たとえば、次のプロパティをもつ UI コンポーネントについて考えます。

setupメソッドでは、UI コンポーネントのインスタンス (obj) をターゲットの親として指定し、関数uigridlayout、uieditfield、uibuttonを呼び出して各プライベート プロパティの基となるグラフィックス オブジェクトを作成します。

functionsetup(obj)％创建网格布局来管理构建块obj.Grid = uigridlayout(obj,[1 2],'ColumnWidth',{'1x',22},...'RowHeight',{'fit'},'ColumnSpacing',2,'Padding',2);% Create edit field for entering color valueobj.EditField = uieditfield(obj.Grid,'Editable',false,...'HorizontalAlignment','center');% Create button to confirm color changeobj.Button = uibutton(obj.Grid,'文本',char(9998),...'ButtonPushedFcn',@(o,e) obj.getColorFromUser());end

update メソッド

ユーザー クラスにupdateメソッドを定義します。このメソッドは、UI コンポーネント オブジェクトが値の変化に応じてその外観を変える必要がある場合に実行されます。

updateメソッドを使用して、パブリック プロパティの新しい値を基に、UI コンポーネント内の基となるグラフィックス オブジェクトを再構成します。通常、このメソッドではどのパブリック プロパティが変更されたかを判定しません。パブリック プロパティに依存する、基となるグラフィックス オブジェクトのすべての特性が再構成されます。

たとえば、次のプロパティをもつ UI コンポーネントについて考えます。

updateメソッドは、Valueに保存されている色を使ってEditFieldオブジェクトとButtonオブジェクトの背景颜色を更新します。updateメソッドはまた、色の数値表現によってもEditFieldオブジェクトを更新します。この方法では、Valueがどのように変更されても、その変更はあらゆる場所で等しく可視化されます。

functionupdate(obj)% Update edit field and button colorsset([obj.EditField obj.Button],'BackgroundColor',obj.Value,...'FontColor',obj.getContrastingColor(obj.Value));% Update edit field display textobj.EditField.Value = num2str(obj.Value,'%0.2g ');end

プロパティ値を変更してから、それら変更の結果が表示されるまでには遅延が生ずる場合があります。updateメソッドは、setupメソッドの実行後に初めて実行され、その後は、drawnowが実行されるたびに実行されます。関数drawnowは、ユーザーの MATLAB セッションにおけるグラフィックス環境の状態に基づき、定期的に自動実行されます。この定期的な実行は、遅延につながる可能性があります。

例: カラー セレクターの UI コンポーネント

この例では、このページの他の節で説明されているコードを使用して、色を選択するための UI コンポーネントを作成する方法を説明します。ColorSelectorComponent.mという名前のクラス定義ファイルを、MATLAB パス上にあるフォルダー内に作成します。以下の手順に従ってクラスを定義します。

classdefColorSelector < matlab.ui.componentcontainer.ComponentContainer

properties Value{validateattributes(Value,...{'double'},{'<=',1,'>=',0,'size',[1 3]})} = [1 0 0];end

events (HasCallbackProperty, NotifyAccess = protected) ValueChanged% ValueChangedFcn will be the generated callback propertyend

properties (Access = private, Transient, NonCopyable) Gridmatlab.ui.container.GridLayoutButtonmatlab.ui.control.ButtonEditFieldmatlab.ui.control.EditFieldend

methods (Access = protected)functionsetup(obj)% Grid layout to manage building blocksobj.Grid = uigridlayout(obj,[1,2],'ColumnWidth',{'1x',22},...'RowHeight',{'fit'},'ColumnSpacing',2,'Padding',2);% Edit field for value display and button to launch uisetcolorobj.EditField = uieditfield(obj.Grid,'Editable',false,...'HorizontalAlignment','center'); obj.Button = uibutton(obj.Grid,'文本',char(9998),...'ButtonPushedFcn',@(o,e) obj.getColorFromUser());end

functionupdate(obj)% Update edit field and button colorsset([obj.EditField obj.Button],'BackgroundColor',obj.Value,...'FontColor',obj.getContrastingColor(obj.Value));% Update the display textobj.EditField.Value = num2str(obj.Value,'%0.2g ');endend

methods (Access = private)functionGetColorFromuser(obj) c = uisetcolor(obj.Value);if(isscalar(c) && (c == 0))return;end% Update the Value propertyobj.Value = c;% Execute user callbacks and listenersnotify(obj,'ValueChanged');endfunctioncontrastColor = getContrastingColor(~,color)% Calculate opposite colorc = color * 255; contrastColor = [1 1 1];if(c(1)*.299 + c(2)*.587 + c(3)*.114) > 186 contrastColor = [0 0 0];endendendend

次に、いくつかのパブリック プロパティを指定して暗黙的なコンストラクター メソッドを呼び出すことで、UI コンポーネントのインスタンスを作成します。コールバックを、カラー値が変更されるとColor changedという語が表示されるように指定します。

h = ColorSelector('Value', [1 1 0]); h.ValueChangedFcn = @(o,e) disp('Color changed');

ボタンをクリックし、カラー ピッカーを使用して色を選択します。コンポーネントの外観が変わり、MATLAB はColor changedの语コマンドウィンドウ表示します。