getColorName() method returns this value if the passed-in
* String is not a legitimate color name.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const NOT_A_COLOR:uint = 0xFFFFFFFF;
//--------------------------------------------------------------------------
//
// Class variables
//
//--------------------------------------------------------------------------
/**
* @private
* Linker dependency on implementation class.
*/
private static var implClassDependency:StyleManagerImpl;
/**
* @private
* Storage for the impl getter.
* This gets initialized on first access,
* not at static initialization time, in order to ensure
* that the Singleton registry has already been initialized.
*/
private static var _impl:IStyleManager2;
/**
* @private
* The singleton instance of StyleManagerImpl which was
* registered as implementing the IStyleManager2 interface.
*/
private static function get impl():IStyleManager2
{
if (!_impl)
{
_impl = IStyleManager2(
Singleton.getInstance("mx.styles::IStyleManager2"));
}
return _impl;
}
//--------------------------------------------------------------------------
//
// Class methods
//
//--------------------------------------------------------------------------
/**
* @private
* Dictionary that maps a moduleFactory to its associated styleManager
*/
private static var styleManagerDictionary:Dictionary;
/**
* Returns the style manager for an object.
*
* @param moduleFactory The module factory of an object you want the
* style manager for. If null, the top-level style manager is returned.
*
* @return the style manager for the given module factory.
*
* @langversion 3.0
* @playerversion Flash 10
* @playerversion AIR 1.5
* @productversion Flex 4
*/
public static function getStyleManager(moduleFactory:IFlexModuleFactory):IStyleManager2
{
if (!moduleFactory)
{
moduleFactory = SystemManagerGlobals.topLevelSystemManagers[0];
// trace("no style manager specified, using top-level style manager");
}
if (!styleManagerDictionary)
styleManagerDictionary = new Dictionary(true);
var styleManager:IStyleManager2;
var dictionary:Dictionary = styleManagerDictionary[moduleFactory];
if (dictionary == null)
{
styleManager = IStyleManager2(moduleFactory.getImplementation("mx.styles::IStyleManager2"));
if (styleManager == null)
{
// All Flex 4 swfs should have a style manager.
// In the transition to multiple style managers, use the top-level style manager.
// trace("no style manager found");
styleManager = impl;
}
dictionary = new Dictionary(true);
styleManagerDictionary[moduleFactory] = dictionary;
dictionary[styleManager] = 1;
}
else
{
for (var o:Object in dictionary)
{
styleManager = o as IStyleManager2;
break;
}
}
return styleManager;
}
/**
* @private
* The root of all proto chains used for looking up styles.
* This object is initialized once by initProtoChainRoots() and
* then updated by calls to setStyle() on the global CSSStyleDeclaration.
* It is accessed by code that needs to construct proto chains,
* such as the initProtoChain() method of UIComponent.
*/
[Deprecated(replacement="IStyleManager2.stylesRoot on a style manager instance",
since="4.0")]
mx_internal static function get stylesRoot():Object
{
return impl.stylesRoot;
}
mx_internal static function set stylesRoot(value:Object):void
{
impl.stylesRoot = value;
}
/**
* @private
* Set of inheriting non-color styles.
* This is not the complete set from CSS.
* Some of the omitted we don't support at all,
* others may be added later as needed.
* The method registerInheritingStyle() adds to this set
* and isInheritingStyle() queries this set.
*/
[Deprecated(replacement="IStyleManager2.inheritingStyles on a style manager instance",
since="4.0")]
mx_internal static function get inheritingStyles():Object
{
return impl.inheritingStyles;
}
mx_internal static function set inheritingStyles(value:Object):void
{
impl.inheritingStyles = value;
}
/**
* @private
*/
[Deprecated(replacement="IStyleManager2.typeHierarchyCache on a style manager instance",
since="4.0")]
mx_internal static function get typeHierarchyCache():Object
{
return impl.typeHierarchyCache;
}
mx_internal static function set typeHierarchyCache(value:Object):void
{
impl.typeHierarchyCache = value;
}
/**
* @private
*/
[Deprecated(replacement="IStyleManager2.typeSelectorCache on a style manager instance",
since="4.0")]
mx_internal static function get typeSelectorCache():Object
{
return impl.typeSelectorCache;
}
mx_internal static function set typeSelectorCache(value:Object):void
{
impl.typeSelectorCache = value;
}
/**
* @private
* This method is called by code autogenerated by the MXML compiler,
* after StyleManager.styles is popuplated with CSSStyleDeclarations.
*/
[Deprecated(replacement="IStyleManager2.initProtoChainRoots on a style manager instance",
since="4.0")]
mx_internal static function initProtoChainRoots():void
{
impl.initProtoChainRoots();
}
/**
* 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.
*
* @return An Array of all of the selectors
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.selectors on a style manager instance",
since="4.0")]
public static function get selectors():Array
{
return impl.selectors;
}
/**
* 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.
selector property.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.getStyleDeclaration on a style manager instance",
since="4.0")]
public static function getStyleDeclaration(
selector:String):CSSStyleDeclaration
{
return impl.getStyleDeclaration(selector);
}
/**
* 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.
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 update property set to true:
*
clearStyleDeclaration()loadStyleDeclarations()setStyleDeclaration()unloadStyleDeclarations()Typically, if you call the one of these methods multiple times,
* you set this property to true only on the last call,
* so that Flex does not call the styleChanged() method multiple times.
If you call the getStyle() method, Flex returns the style value
* that was last applied to the UIComponent through a call to the styleChanged() method.
* The component's appearance might not reflect the value returned by the getStyle() method. This occurs
* because one of these style declaration methods might not yet have been called with the
* update property set to true.
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.
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.
*
* @see #setStyleDeclaration()
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.clearStyleDeclaration on a style manager instance",
since="4.0")]
public static function clearStyleDeclaration(selector:String,
update:Boolean):void
{
impl.clearStyleDeclaration(selector, update);
}
/**
* @private
* After an entire selector is added, replaced, or removed,
* this method updates all the DisplayList trees.
*/
[Deprecated(replacement="IStyleManager2.styleDeclarationsChanged on a style manager instance",
since="4.0")]
mx_internal static function styleDeclarationsChanged():void
{
impl.styleDeclarationsChanged();
}
/**
* 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.
* * @param styleName The name of the style that is added to the list of styles that can inherit values. * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 */ [Deprecated(replacement="IStyleManager2.registerInheritingStyle on a style manager instance", since="4.0")] public static function registerInheritingStyle(styleName:String):void { impl.registerInheritingStyle(styleName); } /** * Tests to see if a style is inheriting. * * @param styleName The name of the style that you test to see if it is inheriting. * * @return Returnstrue if the specified style is inheriting.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.isInheritingStyle on a style manager instance",
since="4.0")]
public static function isInheritingStyle(styleName:String):Boolean
{
return impl.isInheritingStyle(styleName);
}
/**
* Test to see if a TextFormat style is inheriting.
*
* @param styleName The name of the style that you test to see if it is inheriting.
*
* @return Returns true if the specified TextFormat style
* is inheriting.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.isInheritingTextFormatStyle on a style manager instance",
since="4.0")]
public static function isInheritingTextFormatStyle(styleName:String):Boolean
{
return impl.isInheritingTextFormatStyle(styleName);
}
/**
* 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.
*
* @param styleName The name of the style that you add to the list.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.registerSizeInvalidatingStyle on a style manager instance",
since="4.0")]
public static function registerSizeInvalidatingStyle(styleName:String):void
{
impl.registerSizeInvalidatingStyle(styleName);
}
/**
* 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.
true if the specified style is one
* which may affect the measured size of the component.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.isSizeInvalidatingStyle on a style manager instance",
since="4.0")]
public static function isSizeInvalidatingStyle(styleName:String):Boolean
{
return impl.isSizeInvalidatingStyle(styleName);
}
/**
* 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.
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.
true if the specified style is one
* which may affect the measured size of the component's
* parent container.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.isParentSizeInvalidatingStyle on a style manager instance",
since="4.0")]
public static function isParentSizeInvalidatingStyle(styleName:String):Boolean
{
return impl.isParentSizeInvalidatingStyle(styleName);
}
/**
* 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.
*
* @param styleName The name of the style to register.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.registerParentDisplayListInvalidatingStyle on a style manager instance",
since="4.0")]
public static function registerParentDisplayListInvalidatingStyle(
styleName:String):void
{
impl.registerParentDisplayListInvalidatingStyle(styleName);
}
/**
* 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.
true if the specified style is one
* which may affect the appearance or layout of the component's
* parent container.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.isParentDisplayListInvalidatingStyle on a style manager instance",
since="4.0")]
public static function isParentDisplayListInvalidatingStyle(
styleName:String):Boolean
{
return impl.isParentDisplayListInvalidatingStyle(styleName);
}
/**
* Adds a color name to the list of aliases for colors.
*
* @param colorName 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.
*
* @param colorValue Color value, for example, 0x0000FF.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.registerColorName on a style manager instance",
since="4.0")]
public static function registerColorName(colorName:String, colorValue:uint):void
{
impl.registerColorName(colorName, colorValue);
}
/**
* 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.
*
* @param colorName The color name to test. This parameter is not case-sensitive.
*
* @return Returns true if colorName is an alias
* for a color.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.isColorName on a style manager instance",
since="4.0")]
public static function isColorName(colorName:String):Boolean
{
return impl.isColorName(colorName);
}
/**
* 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));
* }
*
*
* @param colorName The color name.
*
* @return 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.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.getColorName on a style manager instance",
since="4.0")]
public static function getColorName(colorName:Object):uint
{
return impl.getColorName(colorName);
}
/**
* 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"..
*
* @param colors An Array of color names.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.getColorNames on a style manager instance",
since="4.0")]
public static function getColorNames(colors:Array /* of Number or String */):void
{
impl.getColorNames(colors);
}
/**
* 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.
getStyle() method call
* to this method, it returns true if the style
* was set and false if it was not set.
*
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.isValidStyleValue on a style manager instance",
since="4.0")]
public static function isValidStyleValue(value:*):Boolean
{
return impl.isValidStyleValue(value);
}
/**
* Loads a style SWF.
*
* @param url Location of the style SWF.
*
* @param update 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.
* This parameter is optional and defaults to true
* For more information about this parameter, see the description
* in the setStyleDeclaration() method.
*
* @param trustContent Obsolete, no longer used.
* This parameter is optional and defaults to false.
*
* @param applicationDomain The ApplicationDomain passed to the
* load() method of the IModuleInfo that loads the style SWF.
* This parameter is optional and defaults to null.
*
* @param securityDomain The SecurityDomain passed to the
* load() method of the IModuleInfo that loads the style SWF.
* This parameter is optional and defaults to null.
*
* @return An IEventDispatcher implementation that supports
* StyleEvent.PROGRESS, StyleEvent.COMPLETE, and
* StyleEvent.ERROR.
*
* @see #setStyleDeclaration()
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.loadStyleDeclarations on a style manager instance",
since="4.0")]
public static function loadStyleDeclarations(
url:String, update:Boolean = true,
trustContent:Boolean = false,
applicationDomain:ApplicationDomain = null,
securityDomain:SecurityDomain = null):IEventDispatcher
{
return impl.loadStyleDeclarations2(url, update,
applicationDomain, securityDomain);
}
/**
* Unloads a style SWF.
*
* @param url Location of the style SWF.
* @param update 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.
*
* @see #setStyleDeclaration()
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Deprecated(replacement="IStyleManager2.unloadStyleDeclarations on a style manager instance",
since="4.0")]
public static function unloadStyleDeclarations(
url:String, update:Boolean = true):void
{
impl.unloadStyleDeclarations(url, update);
}
}
}