AbstractTimeLineSchedulePage - グローバル

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む12読むのに数分

    • AbstractTimeLineSchedulePage API は、タイムラインに表示されるデータの操作を容易にするヘルパー クラスです。

    タイムライン内に表示されるデータの処理は、指定されたスクリプト インクルードの対応する関数を実行することによって開始されます。その他のスクリプト インクルードのように、言語構文は JavaScript であり、このタイプのリソースのデフォルトのセキュリティ制約に従います。ただし、さまざまな種類の表示オプションが複雑なため、ヘルパー クラスが作成されました。タイムラインを表示するには、 AbstractTimelineSchedulePage クラスを拡張し、それに対応するスケジュール ページとペアリングします。最低限、クラスの拡張により、getItems() メソッドが上書きされる必要があります。このメソッドは、クライアントに表示されるアイテムを返すための主要なイベント ハンドラーであるためです。

    クライアントは、AbstractTimelineSchedulePage が 2 つのフェーズで戻すデータを処理します。最初のフェーズでは、タイムラインの実際の更新が行われます。直後に (設定されている場合)、2 番目のフェーズで、成功メッセージ ボックス、エラー メッセージ ボックス、またはダイアログ メッセージ プロンプトが表示されます。フェーズ 1 で、データを操作するために使用できるオプションは次のとおりです。

    • アイテムを更新しない - これはデフォルトの動作です。フェーズ 1 で残りのステップを実行しないでください。
    • 特定のアイテムで更新 - これは add() を使用して行われます。
    • getItems() 関数を使用したタイムラインのレンダリング - これは setDoReRenderTimeline(true) を使用して行われます。
    注:
    両方の TimelineItem が返され、setDoReRenderTimeline が trueに設定されている場合、システムは setDoReRenderTimeline プロパティを無視し、add() 機能を介して追加された TimelineItem のみを明示的に表示します。

    フェーズ 2 で利用できるオプションは次のとおりです。

    • メッセージ ボックスを表示しない - これがデフォルトの動作です。
    • 成功ダイアログ ボックスを表示する - これは setStatusSuccess() を使用して行われます。
    • エラー ダイアログ ボックスを表示する - これは setStatusError() を使用して行われます。
    • ダイアログ確認ボックスを表示する - これは setStatusPrompt() を使用して行われます。
    注:

    AbstractTimelineSchedulePage を拡張するスクリプト インクルード クラスは、プリフィックスが sysparm_timeline_ で始まる元の URL からすべての URI パラメーターを自動的に受け取ります。これらの値にアクセスするには、拡張クラスの中で this.getParameter("sysparm_timeline_VARIABLE"); を使用します。

    これは、リストからのコンテキストメニューなど、動的要素からスケジュール ページを表示する必要がある場合に便利です。URL を介して動的データを渡すことで、スケジュール ページは Ajax 呼び出しの中でこれらのパラメーターを自動的にインクルードするため AbstractTimelineSchedulePage スクリプト インクルード内でアクセス可能になります。

    AbstractTimelineSchedulePage - add(Object ObjTimeline)

    クライアントに返され、タイムラインに適切に表示される TimelineItem オブジェクトを追加します。

    表 : 1. パラメーター
    名前 タイプ 説明
    ObjTimeline オブジェクト タイムラインに追加する TimelineItem オブジェクト
    表 : 2. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - addSeparator()

    タイムライン アイテムのリストに水平フレーム セパレーターを追加します。 add() を介して今後追加されるすべてのアイテムは、後続のタイムライン フレームに追加されます。

    add() を介して今後追加されるすべてのアイテムは、後続のタイムライン フレームに追加されます。

    表 : 3. パラメーター
    名前 タイプ 説明
    none
    表 : 4. 返される内容
    タイプ 説明
    なし 
    // Inside of a script include that extends AbstractTimelineSchedulePage
      this.addSeparator();

    AbstractTimelineSchedulePage - elementMoveX(文字列 spanSysId, 文字列 newStartDateTimeMs)

    タイムライン スパンが水平方向に移動する場合のイベント ハンドラー

    表 : 5. パラメーター
    名前 タイプ 説明
    spanSysId 文字列 調整中の現在のスパンのSys ID
    newStartDateTimeMs 文字列 スパンの新しい開始時刻 (ミリ秒)。数値比較を実行する前に、必ず parseInt を使用して文字列を解析してください。
    表 : 6. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - elementMoveY(文字列 spanSysId, 文字列 itemSysId, 文字列 newItemSysId)

    タイムライン スパンが垂直方向に移動する場合のイベント ハンドラー

    表 : 7. パラメーター
    名前 タイプ 説明
    spanSysId 文字列 調整中の現在のスパンのSys ID
    itemSysId 文字列 現在のスパンに関連付けられたタイムライン アイテムのSys ID
    newItemSysId 文字列 現在のスパンがドラッグされたタイムライン アイテム (行) のSys ID
    表 : 8. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - elementMoveXY(文字列 spanSysId, 文字列 itemSysId, 文字列 itemSysId, 文字列 newItemSysId, 文字列 newStartDateTimeMs)

    タイムライン スパンが水平方向と垂直方向の両方に移動する場合のイベント ハンドラー

    表 : 9. パラメーター
    名前 タイプ 説明
    spanSysId 文字列 調整中の現在のスパンのSys ID
    itemSysId 文字列 現在のスパンに関連付けられたタイムライン アイテムのSys ID
    newItemSysId 文字列 現在のスパンがドラッグされたタイムライン アイテム (行) のSys ID
    newStartDateTimeMs 文字列 スパンの新しい開始時刻 (ミリ秒)。数値比較を実行する前に、必ず parseInt() を使用して文字列を解析してください。
    表 : 10. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - elementSuccessor(文字列 spanSysId, 文字列 newSuccSpanId)

    2 つのスパンの間にタイムライン関係が作成された場合のイベント ハンドラー

    表 : 11. パラメーター
    名前 タイプ 説明
    spanSysId 文字列 新しく作成された関係の先行となる現在のスパンのSys ID
    newSuccSpanId 文字列 作成された関係からの後続スパンのSys ID
    表 : 12. 返される内容
    タイプ 説明
    なし ReturnValue

    AbstractTimelineSchedulePage - elementMoveX(String spanSysId, String newStartDateTimeMs)

    タイムライン スパンの開始日が変更されたときのイベント ハンドラー

    表 : 13. パラメーター
    名前 タイプ 説明
    spanSysId 文字列 調整中の現在のスパンのSys ID
    newStartDateTimeMs 文字列 スパンの新しい開始時刻 (ミリ秒)。数値比較を実行する前に、必ず parseInt() を使用して文字列を解析してください。
    表 : 14. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - elementMoveX(String spanSysId, String newStartDateTimeMs)

    タイムライン スパンの終了日が変更されたときのイベント ハンドラー

    表 : 15. パラメーター
    名前 タイプ 説明
    spanSysId 文字列 調整中の現在のスパンのSys ID
    newEndDateTimeMs 文字列 スパンの新しい終了時刻 (ミリ秒単位)。数値比較を実行する前に、必ず parseInt() を使用して文字列を解析してください。
    表 : 16. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - getItems()

    タイムラインに表示するスケジュール項目を返すイベント ハンドラー

    表 : 17. パラメーター
    名前 タイプ 説明
    none
    表 : 18. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - inputBox(文字列 strInputText)

    文字列が左ペインの入力ボックスに入力されたときのイベント ハンドラー

    表 : 19. パラメーター
    名前 タイプ 説明
    strInputText 文字列 左ペインの入力ボックスに入力されたテキスト
    表 : 20. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - itemMove(文字列 itemSysId, 文字列 newItemSysId)

    タイムラインの行アイテムが移動され、別の行アイテムにドラッグされたときのイベント ハンドラー

    表 : 21. パラメーター
    名前 タイプ 説明
    itemSysId 文字列 現在のスパンに関連付けられたタイムライン アイテムのSys ID
    newItemSysId 文字列 現在のスパンがドラッグされたタイムライン アイテム (行) のSys ID
    表 : 22. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - setDoReRenderTimeline(ブール b)

    getItems() 関数を使用してすべてのタイムライン アイテムを再レンダリングするかどうかを指定します。

    表 : 23. パラメーター
    名前 タイプ 説明
    b ブーリアン true の場合、サーバーの getItems() ハンドラーへの新しいイベント コールを作成してタイムラインを再レンダリングします。
    表 : 24. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - setStatusSuccess(String strTitle)

    タイムラインのタイトルとして表示するテキストを指定します。

    ページ タイトルは、任意のインタラクティブ イベントから設定 (および更新) できます。ただし、getItems() イベント中に設定することをお勧めします

    表 : 25. パラメーター
    名前 タイプ 説明
    strTitle 文字列 タイムライン タイトルに表示されるテキスト
    表 : 26. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - setStatusSuccess(String strTitle, String strMessage)

    現在のイベント要求を、指定されたタイトルと GlideTimeline イベント処理のフェーズ 2 に表示するメッセージを指定したエラー ステータスに設定します。

    表 : 27. パラメーター
    名前 タイプ 説明
    strTitle 文字列 ダイアログ ボックスのタイトルに表示されるテキスト
    strMessage 文字列 ダイアログ ボックス内に表示されるテキスト。テキストに HTML 書式を含めることができます。
    表 : 28. 返される内容
    タイプ 説明
    なし

    AbstractTimelineSchedulePage - setStatusPrompt(文字列 strTitle, 文字列 strOkFunction, 文字列 strCancelFunction, 文字列 strCloseFunction)

    現在のイベント要求を、指定されたタイトルと GlideTimeline イベント処理のフェーズ 2 の間に確認ダイアログ ボックスに表示するメッセージを指定したプロンプト エラー ステータスに設定します。 確認ボックスには、 および ボタンが表示され、各ボタンによりパラメーター引数を指定した関数を呼び出す新しいイベントが生成されます。、、および のカスタム定義関数は、現在のイベントと同じパラメーター引数を受け取ります。

    確認ボックスには、 および ボタンが表示され、各ボタンによりパラメーター引数を指定した関数を呼び出す新しいイベントが生成されます。
    注:
    、、および のカスタム定義関数は、現在のイベントと同じパラメーター引数を受け取ります。
    表 : 29. パラメーター
    名前 タイプ 説明
    strTitle 文字列 ダイアログ ボックスに表示するテキスト。テキストに HTML 書式を含めることができます。
    strOkFunction 文字列 ユーザーが ボタンをクリックした場合に、現在のスクリプト インクルード クラスで呼び出す関数
    strCancelFunction 文字列 ユーザーが ボタンをクリックした場合に、現在のスクリプト インクルード クラスで呼び出す関数
    strCloseFunction 文字列 ユーザーが ボタンをクリックした場合に、現在のスクリプト インクルード クラスで呼び出す関数
    表 : 30. 返される内容
    タイプ 説明
    なし 
    var MyTimelineScriptIncludeClass = Class.create();
      MyTimelineScriptIncludeClass.prototype = Object.extendsObject(AbstractTimelineSchedulePage, {
      
      getItems: function() {
      //...
      },
      
      elementTimeAdjustEnd: function(spanSysId, newEndDateTimeMs) {
      // Display a status prompt dialog box
      this.setStatusPrompt('Confirm Action', 'Are you sure you want to do that?',
      'this._myOkHandlerFunction',  
      'this._myCancelHandlerFunction',
      'this._myCloseHandlerFunction');
      },
      
      _myOkHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... },
      
      _myCancelHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... },
      
      _myCloseHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... }
      };

    AbstractTimelineSchedulePage - setStatusSuccess(文字列 strTitle, 文字列 strMessage)

    現在のイベント要求を、指定されたタイトルと GlideTimelineイベント処理のフェーズ 2 に表示するメッセージを指定した成功ステータスに設定します。

    表 : 31. パラメーター
    名前 タイプ 説明
    strTitle 文字列 ダイアログ ボックスのタイトルに表示されるテキスト
    strMessage 文字列 ダイアログ ボックス内に表示されるテキスト。テキストに HTML 書式を含めることができます。
    表 : 32. 返される内容
    タイプ 説明
    なし