Drag
3.2.7 Drag
説明
DragはWaitfor matchとMouseコマンドの組み合わせです。イメージ、ソリッドカラー、またはテキストによって ソースコンポーネントをデスクトップから検索し、相対座標で指定された場所、または別のイメージ検索で指定されたターゲットコンポーネントにドラッグします。オブジェクトが見つからない場合はスクリプトを終了します。
コマンドはClickとよく似ています。
SYNOPSIS
Drag <comparison_method>[shift=x:<relativeX>,y:<relativeY>] [template2=<target_component_template>] [number2=<target_component_number>] [timeout=<time>] [cmparea=<[x:<x>][,y:<y>][,w:<width>][,h:<height>]>] [number=<component_number>] [btn=<button>] [modifiers=<modifiers>] [count=<number>] [continue=<true|false>] [step=<step_name>] [wait=<time>] [<method specific options>]
赤色は必須パラメーターを示します。
comparison_method
-サポートされているメソッドは以下の通りです:
'image' - コンポーネントを画像もしくはImage Collectionsメソッドを使ってsearch2メソッドを使用します、
'object' - メソッドを使って色でコンポーネントを検索します。objectメソッドを使用します、
'ocr' - OCR(メソッド)を使って画面上のテキストを認識し、指定された文字列またはパターンを検索します。tocrメソッド)を使用して画面上のテキストを認識し、指定された文字列またはパターンを検索します。
コモンオプション
timeout=<時間>
-コンポーネントが画面に表示されるまでの最大待機時間を指定するタイムアウト。値はミリ秒数か有効な値でなければならない。Time Values.デフォルト値は30秒です。
cmparea=[x:<x>][,y:<y>][,w:<width>][,h:<height>]
-比較を制限するデスクトップの矩形領域。このパラメータを省略すると、リモートデスクトップ全体が処理されます。領域の座標は、'x:<x>,y:<y>,w:<width>,h:<height>'のフォーマットで、各座標はピクセル単位(例えば、"x:225")またはパーセント単位("x:23%")で指定できます。x,y,width,heightのいずれかが省略された場合、Robotはフルスクリーンの値を使って足りないパラメータを決定します(x:0, y:0, w:<screen_width>, h:<screen_height>)。
number=<コンポーネント番号>
ドラッグを適用するスクリーン上のソースコンポーネントの番号。画面上に配置されたコンポーネント(オブジェクト)は、上から下、左から右の読み順にソートされます。デフォルト値は1(最初に配置されたコンポーネントをドラッグ)です。画面上で見つかったコンポーネントの数が指定された数より少ない場合、コマンドはスクリプトを終了します。
move=[x:<x>][,y:<y>]
-ターゲットオブジェクトの中心からの相対的なマウス押下開始位置を指定します(4.2以降)。これにより、オブジェクトそのものではなく、近くの位置からドラッグを開始することができます。比較対象が画像の場合、このパラメータは画像を上書きしclick pointを上書きし、画像の中心を基点として使用します。例えば、"Drag image template=button.png move=x:-40 shift=x:100,y:100 "のコマンドは、ボタンの中心から左へ40ピクセルの位置からドラッグを開始します。
btn=<ボタン>
-ドラッグするマウスボタン。指定可能な値は "left"、"middle" および "right" です。
modifiers=<修飾子>
-ドラッグ中に保持する修飾子(オプション)。値は Shift、Alt、Ctrl の任意の組み合わせで、プラス「+」記号で区切って指定します (例: "Ctrl+Alt+Shift")。
shift=x:<相対X>,y:<相対Y>
-コンポーネントを現在の位置からドラッグする場所を指定する相対座標。ターゲット(ドロップ)位置はtemplate2で指定することもできます。
template2=<target_component_template>。
-ドロップコンポーネント。指定すると、コマンドはsearch2を使用して指定されたコンポーネントの画像検索を行い、その場所にオブジェクトをドラッグします。画面上に複数のドロップコンポーネントがある場合、number2 パラメータを使用してドロップコンポーネント番号を指定できます。template2 が指定されている場合、shift パラメータは存在してはなりません。
number2=<target_component_number>
-ターゲットコンポーネントの通常の番号。画面上に配置されたコンポーネント(オブジェクト)は、上から下、左から右の読み順にソートされます。デフォルト値は1(最初に配置されたコンポーネントにドロップ)。画面上で見つかったコンポーネントの数が指定された数より少ない場合、コマンドはスクリプトを終了する。template2パラメータと共にのみ使用します。
continue=<番号>
-trueを指定すると、オブジェクトが見つからなかった場合にスクリプトを終了しない(4.2以降)。デフォルト値はfalse(失敗時に終了)です。リリース4.4.2以降、コマンドは_DRAG_CONNECT変数の値も監視し、デフォルト値として使用します。たとえば、スクリプト内のすべての Drag コマンドをデフォルトで終了しないようにするには、最初にこの変数を true に設定します ("Var _DRAG_CONTINUE=true")。
step=<ステップ名>
-コマンドとのシンプルな統合。Step コマンドとのシンプルな統合(4.2以降)。指定された場合、指定された名前のテストステップを作成し、結果は合格(オブジェクトが見つかり、ドラッグされた)または不合格(オブジェクトが見つからなかった)です。
wait=<時間>
-クリック後の待ち時間。次のコマンドが 'Wait <time_in_ms>' である場合と同じ効果があります。値はミリ秒数か有効な値でなければなりません。Time Values.デフォルト値は0(待機しない)である。スクリプトは、"Var _DRAG_WAIT=1s "のように、_DRAG_WAIT変数に希望の遅延を代入することでデフォルト値を設定できます。
Drag image template=<image_collection>[passrate=<pass_rate_in_%>] [<search2_specific_params>] [<common_options>].
赤色は必須パラメータ
特定のオプション - image
template=<image_collection>
-テンプレートimage collection- リモートデスクトップのイメージと比較する 1 つ以上のイメージファイル名、またはイメージをセミコロン (';') で区切ったフォルダ。Linux/Unix では、ファイル名にセミコロンが含まれていないと、リストが正しく解析されません。ファイル名には、相対パス(img.png など)または絶対パス(/root/report/img.png など)を指定できます。相対パスを使った場合、画像は_TEMPLATE_DIR variable.サポートされる画像フォーマットは、Javaのバージョンに依存します。Java 1.6では、少なくともPNG、JPG、GIF、BMPをサポートしています。
テンプレート画像は、指定されたリスト順序でリモートデスクトップ画像と比較されます。テンプレートの比較で肯定的な結果(指定されたイベントに応じて、一致または不一致のいずれか)が得られた場合、条件は満たされたとみなされ、コマンドは終了コード0で終了し、リスト内の残りのテンプレートをスキップします。定義済み変数 _COMPARETO_TEMPLATE_INDEX は、マッチするテンプレート画像のインデックスを決定するために使われます。対応する変数の一覧は画像比較固有の変数を参照してください。
passrate=<pass_rate_in%>
-画像比較の通過率。0から100までの数値を指定し、その後にパーセンテージを指定することもできます(例: "passrate=95 "または "passrate=95%")。このパラメータが省略された場合、デフォルトのsearch2の通過率50%が使用されます。
search2_specific_params
比較メソッドでサポートされる任意のパラメータ。search2比較メソッドでサポートされる任意のパラメータ (オプション)。
Drag object [<object specific options>] [<common_options>].
特定のオプション - OBJECT
object_specific_params
オブジェクト比較メソッドでサポートされる任意のパラメータ(オプション)。通常、少なくともオブジェクトの色を指定する必要があります。
Drag ocr [<tocr_specific_options>] [<common_options>].
特定のオプション - OCR
tocr_specific_options
-比較メソッドでサポートされるtocr比較メソッドでサポートされるパラメータ。textまたはpatternオプションを通して、クリックを適用するターゲットテキストを指定する必要があります。
戻り値
このコマンドは成功すると常に0を返し、失敗すると指定された比較メソッドからのエラーコードを返してスクリプトを終了します。
例
Drag image template="lever.png" shift="x:100"
画面上の最初のレバーのコンポーネントを見つけ、右に100ピクセルドラッグします。
Drag image template="column.png" number="2" template2="column.png" number2="3"
2つの表の列を入れ替える例。このコマンドは、表の2番目の列のヘッダーを見つけ、それを3番目の列の上にドラッグします。列が見つからなかったり、画面上の列の数が3より少なかったりすると、コマンドはスクリプトに失敗します。
Drag object tolerance="10" color="0;255;0" max="w:20,h:20" shift="x:50,y:-100"
20x20ピクセル以下の緑色のオブジェクトを見つけ、右方向に50ピクセル、上方向に100ピクセルドラッグする。トレランスは、このメソッドがより多くの緑の色合いを見つけることを保証します。
Drag ocr text="Flower" shift="y:220"
OCRを使って画面上のテキストを読み取り、"Flower "という単語を220ピクセル下にドラッグします。