アクション可能なコンポーネントのプロパティ

アクション可能なコンポーネントのプロパティ

アクション可能なコンポーネントは、タッチ、カーソル、キーボードのイベントから直接、入力を受け付けることができるコンポーネントです。このドキュメントでは、アクション可能なすべてのコンポーネントに共通のプロパティについて説明します。

アクション可能なコンポーネント

アクション可能なコンポーネントには、次のものがあります。

プロパティ

アクション可能なコンポーネントは、すべてのコンポーネントに共通のプロパティ、および各コンポーネントに固有のプロパティに加え、以下のプロパティをサポートしています。

プロパティ 型 デフォルト スタイル設定 動的 説明
onFocus コマンドの配列 [] ✕ ✕ コンポーネントがフォーカスされたときに実行されるコマンドです。
onBlur コマンドの配列 [] ✕ ✕ コンポーネントがフォーカスを失ったときに実行されるコマンドです。
handleKeyDown キーボードハンドラーの配列 [] ✕ ✕ コンポーネントがキーの押下を受け付けたときに検出するキーボードハンドラーです。
handleKeyUp キーボードハンドラーの配列 [] ✕ ✕ コンポーネントがキーの解放を受け付けたときに検出するキーボードハンドラーです。

onFocus

コンポーネントがフォーカスされたときに実行されるコマンドです。

event.source.focused値にコンポーネントのfocused状態が設定されます。event.source.valueにコンポーネントの標準的なsource値が設定されます。詳しくは、 イベントのsourceプロパティを参照してください。

Disabled状態がtrueに設定されているコンポーネントはフォーカスを取得できません。そのため、onFocusイベントハンドラーは実行されません。フォーカスがあるコンポーネントのDisabled状態がtrueに設定された場合、そのコンポーネントはフォーカスを失い、onBlurイベントハンドラーが実行されます。

生成されるイベントの形式は次のようになります。

"event": {
  "source": {
    "type": NAME,      // このイベントの発生元となったコンポーネントの型
    "handler": "Focus",
    "id": ID,          // コンポーネントのID
    "uid": UID,          // ランタイムで生成されたコンポーネントの固有ID
    "value": Any,      // コンポーネントの標準的なsource値
    "focused": Boolean // コンポーネントのfocused状態
  }
}

イベントのtypeプロパティには、コンポーネントの名前（「TouchWrapper」、「ScrollView」、「Sequence」など）が設定されます。

onBlur

コンポーネントがフォーカスを失ったときに実行されるコマンドです。

event.source.focused値にコンポーネントのfocused状態が設定されます。event.source.valueにコンポーネントの標準的なsource値が設定されます。詳しくは、 イベントのsourceプロパティを参照してください。

Disabled状態がtrueに設定されているコンポーネントはフォーカスを取得できません。フォーカスがあるコンポーネントのDisabled状態がtrueに設定された場合、そのコンポーネントはフォーカスを失い、onBlurイベントハンドラーが実行されます。

生成されるイベントの形式は次のようになります。

"event": {
  "source": {
    "type": NAME,      // このイベントの発生元となったコンポーネントの型
    "handler": "Blur",
    "id": ID,          // コンポーネントのID
    "uid": UID,          // ランタイムで生成されたコンポーネントの固有ID
    "value": Any,      // コンポーネントの標準的なsource値
    "focused": Boolean // コンポーネントのfocused状態
  }
}

イベントのtypeプロパティには、コンポーネントの名前（「TouchWrapper」、「ScrollView」、「Sequence」など）が設定されます。

handleKeyDown

キーボードのキーが押下されたとき、またはキーがオートリピートされたときに実行されるキーボードイベントハンドラーの配列です。keyDownイベントは、可能な場合には必ず生成されます。たとえば、Shiftキーが押下されるとkeyDownイベントが発生します。

生成されるイベントの形式は次のようになります。

"event": {
  "source": {
    "type": NAME,         // このイベントの発生元となったコンポーネントの型
    "handler": "KeyDown",
    "id": ID              // コンポーネントのID
    "uid": UID,           // ランタイムで生成されたコンポーネントの固有ID
    "value": Any          // コンポーネントの標準的なsource値
  },
  "keyboard": {
    "altKey":   Boolean
    "code":     String,
    "ctrlKey":  Boolean,
    "key":      String,
    "metaKey":  Boolean,
    "repeat":   Boolean,
    "shiftKey": Boolean
  }
}

keyboardプロパティの詳細については、keyboardイベントのドキュメントを参照してください。

handleKeyUp

キーボードのキーが解放されたときに実行されるキーボードイベントハンドラーの配列です。keyUpイベントは、文字入力時だけでなく、可能な場合には必ず生成されます。たとえば、キーボードのShiftキーが解放されるとkeyUpイベントが生成されます。

生成されるイベントの形式は次のようになります。

"event": {
  "source": {
    "type": NAME,         // このイベントの発生元となったコンポーネントの型
    "handler": "KeyUp",
    "id": ID              // コンポーネントのID
    "uid": UID,           // ランタイムで生成されたコンポーネントの固有ID
    "value": Any          // コンポーネントの標準的なsource値
  },
  "keyboard": {
    "altKey":   Boolean
    "code":     String,
    "ctrlKey":  Boolean,
    "key":      String,
    "metaKey":  Boolean,
    "repeat":   Boolean,
    "shiftKey": Boolean
  }
}

イベントのtypeプロパティには、コンポーネントの名前（「TouchWrapper」、「ScrollView」、「Sequence」など）が設定されます。

keyboardプロパティの詳細については、keyboardイベントのドキュメントを参照してください。