メソッド | プロパティ | エフェクト | イベント | スタイル フレームあり | フレームなし

mx.core
UIComponent クラス

継承を示す線
直接の既知のサブクラス
           mx.charts.chartClasses.ChartBase, mx.charts.chartClasses.DataTip, mx.containers.FormHeading, mx.controls.ComboBase, mx.controls.DateChooser, mx.controls.HRule, mx.controls.MediaController, mx.controls.MediaDisplay, mx.controls.MenuBar, mx.controls.NumericStepper, mx.controls.SimpleButton, mx.controls.TextInput, mx.controls.ToolTip, mx.controls.VRule, mx.controls.alertClasses.AlertForm, mx.controls.listclasses.SelectableItem, mx.controls.listclasses.SelectableRow, mx.controls.menuclasses.MenuBarItem, mx.controls.scrollClasses.ScrollBar, mx.controls.sliderclasses.Slider, mx.core.View, mx.managers.FocusManager

UIComponent クラス
mx.core.UIObject の拡張

UIComponent クラスは、すべてのインタラクティブコンポーネントの基本クラスです。インタラクティブコンポーネントを使用すると、Tab キーなどを使用したキーボード上でのフォーカス操作や、キーボード入力やマウス入力などの下位レベルイベントの受け入れができます。また、これらの入力を受け入れないようにインタラクティブコンポーネントを無効にすることもできます。この点が、Label や ProgressBar のようなインタラクティブではないコンポーネントとは異なります。これらのコンポーネントは単なる表示機能を持つだけで、ユーザー側からは操作できません。インタラクティブではないコンポーネントは、UIObject から継承する必要があります。UIObject 同様、UIComponent クラスも MXML タグとしては使用されません。

UIComponent から継承される一般的な MXML シンタックス

UIObject クラスは、Flex のすべてのユーザーインターフェイスコンポーネントで拡張されています。Flex のコンポーネントが UIComponent クラスから継承するプロパティは次のとおりです。

 <mx:tagname
enabled="value"
errorString=""
tabEnabled="true|false"
tabIndex="value"
focusInEffect="value"
focusOutEffect="value"
backgroundColor="No default"
backgroundDisabledColor="0xEFEEEF"
backgroundImage="No default"
backgroundAlpha="100"
backgroundSize="100%"
barColor="No default"
borderCapColor="No default"
borderColor="Depends on component"
buttonColor="0xEFEEEF"
borderStyle="inset"
cornerRadius="0"
disabledColor="No default"
errorColor="No default"
highlightColor="No default"
modalTransparency="100"
scrollTrackColor="0xEFEEEF"
shadowColor="0x848384"
shadowCapColor="No default"
symbolColor="0x000000"
symbolBackgroundColor="0xFFFFFF"
symbolBackgroundDisabledColor="0xEFEEEF"
symbolBackgroundPressedColor="0xFFFFFF"
symbolDisabledColor="0x848384"
themeColor="No default"
focusIn="Event handler; no default."
focusOut="Event handler; no default."
hide="Event handler; no default."
invalid="Event handler; no default."
keyDown="Event handler; no default."
keyUp="Event handler; no default."
resize="Event handler; no default."
show="Event handler; no default."
valid="Event handler; no default."
valueCommitted="Event handler; no default."

>
...
子タグ
...
</mx:UIComponent>

関連項目
    UIObject



メソッド
       drawFocus
オブジェクトがフォーカスを持っていることを示すグラフィックを、そのオブジェクト上に描画します。または、そのグラフィックを削除します。
       getFocus( ) :  Object
現在フォーカスを持っているオブジェクトを取得します。
       getFocusManager( ) :  Object
このコンポーネントとそのピアーに対するフォーカスを制御する FocusManager を取得します。
       setEnabled( enabled:Boolean) :  Void
サブクラスの処理で使用する高度なメソッドです。
このメソッドは、有効なプロパティが変更されたときに Flex から呼び出されます。通常は、有効なプロパティを子オブジェクトに設定する場合に使用します。
       setFocus( ) :  Void
このコンポーネントにフォーカスを設定します。

mx.core.UIObject クラスから継承されるメソッド
addEventListener   applyProperties   buildDepthTable   commitProperties   constructObject2   createAccessibilityImplementation   createChildAtDepth   createChildren   createClassChildAtDepth   createClassObject   createEmptyObject   destroyObject   dispatchEvent   doLater   draw   drawRect   executeBindings   fillRect   findNextAvailableDepth   getRepeaterItem   getStyle   handleEvent   init   invalidate   invalidateLayout   invalidateProperties   invalidateSize   invalidateStyle   layoutChildren   measure   move   redraw   removeEventListener   setDepthAbove   setDepthBelow   setMask   setSize   setSizeNoLayout   setStyle   swapDepths  



プロパティ
       enabled:Boolean
コンポーネントがユーザーの操作を受け入れることができるかどうかを指定します。
       errorString:String
Validator によってコンポーネントを監視しているとき、検証が失敗した場合に、そのコンポーネントのツールヒントに表示されるテキストです。
       tabEnabled:Boolean
true の場合、オブジェクトはフォーカスを受け取ることができます。
       tabIndex:Number
アプリケーションの中でコンポーネントに割り当てられているタブ順序を、他のコンポーネントとの関係で示す数値です。
staticversion:String
このクラスのバージョンを表すストリングです。

mx.core.UIObject クラスから継承されるプロパティ
alpha   baselinePosition   className   depth   documentDescriptor   height   heightFlex   id   instanceIndices   isDocument   kStretch   layoutHeight   layoutWidth   maxHeight   maxWidth   minHeight   minWidth   mouseX   mouseY   nestLevel   oldHeight   oldWidth   oldX   oldY   parent   parentApplication   parentDocument   percentHeight   percentWidth   preferredHeight   preferredWidth   repeaterIndices   scaleX   scaleY   styleName   tabEnabled   toolTip   version   visible   width   widthFlex   x   y  



エフェクト
focusInEffectコンポーネントがキーボードのフォーカスを取得します。
focusOutEffectコンポーネントがキーボードのフォーカスを失います。

mx.core.UIObject クラスから継承されるエフェクト
creationCompleteEffect   hideEffect   mouseDownEffect   mouseOutEffect   mouseOverEffect   mouseUpEffect   moveEffect   resizeEffect   showEffect  



イベント
focusInオブジェクトがフォーカスを取得したときにブロードキャストします。イベントオブジェクトの target プロパティには、このイベントをトリガしたコンポーネントへの参照が設定されます。イベントオブジェクトの type プロパティには、イベント名 focusIn が設定されます。
focusOutオブジェクトがフォーカスを失ったときにブロードキャストします。イベントオブジェクトの target プロパティには、このイベントをトリガしたコンポーネントへの参照が設定されます。イベントオブジェクトの type プロパティには、イベント名 focusOut が設定されます。
invalidコンポーネントを Validator によって監視しているとき、検証が失敗するとブロードキャストします。イベントオブジェクトの target プロパティには、このイベントをトリガしたコンポーネントへの参照が設定されます。イベントオブジェクトの type プロパティには、イベント名 invalid が設定されます。
keyDownキーが押されたときにブロードキャストします。イベントオブジェクトの target プロパティには、このイベントをトリガしたコンポーネントへの参照が設定されます。イベントオブジェクトの type プロパティには、イベント名 keyDown が設定されます。イベントオブジェクトには次のようなプロパティもあります。
  • code:押されたキーのキーコードです。
  • ascii:押されたキーの ASCII 値です。
  • shiftKey:Shift キーが押されると true になります。
  • crtlKey: Ctrl キーが押されると true になります。

keyUpキーが離されたときにブロードキャストします。イベントオブジェクトの target プロパティには、このイベントをトリガしたコンポーネントへの参照が設定されます。イベントオブジェクトの type プロパティには、イベント名 KeyUp が設定されます。イベントオブジェクトには次のようなプロパティもあります。
  • code:離されたキーのコードです。
  • ascii:離されたキーの ASCII 値です。
  • shiftKey:Shift キーが押されると true になります。
  • crtlKey: Ctrl キーが押されると true になります。

validコンポーネントを Validator によって監視しているとき、検証が成功するとブロードキャストします。イベントオブジェクトの target プロパティには、このイベントをトリガしたコンポーネントへの参照が設定されます。イベントオブジェクトの type プロパティには、イベント名 valid が設定されます。
valueCommittedプログラム処理によって値が変更されるとブロードキャストします。イベントオブジェクトの target プロパティには、このイベントをトリガしたコンポーネントへの参照が設定されます。イベントオブジェクトの type プロパティには、イベント名 valueCommitted が設定されます。

mx.core.UIObject クラスから継承されるイベント
creationComplete  dragComplete  dragDrop  dragEnter  dragExit  dragOver  draw  effectEnd  effectStart  hide  hideToolTip  initialize  load  mouseChangeSomewhere  mouseDown  mouseDownSomewhere  mouseMove  mouseMoveSomewhere  mouseOut  mouseOver  mouseUp  mouseUpSomewhere  move  resize  show  showToolTip  unload 



スタイル
backgroundAlpha 型 : Number   CSS の継承 : なし
backgroundImage で定義されている SWF ファイルまたはイメージのアルファレベル、または backgroundColor プロパティで定義されているカラーです。有効な値は 0 から 100 までで、デフォルト値は 100 です。
backgroundColor 型 : Number   形式 : Color   CSS の継承 : なし
コンポーネントの背景色です。Button のように、表面全体がボタン面や他のグラフィックで占められているために、背景色を持たないコンポーネントもあります。DataGrid コントロールでも、このスタイル設定は無視されます。
backgroundDisabledColor 型 : Number   形式 : Color   CSS の継承 : あり
無効になっているコンポーネントの背景色です。デフォルト値は 0xEFEEEF (薄い灰色) です。backgroundColor と backgroundImage は、いずれか一方を設定できます。両方を設定することはできません。
backgroundImage 型 : String   形式 : File   CSS の継承 : なし
コントロールの背景イメージです。backgroundColor と backgroundImage は、いずれか一方を設定できます。両方を設定することはできません。
backgroundSize 型 : String   CSS の継承 : なし
backgroundImage で指定されているイメージを、元のサイズとは異なるサイズで表示します。デフォルトの設定は auto で、この場合は元のサイズを維持します。100% に設定すると、画面全体に収まるサイズにイメージを伸縮します。この値は、パーセント記号付きで指定する必要があります。
barColor 型 : Number   形式 : Color   CSS の継承 : あり
外側のバーのカラーです。
borderCapColor 型 : Number   形式 : Color   CSS の継承 : あり
スキン外側の左側と右側のカラーです。
borderColor 型 : Number   形式 : Color   CSS の継承 : なし
3 次元境界の黒い区画、または 2 次元境界のカラー区画のカラーです。このスタイルは、Button、CheckBox、ComboBox、NumericStepper、ProgressBar、RadioButton、ScrollBar、Slider の各コンポーネント、および borderStyle スタイルをサポートするすべてのコンポーネントによってサポートされます。
borderSides 型 : String   CSS の継承 : なし
境界ボックスの境界のうち、どれが表示されるかを示します。borderStyle が "solid" の場合にのみ使用できます。表示する境界をスペース区切りのストリングで指定します。指定する順番は任意です。デフォルトの値は、"left top right bottom" です。
borderStyle CSS の継承 : なし
境界ボックスの表示スタイルです。指定できる値は、"none"、"solid"、"inset" および "outset" です。デフォルト値は、"inset" です。
メモ : borderStyle スタイルは、Button コントロールまたは Panel コンテナでサポートされません。実線の境界を持つ Panel を作成するには、borderThickness プロパティを目的の値に設定し、必要に応じて dropShadow プロパティを false に設定します。
borderThickness 型 : Number   CSS の継承 : なし
境界ボックスの境界線の幅です。borderStyle が "solid" の場合にのみ使用できます。デフォルト値は 1 です。
cornerRadius 型 : Number   CSS の継承 : なし
コンポーネントの角に付いている丸みの半径です。このスタイルは、Panel、TitleWindow、Alert、Button、Tab、Link、ScrollBar、NumericStepper、ComboBox の各コンポーネント、および borderStyle を "solid" に指定できるすべてのコンポーネントによってサポートされます。デフォルト値は 0 です。
disabledColor 型 : Number   形式 : Color   CSS の継承 : あり
UIComponent の無効なカラーです。
dropShadow 型 : Boolean   CSS の継承 : なし
コンポーネントのドロップシャドウの可視性を制御するブール型プロパティです。デフォルト値は false です。このスタイルは、borderStyle が "solid" の場合に使用します。
ドロップシャドウをコンテナに表示するには、backgroundColor または backgroundImage を設定します。設定しない場合、コンテナのデフォルトの背景は透明なので、シャドウはコンテナの背後に表示されます。
errorColor 型 : Number   形式 : Color   CSS の継承 : あり
エラーテキストのカラーです。
fillColors 型 : Array   CSS の継承 : なし
コントロールの背景の着色に使用されるカラーです。均一な外観のコントロールを作成するには、両方の値で同じカラーを渡します。デフォルト値は [0xE6EEEE,0xFFFFFF] です。
highlightColor 型 : Number   形式 : Color   CSS の継承 : あり
フォーカスを取得したコントロールのカラーです。
modalTransparency 型 : Number   CSS の継承 : あり
モーダル性は、TitleWindow コンポーネントの真下に大きな透明ウィンドウを作成することによってシミュレートされます。透明ウィンドウを描画する方法によって、透明ウィンドウの下のオブジェクトは少し薄く表示されます。効果的な透明性を設定するには、modalTransparency の値を 0 (完全に透明) から 100 (不透明) の範囲で調整します。ウィンドウを部分的に透明にする場合は、デフォルトテーマの Modal スキンを変更してウィンドウのカラーを設定することもできます。
scrollTrackColor 型 : Number   形式 : Color   CSS の継承 : あり
スクロールバーのスクロールトラック部分のカラーです。デフォルト値は 0xEFEEEF (薄い灰色) です。
selectedFillColors 型 : Array   CSS の継承 : なし
コントロールの選択状態で背景の着色に使用されるカラーです。均一な外観のコントロールを作成するには、両方の値で同じカラーを渡します。デフォルト値は undefined で、themeColor のカラーを継承します。
shadowCapColor 型 : Number   形式 : Color   CSS の継承 : あり
ボタンのスキンの左側縁と右側縁に沿った内側のカラーです。
shadowColor 型 : Number   形式 : Color   CSS の継承 : あり
ボタンのスキンの、ボタン内部のカラーです。これは、3 次元境界の 1 区画です。デフォルト値は 0x848384 (濃い灰色) です。
shadowDirection CSS の継承 : なし
ドロップシャドウの方向です。有効な値は "left"、"center"、および "right" です。デフォルト値は "center" です。
shadowDistance 型 : Number   CSS の継承 : なし
ドロップシャドウの幅です。負の値を指定した場合、シャドウはパネルの上に移動します。デフォルト値は 2 です。
symbolBackgroundColor 型 : Number   形式 : Color   CSS の継承 : あり
チェックボックスおよびラジオボタンの背景色です。デフォルト値は 0xFFFFFF (白) です。
symbolBackgroundDisabledColor 型 : Number   形式 : Color   CSS の継承 : あり
使用不可になっているチェックボックスおよびラジオボタンの背景色です。デフォルト値は 0xEFEEEF (薄い灰色) です。
symbolBackgroundPressedColor 型 : Number   形式 : Color   CSS の継承 : あり
選択された状態のチェックボックスおよびラジオボタンの背景色です。デフォルト値は 0xFFFFFF (白) です。
symbolColor 型 : Number   形式 : Color   CSS の継承 : あり
チェックボックスのチェックマーク、およびラジオボタンのドットのカラーです。デフォルト値は 0x000000 (黒) です。
symbolDisabledColor 型 : Number   形式 : Color   CSS の継承 : あり
使用不可になっているチェックボックスのチェックマーク、およびラジオボタンのドットのカラーです。デフォルト値は 0x848384 (濃い灰色) です。
themeColor 型 : Number   形式 : Color   CSS の継承 : あり
コンポーネントの背景色です。指定できる値は、"haloGreen"、"haloBlue"、"haloOrange"、および "haloSilver" です。このプロパティには任意の有効なカラーを設定できますが、前述の halo カラーのいずれかを指定した場合にのみ、"にじみ" 効果が得られます。

mx.core.UIObject クラスから継承されるスタイル
color   fontFamily   fontSize   fontStyle   fontWeight   horizontalGap   leading   marginLeft   marginRight   textAlign   textDecoration   textIndent   verticalGap  



メソッドの詳細

drawFocus

drawFocus( )

オブジェクトがフォーカスを持っていることを示すグラフィックを、そのオブジェクト上に描画します。または、そのグラフィックを削除します。これは、サブクラスの処理で使用する高度なメソッドです。
このメソッドを直接呼び出すことはほとんどありません。setFocus() メソッドを呼び出した結果として、呼び出されることが普通です。このメソッドのシグネチャは、次のとおりです。
drawFocus(hasFocus:Boolean):Void


getFocus

getFocus( ) :  Object

現在フォーカスを持っているオブジェクトを取得します。今扱っているオブジェクトにはフォーカスがない可能性があります。ただし、必ずしもフォーカスを持っているコンポーネントが返されるとは限りません。フォーカスを持っているコンポーネントの内部サブコンポーネントが返されることがあります。フォーカスを持っているコンポーネントを確実に取得するには、getFocusManager().getFocus() メソッドを使用します。

戻り値
     フォーカスを持っているオブジェクトです。


getFocusManager

getFocusManager( ) :  Object

このコンポーネントとそのピアーに対するフォーカスを制御する FocusManager を取得します。ポップアップは、それぞれ独自のフォーカスループを持ち、その結果、それぞれ FocusManager の独自のインスタンスを持ちます。間違いなく目的のオブジェクトを扱うためには、このメソッドを使用します。


setEnabled

setEnabled( enabled:Boolean) :  Void

これは、サブクラスの処理で使用する高度なメソッドです。
このメソッドは、有効なプロパティが変更されたときに Flex から呼び出されます。通常は、有効なプロパティを子オブジェクトに設定する場合に使用します。このメソッドを直接呼び出しても、実際にオブジェクトが無効や有効になることはありません。

パラメータ
    enabled:Boolean - 有効なプロパティの値です。


setFocus

setFocus( ) :  Void

現在扱っているコンポーネントにフォーカスを設定します。このとき、コンポーネントのサブコンポーネントにフォーカスが渡されることがあります。



プロパティの詳細

enabled

enabled:Boolean  

コンポーネントがユーザーの操作を受け入れることができるかどうかを指定します。デフォルトは true です。あるコンテナに対して enabledfalse に設定すると、そのコンテナとそのすべての子がグレー表示になり、それらコンテナと子には入力できなくなります。


errorString

errorString:String  

Validator によってコンポーネントを監視しているとき、検証が失敗した場合に、そのコンポーネントのツールヒントに表示されるテキストです。


tabEnabled

tabEnabled:Boolean  

true の場合、オブジェクトはフォーカスを受け取ることができます。デフォルト値は true です。


tabIndex

tabIndex:Number  

アプリケーションの中でコンポーネントに割り当てられているタブ順序を、他のコンポーネントとの関係で示す数値です。


version

static  version:String  

このクラスのバージョンを表すストリングです。