mx.styles.IStyleClient - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.styles
Interface	public interface IStyleClient extends ISimpleStyleClient
Implementors	AdvancedDataGridItemRenderer, DataGridItemRenderer, FTEAdvancedDataGridItemRenderer, FTEDataGridItemRenderer, HaloFocusRect

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

This interface describes the properties and methods that an object must implement so that it can fully participate in the style subsystem. This interface is implemented by UIComponent.

If the object does not need to store style values locally, it can implement the ISimpleStyleClient interface instead.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		className : String [read-only] The name of the component class.	IStyleClient
		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

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
		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

Property Detail

className

property

className:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The name of the component class.

Implementation
public function get className():String

inheritingStyles

property

inheritingStyles:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

An object containing the inheritable styles for this component.

Implementation
public function get inheritingStyles():Object
public function set inheritingStyles(value:Object):void

nonInheritingStyles

property

nonInheritingStyles:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

An object containing the noninheritable styles for this component.

Implementation
public function get nonInheritingStyles():Object
public function set nonInheritingStyles(value:Object):void

styleDeclaration

property

styleDeclaration:CSSStyleDeclaration

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The style declaration that holds the inline styles declared by this object.

Implementation
public function get styleDeclaration():CSSStyleDeclaration
public function set styleDeclaration(value:CSSStyleDeclaration):void

clearStyle

()

method

public function clearStyle(styleProp:String):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Deletes a style property from this component instance.

This does not necessarily cause the getStyle() method to return undefined.

Parameters

styleProp:String — Name of the style property.

getClassStyleDeclarations

()

method

public function getClassStyleDeclarations():Array

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist.

For example, suppose that component MyButton extends Button. This method first looks for a MyButton selector; then, it looks for a Button type selector; finally, it looks for a UIComponent type selector.

Returns

Array — Array of CSSStyleDeclaration objects.

getStyle

()

method

public function getStyle(styleProp:String):*

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Gets a style property that has been set anywhere in this component's style lookup chain.

This same method is used to get any kind of style property, so the value returned may be a Boolean, String, Number, int, uint (for an RGB color), Class (for a skin), or any kind of object. Therefore the return type is specified as *.

If you are getting a particular style property, you will know its type and will often want to store the result in a variable of that type. You can use either the as operator or coercion to do this. For example:

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

If the style property has not been set anywhere in the style lookup chain, the value returned by the getStyle() method is undefined. Note that undefined is a special value that is not the same as false, the empty String (""), NaN, 0, or null. No valid style value is ever undefined. You can use the static method StyleManager.isValidStyleValue() to test whether the value was set.

Parameters

styleProp:String — Name of the style property.

Returns

* — Style value.

notifyStyleChangeInChildren

()

method

public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Propagates style changes to the children of this component.

Parameters

	`styleProp:String` — Name of the style property.

	`recursive:Boolean` — Whether to propagate the style changes to the children's children.

regenerateStyleCache

()

method

public function regenerateStyleCache(recursive:Boolean):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Sets up the internal style cache values so that the getStyle() method functions. If this object already has children, then reinitialize the children's style caches.

Parameters

recursive:Boolean — Regenerate the proto chains of the children.

registerEffects

()

method

public function registerEffects(effects:Array):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Registers the EffectManager as one of the event listeners for each effect event.

Parameters

effects:Array — An Array of Strings of effect names.

setStyle

()

method

public function setStyle(styleProp:String, newValue:*):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Sets a style property on this component instance.

This may override a style that was set globally.

Calling the setStyle() method can result in decreased performance. Use it only when necessary.

Parameters

	`styleProp:String` — Name of the style property.

	`newValue:*` — New value for the style.