Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Wraps an object that implements the IAdvancedStyleClient interface. This
interface supports a
filterMap
property that contains
style-source/style-destination pairs.
className:String
[read-only]
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The name of the component class.
Implementation public function get className():String
filterMap:Object
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
A set of string pairs. The first item of the string pair is the name of the style
in the source component. The second item of the String pair is the name of the style
in the subcomponent. With this object, you can map a particular style in the parent component
to a different style in the subcomponent. This is useful if both the parent
component and the subcomponent share the same style, but you want to be able to
control the values seperately.
Implementation public function get filterMap():Object
public function set filterMap(value:Object):void
id:String
[read-only]
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The identity of the component.
Implementation public function get id():String
inheritingStyles:Object
Language Version: | ActionScript 3.0 |
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:Object
Language Version: | ActionScript 3.0 |
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
source:IStyleClient
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The object that implements the IStyleClient interface. This is the object
that is being proxied.
Implementation public function get source():IStyleClient
public function set source(value:IStyleClient):void
styleDeclaration:CSSStyleDeclaration
Language Version: | ActionScript 3.0 |
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
styleName:Object
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The source of this object's style values.
The value of the styleName
property can be one of three possible types:
- String, such as "headerStyle". The String names a class selector that is defined in a CSS style sheet.
- CSSStyleDeclaration, such as
StyleManager.getStyleDeclaration(".headerStyle")
. - UIComponent. The object that implements this interface inherits all the style values from the referenced UIComponent.
Implementation public function get styleName():Object
public function set styleName(value:Object):void
styleParent:IAdvancedStyleClient
[read-only]
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The parent of this component.
Implementation public function get styleParent():IAdvancedStyleClient
public function StyleProxy(source:IStyleClient, filterMap:Object)
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Parameters | source:IStyleClient — The object that implements the IStyleClient interface.
|
|
| filterMap:Object — The set of styles to pass from the source to the subcomponent.
|
public function clearStyle(styleProp:String):void
Language Version: | ActionScript 3.0 |
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.
|
public function getClassStyleDeclarations():Array
Language Version: | ActionScript 3.0 |
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.
|
public function getStyle(styleProp:String):*
Language Version: | ActionScript 3.0 |
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 public function matchesCSSState(cssState:String):Boolean
Language Version: | ActionScript 3.0 |
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.
|
public function matchesCSSType(cssType:String):Boolean
Language Version: | ActionScript 3.0 |
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.
|
public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Language Version: | ActionScript 3.0 |
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.
|
public function regenerateStyleCache(recursive:Boolean):void
Language Version: | ActionScript 3.0 |
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.
|
public function registerEffects(effects:Array):void
Language Version: | ActionScript 3.0 |
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.
|
public function setStyle(styleProp:String, newValue:*):void
Language Version: | ActionScript 3.0 |
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.
|
public function styleChanged(styleProp:String):void
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called when the value of a style property is changed.
Parameters
| styleProp:String — The name of the style property that changed.
|
public function stylesInitialized():void
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Flex calls the stylesInitialized()
method when
the styles for a component are first initialized.