Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
IAdvancedStyleClient

Package | mx.styles
Interface | public interface IAdvancedStyleClient extends IStyleClient, ISimpleStyleClient
Implementors | AdvancedStyleClient, Sort, SortField, StyleProxy, UIComponent

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

This interface describes the advanced properties that a component must implement to fully participate in the advanced style subsystem.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | className : String [read-only] The name of the component class. | IStyleClient
|  | id : String [read-only] The identity of the component. | IAdvancedStyleClient
|  | inheritingStyles : Object An object containing the inheritable styles for this component. | IStyleClient
|  | nonInheritingStyles : Object An object containing the noninheritable styles for this component. | IStyleClient
|  | styleDeclaration : CSSStyleDeclaration The style declaration that holds the inline styles declared by this object. | IStyleClient
|  | styleName : Object The source of this object's style values. | ISimpleStyleClient
|  | styleParent : IAdvancedStyleClient The parent of this IAdvancedStyleClient.. | IAdvancedStyleClient

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | IStyleClient
|  | getClassStyleDeclarations():Array Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist. | IStyleClient
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | IStyleClient
|  | hasCSSState():Boolean Returns true if currentCSSState is not null. | IAdvancedStyleClient
|  | matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState. | IAdvancedStyleClient
|  | matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type. | IAdvancedStyleClient
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children of this component. | IStyleClient
|  | regenerateStyleCache(recursive:Boolean):void Sets up the internal style cache values so that the getStyle() method functions. | IStyleClient
|  | registerEffects(effects:Array):void Registers the EffectManager as one of the event listeners for each effect event. | IStyleClient
|  | setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance. | IStyleClient
|  | styleChanged(styleProp:String):void Called when the value of a style property is changed. | ISimpleStyleClient
|  | stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized. | IAdvancedStyleClient

Property Detail

id | property

`id:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The identity of the component.

Implementation
`public function get id():String`

styleParent | property |

`styleParent:IAdvancedStyleClient`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The parent of this `IAdvancedStyleClient`.. Typically, you do not assign this property directly. It is set by the `addChild, addChildAt, removeChild, and removeChildAt` methods of the `flash.display.DisplayObjectContainer` and the `mx.core.UIComponent.addStyleClient()` and the `mx.core.UIComponent.removeStyleClient()` methods. If it is assigned a value directly, without calling one of the above mentioned methods the instance of the class that implements this interface will not inherit styles from the UIComponent or DisplayObject. Also if assigned a value directly without, first removing the object from the current parent with the remove methods listed above, a memory leak could occur.

Implementation
`public function get styleParent():IAdvancedStyleClient`
`public function set styleParent(value:IAdvancedStyleClient):void`
Method Detail

hasCSSState | () | method

`public function hasCSSState():Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.6

Runtime Versions : | Flash Player 10, AIR 2.5

Returns `true` if `currentCSSState` is not `null`. Typically, you do not call this method directly. It is called by the `mx.styles.CSSCondition.matchesStyleClient()` method.

Note Spark components use their skin state as the pseudo state. Halo components use the `currentState` property.

Returns

| `Boolean` — `true` if `currentCSSState` is not `null`. By default, `currentCSSState` is the same as `currentState`. If no state exists, return false.

matchesCSSState | () | method |

`public function matchesCSSState(cssState:String):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns `true` if `cssState` matches `currentCSSState`. Typically, you do not call this method directly. It is called by the `mx.styles.CSSCondition.matchesStyleClient()` method.

Note Spark components use their skin state as the pseudo state. Halo components use the `currentState` property.

Parameters

| `cssState:String` — A possible value of `CSSCondition.value`. It represents the current state of this component used to match CSS pseudo-selectors.

Returns

| `Boolean` — `true` if `cssState` matches `currentCSSState`. By default, `currentCSSState` is the same as `currentState`. If no state exists, return null.

matchesCSSType | () | method |

`public function matchesCSSType(cssType:String):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Determines whether this instance is the same as, or is a subclass of, the given type. Typically, you do not call this method directly. It is called by the `mx.styles.CSSCondition.matchesStyleClient()` method.

Parameters

| `cssType:String` — A CSSSelector object.

Returns

| `Boolean` — `true` if `cssType` is in the hierarchy of qualified type selectors.

stylesInitialized | () | method |

`public function stylesInitialized():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Flex calls the `stylesInitialized()` method when the styles for a component are first initialized.

Wed Nov 15 2017, 09:50 AM +01:00