ig.scheduler.ScheduleDataSource
備考
ScheduleDataSource は、Scheduler を Appointment および ScheduleResource オブジェクトが作成、更新、削除できるデータ ソースにバインドする機能を提供します。
指定した日付範囲にある Appointment オブジェクトのサブセットを取得するには ScheduleDataSource.getAppointmentsInRange メソッドを使用します。
既存の Appointment オブジェクトを更新するには、編集セッションを開始するために ScheduleDataSource.beginEdit メソッドを呼び出し、オブジェクトの変更を保存するために ScheduleDataSource.endEdit メソッドを呼び出します。
同様に、新しい Appointment を作成するために ScheduleDataSource.createAppointment メソッドを呼び出して、変更を保存する EndEdit を呼び出します。
既存の Appointment を削除するために ScheduleDataSource.deleteAppointment メソッドを使用します。
ScheduleDataSource クラスがデータ ソースとの非同期操作をサポートするので、作成/読み込み/更新/削除に関連するメソッドが、派生クラスの実装に基づいて同期または非同期にデータを取得できるオブジェクトを返します。
ローカルに保存されるデータ ソースへの同期アクセスのため、ScheduleListDataSource クラスは ScheduleDataSource の実装を提供します。 詳細については、そのクラスのヘルプを参照してください。
依存関係
-
ig.scheduler.ScheduleDataSource
コンストラクター- new $.ig.scheduler.ScheduleDataSource( );
新しいインスタンスを作成します。
-
beginEdit
- .beginEdit( appointment:ig.scheduler.Appointment, errorCallback:function );
- 返却型:
- boolean
- 返却型の説明:
- 操作が成功した場合は True。
指定したアクティビティで編集モードセッションを開始します。
- appointment
- タイプ:ig.scheduler.Appointment
- 編集される Appointment。
- errorCallback
- タイプ:function
-
bumpResourcesVersion
- .bumpResourcesVersion( );
リソース キャッシュをダーティとしてマークします。
-
cancelEdit
- .cancelEdit( appointment:ig.scheduler.Appointment );
- 返却型:
- ig.scheduler.AppointmentOperationResult
- 返却型の説明:
- 操作の結果を含む AppointmentOperationResult インスタンス。
ScheduleDataSource.beginEdit または ScheduleDataSource.createAppointment メソッドから開始された編集モード セッションで実行された Appointment への変更を元に戻します。
- appointment
- タイプ:ig.scheduler.Appointment
- 編集中の Appointment。
-
createAppointment
- .createAppointment( errorCallback:function );
- 返却型:
- ig.scheduler.Appointment
- 返却型の説明:
- 新しい Appointment への参照、または操作が失敗する場合に null。 操作の失敗の理由についての詳細情報を受けるには、デリゲートを errorCallback パラメーターに割り当てます。
派生クラスでオーバーライドされる場合、新しい Appointment を作成します。
- errorCallback
- タイプ:function
備考
CreateAppointment メソッドは、新しい初期化されていない Appointment インスタンスを返します。予定は ScheduleDataSource.endEdit メソッドが呼び出されるまでデータ ソースと関連付けられません。つまり、アタッチされた Scheduler のユーザー インターフェイスまたはアクティビティ クエリで表示されません。
注: 新しい予定の作成をコミットするために ScheduleDataSource.endEdit メソッドを呼び出す必要があります。
また、予定データの基本の項目ソースが新しいオブジェクトの作成をサポートする必要があります。全般的、オブジェクトがパラメーターなしのコンストラクターを公開する必要があります。派生クラスは新しいデータ オブジェクト インスタンスを生成する代わりの方法を提供できます。
-
createVariance
- .createVariance( appointment:ig.scheduler.Appointment );
繰り返しの変更済みのインスタンス (バリアンス) を作成します。
- appointment
- タイプ:ig.scheduler.Appointment
-
dataErrorCallback
- .dataErrorCallback( );
dataSource との操作でエラーが発生されるときに呼び出されるデリゲートを返します。
-
dataErrorCallback
- .dataErrorCallback( value:function );
dataSource との操作でエラーが発生されるときに呼び出されるデリゲートを返します。
- value
- タイプ:function
-
deleteAppointment
- .deleteAppointment( appointment:ig.scheduler.Appointment );
- 返却型:
- ig.scheduler.AppointmentOperationResult
- 返却型の説明:
- 操作の結果を含む AppointmentOperationResult インスタンス。
派生クラスでオーバーライドされる場合、指定した Appointment を削除します。
- appointment
- タイプ:ig.scheduler.Appointment
- 削除する予定。
備考
DeleteAppointment メソッドは既存の Appointment インスタンスを削除し、データ ソースとの関係を削除します。正常に削除された後、Appointment はアクティビティ クエリまたはユーザー インターフェイスに表示されません。
注: 予定データの基本の項目ソースが項目の削除をサポートする必要があります。
-
destroy
- .destroy( );
派生クラスで実装される場合、このオブジェクトが使用されるメモリを解放するためにクリーンアップ操作を実行します。
-
endEdit
- .endEdit( appointment:ig.scheduler.Appointment, force:boolean );
- 返却型:
- ig.scheduler.AppointmentOperationResult
- 返却型の説明:
- 操作の結果を含む AppointmentOperationResult インスタンス。
ScheduleDataSource.beginEdit または ScheduleDataSource.createAppointment メソッドから開始された編集モード セッションで実行された ActivityBase への変更をコミットします。
- appointment
- タイプ:ig.scheduler.Appointment
- 編集中の Appointment。
- force
- タイプ:boolean
- True の場合、編集モードを終了します。
-
getAppointmentBackgroundColor
- .getAppointmentBackgroundColor( resource:ig.scheduler.ScheduleResource );
- 返却型:
- string
- 返却型の説明:
- 16 進数書式での解決された色。
指定した ScheduleResource の解決された Appointment の背景色を返します。
- resource
- タイプ:ig.scheduler.ScheduleResource
- テストする ScheduleResource。
-
getAppointmentsInRange
- .getAppointmentsInRange( range:ig.scheduler.DateTimeRange );
- 返却型:
- ig.scheduler.AppointmentQueryResult
- 返却型の説明:
- クエリの結果を含む AppointmentQueryResult オブジェクト。
指定した日時範囲内のすべての予定を返します。
- range
- タイプ:ig.scheduler.DateTimeRange
- 予定が返される時間範囲。
備考
予定に関連する ScheduleResource に関係なしで、このメソッドが指定した範囲ですべての予定を返します。
返された予定リストを 1 つ以上の ScheduleResource によってフィルターするには、ScheduleDataSource.getAppointmentsInRange オーバーロードを使用します。
-
getAppointmentsInRange
- .getAppointmentsInRange( range:ig.scheduler.DateTimeRange, resources:ig.IEnumerable`1 );
- 返却型:
- ig.scheduler.AppointmentQueryResult
- 返却型の説明:
- クエリの結果を含む AppointmentQueryResult オブジェクト。
-
getAppointmentTextColor
- .getAppointmentTextColor( resource:ig.scheduler.ScheduleResource );
- 返却型:
- string
- 返却型の説明:
- 16 進数書式での解決された色。
指定した ScheduleResource の解決された Appointment のテキスト色を返します。
- resource
- タイプ:ig.scheduler.ScheduleResource
- テストする ScheduleResource。
-
getResources
- .getResources( );
このデータ ソースと関連付けられたリソースの列挙可能なリストを返します。
備考
ScheduleResource は Appointment データをグループ化する機能を提供します。アクティビティ クエリが、特定のリソースと関連付けられた予定のみが返されるために、リソースによってフィルターできます。
リソースがデータ ソースと関連つける方法は派生クラスの実装に基づきます。たとえば、ScheduleListDataSource はリソース データの項目ソースが定義する ScheduleListDataSource.resourceItemsSource プロパティを公開します。
-
hasAppointmentsInRange
- .hasAppointmentsInRange( range:ig.scheduler.DateTimeRange, resources:ig.IEnumerable`1, findFirst:boolean );
- 返却型:
- ig.scheduler.DateQueryResult
- 返却型の説明:
- クエリの結果を含む DateQueryResult オブジェクト。
指定した日時範囲で予定を含む日を表す日付の配列を返します。
- range
- タイプ:ig.scheduler.DateTimeRange
- テストする時間範囲。
- resources
- タイプ:ig.IEnumerable`1
- フィルターするリソースのオプションのリスト。 null 以外の値が指定される場合、指定したリソースのみの予定が返されます。
- findFirst
- タイプ:boolean
- True の場合、指定した範囲でアクティビティが見つかったときにクエリが終了します。アクティビティを持つ日付に興味なくて、指定した範囲で各日付にアクティビティがあるかどうかが必要な場合、これを使用します。
備考
HasAppointmentsInRange。
-
internalNotifyPropertyChanging
- .internalNotifyPropertyChanging( activity:ig.scheduler.ActivityBase, propertyName:string, oldValue:object, newValue:object );
- 返却型:
- boolean
- 返却型の説明:
- 通知を許可するには True、制御するには False。
内部プロパティ変更通知が処理される前に呼び出されます。これは通知を制御するチャンスをデータ ソースに提供します。
- activity
- タイプ:ig.scheduler.ActivityBase
- ActivityBase インスタンス
- propertyName
- タイプ:string
- 値が変更されているプロパティの名前。
- oldValue
- タイプ:object
- 変更前のプロパティ値。
- newValue
- タイプ:object
- 変更後のプロパティ値。
-
isAppointmentDataReady
- .isAppointmentDataReady( );
予定項目ソースが割り当てられて、初期化が実行中の場合に False を返します。
-
onAppointmentPropertyChanged
- .onAppointmentPropertyChanged( appointment:ig.scheduler.Appointment, property:ig.scheduler.AppointmentProperty, oldValue:object, newValue:object, [raiseEvent:boolean] );
AppointmentPropertyChanged イベントを発生させます。
- appointment
- タイプ:ig.scheduler.Appointment
- property
- タイプ:ig.scheduler.AppointmentProperty
- oldValue
- タイプ:object
- newValue
- タイプ:object
- raiseEvent
- タイプ:boolean
- オプション
-
onPropertyChanged
- .onPropertyChanged( propertyName:string );
PropertyChanged イベントを発生させます。
- propertyName
- タイプ:string
-
onResourcePropertyChanged
- .onResourcePropertyChanged( resource:ig.scheduler.ScheduleResource, property:ig.scheduler.ScheduleResourceProperty, dayOfWeek:ig.DayOfWeek );
ResourcePropertyChanged イベントを発生させます。
- resource
- タイプ:ig.scheduler.ScheduleResource
- property
- タイプ:ig.scheduler.ScheduleResourceProperty
- dayOfWeek
- タイプ:ig.DayOfWeek