パッケージmx.core
インターフェイスpublic interface IUIComponent extends IFlexDisplayObject, IBitmapDrawable, IEventDispatcher
SubinterfacesIAxisRenderer, IDeferredInstantiationUIComponent, IListItemRenderer, IToolTip
インプリメンタUIComponent, UITextField

IUIComponent インターフェイスは、Flex コンテナまたはリストの子を作成するために実装する必要のある API の基本セットを定義します。



パブリックプロパティ
 プロパティ定義
 Inheritedalpha : Number
このオブジェクトの透明度です。
IFlexDisplayObject
  baselinePosition : Number
[read-only] コンポーネントのテキストの 1 行目のベースライン y 座標を指定します。
IUIComponent
  cacheAsBitmap : Boolean
true に設定されている場合、オブジェクトの内部ビットマップ表現がキャッシュされます。
IUIComponent
  document : Object
このコンポーネントに関連付けられたドキュメントオブジェクトへの参照です。
IUIComponent
  enabled : Boolean
コンポーネントがユーザーの操作を受け入れることができるかどうかを指定します。
IUIComponent
  explicitHeight : Number
コンポーネントの座標として明示的に指定されたコンポーネントの高さ (ピクセル単位) です。
IUIComponent
  explicitMaxHeight : Number
[read-only] コンポーネントの座標としてコンポーネントの最大の高さ (ピクセル単位) を指定する数値です。
IUIComponent
  explicitMaxWidth : Number
[read-only] コンポーネントの座標としてコンポーネントの最大の幅 (ピクセル単位) を指定する数値です。
IUIComponent
  explicitMinHeight : Number
[read-only] コンポーネントの座標としてコンポーネントの最小の高さ (ピクセル単位) を指定する数値です。
IUIComponent
  explicitMinWidth : Number
[read-only] コンポーネントの座標としてコンポーネントの最小の幅 (ピクセル単位) を指定する数値です。
IUIComponent
  explicitWidth : Number
コンポーネントの座標として明示的に指定されたコンポーネントの幅 (ピクセル単位) です。
IUIComponent
  focusPane : Sprite
複数のコンポーネント間で共有され、フォーカス描画のオーバーレイとして使用される単一の Sprite オブジェクトです。
IUIComponent
 Inheritedheight : Number
このオブジェクトの高さ (ピクセル単位) です。
IFlexDisplayObject
  includeInLayout : Boolean
このコンポーネントを親コンテナのレイアウトに含めるかどうかを指定します。
IUIComponent
 Inheritedmask : DisplayObject
このオブジェクトをマスクするために使用する DisplayObject。マスクすることによって、オブジェクトの一部だけを描画することができます。
IFlexDisplayObject
  maxHeight : Number
[read-only] コンポーネントの座標としてコンポーネントの最大の高さ (ピクセル単位) を指定する数値です。
IUIComponent
  maxWidth : Number
[read-only] コンポーネントの座標としてコンポーネントの最大の幅 (ピクセル単位) を指定する数値です。
IUIComponent
 InheritedmeasuredHeight : Number
このオブジェクトの測定した高さです。
IFlexDisplayObject
  measuredMinHeight : Number
コンポーネントのデフォルトの最小高さです (ピクセル単位)。
IUIComponent
  measuredMinWidth : Number
コンポーネントのデフォルトの最小幅です (ピクセル単位)。
IUIComponent
 InheritedmeasuredWidth : Number
このオブジェクトの測定した幅です。
IFlexDisplayObject
  minHeight : Number
[read-only] コンポーネントの座標としてコンポーネントの最小の高さ (ピクセル単位) を指定する数値です。
IUIComponent
  minWidth : Number
[read-only] コンポーネントの座標としてコンポーネントの最小の幅 (ピクセル単位) を指定する数値です。
IUIComponent
 Inheritedname : String
このオブジェクトのインスタンス名です。
IFlexDisplayObject
  opaqueBackground : Object
表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。
IUIComponent
  owner : DisplayObjectContainer
通常は親が所有者ですが、ポップアップサブコンポーネントの場合には、ポップアップを発生させたコンポーネントが所有者です。
IUIComponent
 Inheritedparent : DisplayObjectContainer
このオブジェクトの親です。
IFlexDisplayObject
  percentHeight : Number
コンポーネントの高さを親のサイズに対する比率 (パーセンテージ) で指定する数値です。
IUIComponent
  percentWidth : Number
コンポーネントの幅を親のサイズに対する比率 (パーセンテージ) で指定する数値です。
IUIComponent
 InheritedscaleX : Number
このオブジェクトの水平方向の拡大 / 縮小倍率です。
IFlexDisplayObject
 InheritedscaleY : Number
このオブジェクトの垂直方向の拡大 / 縮小倍率です。
IFlexDisplayObject
  scrollRect : Rectangle
コンポーネントのサーフェスのスクロール矩形の境界です。
IUIComponent
  systemManager : ISystemManager
このコンポーネントの SystemManager オブジェクトへの参照です。
IUIComponent
  tweeningProperties : Array
EffectManager によって使用されます。
IUIComponent
 Inheritedvisible : Boolean
このオブジェクトが表示されるかどうかを示すフラグです。
IFlexDisplayObject
 Inheritedwidth : Number
このオブジェクトの幅 (ピクセル単位) です。
IFlexDisplayObject
 Inheritedx : Number
親の位置を基準とした、このオブジェクトの水平位置 (ピクセル座標単位) です。
IFlexDisplayObject
 Inheritedy : Number
親の位置を基準とした、このオブジェクトの垂直位置 (ピクセル座標単位) です。
IFlexDisplayObject
パブリックメソッド
 メソッド定義
 InheritedaddEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
IEventDispatcher
 InheriteddispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
IEventDispatcher
  getExplicitOrMeasuredHeight():Number
明示された高さを使用するのか、それとも測定した高さを使用するのかを決定する便利なメソッドです。
IUIComponent
  getExplicitOrMeasuredWidth():Number
明示的な幅または測定幅を使用するかどうかを決定するための便利なメソッドです。
IUIComponent
 InheritedhasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
IEventDispatcher
  initialize():void
オブジェクトを初期化します。
IUIComponent
 Inheritedmove(x:Number, y:Number):void
このオブジェクトを指定の x および y 座標に移動します。
IFlexDisplayObject
  owns(child:DisplayObject):Boolean
owner プロパティのチェーンが child からこの UIComponent を指定している場合に、true を返します。
IUIComponent
  parentChanged(p:DisplayObjectContainer):void
UIComponent オブジェクトを親に対して追加または削除したときに Flex によって呼び出されます。
IUIComponent
 InheritedremoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
IEventDispatcher
 InheritedsetActualSize(newWidth:Number, newHeight:Number):void
このオブジェクトの実際のサイズを設定します。
IFlexDisplayObject
  setVisible(value:Boolean, noEvent:Boolean = false):void
visible プロパティが変更されたときに呼び出されます。
IUIComponent
 InheritedwillTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
IEventDispatcher
プロパティの詳細
baselinePositionプロパティ
baselinePosition:Number  [read-only]

コンポーネントのテキストの 1 行目のベースライン y 座標を指定します。

実装
    public function get baselinePosition():Number
cacheAsBitmapプロパティ 
cacheAsBitmap:Boolean  [read-write]

true に設定されている場合、オブジェクトの内部ビットマップ表現がキャッシュされます。これにより、複雑なベクターコンテンツを含んでいる表示オブジェクトのパフォーマンスを向上できます。

実装
    public function get cacheAsBitmap():Boolean
    public function set cacheAsBitmap(value:Boolean):void

関連項目

documentプロパティ 
document:Object  [read-write]

このコンポーネントに関連付けられたドキュメントオブジェクトへの参照です。ドキュメントオブジェクトは、Flex アプリケーション、MXML コンポーネント、または ActionScript コンポーネントの階層の最上位にあるオブジェクトです。

実装
    public function get document():Object
    public function set document(value:Object):void
enabledプロパティ 
enabled:Boolean  [read-write]

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

実装
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
explicitHeightプロパティ 
explicitHeight:Number  [read-write]

コンポーネントの座標として明示的に指定されたコンポーネントの高さ (ピクセル単位) です。高さが明示的に指定されていない場合、この値は NaN になります。

実装
    public function get explicitHeight():Number
    public function set explicitHeight(value:Number):void

関連項目

explicitMaxHeightプロパティ 
explicitMaxHeight:Number  [read-only]

コンポーネントの座標としてコンポーネントの最大の高さ (ピクセル単位) を指定する数値です。

実装
    public function get explicitMaxHeight():Number

関連項目

explicitMaxWidthプロパティ 
explicitMaxWidth:Number  [read-only]

コンポーネントの座標としてコンポーネントの最大の幅 (ピクセル単位) を指定する数値です。

実装
    public function get explicitMaxWidth():Number

関連項目

explicitMinHeightプロパティ 
explicitMinHeight:Number  [read-only]

コンポーネントの座標としてコンポーネントの最小の高さ (ピクセル単位) を指定する数値です。

実装
    public function get explicitMinHeight():Number

関連項目

explicitMinWidthプロパティ 
explicitMinWidth:Number  [read-only]

コンポーネントの座標としてコンポーネントの最小の幅 (ピクセル単位) を指定する数値です。

実装
    public function get explicitMinWidth():Number

関連項目

explicitWidthプロパティ 
explicitWidth:Number  [read-write]

コンポーネントの座標として明示的に指定されたコンポーネントの幅 (ピクセル単位) です。幅が明示的に指定されていない場合、この値は NaN になります。

実装
    public function get explicitWidth():Number
    public function set explicitWidth(value:Number):void

関連項目

focusPaneプロパティ 
focusPane:Sprite  [read-write]

複数のコンポーネント間で共有され、フォーカス描画のオーバーレイとして使用される単一の Sprite オブジェクトです。コンポーネントは、親がフォーカスの設定されたコンポーネントの場合にはこのオブジェクトを共有し、コンポーネントが IFocusManagerComponent インターフェイスを実装している場合には共有しません。

実装
    public function get focusPane():Sprite
    public function set focusPane(value:Sprite):void

関連項目

includeInLayoutプロパティ 
includeInLayout:Boolean  [read-write]

このコンポーネントを親コンテナのレイアウトに含めるかどうかを指定します。true の場合、オブジェクトは親コンテナのレイアウトに含まれます。false の場合、オブジェクトはそのレイアウト規則に従って親コンテナによって位置付けられますが、次の子の位置の計算では無視されます。

実装
    public function get includeInLayout():Boolean
    public function set includeInLayout(value:Boolean):void
maxHeightプロパティ 
maxHeight:Number  [read-only]

コンポーネントの座標としてコンポーネントの最大の高さ (ピクセル単位) を指定する数値です。

実装
    public function get maxHeight():Number

関連項目

maxWidthプロパティ 
maxWidth:Number  [read-only]

コンポーネントの座標としてコンポーネントの最大の幅 (ピクセル単位) を指定する数値です。

実装
    public function get maxWidth():Number

関連項目

measuredMinHeightプロパティ 
measuredMinHeight:Number  [read-write]

コンポーネントのデフォルトの最小高さです (ピクセル単位)。この値は measure() メソッドによって設定されます。

実装
    public function get measuredMinHeight():Number
    public function set measuredMinHeight(value:Number):void
measuredMinWidthプロパティ 
measuredMinWidth:Number  [read-write]

コンポーネントのデフォルトの最小幅です (ピクセル単位)。この値は measure() メソッドによって設定されます。

実装
    public function get measuredMinWidth():Number
    public function set measuredMinWidth(value:Number):void
minHeightプロパティ 
minHeight:Number  [read-only]

コンポーネントの座標としてコンポーネントの最小の高さ (ピクセル単位) を指定する数値です。

実装
    public function get minHeight():Number

関連項目

minWidthプロパティ 
minWidth:Number  [read-only]

コンポーネントの座標としてコンポーネントの最小の幅 (ピクセル単位) を指定する数値です。

実装
    public function get minWidth():Number

関連項目

opaqueBackgroundプロパティ 
opaqueBackground:Object  [read-write]

表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。透明のビットマップにはアルファチャンネルデータが含まれ、透明に描画されます。不透明のビットマップには、アルファチャンネルがありません (したがって透明のビットマップより速くレンダリングされます)。ビットマップが不透明の場合、使用する独自の背景色を指定する必要があります。

実装
    public function get opaqueBackground():Object
    public function set opaqueBackground(value:Object):void

関連項目

ownerプロパティ 
owner:DisplayObjectContainer  [read-write]

通常は親が所有者ですが、ポップアップサブコンポーネントの場合には、ポップアップを発生させたコンポーネントが所有者です。たとえば、ComboBox ドロップダウンの owner は ComboBox です。このプロパティはフレームワークではなく各コンポーネントによって管理されるため、サブコンポーネントをポップアップする場合は、このプロパティを設定する必要があります。

実装
    public function get owner():DisplayObjectContainer
    public function set owner(value:DisplayObjectContainer):void
percentHeightプロパティ 
percentHeight:Number  [read-write]

コンポーネントの高さを親のサイズに対する比率 (パーセンテージ) で指定する数値です。指定できる値は 0 ~ 100 です。

実装
    public function get percentHeight():Number
    public function set percentHeight(value:Number):void
percentWidthプロパティ 
percentWidth:Number  [read-write]

コンポーネントの幅を親のサイズに対する比率 (パーセンテージ) で指定する数値です。指定できる値は 0 ~ 100 です。

実装
    public function get percentWidth():Number
    public function set percentWidth(value:Number):void
scrollRectプロパティ 
scrollRect:Rectangle  [read-write]

コンポーネントのサーフェスのスクロール矩形の境界です。

実装
    public function get scrollRect():Rectangle
    public function set scrollRect(value:Rectangle):void

関連項目

systemManagerプロパティ 
systemManager:ISystemManager  [read-write]

このコンポーネントの SystemManager オブジェクトへの参照です。

実装
    public function get systemManager():ISystemManager
    public function set systemManager(value:ISystemManager):void
tweeningPropertiesプロパティ 
tweeningProperties:Array  [read-write]

EffectManager によって使用されます。コンポーネントが Tween を実行するために EffectManager を使用していない場合は、null 以外の値を返します。

実装
    public function get tweeningProperties():Array
    public function set tweeningProperties(value:Array):void
メソッドの詳細
getExplicitOrMeasuredHeight()メソッド
public function getExplicitOrMeasuredHeight():Number

明示された高さを使用するのか、それとも測定した高さを使用するのかを決定する便利なメソッドです。

戻り値
Number — 定義されている場合は数値 explicitHeight、定義されていない場合は数値 measuredHeight です。
getExplicitOrMeasuredWidth()メソッド 
public function getExplicitOrMeasuredWidth():Number

明示的な幅または測定幅を使用するかどうかを決定するための便利なメソッドです。

戻り値
Number — 定義されている場合は数値 explicitWidth、定義されていない場合は数値 measuredWidth です。
initialize()メソッド 
public function initialize():void

オブジェクトを初期化します。

関連項目

owns()メソッド 
public function owns(child:DisplayObject):Boolean

owner プロパティのチェーンが child からこの UIComponent を指定している場合に、true を返します。

パラメータ
child:DisplayObject — UIComponent です。

戻り値
Boolean — UIComponent が子の親であるか、子を所有している場合は true になります。
parentChanged()メソッド 
public function parentChanged(p:DisplayObjectContainer):void

UIComponent オブジェクトを親に対して追加または削除したときに Flex によって呼び出されます。開発者は通常このメソッドを呼び出す必要はありません。

パラメータ
p:DisplayObjectContainer — この UIComponent オブジェクトの親です。
setVisible()メソッド 
public function setVisible(value:Boolean, noEvent:Boolean = false):void

visible プロパティが変更されたときに呼び出されます。コンポーネントの表示と非表示を切り替えるには、このメソッドを直接呼び出す代わりに visible プロパティを設定してください。

パラメータ
value:Booleanvisible プロパティの新しい値です。true を指定するとコンポーネントが表示され、false を指定すると非表示になります。
 
noEvent:Boolean (default = false)true の場合は、イベントは送出されません。false の場合は、コンポーネントが表示されたときに show イベントが送出され、コンポーネントが非表示になったときに hide イベントが送出されます。