TPDFlibFormSession

フォーム、インタラクション、データ型

説明

GUIフレームワークに依存せずに、AcroFormのヒットテスト、キーボードナビゲーション、フォーカス、編集値、テキスト選択状態を維持します

アタッチされたTPDFlibインスタンスは呼び出し元所有のまま残り、セッションより長く生存する必要があります

フォーカス遷移はWidgetの/Foと/Blアクションを、型付きホストコールバックとしてOnAction経由で公開します

ページ矩形は、ページ回転後の視覚CropBoxをライブラリの現在の測定単位で使います。原点は視覚左上です

方向付き選択は独立したアンカーとキャレットの位置を保持し、UTF-16コードユニット、Unicodeコードポイント、拡張書素クラスタで設定・照会できます

双方向編集は論理的なフィールド値順を保ちつつ、埋め込みレベルから行ごとの視覚キャレットスロットを解決するため、物理的な左右移動は左から右と右から左が混在するテキストに従います

選択の置換は/Kをホストへディスパッチし、選択テキストと置換テキストをOnTextEditで公開し、完全な書素境界で/MaxLenを強制し、1回の受け入れられた編集の後に選択を折りたたみます

各アクティブ編集は、フォームアクションやホストの編集コールバックを再ディスパッチせずに一時値、表示値、方向付き選択を復元する、上限付きの差分履歴を保持します

DispatchInputEventは、プラットフォーム中立なポインター、ホイール、名前付きキー、合成テキストのレコードを、制約付きWidgetアクション、フォーカス遷移、書素セーフな編集、ボタンのアクティブ化、チョイスナビゲーションへ変換します

セッションは進入中と押下中のWidget識別を保持するため、/E、/X、/D、/UはポインターのキャプチャやキャンセルをまたいでもPDFトリガー順序に従います

コミットは/Vと/Fアクションをディスパッチし、ドキュメントを変更する前にサポートされる有界JavaScriptサブセットを実行し、検証・フォーマット・ホストコールバックがトランザクションを拒否した場合はアクティブな編集を保持します

検証済みの生の値はフィールドへ保存され、DisplayValueと生成されたWidget外観はフォーマットの結果を保持します

宣言

type
  TPDFlibFormFieldIndices = array of Integer;

  TPDFlibFormSelectionUnit = (fsuUTF16CodeUnit,
    fsuUnicodeCodePoint, fsuGraphemeCluster);

  TPDFlibFormTextDirection = (ftdAuto,
    ftdLeftToRight, ftdRightToLeft);
  TPDFlibFormCaretIndices = array of Integer;

  TPDFlibFormSelection = record
    IndexUnit: TPDFlibFormSelectionUnit;
    AnchorIndex: Integer;
    CaretIndex: Integer;
    StartIndex: Integer;
    SelectionLength: Integer;
    IsReversed: Boolean;
  end;

  TPDFlibFormSessionActionEvent = procedure(Sender: TObject;
    FieldIndex: Integer; const TriggerEvent: AnsiString;
    const ActionInfo: TPDFlibActionInfo; var Allow: Boolean) of object;
  TPDFlibFormSessionFocusEvent = procedure(Sender: TObject;
    OldFieldIndex, NewFieldIndex: Integer) of object;
  TPDFlibFormSessionValueEvent = procedure(Sender: TObject;
    FieldIndex: Integer; const OldValue, NewValue: WideString) of object;
  TPDFlibFormEditKind = (fekReplaceSelection,
    fekCutSelection, fekPasteText);
  TPDFlibFormSessionTextEditEvent = procedure(Sender: TObject;
    FieldIndex: Integer; EditKind: TPDFlibFormEditKind;
    SelectionStart, SelectionLength: Integer;
    const SelectedText: WideString; var ReplacementText: WideString;
    var Allow: Boolean) of object;

  TPDFlibFormInputEventKind = (fiekPointerMove,
    fiekPointerDown, fiekPointerUp, fiekPointerDoubleClick,
    fiekPointerLeave, fiekPointerCancel, fiekWheel,
    fiekKeyDown, fiekKeyUp, fiekTextInput);
  TPDFlibFormInputModifiers = set of TPDFlibFormInputModifier;

  TPDFlibFormInputEvent = record
    Kind: TPDFlibFormInputEventKind;
    Modifiers: TPDFlibFormInputModifiers;
    Button: TPDFlibFormInputButton;
    Key: TPDFlibFormInputKey;
    Page: Integer;
    X, Y: Double;
    WheelDeltaX, WheelDeltaY: Double;
    Text: WideString;
  end;

  TPDFlibFormSession = class
  public
    constructor Create(ALibrary: TPDFlib);
    procedure AttachLibrary(ALibrary: TPDFlib);
    procedure Reset;
    function FocusField(FieldIndex: Integer;
      CommitCurrent: Boolean = True): Integer;
    function GetFieldPageRect(FieldIndex: Integer; out Page: Integer;
      out Left, Top, Width, Height: Double): Integer;
    function HitTest(Page: Integer; X, Y: Double): Integer;
    function GetTabSequence(out FieldIndices: TPDFlibFormFieldIndices): Integer;
    function FocusAt(Page: Integer; X, Y: Double;
      CommitCurrent: Boolean = True): Integer;
    function FocusNext(Backwards: Boolean = False;
      WrapAround: Boolean = True; CommitCurrent: Boolean = True): Integer;
    function Blur(CommitCurrent: Boolean = True): Integer;
    function BeginEdit(FieldIndex: Integer): Integer;
    function SetEditValue(const NewValue: WideString): Integer;
    function SetSelection(StartIndex, SelectionLength: Integer): Integer;
    function SetSelectionRange(AnchorIndex, CaretIndex: Integer;
      IndexUnit: TPDFlibFormSelectionUnit): Integer;
    function GetSelectionRange(IndexUnit: TPDFlibFormSelectionUnit;
      out Selection: TPDFlibFormSelection): Integer;
    function SetTextDirection(
      Direction: TPDFlibFormTextDirection): Integer;
    function GetVisualCaretOrder(IndexUnit: TPDFlibFormSelectionUnit;
      out CaretIndices: TPDFlibFormCaretIndices): Integer;
    function MoveVisualCaret(ToRight: Boolean;
      ExtendSelection: Boolean = False): Integer;
    function GetSelectedText: WideString;
    function ReplaceSelection(const ReplacementText: WideString): Integer;
    function CutSelection(out CutText: WideString): Integer;
    function PasteText(const Text: WideString): Integer;
    function CanUndoEdit: Boolean;
    function CanRedoEdit: Boolean;
    function UndoEdit: Integer;
    function RedoEdit: Integer;
    procedure ClearEditHistory;
    function DispatchInputEvent(
      const InputEvent: TPDFlibFormInputEvent;
      out InputResult: TPDFlibFormInputResult): Integer;
    function CommitEdit: Integer;
    procedure CancelEdit;
    property TextDirection: TPDFlibFormTextDirection;
    property ResolvedTextDirection: TPDFlibFormTextDirection;
    property VisualCaretPosition: Integer;
    property MaxUndoSteps: Integer;
    property UndoEditCount: Integer;
    property RedoEditCount: Integer;
    property HoveredFieldIndex: Integer;
    property PressedFieldIndex: Integer;
  end;

メソッド

状態プロパティ

イベント

戻り値

状態を変更する関数は、成功時に 1 を返し、要求が不正、再入、拒否された、または確定できない場合は 0 を返します。HitTest はフィールドまたは一時 Widget インデックスを返し、GetTabSequence はエントリ数を返します

選択の単位

fsuUTF16CodeUnitは従来のゼロ始まりWideStringインデックス契約を保持します。明示的に要求された場合のサロゲートペア内部の位置も含みます

fsuUnicodeCodePointは有効なサロゲートペアを1つの補助コードポイントとして数え、ペアでないサロゲートは1つの独立したコードポイントとして扱います

fsuGraphemeClusterは完全な拡張書素クラスタを数えるため、結合シーケンスと結合絵文字は分割されません

Unicode境界テーブルは現在の編集値に対してキャッシュされ、その値が変わると無効化されます

双方向ナビゲーション

ftdAutoは最初の強い文字を使い、編集に強い方向文字がなければ左から右を既定とします

視覚ラン順は行ごとに独立して解決され、論理的なUTF-16フィールド値、PDF文字列、テキスト配置は変更しません

混合方向境界では1つの論理インデックスが2つの異なる視覚スロットを占め得るため、VisualCaretPositionはその境界をまたぐ繰り返し移動を曖昧さなく区別します

例

var
  Session: TPDFlibFormSession;
  Selection: TPDFlibFormSelection;
begin
  Session := TPDFlibFormSession.Create(PDF);
  try
    if Session.FocusAt(PageNumber, MouseX, MouseY) = 1 then
      Session.FocusNext(False, True);
    if Session.BeginEdit(Session.FocusedFieldIndex) = 1 then
    begin
      Session.SetEditValue('A' + WideChar($D83D) + WideChar($DE00) + 'B');
      Session.SetSelectionRange(1, 2, fsuUnicodeCodePoint);
      Session.GetSelectionRange(fsuUTF16CodeUnit, Selection);
      Session.SetTextDirection(ftdAuto);
      Session.MoveVisualCaret(True, True);
      Session.PasteText('replacement');
      if Session.CanUndoEdit then
        Session.UndoEdit;
      if Session.CanRedoEdit then
        Session.RedoEdit;
      Session.CommitEdit;
    end;
  finally
    Session.Free;
  end;
end;

関連項目

SetTextDirection, GetVisualCaretOrder, MoveVisualCaret, TPDFlibFormTextDirection, DispatchInputEvent, TPDFlibFormInputEvent, TPDFlibFormInputResult, UndoEdit, RedoEdit, ClearEditHistory, ReplaceSelection, CutSelection, PasteText, TPDFlibFormEditKind, SetSelectionRange, GetSelectionRange, ExecuteFormFieldScript, TPDFlibActionInfo