| Package | mx.styles |
| Class | public class AdvancedStyleClient |
| Inheritance | AdvancedStyleClient  EventDispatcher Object |
| Implements | IAdvancedStyleClient, IFlexModule, IMXMLObject |
| Subclasses | GlobalizationBase, Sort, SortField |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
IAdvancedStyleClient interface. The base class supplies
implementations of the methods and properties required for an object
to participate in the style subsystem.
In addition to the IAdvancedStyleClient interface,
this object also implements the IFlexModule and
IMXMLObject interfaces. The IMXMLObject
interface contains an initialized method that is called
when the class is instantiated using an MXML declaration.
The implementation of the initialized method provided
by this base class will add the class instance to the document object
that contains the MXML declaration. For more details, see the description
of the initilized method.
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| className : String [read-only]
The name of the component class. | AdvancedStyleClient | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| id : String
The identity of the component. | AdvancedStyleClient | ||
| inheritingStyles : Object
An object containing the inheritable styles for this non-visual
style client instance. | AdvancedStyleClient | ||
| moduleFactory : IFlexModuleFactory
A module factory is used as context for
finding the style manager that controls the styles for this
non-visual style client instance. | AdvancedStyleClient | ||
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | AdvancedStyleClient | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| styleDeclaration : CSSStyleDeclaration
The style declaration that holds the inline styles declared by this
object. | AdvancedStyleClient | ||
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | AdvancedStyleClient | ||
| styleName : Object
The source of this object's style values. | AdvancedStyleClient | ||
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | AdvancedStyleClient | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | AdvancedStyleClient | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
Deletes a style property from this component instance. | AdvancedStyleClient | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
Returns an Array of CSSStyleDeclaration objects for the type selector
that applies to this component, or null if none exist. | AdvancedStyleClient | ||
Gets a style property that has been set anywhere in this
component's style lookup chain. | AdvancedStyleClient | ||
Returns true if currentCSSState is not null. | AdvancedStyleClient | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
The initialized method is called when this class or a class that
extends this class is used in an MXML declaration. | AdvancedStyleClient | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Returns true if cssState matches currentCSSState. | AdvancedStyleClient | ||
Determines whether this instance is the same as, or is a subclass of,
the given type. | AdvancedStyleClient | ||
Propagates style changes to the children of this style client
instance. | AdvancedStyleClient | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
Sets up the internal style cache values so that the
getStyle()
method functions. | AdvancedStyleClient | ||
Registers the EffectManager as one of the event listeners
for each effect event. | AdvancedStyleClient | ||
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
Sets a style property on this component instance. | AdvancedStyleClient | ||
Detects changes to style properties. | AdvancedStyleClient | ||
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | AdvancedStyleClient | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
className | property |
id | property |
inheritingStyles | property |
inheritingStyles:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
An object containing the inheritable styles for this non-visual style client instance.
Implementation
public function get inheritingStyles():Object public function set inheritingStyles(value:Object):voidmoduleFactory | property |
moduleFactory:IFlexModuleFactory| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
A module factory is used as context for finding the style manager that controls the styles for this non-visual style client instance.
Implementation
public function get moduleFactory():IFlexModuleFactory public function set moduleFactory(value:IFlexModuleFactory):voidnonInheritingStyles | property |
nonInheritingStyles:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
The beginning of this component's chain of non-inheriting styles.
The getStyle() method simply accesses
nonInheritingStyles[styleName] to search the entire
prototype-linked chain.
This object is set up by initProtoChain().
Developers typically never need to access this property directly.
Implementation
public function get nonInheritingStyles():Object public function set nonInheritingStyles(value:Object):voidstyleDeclaration | property |
styleDeclaration:CSSStyleDeclaration| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
The style declaration that holds the inline styles declared by this object.
Implementation
public function get styleDeclaration():CSSStyleDeclaration public function set styleDeclaration(value:CSSStyleDeclaration):voidRelated API Elements
styleManager | property |
styleManager:IStyleManager2 [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Returns the StyleManager instance used by this component.
Implementation
public function get styleManager():IStyleManager2styleName | property |
styleName:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
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):voidstyleParent | property |
styleParent:IAdvancedStyleClient| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
A component's parent is used to evaluate descendant selectors. A parent must also be an IAdvancedStyleClient to participate in advanced style declarations.
Implementation
public function get styleParent():IAdvancedStyleClient public function set styleParent(value:IAdvancedStyleClient):voidAdvancedStyleClient | () | Constructor |
public function AdvancedStyleClient()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Constructor.
clearStyle | () | method |
public function clearStyle(styleProp:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
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 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
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.
ReturnsArray — Array of CSSStyleDeclaration objects.
|
getStyle | () | method |
public function getStyle(styleProp:String):*| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
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.
|
* — Style value.
|
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.
Boolean — true if currentCSSState is not null.
By default, currentCSSState is the same as currentState.
If no state exists, return false.
|
initialized | () | method |
public function initialized(document:Object, id:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
The initialized method is called when this class or a class that extends this class is used in an MXML declaration. It is called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
If the document that created this object is a UIComponent,
(e.g. Application, Module, etc.) then the UIComponent's
addStyleClient method will be called to add this object to the
UIComponent's list of non-visual style clients. This allows the
object to inherit styles from the document.
Parameters
document:Object — The MXML document that created this object.
| |
id:String — The identifier used by the document object to refer to
this object.
|
matchesCSSState | () | method |
public function matchesCSSState(cssState:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.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.
|
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.5 |
| Runtime Versions: | Flash Player 10, AIR 2.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.
|
Boolean — true if cssType is in the hierarchy of qualified type selectors.
|
notifyStyleChangeInChildren | () | method |
public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Propagates style changes to the children of this style client instance. A non-visual style client (i.e. a style client that is not a DisplayObject) does not have children, therefore this method does not do anything for non-visual style clients.
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 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Sets up the internal style cache values so that the
getStyle()
method functions.
Parameters
recursive:Boolean — Regenerate the proto chains of the children.
|
registerEffects | () | method |
setStyle | () | method |
public function setStyle(styleProp:String, newValue:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
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.
|
styleChanged | () | method |
public function styleChanged(styleProp:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Detects changes to style properties. When any style property is set,
Flex calls the styleChanged() method,
passing to it the name of the style being set.
This is an advanced method that you might override
when creating a subclass of AdvancedStyleClient.
When you create a custom class,
you can override the styleChanged() method
to check the style name passed to it, and handle the change
accordingly.
This lets you override the default behavior of an existing style,
or add your own custom style properties.
Parameters
styleProp:String — The name of the style property, or null if all
styles for this
style client have changed.
|
stylesInitialized | () | method |
public function stylesInitialized():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4.5 |
| Runtime Versions: | Flash Player 10, AIR 2.5 |
Flex calls the stylesInitialized() method when
the styles for a component are first initialized.
Mon Nov 28 2011, 06:48 AM -08:00