| Package | mx.styles |
| Class | public class StyleManager |
| Inheritance | StyleManager  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
- Which CSS style properties the class inherits
- Which style properties are colors, and therefore get special handling
- A list of strings that are aliases for color values
More examples
Styles and style modules in multi-versioned applications
StyleManager class
Using the StyleManager class
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| selectors : Array Deprecated since 4.0: Please Use IStyleManager2.selectors on a style manager instance [static] [read-only]
Returns an Array of all the CSS selectors that are registered with the StyleManager. | StyleManager | ||
| Method | Defined By | ||
|---|---|---|---|
Deprecated since 4.0: Please Use IStyleManager2.clearStyleDeclaration on a style manager instance [static]
Clears the CSSStyleDeclaration object that stores the rules
for the specified CSS selector. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.getColorName on a style manager instance [static]
Returns the numeric RGB color value that corresponds to the
specified color string. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.getColorNames on a style manager instance [static]
Converts each element of the colors Array from a color name
to a numeric RGB color value. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.getStyleDeclaration on a style manager instance [static]
Gets the CSSStyleDeclaration object that stores the rules
for the specified CSS selector. | StyleManager | ||
[static]
Returns the style manager for an object. | StyleManager | ||
|
Indicates whether an object has a specified property defined. | Object | |
Deprecated since 4.0: Please Use IStyleManager2.isColorName on a style manager instance [static]
Tests to see if the given String is an alias for a color value. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.isInheritingStyle on a style manager instance [static]
Tests to see if a style is inheriting. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.isInheritingTextFormatStyle on a style manager instance [static]
Test to see if a TextFormat style is inheriting. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.isParentDisplayListInvalidatingStyle on a style manager instance [static]
Tests to see if this style affects the component's parent container in
such a way as to require that the parent container redraws itself when this style changes. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.isParentSizeInvalidatingStyle on a style manager instance [static]
Tests to see if the style changes the size of the component's parent container. | StyleManager | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Deprecated since 4.0: Please Use IStyleManager2.isSizeInvalidatingStyle on a style manager instance [static]
Tests to see if a style changes the size of a component. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.isValidStyleValue on a style manager instance [static]
Determines if a specified parameter is a valid style property. | StyleManager | ||
loadStyleDeclarations(url:String, update:Boolean = true, trustContent:Boolean = false, applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null):IEventDispatcher Deprecated since 4.0: Please Use IStyleManager2.loadStyleDeclarations on a style manager instance [static]
Loads a style SWF. | StyleManager | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
Deprecated since 4.0: Please Use IStyleManager2.registerColorName on a style manager instance [static]
Adds a color name to the list of aliases for colors. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.registerInheritingStyle on a style manager instance [static]
Adds to the list of styles that can inherit values
from their parents. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.registerParentDisplayListInvalidatingStyle on a style manager instance [static]
Adds to the list of styles which may affect the appearance
or layout of the component's parent container. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.registerParentSizeInvalidatingStyle on a style manager instance [static]
Adds to the list of styles which may affect the measured size
of the component's parent container. | StyleManager | ||
Deprecated since 4.0: Please Use IStyleManager2.registerSizeInvalidatingStyle on a style manager instance [static]
Adds to the list of styles which may affect the measured size
of the component. | StyleManager | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
Deprecated since 4.0: Please Use IStyleManager2.setStyleDeclaration on a style manager instance [static]
Sets the CSSStyleDeclaration object that stores the rules
for the specified CSS selector. | StyleManager | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
Deprecated since 4.0: Please Use IStyleManager2.unloadStyleDeclarations on a style manager instance [static]
Unloads a style SWF. | StyleManager | ||
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| NOT_A_COLOR : uint = 0xFFFFFFFF [static]
The getColorName() method returns this value if the passed-in
String is not a legitimate color name. | StyleManager | ||
selectors | property |
selectors:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns an Array of all the CSS selectors that are registered with the StyleManager.
You can pass items in this Array to the getStyleDeclaration() method to get the corresponding CSSStyleDeclaration object.
Class selectors are prepended with a period.
Implementation
public static function get selectors():ArrayclearStyleDeclaration | () | method |
public static function clearStyleDeclaration(selector:String, update:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Clears the CSSStyleDeclaration object that stores the rules for the specified CSS selector.
If the specified selector is a class selector (for example, ".bigMargins" or ".myStyle"),
you must be sure to start the
selector property with a period (.).
If the specified selector is a type selector (for example, "Button"), do not start the
selector property with a period.
The global selector is similar to a type selector
and does not start with a period.
Parameters
selector:String — The name of the CSS selector to clear.
| |
update:Boolean — Set to true to force an immediate update of the styles.
Set to false to avoid an immediate update of the styles in the application.
For more information about this method, see the description in the setStyleDeclaration()
method.
|
Related API Elements
getColorName | () | method |
public static function getColorName(colorName:Object):uint| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the numeric RGB color value that corresponds to the
specified color string.
The color string can be either a case-insensitive color name
such as "red", "Blue", or
"haloGreen", a hexadecimal value such as 0xFF0000, or a #-hexadecimal String
such as "#FF0000".
This method returns a uint, such as 4521830, that represents a color. You can convert
this uint to a hexadecimal value by passing the numeric base (in this case, 16), to
the uint class's toString() method, as the following example shows:
import mx.styles.StyleManager;
private function getNewColorName():void {
StyleManager.registerColorName("soylentGreen",0x44FF66);
trace(StyleManager.getColorName("soylentGreen").toString(16));
}
Parameters
colorName:Object — The color name.
|
uint — Returns a uint that represents the color value or NOT_A_COLOR
if the value of the colorName property is not an alias for a color.
|
getColorNames | () | method |
public static function getColorNames(colors:Array):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts each element of the colors Array from a color name
to a numeric RGB color value.
Each color String can be either a case-insensitive color name
such as "red", "Blue", or
"haloGreen", a hexadecimal value such as 0xFF0000, or a #-hexadecimal String
such as "#FF0000"..
Parameters
colors:Array — An Array of color names.
|
getStyleDeclaration | () | method |
public static function getStyleDeclaration(selector:String):CSSStyleDeclaration| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the CSSStyleDeclaration object that stores the rules for the specified CSS selector.
If the selector parameter starts with a period (.),
the returned CSSStyleDeclaration is a class selector and applies only to those instances
whose styleName property specifies that selector
(not including the period).
For example, the class selector ".bigMargins"
applies to any UIComponent whose styleName
is "bigMargins".
If the selector parameter does not start with a period,
the returned CSSStyleDeclaration is a type selector and applies to all instances
of that type.
For example, the type selector "Button"
applies to all instances of Button and its subclasses.
The global selector is similar to a type selector
and does not start with a period.
Parameters
selector:String — The name of the CSS selector.
|
CSSStyleDeclaration — The style declaration whose name matches the selector property.
|
getStyleManager | () | method |
public static function getStyleManager(moduleFactory:IFlexModuleFactory):IStyleManager2| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the style manager for an object.
Parameters
moduleFactory:IFlexModuleFactory — The module factory of an object you want the
style manager for. If null, the top-level style manager is returned.
|
IStyleManager2 — the style manager for the given module factory.
|
isColorName | () | method |
public static function isColorName(colorName:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Tests to see if the given String is an alias for a color value. For example, by default, the String "blue" is an alias for 0x0000FF.
Parameters
colorName:String — The color name to test. This parameter is not case-sensitive.
|
Boolean — Returns true if colorName is an alias
for a color.
|
isInheritingStyle | () | method |
public static function isInheritingStyle(styleName:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Tests to see if a style is inheriting.
Parameters
styleName:String — The name of the style that you test to see if it is inheriting.
|
Boolean — Returns true if the specified style is inheriting.
|
isInheritingTextFormatStyle | () | method |
public static function isInheritingTextFormatStyle(styleName:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Test to see if a TextFormat style is inheriting.
Parameters
styleName:String — The name of the style that you test to see if it is inheriting.
|
Boolean — Returns true if the specified TextFormat style
is inheriting.
|
isParentDisplayListInvalidatingStyle | () | method |
public static function isParentDisplayListInvalidatingStyle(styleName:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Tests to see if this style affects the component's parent container in such a way as to require that the parent container redraws itself when this style changes.
When one of these styles is set with setStyle(),
the invalidateDisplayList() method is auomatically called on the component's
parent container to make it redraw and/or relayout its children.
Parameters
styleName:String — The name of the style to test.
|
Boolean — Returns true if the specified style is one
which may affect the appearance or layout of the component's
parent container.
|
isParentSizeInvalidatingStyle | () | method |
public static function isParentSizeInvalidatingStyle(styleName:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Tests to see if the style changes the size of the component's parent container.
When one of these styles is set with setStyle(),
the invalidateSize() method is automatically called on the component's
parent container to make its measured size get recalculated
later.
Parameters
styleName:String — The name of the style to test.
|
Boolean — Returns true if the specified style is one
which may affect the measured size of the component's
parent container.
|
isSizeInvalidatingStyle | () | method |
public static function isSizeInvalidatingStyle(styleName:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Tests to see if a style changes the size of a component.
When one of these styles is set with the setStyle() method,
the invalidateSize() method is automatically called on the component
to make its measured size get recalculated later.
Parameters
styleName:String — The name of the style to test.
|
Boolean — Returns true if the specified style is one
which may affect the measured size of the component.
|
isValidStyleValue | () | method |
public static function isValidStyleValue(value:*):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines if a specified parameter is a valid style property. For example:
trace(StyleManager.isValidStyleValue(myButton.getStyle("color")).toString());
This can be useful because some styles can be set to values
such as 0, NaN,
the empty String (""), or null, which can
cause an if (value) test to fail.
Parameters
value:* — The style property to test.
|
Boolean — If you pass the value returned by a getStyle() method call
to this method, it returns true if the style
was set and false if it was not set.
|
loadStyleDeclarations | () | method |
public static function loadStyleDeclarations(url:String, update:Boolean = true, trustContent:Boolean = false, applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null):IEventDispatcher| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Loads a style SWF.
Parameters
url:String — Location of the style SWF.
| |
update:Boolean (default = true)true to force
an immediate update of the styles.
Set to false to avoid an immediate update
of the styles in the application.
This parameter is optional and defaults to true
For more information about this parameter, see the description
in the setStyleDeclaration() method.
| |
trustContent:Boolean (default = false)false.
| |
applicationDomain:ApplicationDomain (default = null)load() method of the IModuleInfo that loads the style SWF.
This parameter is optional and defaults to null.
| |
securityDomain:SecurityDomain (default = null)load() method of the IModuleInfo that loads the style SWF.
This parameter is optional and defaults to null.
|
IEventDispatcher — An IEventDispatcher implementation that supports
StyleEvent.PROGRESS, StyleEvent.COMPLETE, and
StyleEvent.ERROR.
|
Related API Elements
registerColorName | () | method |
public static function registerColorName(colorName:String, colorValue:uint):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds a color name to the list of aliases for colors.
Parameters
colorName:String — The name of the color to add to the list; for example, "blue".
If you later access this color name, the value is not case-sensitive.
| |
colorValue:uint — Color value, for example, 0x0000FF.
|
registerInheritingStyle | () | method |
public static function registerInheritingStyle(styleName:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds to the list of styles that can inherit values from their parents.
Note: Ensure that you avoid using duplicate style names, as name collisions can result in decreased performance if a style that is already used becomes inheriting.
Parameters
styleName:String — The name of the style that is added to the list of styles that can inherit values.
|
registerParentDisplayListInvalidatingStyle | () | method |
public static function registerParentDisplayListInvalidatingStyle(styleName:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds to the list of styles which may affect the appearance
or layout of the component's parent container.
When one of these styles is set with setStyle(),
the invalidateDisplayList() method is auomatically called on the component's
parent container to make it redraw and/or relayout its children.
Parameters
styleName:String — The name of the style to register.
|
registerParentSizeInvalidatingStyle | () | method |
public static function registerParentSizeInvalidatingStyle(styleName:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds to the list of styles which may affect the measured size of the component's parent container.
When one of these styles is set with setStyle(),
the invalidateSize() method is automatically called on the component's
parent container to make its measured size get recalculated
later.
Parameters
styleName:String — The name of the style to register.
|
registerSizeInvalidatingStyle | () | method |
public static function registerSizeInvalidatingStyle(styleName:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds to the list of styles which may affect the measured size
of the component.
When one of these styles is set with setStyle(),
the invalidateSize() method is automatically called on the component
to make its measured size get recalculated later.
Parameters
styleName:String — The name of the style that you add to the list.
|
setStyleDeclaration | () | method |
public static function setStyleDeclaration(selector:String, styleDeclaration:CSSStyleDeclaration, update:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the CSSStyleDeclaration object that stores the rules for the specified CSS selector.
If the selector parameter starts with a period (.),
the specified selector is a "class selector" and applies only to those instances
whose styleName property specifies that selector
(not including the period).
For example, the class selector ".bigMargins"
applies to any UIComponent whose styleName
is "bigMargins".
If the selector parameter does not start with a period,
the specified selector is a "type selector" and applies to all instances
of that type.
For example, the type selector "Button"
applies to all instances of Button and its subclasses.
The global selector is similar to a type selector
and does not start with a period.
Parameters
selector:String — The name of the CSS selector.
| |
styleDeclaration:CSSStyleDeclaration — The new style declaration.
| |
update:Boolean — Set to true to force an immediate update of the styles; internally, Flex
calls the styleChanged() method of UIComponent.
Set to false to avoid an immediate update of the styles in the application.
The styles will be updated the next time one of the following methods is called with
the
Typically, if you call the one of these methods multiple times,
you set this property to If you call the |
unloadStyleDeclarations | () | method |
public static function unloadStyleDeclarations(url:String, update:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Unloads a style SWF.
Parameters
url:String — Location of the style SWF.
| |
update:Boolean (default = true)true to force an immediate update of the styles.
Set to false to avoid an immediate update of the styles in the application.
For more information about this method, see the description in the setStyleDeclaration()
method.
|
Related API Elements
NOT_A_COLOR | Constant |
public static const NOT_A_COLOR:uint = 0xFFFFFFFF| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The getColorName() method returns this value if the passed-in
String is not a legitimate color name.
Wed Nov 21 2018, 06:34 AM -08:00