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

IStyleClient  - AS3 Flex

パッケージmx.styles
インターフェイスpublic interface IStyleClient extends ISimpleStyleClient
実装者 AdvancedDataGridItemRenderer, DataGridItemRenderer, DefaultGridItemRenderer, FTEAdvancedDataGridItemRenderer, FTEDataGridItemRenderer, HaloFocusRect, UITextFieldGridItemRenderer

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

このインターフェイスは、オブジェクトがスタイルサブシステムに完全に対応するために実装しなければならないプロパティとメソッドを示します。 このインターフェイスは UIComponent によって実装されます。

オブジェクトは、スタイル値をローカルに保存する必要がない場合、代わりに ISimpleStyleClient インターフェイスを実装します。

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
  className : String
[読み取り専用] コンポーネントクラスの名前です。
IStyleClient
  inheritingStyles : Object
このコンポーネントの継承可能なスタイルを格納するオブジェクトです。
IStyleClient
  nonInheritingStyles : Object
このコンポーネントの継承不可能なスタイルを格納するオブジェクトです。
IStyleClient
  styleDeclaration : CSSStyleDeclaration
このオブジェクトで宣言されたインラインスタイルを保持するスタイル宣言です。
IStyleClient
 InheritedstyleName : Object
オブジェクトのスタイル値のソースです。
ISimpleStyleClient
パブリックメソッド
 メソッド定義元
  
このコンポーネントインスタンスからスタイルプロパティを削除します。
IStyleClient
  
このコンポーネントに適用されるタイプセレクターの CSSStyleDeclaration オブジェクトの配列を返します。何も存在しない場合は null を返します。
IStyleClient
  
getStyle(styleProp:String):*
このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。
IStyleClient
  
このコンポーネントの子にスタイルの変更を反映します。
IStyleClient
  
getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。
IStyleClient
  
各エフェクトイベントのイベントリスナーの 1 つとして、EffectManager を登録します。
IStyleClient
  
setStyle(styleProp:String, newValue:*):void
このコンポーネントインスタンスのスタイルプロパティを設定します。
IStyleClient
 Inherited
スタイルプロパティの値が変化したときに呼び出されます。
ISimpleStyleClient
プロパティの詳細

className

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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



実装
    public function get className():String

inheritingStyles

プロパティ 
inheritingStyles:Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

このコンポーネントの継承可能なスタイルを格納するオブジェクトです。



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

nonInheritingStyles

プロパティ 
nonInheritingStyles:Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

このコンポーネントの継承不可能なスタイルを格納するオブジェクトです。



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

styleDeclaration

プロパティ 
styleDeclaration:CSSStyleDeclaration

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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



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

関連する API エレメント

メソッドの詳細

clearStyle

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

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

パラメーター

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

getClassStyleDeclarations

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

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

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

getStyle

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

この同じメソッドを使用して任意の種類のスタイルプロパティを取得するため、戻り値は、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 — スタイルプロパティの名前です。

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

notifyStyleChangeInChildren

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

このコンポーネントの子にスタイルの変更を反映します。

パラメーター

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

regenerateStyleCache

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。 このオブジェクトに既に子がある場合に、その子のスタイルキャッシュを再初期化します。

パラメーター

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

registerEffects

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

パラメーター

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

setStyle

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

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

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

パラメーター

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





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

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