View comments | RSS feed
Packagemx.styles
Classpublic class StyleManager
InheritanceStyleManager Inheritance Object

The StyleManager class manages the following:

See also

mx.styles.CSSStyleDeclaration
External style sheets
Using the StyleManager class
Applying programmatic skins


Public Properties
 PropertyDefined by
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined by
  
[static] Clears the CSSStyleDeclaration object that stores the rules for the specified CSS selector.
StyleManager
  
getColorName(colorName:Object):uint
[static] Returns the numeric RGB color value that corresponds to the specified color string.
StyleManager
  
[static] Converts each element of the colors Array from a color name to a numeric RGB color value.
StyleManager
  
[static] Gets the CSSStyleDeclaration object that stores the rules for the specified CSS selector.
StyleManager
 Inherited
Indicates whether an object has a specified property defined.
Object
  
[static] Tests to see if the given String is an alias for a color value.
StyleManager
  
[static] Tests to see if a style is inheriting.
StyleManager
  
[static] Test to see if a TextFormat style is inheriting.
StyleManager
  
[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
  
[static] Tests to see if the style changes the size of the component's parent container.
StyleManager
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
[static] Tests to see if a style changes the size of a component.
StyleManager
  
[static] Determines if a specified parameter is a valid style property.
StyleManager
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
registerColorName(colorName:String, colorValue:uint):void
[static] Adds a color name to the list of aliases for colors.
StyleManager
  
[static] Adds to the list of styles that can inherit values from their parents.
StyleManager
  
[static] Adds to the list of styles which may affect the appearance or layout of the component's parent container.
StyleManager
  
[static] Adds to the list of styles which may affect the measured size of the component's parent container.
StyleManager
  
[static] Adds to the list of styles which may affect the measured size of the component.
StyleManager
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
setStyleDeclaration(selector:String, styleDeclaration:CSSStyleDeclaration, update:Boolean):void
[static] Sets the CSSStyleDeclaration object that stores the rules for the specified CSS selector.
StyleManager
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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
Method detail
clearStyleDeclaration()method
public static function clearStyleDeclaration(selector:String, update:Boolean):void

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. The styles will be updated the next time this method or the setStyleDeclaration() method is called with the update property set to true.
getColorName()method 
public static function getColorName(colorName:Object):uint

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.

Returns
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

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

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.

Returns
CSSStyleDeclaration — The style declaration whose name matches the selector property.
isColorName()method 
public static function isColorName(colorName:String):Boolean

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.

Returns
Boolean — Returns true if colorName is an alias for a color.
isInheritingStyle()method 
public static function isInheritingStyle(styleName:String):Boolean

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.

Returns
Boolean — Returns true if the specified style is inheriting.
isInheritingTextFormatStyle()method 
public static function isInheritingTextFormatStyle(styleName:String):Boolean

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.

Returns
Boolean — Returns true if the specified TextFormat style is inheriting.
isParentDisplayListInvalidatingStyle()method 
public static function isParentDisplayListInvalidatingStyle(styleName:String):Boolean

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.

Returns
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

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.

Returns
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

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.

Returns
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

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.

Returns
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.
registerColorName()method 
public static function registerColorName(colorName:String, colorValue:uint):void

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

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

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

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

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

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. Set to false to avoid an immediate update of the styles in the application. The styles will be updated the next time this method or the clearStyleDeclaration() method is called with the update property set to true.
Constant detail
NOT_A_COLORconstant
public static const NOT_A_COLOR:uint = 0xFFFFFFFF

The getColorName() method returns this value if the passed-in String is not a legitimate color name.





Comments


_del_p_ said on Oct 2, 2007 at 12:53 PM :
After trying to find info on dynamically changing themes at run time I've found a couple of methods that are part of StyleManager but do not appear in the documentation and searching upon the method names does not return any results either (I’ve never found the search facilities any good, even if it is powered by Google).
StyleManager.loadStyleDeclarations & StyleManager.unloadStyleDeclarations do not appear in the documentation.

I did however find this link after searching livedocs manually http://livedocs.adobe.com/flex/201/html/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Book_Parts&file=styles_069_26.html and it does mention the methods, but this is the only place I've found it.

 

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/styles/StyleManager.html