パッケージfl.core
クラスpublic class UIComponent
継承UIComponent Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
サブクラス BaseButton, BaseScrollPane, ColorPicker, ComboBox, IndeterminateBar, Label, NumericStepper, ProgressBar, ScrollBar, Slider, TextArea, TextInput, UILoader

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

UIComponent クラスは、インタラクティブおよび非インタラクティブのすべてのビジュアルコンポーネントの基本クラスです。インタラクティブコンポーネントとは、キーボード操作やマウス操作などのユーザー入力を受け取るコンポーネントです。非インタラクティブコンポーネントはデータの表示に使用され、ユーザーの操作に反応することはありません。非インタラクティブコンポーネントの一例として、ProgressBar コンポーネントおよび UILoader コンポーネントがあります。

インタラクティブコンポーネントにフォーカスを移動する際は、Tab キーや矢印キーを使用できます。インタラクティブコンポーネントは、マウスデバイスやキーボードデバイスを使った入力など、低レベルのイベントを受け取ることができます。マウスやキーボードの入力を受け付けないように、インタラクティブコンポーネントを無効化することもできます。



パブリック プロパティ
 プロパティ定義元
 InheritedaccessibilityProperties : AccessibilityProperties
この表示オブジェクトの現在のアクセシビリティオプションです。
DisplayObject
 Inheritedalpha : Number
指定されたオブジェクトのアルファ透明度値を示します。
DisplayObject
 InheritedblendMode : String
使用するブレンドモードを指定する BlendMode クラスの値です。
DisplayObject
 InheritedbuttonMode : Boolean
このスプライトのボタンモードを指定します。
Sprite
 InheritedcacheAsBitmap : Boolean
true に設定されている場合、表示オブジェクトの内部ビットマップ表現が Flash Player にキャッシュされます。
DisplayObject
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcontextMenu : ContextMenu
このオブジェクトに関連付けられたコンテキストメニューを指定します。
InteractiveObject
 InheriteddoubleClickEnabled : Boolean
オブジェクトが doubleClick イベントを受け取るかどうかを指定します。
InteractiveObject
 InheriteddropTarget : DisplayObject
[read-only] スプライトのドラッグ先またはスプライトがドロップされた先の表示オブジェクトを指定します。
Sprite
  enabled : Boolean
コンポーネントがユーザーの操作を受け付けるかどうかを示す値を取得または設定します。
UIComponent
 Inheritedfilters : Array
表示オブジェクトに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。
DisplayObject
  focusEnabled : Boolean
ユーザーがコンポーネントをクリックしたときに、コンポーネントがフォーカスを受け取ることが可能かどうかを示すブール値を取得または設定します。
UIComponent
  focusManager : IFocusManager
このコンポーネントとそのピアーに対するフォーカスを制御する FocusManager を取得または設定します。
UIComponent
 InheritedfocusRect : Object
このオブジェクトがフォーカス矩形を表示するかどうかを指定します。
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] ベクターの描画コマンドが発生する、このスプライトに属する Graphics オブジェクトを指定します。
Sprite
  height : Number
コンポーネントの高さを取得または設定します (ピクセル単位)。
UIComponent
 InheritedhitArea : Sprite
スプライトのヒット領域となる別のスプライトを指定します。
Sprite
 InheritedloaderInfo : LoaderInfo
[read-only] この表示オブジェクトが属するファイルのロード情報を含む LoaderInfo オブジェクトを返します。
DisplayObject
 Inheritedmask : DisplayObject
呼び出し元の表示オブジェクトは、指定された mask オブジェクトによってマスクされます。
DisplayObject
 InheritedmouseChildren : Boolean
オブジェクトの子に対してマウスが有効かどうかを調べます。
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
このオブジェクトがマウスメッセージを受け取るかどうかを指定します。
InteractiveObject
  mouseFocusEnabled : Boolean
ユーザーがコンポーネントをクリックしたときに、コンポーネントがフォーカスを受け取ることが可能かどうかを示す値を取得または設定します。
UIComponent
 InheritedmouseX : Number
[read-only] マウス位置の x 座標を示します (ピクセル単位)。
DisplayObject
 InheritedmouseY : Number
[read-only] マウス位置の y 座標を示します (ピクセル単位)。
DisplayObject
 Inheritedname : String
DisplayObject のインスタンス名を示します。
DisplayObject
 InheritednumChildren : int
[read-only] このオブジェクトの子の数を返します。
DisplayObjectContainer
 InheritedopaqueBackground : Object
表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。
DisplayObject
 Inheritedparent : DisplayObjectContainer
[read-only] この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。
DisplayObject
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 Inheritedroot : DisplayObject
[read-only] ロードされた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。
DisplayObject
 Inheritedrotation : Number
DisplayObject インスタンスの元の位置からの回転角を度単位で示します。
DisplayObject
 Inheritedscale9Grid : Rectangle
現在有効な拡大 / 縮小グリッドです。
DisplayObject
  scaleX : Number
コンポーネントの現在の幅に縮尺率を乗算します。
UIComponent
  scaleY : Number
コンポーネントの現在の高さに縮尺率を乗算します。
UIComponent
 InheritedscrollRect : Rectangle
表示オブジェクトのスクロール矩形の境界です。
DisplayObject
 InheritedsoundTransform : SoundTransform
このスプライト内のサウンドを制御します。
Sprite
 Inheritedstage : Stage
[read-only] 表示オブジェクトのステージです。
DisplayObject
 InheritedtabChildren : Boolean
オブジェクトの子に対してタブが有効かどうかを調べます。
DisplayObjectContainer
 InheritedtabEnabled : Boolean
このオブジェクトがタブ順序に含まれるかどうかを指定します。
InteractiveObject
 InheritedtabIndex : int
SWF ファイル内のオブジェクトのタブ順序を指定します。
InteractiveObject
 InheritedtextSnapshot : TextSnapshot
[read-only] この DisplayObjectContainer インスタンスの TextSnapshot オブジェクトを返します。
DisplayObjectContainer
 Inheritedtransform : Transform
表示オブジェクトのマトリックス、カラー変換、ピクセル境界に関係するプロパティを持つオブジェクトです。
DisplayObject
 InheriteduseHandCursor : Boolean
buttonMode プロパティが true に設定されたスプライト上にマウスが移動したときに、指差しハンドポインタ (ハンドカーソル) を表示するかどうかを示すブール値です。
Sprite
  version : String = "3.0.0.15"
コンポーネントのバージョン番号。
UIComponent
  visible : Boolean
現在のコンポーネントのインスタンスが可視かどうかを示す値を取得または設定します。
UIComponent
  width : Number
コンポーネントの幅を取得または設定します (ピクセル単位)。
UIComponent
  x : Number
親コンテナ内での x 軸に沿ったコンポーネントの位置を表す x 座標を取得または設定します。
UIComponent
  y : Number
親コンテナ内での y 軸に沿ったコンポーネントの位置を表す y 座標を取得または設定します。
UIComponent
パブリック メソッド
 メソッド定義元
  
新しい UIComponent コンポーネントインスタンスを作成します。
UIComponent
 Inherited
この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
DisplayObjectContainer
 Inherited
この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 Inherited
特定の point ポイントを指定して呼び出した DisplayObjectContainer.getObjectsUnderPoint() メソッドから返されたリストに、セキュリティ上の制約のために省略される表示オブジェクトがあるかどうかを示します。
DisplayObjectContainer
  
このコンポーネントインスタンスからスタイルプロパティを削除します。
UIComponent
 Inherited
指定された表示オブジェクトが、DisplayObjectContainer インスタンスの子であるか、インスタンス自体であるかを指定します。
DisplayObjectContainer
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
  
このコンポーネントのフォーカスインジケータを表示または非表示にします。
UIComponent
  
invalidateNow とは異なり、すべてを無効化せずに直ちに描画を開始します。
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
targetCoordinateSpace オブジェクトの座標系を基準にして、表示オブジェクトの領域を定義する矩形を返します。
DisplayObject
 Inherited
指定のインデックス位置にある子表示オブジェクトインスタンスを返します。
DisplayObjectContainer
 Inherited
指定された名前に一致する子表示オブジェクトを返します。
DisplayObjectContainer
 Inherited
子 DisplayObject インスタンスのインデックス位置を返します。
DisplayObjectContainer
  
現在フォーカスを持っているオブジェクトを取得します。
UIComponent
 Inherited
指定されたポイントの下にあり、この DisplayObjectContainer インスタンスの子または孫などであるオブジェクトの配列を返します。
DisplayObjectContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
シェイプ上の線を除き、targetCoordinateSpace パラメータによって定義された座標系に基づいて、表示オブジェクトの境界を定義する矩形を返します。
DisplayObject
  
コンポーネントのスタイル参照チェーンに設定されているスタイルプロパティを取得します。
UIComponent
  
[static] 現在のコンポーネントのデフォルトスタイルマップを取得します。
UIComponent
 Inherited
point オブジェクトをステージ (グローバル) 座標から表示オブジェクトの (ローカル) 座標に変換します。
DisplayObject
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
表示オブジェクトを評価して、obj 表示オブジェクトと重複または交差するかどうかを調べます。
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
表示オブジェクトを評価して、x および y パラメータで指定されたポイントと重複または交差するかどうかを調べます。
DisplayObject
  
invalidate(property:String, callLater:Boolean = true):void
プロパティが無効であることを示し、指定がない限り、コンポーネントを次のフレームに再描画します。
UIComponent
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
point オブジェクトを表示オブジェクトの (ローカル) 座標からステージ (グローバル) 座標に変換します。
DisplayObject
  
[static] 複数のクラスのスタイルを 1 つのオブジェクトに結合します。
UIComponent
  
親の内部の指定された位置にコンポーネントを移動します。
UIComponent
 Inherited
指定されたプロパティが存在し列挙できるかどうかを示します。
Object
 Inherited
DisplayObjectContainer インスタンスの子リストから指定の child DisplayObject インスタンスを削除します。
DisplayObjectContainer
 Inherited
DisplayObjectContainer の子リストの指定されたインデックス位置から子 DisplayObject を削除します。
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
表示オブジェクトコンテナの既存の子の位置を変更します。
DisplayObjectContainer
  
現在扱っているコンポーネントにフォーカスを設定します。
UIComponent
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
setSize(width:Number, height:Number):void
コンポーネントのサイズを、指定した幅と高さに設定します。
UIComponent
  
setStyle(style:String, value:Object):void
このコンポーネントインスタンスのスタイルプロパティを設定します。
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
指定されたスプライトをユーザーがドラッグできるようにします。
Sprite
 Inherited
startDrag() メソッドを終了します。
Sprite
 Inherited
指定された 2 つの子オブジェクトの z 順序 (重ね順) を入れ替えます。
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序 (重ね順) を入れ替えます。
DisplayObjectContainer
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
  
必要に応じて、このオブジェクトのプロパティとレイアウトを検証および更新し、それを再描画します。
UIComponent
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント 概要 定義元
 Inherited Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited 表示オブジェクトが表示リストに追加されたときに送出されます。DisplayObject
 Inherited 表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの追加により、ステージ上の表示リストに追加されたときに送出されます。DisplayObject
 Inherited ユーザーが InteractiveObject をポインティングデバイスのメインボタンでクリックしたときに送出されます。InteractiveObject
 Inherited Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
 Inherited オブジェクトの doubleClickEnabled フラグが true に設定されている場合にユーザーが InteractiveObject をポインティングデバイスのメインボタンで 2 回続けてすばやくクリックすると送出されます。InteractiveObject
 Inherited 再生ヘッドが新しいフレームに入るときに送出されます。DisplayObject
 Inherited 表示オブジェクトがフォーカスを取得したときに送出されます。InteractiveObject
 Inherited 表示オブジェクトがフォーカスを失ったときに送出されます。InteractiveObject
   コンポーネントの可視性が可視から不可視に変化した後に送出されます。UIComponent
 Inherited ユーザーがキーを押したときに送出されます。InteractiveObject
 Inherited ユーザーがキーボード操作によってフォーカスを変更しようとすると送出されます。InteractiveObject
 Inherited ユーザーがキーを離したときに送出されます。InteractiveObject
 Inherited Flash Player ウィンドウの InteractiveObject インスタンスの上でユーザーがポインティングデバイスのボタンを押すと送出されます。InteractiveObject
 Inherited ユーザーがポインティングデバイスでフォーカスを変更しようとすると送出されます。InteractiveObject
 Inherited ユーザーが InteractiveObject の上でポインティングデバイスを移動させたときに送出されます。InteractiveObject
 Inherited ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。InteractiveObject
 Inherited ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスにポインティングデバイスを合わせたときに送出されます。InteractiveObject
 Inherited ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスの上でポインティングデバイスのボタンを解放したときに送出されます。InteractiveObject
 Inherited Flash Player ウィンドウの InteractiveObject インスタンスの上でマウスホイールを回転させたときに送出されます。InteractiveObject
   コンポーネントが移動された後に送出されます。UIComponent
 Inherited 表示オブジェクトが表示リストから削除されようとしているときに送出されます。DisplayObject
 Inherited 表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの削除により、表示リストから削除されようとしているときに送出されます。DisplayObject
 Inherited 表示リストが更新およびレンダリングされようとしているときに送出されます。DisplayObject
   コンポーネントのサイズが変更された後に送出されます。UIComponent
 Inherited ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。InteractiveObject
 Inherited ユーザーが InteractiveObject インスタンスにポインティングデバイスを合わせたときに送出されます。InteractiveObject
   コンポーネントの可視性が不可視から可視に変化した後に送出されます。UIComponent
 Inherited オブジェクトの tabChildren フラグの値が変更されたときに送出されます。InteractiveObject
 Inherited オブジェクトの tabEnabled フラグが変更されたときに送出されます。InteractiveObject
 Inherited オブジェクトの tabIndex プロパティの値が変更されたときに送出されます。InteractiveObject
スタイル
 スタイル 説明 定義元
  
disabledTextFormat
データ型: flash.text.TextFormat
ボタンが無効な場合に、コンポーネントラベルのレンダリングに使用される TextFormat オブジェクトです。 デフォルト値 : TextFormat("_sans", 11, 0x999999, false, false, false, '', '', TextFormatAlign.LEFT, 0, 0, 0, 0).
UIComponent
  
focusRectPadding
データ型: Number   形式: Length
コンポーネント領域の外側とフォーカスインジケータ領域のエッジを区切るパディングです (ピクセル単位)。 デフォルト値 : 2.
UIComponent
  
focusRectSkin
データ型: Class
フォーカスインジケータの表示に使用されるスキンです。 デフォルト値 : focusRectSkin.
UIComponent
  
textFormat
データ型: flash.text.TextFormat
コンポーネントラベルのレンダリングに使用される TextFormat オブジェクトです。 デフォルト値 : TextFormat("_sans", 11, 0x000000, false, false, false, '', '', TextFormatAlign.LEFT, 0, 0, 0, 0).
UIComponent
プロパティの詳細
enabledプロパティ
enabled:Boolean  [read-write]

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントがユーザーの操作を受け付けるかどうかを示す値を取得または設定します。true の値は、コンポーネントがユーザーの操作を受け付けるかどうかを示します。この値が false の場合、コンポーネントはユーザーの操作を受け付けません。

enabled プロパティを false に設定した場合、コンテナの色はグレー表示になり、ユーザー入力がブロックされます (ただし、Label および ProgressBar コンポーネントは例外です)。

デフォルト値 : true.


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

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

ユーザーがコンポーネントをクリックしたときに、コンポーネントがフォーカスを受け取ることが可能かどうかを示すブール値を取得または設定します。true は、フォーカスを受け取ることができることを示します。false は、フォーカスを受け取ることができないことを示します。

このプロパティを false に設定した場合、フォーカスは、mouseFocusEnabled プロパティが true に設定されている最初の親に移ります。

デフォルト値 : true.


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

関連項目

focusManagerプロパティ 
focusManager:IFocusManager  [read-write]

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

このコンポーネントとそのピアーに対するフォーカスを制御する FocusManager を取得または設定します。ポップアップコンポーネントは、それぞれが独自のフォーカスループと FocusManager のインスタンスを保持します。このプロパティを使用することにより、このコンポーネントの適切な FocusManager にアクセスできます。


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

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントの高さを取得または設定します (ピクセル単位)。

このプロパティを設定すると、resize イベントが送出されます。送出されるタイミングについては、resize イベントを参照してください。

コンポーネントの scaleY プロパティが 1.0 以外の場合、内部座標から取得されたコンポーネントの高さと、親座標における高さの値は一致しません。たとえば、高さが 100 ピクセルで、scaleY の値が 2 であるコンポーネントは、親においては 100 ピクセルとなりますが、内部的には高さ 50 ピクセルであることを示す値が格納されます。


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

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

ユーザーがコンポーネントをクリックしたときに、コンポーネントがフォーカスを受け取ることが可能かどうかを示す値を取得または設定します。true は、フォーカスを受け取ることができることを示します。false は、フォーカスを受け取ることができないことを示します。

このプロパティを false に設定した場合、フォーカスは、mouseFocusEnabled プロパティが true に設定されている最初の親に移ります。

デフォルト値 : true.


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

関連項目

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

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントの現在の幅に縮尺率を乗算します。


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

関連項目

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

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントの現在の高さに縮尺率を乗算します。


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

関連項目

versionプロパティ 
public var version:String = "3.0.0.15"

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントのバージョン番号。




次の例では、CheckBox コンポーネントインスタンスのバージョン番号をトレースします。

import fl.controls.CheckBox;

var myCheckBox:CheckBox = new CheckBox();
trace(myCheckBox.version);
visibleプロパティ 
visible:Boolean  [read-write]

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

現在のコンポーネントのインスタンスが可視かどうかを示す値を取得または設定します。true は、現在のコンポーネントが可視であることを示します。false は、不可視であることを示します。

このプロパティを true に設定した場合、対応するオブジェクトから show イベントが送出されます。このプロパティを false に設定した場合、対応するオブジェクトから hide イベントが送出されます。いずれの場合も、オブジェクトで明示的に実装されていない限り、オブジェクトの子は show または hide イベントを生成しません。

デフォルト値 : true.


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

関連項目

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

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントの幅を取得または設定します (ピクセル単位)。

このプロパティを設定すると、resize イベントが送出されます。送出されるタイミングについては、resize イベントを参照してください。

コンポーネントの scaleX プロパティが 1.0 以外の場合、内部座標から取得されたコンポーネントの幅と、親座標における幅の値は一致しません。たとえば、幅が 100 ピクセルで、scaleX の値が 2 であるコンポーネントは、親においては 100 ピクセルとなりますが、内部的には幅 50 ピクセルであることを示す値が格納されます。


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

関連項目

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

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

親コンテナ内での x 軸に沿ったコンポーネントの位置を表す x 座標を取得または設定します。この値は左端を基準に計算され、ピクセル単位で表されます。

このプロパティを設定すると、ComponentEvent.MOVE イベントが送出されます。

デフォルト値 : 0.


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

関連項目

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

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

親コンテナ内での y 軸に沿ったコンポーネントの位置を表す y 座標を取得または設定します。この値は上端を基準に計算され、ピクセル単位で表されます。

このプロパティを設定すると、move イベントが送出されます。


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

関連項目

コンストラクタの詳細
UIComponent()コンストラクタ
public function UIComponent()

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

新しい UIComponent コンポーネントインスタンスを作成します。

メソッドの詳細
clearStyle()メソッド
public function clearStyle(style:String):void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

このコンポーネントインスタンスからスタイルプロパティを削除します。

この場合に getStyle() メソッドを使用しても、undefined の値が返されないことがあります。

パラメータ

style:String — スタイルプロパティの名前です。

関連項目

drawFocus()メソッド 
public function drawFocus(focused:Boolean):void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

このコンポーネントのフォーカスインジケータを表示または非表示にします。

UIComponent クラスは、focusSkin スタイルで指定されたクラスのインスタンスを作成し、適切に配置することによって、このメソッドを実装します。

パラメータ

focused:Boolean — フォーカスインジケータを表示するかどうかを示します。この値が true の場合、フォーカスインジケータが表示されます。この値が false の場合、フォーカスインジケータは表示されません。

drawNow()メソッド 
public function drawNow():void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

invalidateNow とは異なり、すべてを無効化せずに直ちに描画を開始します。

getFocus()メソッド 
public function getFocus():InteractiveObject

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

現在フォーカスを持っているオブジェクトを取得します。

ただし、必ずしもフォーカスを持っているコンポーネントが返されるとは限りません。フォーカスを持っているコンポーネントの内部サブコンポーネントが返されることがあります。フォーカスを持っているコンポーネントを取得するには、focusManager.focus プロパティを使用します。

戻り値
InteractiveObject — フォーカスを持つオブジェクト。フォーカスを持つオブジェクトが存在しない場合は、null が返されます。
getStyle()メソッド 
public function getStyle(style:String):Object

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントのスタイル参照チェーンに設定されているスタイルプロパティを取得します。

このメソッドによって返される型は、取得されたスタイルプロパティによって異なります。戻り型としては、Boolean、String、Number、int、uint (RGB カラーの場合)、Class (スキンの場合) の他、さまざまな種類のオブジェクトが考えられます。

このメソッドで特定のスタイルプロパティを取得する場合、戻り型がわかっているのであれば同じ型の変数に格納できます。型変換は不要です。次のように、単純な代入ステートメントを使用することもできます。

var backgroundColor:uint = getStyle("backgroundColor");

指定したスタイルプロパティがスタイル参照チェーンに設定されていなかった場合、このメソッドは、undefined 値を返します。undefined は、false、""、NaN、0、または null とは異なる特別な値です。有効なスタイル値が undefined になることはありません。値が設定されたかどうかをテストするには、静的メソッド StyleManager.isValidStyleValue() を使用します。

パラメータ

style:String — スタイルプロパティの名前です。

戻り値
Object — スタイル値です。

関連項目




次の例では、DataGrid コンポーネントインスタンスを作成し、ComboBox コンポーネントのデフォルトのスタイルと現在のスタイルを表示します。

import fl.controls.ComboBox;
import fl.controls.DataGrid;
import fl.controls.dataGridClasses.DataGridColumn;
import fl.data.DataProvider;

var myComboBox:ComboBox = new ComboBox();
myComboBox.setStyle("textPadding", 6);
myComboBox.setStyle("disabledAlpha", 0.8);

var styleObject:Object = ComboBox.getStyleDefinition();
var styleDP:DataProvider = new DataProvider();
var styleName:String;
var styleDefaultValue:String;
var styleCurrentValue:String;

for (styleName in styleObject) {
    styleDefaultValue = String(styleObject[styleName]);
    styleCurrentValue = String(myComboBox.getStyle(styleName));
    styleDP.addItem({name:styleName, defaultValue:styleDefaultValue, currentValue:styleCurrentValue});
}
styleDP.sortOn("name", Array.CASEINSENSITIVE);

var c1:DataGridColumn = new DataGridColumn("name");
c1.headerText = "Style name:";
var c2:DataGridColumn = new DataGridColumn("defaultValue");
c2.headerText = "Default style value:";
var c3:DataGridColumn = new DataGridColumn("currentValue");
c3.headerText = "Current style value:"

var styleDataGrid:DataGrid = new DataGrid();
styleDataGrid.addColumn(c1); // name
styleDataGrid.addColumn(c2); // defaultValue
styleDataGrid.addColumn(c3); // currentValue
styleDataGrid.dataProvider = styleDP;
styleDataGrid.setSize(stage.stageWidth - 20, stage.stageHeight - 20);
styleDataGrid.move(10, 10);
addChild(styleDataGrid);
getStyleDefinition()メソッド 
public static function getStyleDefinition():Object

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

現在のコンポーネントのデフォルトスタイルマップを取得します。スタイルマップには、使用されているスタイルに基づき、コンポーネントの適切な型が保持されます。たとえば、disabledTextFormat スタイルには、null または TextFormat オブジェクトの値が保持されます。現在のコンポーネントに対し、これらのスタイルを使用して、setStyle() を呼び出すことができます。次のコードでは、指定したコンポーネントのデフォルトの disabledTextFormat スタイルがオーバーライドされます。

componentInstance.setStyle("disabledTextFormat", new TextFormat());

戻り値
Object — デフォルトスタイルのオブジェクトです。

関連項目




次の例では、複数のコンポーネントクラス用のスタイルブラウザを作成します。
import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane",    data:BaseScrollPane } );
dp.addItem( { label: "Button",             data:Button } );
dp.addItem( { label: "CellRenderer",    data:CellRenderer } );
dp.addItem( { label: "CheckBox",         data:CheckBox } );
dp.addItem( { label: "ColorPicker",     data:ColorPicker } );
dp.addItem( { label: "ComboBox",         data:ComboBox } );
dp.addItem( { label: "DataGrid",         data:DataGrid } );
dp.addItem( { label: "HeaderRenderer",    data:HeaderRenderer } );
dp.addItem( { label: "ImageCell",        data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label",             data:Label } );
dp.addItem( { label: "List",             data:List } );
dp.addItem( { label: "NumericStepper",     data:NumericStepper } );
dp.addItem( { label: "ProgressBar",     data:ProgressBar } );
dp.addItem( { label: "RadioButton",     data:RadioButton } );
dp.addItem( { label: "ScrollPane",         data:ScrollPane } );
dp.addItem( { label: "Slider",             data:Slider } );
dp.addItem( { label: "TextArea",         data:TextArea } );
dp.addItem( { label: "TextInput",         data:TextInput } );
dp.addItem( { label: "TileList",         data:TileList } );
dp.addItem( { label: "UILoader",         data:UILoader } );
dp.addItem( { label: "UIComponent",     data:UIComponent } );

var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);

var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);

function showStyleDefinition(e:Event):void {
    var componentClass:Class = e.target.selectedItem.data as Class;
    var styles:Object = componentClass["getStyleDefinition"].call(this);
    trace(styles.toString());
    var styleData:DataProvider = new DataProvider();
    for(var i:* in styles) {
        trace(i + " : " + styles[i]);
        styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
    }
    styleData.sortOn("StyleName");
    dg.dataProvider = styleData;
}
invalidate()メソッド 
public function invalidate(property:String, callLater:Boolean = true):void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

プロパティが無効であることを示し、指定がない限り、コンポーネントを次のフレームに再描画します。

パラメータ

property:String — 無効化するプロパティ。
 
callLater:Boolean (default = true) — 次のフレームでコンポーネントを再描画するかどうかを示すブール値。デフォルト値は true です。

mergeStyles()メソッド 
public static function mergeStyles(... list):Object

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

複数のクラスのスタイルを 1 つのオブジェクトに結合します。スタイルが複数のオブジェクトに定義されていた場合、最初に見つかったスタイルが使用されます。

パラメータ

... list — 結合するデフォルトスタイルを含むオブジェクトのカンマ区切りリスト。

戻り値
Object — 結合されたスタイルを含むデフォルトスタイルオブジェクト。
move()メソッド 
public function move(x:Number, y:Number):void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

親の内部の指定された位置にコンポーネントを移動します。この効果は、x プロパティと y プロパティを設定することによってコンポーネント位置を変更した場合と同じです。このメソッドを呼び出すと、ComponentEvent.MOVE イベントが送出されます。

カスタムコンポーネントで updateDisplayList() メソッドをオーバーライドするには、x プロパティと y プロパティを設定するのではなく、move() メソッドを使用するようにしてください。これは、move() メソッドを呼び出した場合、move 操作の完了後、直ちに move イベントオブジェクトが送出されるためです。これに対し、x プロパティと y プロパティを設定することによってコンポーネントの位置を変更した場合、次の画面更新時までイベントオブジェクトは送出されません。

パラメータ

x:Number — 親内のコンポーネント位置を指定する x 座標の値 (ピクセル単位)。この値は左端を基準に計算されます。
 
y:Number — 親内のコンポーネント位置を指定する y 座標の値 (ピクセル単位)。この値は上端を基準に計算されます。

関連項目

x
y
setFocus()メソッド 
public function setFocus():void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

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

メモ : このメソッドでフォーカスを設定した場合、フォーカスインジケータが表示されるのは TextInput および TextAreaコンポーネントだけです。ユーザーが Tab キーでコンポーネントを選択した場合、すべてのコンポーネントでフォーカスインジケータが表示されます。

setSize()メソッド 
public function setSize(width:Number, height:Number):void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントのサイズを、指定した幅と高さに設定します。

パラメータ

width:Number — コンポーネントの幅 (ピクセル単位)。
 
height:Number — コンポーネントの高さ (ピクセル単位)。

setStyle()メソッド 
public function setStyle(style:String, value:Object):void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

このコンポーネントインスタンスのスタイルプロパティを設定します。このスタイルは、グローバル設定されたスタイルをオーバーライドできます。

このメソッドを呼び出すと、パフォーマンスが低下することがあります。これは必要な場合のみ使用してください。

パラメータ

style:String — スタイルプロパティの名前です。
 
value:Object — スタイルの値。

関連項目




次の例では、ボタンに Georgia フォントを設定しています。
import fl.controls.Button;

var myFormat:TextFormat = new TextFormat();
myFormat.font = "Georgia";

var b:Button = new Button();
b.label = "Hello World";
b.setStyle("textFormat", myFormat);
addChild(b);

次の例では、Button コンポーネントインスタンスを作成し、外部アイコンイメージを動的にロードします。

import fl.controls.Button;

var flashIcon:Loader = new Loader();
flashIcon.contentLoaderInfo.addEventListener(Event.COMPLETE, completeHandler);
flashIcon.load(new URLRequest("http://www.helpexamples.com/flash/images/logo.png"));

var myButton:Button = new Button();
myButton.label = "Flash";
myButton.move(10, 10);
addChild(myButton);

function completeHandler(event:Event):void {
    flashIcon.width = 16;
    flashIcon.height = 16;
    myButton.setStyle("icon", flashIcon);
}
validateNow()メソッド 
public function validateNow():void

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

必要に応じて、このオブジェクトのプロパティとレイアウトを検証および更新し、それを再描画します。

相当量の計算を必要とするプロパティは、通常はスクリプトの実行が終了するまで処理されません。これは、1 つのプロパティを設定すると、場合によっては他のプロパティの処理まで必要になるためです。たとえば、width プロパティを設定するには、そのオブジェクトの子または親の幅も再計算する必要があります。さらに、オブジェクトの幅を何度も再計算すると、相互に依存するプロパティについても再計算が必要となる場合があります。このメソッドは、このビヘイビアを手動でオーバーライドする場合に使用します。

イベントの詳細
hide イベント
イベントオブジェクトの型: fl.events.ComponentEvent
ComponentEvent.type property = fl.events.ComponentEvent.HIDE

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントの可視性が可視から不可視に変化した後に送出されます。

type プロパティ (hide イベントオブジェクト) の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで event オブジェクトをアクティブに処理しているオブジェクトです。
targetイベントを送出したオブジェクトです。ターゲットは、必ずしもイベントを受け取るオブジェクトではありません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。



次の例では、List コンポーネントの表示と非表示を切り替える Button コンポーネントを作成します。

import fl.controls.Button;
import fl.controls.List;
import fl.events.ComponentEvent;
import fl.events.ListEvent;

var toggleButton:Button = new Button();
toggleButton.label = "toggle visibility";
toggleButton.toggle = true;
toggleButton.selected = true;
toggleButton.emphasized = toggleButton.selected;
toggleButton.addEventListener(Event.CHANGE, changeHandler);
toggleButton.width = 150;
toggleButton.move(10, 10);
addChild(toggleButton);

var myList:List = new List();
myList.addItem({label:"Item 1"});
myList.addItem({label:"Item 2"});
myList.addItem({label:"Item 3"});
myList.addItem({label:"Item 4"});
myList.addItem({label:"Item 5"});
myList.move(10, 40);
myList.addEventListener(ComponentEvent.HIDE, hideHandler);
myList.addEventListener(ComponentEvent.SHOW, showHandler);
myList.addEventListener(ListEvent.ITEM_ROLL_OVER, itemRollOverHandler);
myList.addEventListener(ListEvent.ITEM_ROLL_OUT, itemRollOverHandler);
addChild(myList);


function changeHandler(event:Event):void {
    toggleButton.emphasized = toggleButton.selected;
    myList.visible = toggleButton.selected;
}

function hideHandler(event:ComponentEvent):void {
    trace("hiding list");
    myList.removeEventListener(ListEvent.ITEM_ROLL_OVER, itemRollOverHandler);
    myList.removeEventListener(ListEvent.ITEM_ROLL_OUT, itemRollOverHandler);
}

function showHandler(event:ComponentEvent):void {
    trace("showing list");
    myList.addEventListener(ListEvent.ITEM_ROLL_OVER, itemRollOverHandler);
    myList.addEventListener(ListEvent.ITEM_ROLL_OUT, itemRollOverHandler);
}

function itemRollOverHandler(event:ListEvent):void {
    trace(event.type + ":", event.item.label);
}

function itemRollOutHandler(event:ListEvent):void {
    trace(event.type + ":", event.item.label);
}

関連項目

move イベント  
イベントオブジェクトの型: fl.events.ComponentEvent
ComponentEvent.type property = fl.events.ComponentEvent.MOVE

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントが移動された後に送出されます。

type プロパティ (move イベントオブジェクト) の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで event オブジェクトをアクティブに処理しているオブジェクトです。
targetイベントを送出したオブジェクトです。ターゲットは、必ずしもイベントを受け取るオブジェクトではありません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。



次の例では、Slider コンポーネントの値に基づいて、ステージ上にある UILoader コンポーネントインスタンスの位置を変更します。

import fl.controls.Slider;
import fl.containers.UILoader;
import fl.events.ComponentEvent;
import fl.events.SliderEvent;

var myUILoader:UILoader = new UILoader();
myUILoader.source = "http://www.helpexamples.com/flash/images/image3.jpg";
myUILoader.move(10, 20); 
myUILoader.addEventListener(ComponentEvent.MOVE, moveHandler);
addChild(myUILoader);

var mySlider:Slider = new Slider();
mySlider.liveDragging = true;
mySlider.minimum = myUILoader.x;
mySlider.maximum = myUILoader.x + 200;
mySlider.snapInterval = 1;
mySlider.tickInterval = 10;
mySlider.move(10, 10);
mySlider.addEventListener(SliderEvent.CHANGE, changeHandler);
addChild(mySlider);

function changeHandler(event:SliderEvent):void {
    myUILoader.x = event.value;
}

function moveHandler(event:ComponentEvent):void {
    trace("[move] x:" + event.currentTarget.x + ", y:" + event.currentTarget.y);
}
resize イベント  
イベントオブジェクトの型: fl.events.ComponentEvent
ComponentEvent.type property = fl.events.ComponentEvent.RESIZE

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントのサイズが変更された後に送出されます。

type プロパティ (resize イベントオブジェクト) の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで event オブジェクトをアクティブに処理しているオブジェクトです。
targetイベントを送出したオブジェクトです。ターゲットは、必ずしもイベントを受け取るオブジェクトではありません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。



次の例では、外部イメージを UILoader コンポーネントインスタンスにロードし、resize イベントと move() メソッドを使用して、ロードしたイメージをステージの中央に配置します。

import fl.containers.UILoader;
import fl.events.ComponentEvent;

var myUILoader:UILoader = new UILoader();
myUILoader.scaleContent = false;
myUILoader.addEventListener(ComponentEvent.RESIZE, resizeHandler);
myUILoader.source = "http://www.helpexamples.com/flash/images/image3.jpg";
addChild(myUILoader);

function resizeHandler(event:ComponentEvent):void {
    var myImg:UILoader = event.currentTarget as UILoader;
    var newX:uint = (stage.stageWidth - myImg.width) / 2;
    var newY:uint = (stage.stageHeight - myImg.height) / 2;
    myImg.move(newX, newY);
}
show イベント  
イベントオブジェクトの型: fl.events.ComponentEvent
ComponentEvent.type property = fl.events.ComponentEvent.SHOW

言語バージョン : ActionScript 3.0
Player のバージョン : Flash Player 9.0.28.0

コンポーネントの可視性が不可視から可視に変化した後に送出されます。

type プロパティ (show イベントオブジェクト) の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで event オブジェクトをアクティブに処理しているオブジェクトです。
targetイベントを送出したオブジェクトです。ターゲットは、必ずしもイベントを受け取るオブジェクトではありません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。



次の例では、List コンポーネントの表示と非表示を切り替える Button コンポーネントを作成します。

import fl.controls.Button;
import fl.controls.List;
import fl.events.ComponentEvent;
import fl.events.ListEvent;

var toggleButton:Button = new Button();
toggleButton.label = "toggle visibility";
toggleButton.toggle = true;
toggleButton.selected = true;
toggleButton.emphasized = toggleButton.selected;
toggleButton.addEventListener(Event.CHANGE, changeHandler);
toggleButton.width = 150;
toggleButton.move(10, 10);
addChild(toggleButton);

var myList:List = new List();
myList.addItem({label:"Item 1"});
myList.addItem({label:"Item 2"});
myList.addItem({label:"Item 3"});
myList.addItem({label:"Item 4"});
myList.addItem({label:"Item 5"});
myList.move(10, 40);
myList.addEventListener(ComponentEvent.HIDE, hideHandler);
myList.addEventListener(ComponentEvent.SHOW, showHandler);
myList.addEventListener(ListEvent.ITEM_ROLL_OVER, itemRollOverHandler);
myList.addEventListener(ListEvent.ITEM_ROLL_OUT, itemRollOverHandler);
addChild(myList);


function changeHandler(event:Event):void {
    toggleButton.emphasized = toggleButton.selected;
    myList.visible = toggleButton.selected;
}

function hideHandler(event:ComponentEvent):void {
    trace("hiding list");
    myList.removeEventListener(ListEvent.ITEM_ROLL_OVER, itemRollOverHandler);
    myList.removeEventListener(ListEvent.ITEM_ROLL_OUT, itemRollOverHandler);
}

function showHandler(event:ComponentEvent):void {
    trace("showing list");
    myList.addEventListener(ListEvent.ITEM_ROLL_OVER, itemRollOverHandler);
    myList.addEventListener(ListEvent.ITEM_ROLL_OUT, itemRollOverHandler);
}

function itemRollOverHandler(event:ListEvent):void {
    trace(event.type + ":", event.item.label);
}

function itemRollOutHandler(event:ListEvent):void {
    trace(event.type + ":", event.item.label);
}

関連項目





 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flash/9.0_jp/ActionScriptLangRefV3/fl/core/UIComponent.html