Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
mx.styles 

AdvancedStyleClient  - AS3 Flex

パッケージmx.styles
クラスpublic class AdvancedStyleClient
継承AdvancedStyleClient Inheritance EventDispatcher Inheritance Object
実装 IAdvancedStyleClient, IFlexModule, IMXMLObject
サブクラス GlobalizationBase, Sort, SortField

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

IAdvancedStyleClient インターフェイスを使用するオブジェクトを実装する際に使用できる基本クラスです。この基本クラスには、スタイルサブシステムにオブジェクトが参加するために必要なメソッドとプロパティの実装が用意されています。

IAdvancedStyleClient インターフェイスに加えて、このオブジェクトは、IFlexModule インターフェイスと IMXMLObject インターフェイスも実装します。 IMXMLObject インターフェイスには、MXML 宣言を使用してクラスがインスタンス化されるときに呼び出される initialized メソッドが含まれています。 この基本クラスで提供される initialized メソッドの実装は、MXML 宣言を含むドキュメントオブジェクトにクラスのインスタンスを追加します。 詳細については、initilized メソッドの説明を参照してください。

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
  className : String
[読み取り専用] コンポーネントクラスの名前です。
AdvancedStyleClient
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
  id : String
コンポーネントの ID です。
AdvancedStyleClient
  inheritingStyles : Object
このビジュアルでないスタイルクライアントのインスタンスの継承可能なスタイルを含むオブジェクトです。
AdvancedStyleClient
  moduleFactory : IFlexModuleFactory
モジュールファクトリは、このビジュアルでないスタイルクライアントのインスタンスのスタイルを制御するスタイルマネージャーを検索するためのコンテキストとして使用されます。
AdvancedStyleClient
  nonInheritingStyles : Object
このコンポーネントの非継承スタイルのチェーンの始まりです。
AdvancedStyleClient
  styleDeclaration : CSSStyleDeclaration
このオブジェクトで宣言されたインラインスタイルを保持するスタイル宣言です。
AdvancedStyleClient
  styleManager : IStyleManager2
[読み取り専用] このコンポーネントで使用する StyleManager インスタンスを返します。
AdvancedStyleClient
  styleName : Object
オブジェクトのスタイル値のソースです。
AdvancedStyleClient
  styleParent : IAdvancedStyleClient
コンポーネントの親は、下位要素のセレクターを評価するために使用されます。
AdvancedStyleClient
パブリックメソッド
 メソッド定義元
  
コンストラクターです。
AdvancedStyleClient
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
  
このコンポーネントインスタンスからスタイルプロパティを削除します。
AdvancedStyleClient
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
  
このコンポーネントに適用されるタイプセレクターの CSSStyleDeclaration オブジェクトの配列を返します。何も存在しない場合は null を返します。
AdvancedStyleClient
  
getStyle(styleProp:String):*
このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。
AdvancedStyleClient
  
currentCSSState が null でない場合、true を返します。
AdvancedStyleClient
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
  
initialized メソッドは、このクラスまたはこのクラスを拡張するクラスが MXML 宣言で使用されると呼び出されます。
AdvancedStyleClient
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
cssState が currentCSSState に一致した場合は、true を返します。
AdvancedStyleClient
  
このインスタンスが、指定されたタイプと同じであるのか、それともそのサブクラスであるのかを判別します。
AdvancedStyleClient
  
スタイルの変更を、このスタイルクライアントのインスタンスの子に通知します。
AdvancedStyleClient
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
  
getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。
AdvancedStyleClient
  
各エフェクトイベントのイベントリスナーの 1 つとして、EffectManager を登録します。
AdvancedStyleClient
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
setStyle(styleProp:String, newValue:*):void
このコンポーネントインスタンスのスタイルプロパティを設定します。
AdvancedStyleClient
  
スタイルプロパティの変更を検出します。
AdvancedStyleClient
  
コンポーネントのスタイルを初めて初期化するとき、Flex は stylesInitialized() メソッドを呼び出します。
AdvancedStyleClient
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント 概要 定義元
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
プロパティの詳細

className

プロパティ
className:String  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10.1, AIR 2.5

コンポーネントクラスの名前です。



実装
    public function get className():String

id

プロパティ 
id:String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

コンポーネントの ID です。



実装
    public function get id():String
    public function set id(value:String):void

inheritingStyles

プロパティ 
inheritingStyles:Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

このビジュアルでないスタイルクライアントのインスタンスの継承可能なスタイルを含むオブジェクトです。



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

moduleFactory

プロパティ 
moduleFactory:IFlexModuleFactory

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

モジュールファクトリは、このビジュアルでないスタイルクライアントのインスタンスのスタイルを制御するスタイルマネージャーを検索するためのコンテキストとして使用されます。



実装
    public function get moduleFactory():IFlexModuleFactory
    public function set moduleFactory(value:IFlexModuleFactory):void

nonInheritingStyles

プロパティ 
nonInheritingStyles:Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

このコンポーネントの非継承スタイルのチェーンの始まりです。 getStyle() メソッドは単に nonInheritingStyles[styleName] にアクセスして、プロトタイプリンクのチェーン全体を検索します。 このオブジェクトは initProtoChain() によって設定されます。 開発者は通常このプロパティに直接アクセスする必要はありません。



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

styleDeclaration

プロパティ 
styleDeclaration:CSSStyleDeclaration

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

このオブジェクトで宣言されたインラインスタイルを保持するスタイル宣言です。



実装
    public function get styleDeclaration():CSSStyleDeclaration
    public function set styleDeclaration(value:CSSStyleDeclaration):void

関連する API エレメント

styleManager

プロパティ 
styleManager:IStyleManager2  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

このコンポーネントで使用する StyleManager インスタンスを返します。



実装
    public function get styleManager():IStyleManager2

styleName

プロパティ 
styleName:Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

オブジェクトのスタイル値のソースです。 styleName プロパティの値は、次の 3 つの有効な型のうちのいずれかにすることができます。

  • String(例:"headerStyle")。 この文字列は、CSS スタイルシートで定義されたクラスセレクターの名前です。
  • CSSStyleDeclaration(例:StyleManager.getStyleDeclaration(".headerStyle"))。
  • UIComponent。このインターフェイスを実装するオブジェクトは、参照先の UIComponent からすべてのスタイル値を継承します。



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

styleParent

プロパティ 
styleParent:IAdvancedStyleClient

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

コンポーネントの親は、下位要素のセレクターを評価するために使用されます。高度なスタイル宣言に対応するには、親も IAdvancedStyleClient である必要があります。



実装
    public function get styleParent():IAdvancedStyleClient
    public function set styleParent(value:IAdvancedStyleClient):void
コンストラクターの詳細

AdvancedStyleClient

()コンストラクター
public function AdvancedStyleClient()

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

コンストラクターです。

メソッドの詳細

clearStyle

()メソッド
public function clearStyle(styleProp:String):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

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

getStyle() メソッドは、必ずしも undefined を返すわけではありません。

パラメーター

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

getClassStyleDeclarations

()メソッド 
public function getClassStyleDeclarations():Array

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

このコンポーネントに適用されるタイプセレクターの CSSStyleDeclaration オブジェクトの配列を返します。何も存在しない場合は null を返します。

例えば、コンポーネント MyButton が Button を継承するとします。 このメソッドでは、最初に MyButton セレクターを検索します。その後、Button タイプセレクターを検索し、最後に UIComponent タイプセレクターを検索します。

戻り値
Array — CSSStyleDeclaration オブジェクトの配列です。

getStyle

()メソッド 
public function getStyle(styleProp:String):*

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

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

この同じメソッドを使用して任意の種類のスタイルプロパティを取得するため、戻り値は、Boolean、String、Number、int、uint(RGB カラーの場合)、Class(スキンの場合)、または何らかのオブジェクトになります。 したがって、戻り値の型は * として指定されます。

特定のスタイルプロパティを取得している場合は、その型を認識し、その型の変数に結果を保存することがよくあります。 これを行うには、以下のように as 演算子または強制型変換を使用します。 次に実際の使用例を示します。

      var backgroundColor:uint = getStyle("backgroundColor") as int;
      
      or
      
      var backgroundColor:uint = int(getStyle("backgroundColor"));
      

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

パラメーター

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

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

hasCSSState

()メソッド 
public function hasCSSState():Boolean

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.6
ランタイムバージョン: Flash Player 10, AIR 2.5

currentCSSStatenull でない場合、true を返します。通常、このメソッドは直接呼び出さないでください。このメソッドは、mx.styles.CSSCondition.matchesStyleClient() メソッドによって呼び出されます。

Spark コンポーネントは、スキンステートを擬似ステートとして使用します。Halo コンポーネントは、currentState プロパティを使用します。

戻り値
BooleancurrentCSSStatenull でない場合、true になります。デフォルトでは、currentCSSStatecurrentState と同じです。ステートが存在しない場合は、false を返します。

initialized

()メソッド 
public function initialized(document:Object, id:String):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

initialized メソッドは、このクラスまたはこのクラスを拡張するクラスが MXML 宣言で使用されると呼び出されます。実装オブジェクトが作成され、MXML タグに指定されたすべてのコンポーネントプロパティが初期化された後に呼び出されます。

このオブジェクトを作成したドキュメントが UIComponent(アプリケーション、モジュールなど)の場合は、UIComponent の addStyleClient メソッドが呼び出されて、UIComponent のビジュアルではないスタイルクライアントのリストに、このオブジェクトが追加されます。 これにより、オブジェクトはドキュメントからスタイルを継承できます。

パラメーター

document:Object — このオブジェクトを作成した MXML ドキュメントです。
 
id:String — ドキュメントオブジェクトがこのオブジェクトを参照するために使用する識別子です。

matchesCSSState

()メソッド 
public function matchesCSSState(cssState:String):Boolean

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

cssStatecurrentCSSState に一致した場合は、true を返します。通常、このメソッドは直接呼び出さないでください。このメソッドは、mx.styles.CSSCondition.matchesStyleClient() メソッドによって呼び出されます。

Spark コンポーネントは、スキンステートを擬似ステートとして使用します。Halo コンポーネントは、currentState プロパティを使用します。

パラメーター

cssState:StringCSSCondition.value の有効な値。これは、CSS 擬似セレクターの照合に使用されるこのコンポーネントの現在のステートを表します。

戻り値
BooleancssStatecurrentCSSState に一致した場合は、true を返します。デフォルトでは、currentCSSStatecurrentState と同じです。ステートが存在しない場合は、null を返します。

matchesCSSType

()メソッド 
public function matchesCSSType(cssType:String):Boolean

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

このインスタンスが、指定されたタイプと同じであるのか、それともそのサブクラスであるのかを判別します。通常、このメソッドは直接呼び出さないでください。このメソッドは、mx.styles.CSSCondition.matchesStyleClient() メソッドによって呼び出されます。

パラメーター

cssType:String — CSSSelector オブジェクト。

戻り値
BooleancssType が修飾されたタイプセレクターの階層にある場合は true です。

notifyStyleChangeInChildren

()メソッド 
public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

スタイルの変更を、このスタイルクライアントのインスタンスの子に通知します。ビジュアルでないスタイルクライアント(つまり、DisplayObject でないスタイルクライアント)には子がありません。そのため、このメソッドは、ビジュアルでないスタイルクライアントに対しては、何もしません。

パラメーター

styleProp:String — スタイルプロパティの名前です。
 
recursive:Boolean — スタイルの変更を子の子に反映するかどうかを指定します。

regenerateStyleCache

()メソッド 
public function regenerateStyleCache(recursive:Boolean):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。

パラメーター

recursive:Boolean — 子のプロトチェーンを再生成します。

registerEffects

()メソッド 
public function registerEffects(effects:Array):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

各エフェクトイベントのイベントリスナーの 1 つとして、EffectManager を登録します。

パラメーター

effects:Array — エフェクト名を表すストリングの配列です。

setStyle

()メソッド 
public function setStyle(styleProp:String, newValue:*):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

このコンポーネントインスタンスのスタイルプロパティを設定します。

これは、グローバル設定されたスタイルをオーバーライドできます。

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

パラメーター

styleProp:String — スタイルプロパティの名前です。
 
newValue:* — スタイルの新しい値です。

styleChanged

()メソッド 
public function styleChanged(styleProp:String):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

スタイルプロパティの変更を検出します。何らかのスタイルプロパティが設定されていると、Flex が styleChanged() メソッドを呼び出し、設定されているスタイルの名前を渡します。

これは、AdvancedStyleClient のサブクラスを作成するときにオーバーライド可能な高度なメソッドです。 カスタムクラスを作成するときには、渡されたスタイル名をチェックし、その結果に従って変更内容を処理するよう、styleChanged() メソッドをオーバーライドできます。 これにより、既存スタイルのデフォルト動作をオーバーライドできるだけでなく、独自のスタイルプロパティを追加することもできます。

パラメーター

styleProp:String — スタイルプロパティの名前です。このスタイルクライアントのすべてのスタイルが変更された場合は、null になります。

stylesInitialized

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4.5
ランタイムバージョン: Flash Player 10, AIR 2.5

コンポーネントのスタイルを初めて初期化するとき、Flex は stylesInitialized() メソッドを呼び出します。





[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。