パッケージmx.styles
インターフェイスpublic interface IStyleClient extends ISimpleStyleClient
インプリメンタDataGridItemRenderer, HaloFocusRect, UIComponent

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

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

関連項目

mx.styles.ISimpleStyleClient
mx.styles.CSSStyleDeclaration


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

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

実装
    public function get className():String
inheritingStylesプロパティ 
inheritingStyles:Object  [read-write]

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

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

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

実装
    public function get nonInheritingStyles():Object
    public function set nonInheritingStyles(value:Object):void
styleDeclarationプロパティ 
styleDeclaration:CSSStyleDeclaration  [read-write]

このオブジェクトで使用するスタイル宣言です。

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

関連項目

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

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

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

パラメータ
styleProp:String — スタイルプロパティの名前です。
getClassStyleDeclarations()メソッド 
public function getClassStyleDeclarations():Array

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

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

戻り値
Array — CSSStyleDeclaration オブジェクトの配列です。
getStyle()メソッド 
public function getStyle(styleProp:String):*

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

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

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

パラメータ
styleProp:String — スタイルプロパティの名前です。
 
recursive:Boolean — スタイルの変更を、子の子に反映します。
regenerateStyleCache()メソッド 
public function regenerateStyleCache(recursive:Boolean):void

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

パラメータ
recursive:Boolean — 子のプロトチェーンを再生成します。
registerEffects()メソッド 
public function registerEffects(effects:Array):void

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

パラメータ
effects:Array — エフェクト名を表すストリングの配列です。
setStyle()メソッド 
public function setStyle(styleProp:String, newValue:*):void

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

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

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

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