Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
IStyleManager

Package | mx.styles
Interface | public interface IStyleManager

Language Version : | ActionScript 3.0

Product Version : | Flex 2.0.1

Runtime Versions : | Flash Player 9, AIR 1.1

The IStyleManager class manages the following:

- 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

This interface was used by Flex 2.0.1. Flex 3 now uses IStyleManager2 instead.

See also

mx.styles.CSSStyleDeclaration

Public Methods

| Method | Defined By
--- | --- | ---
|  | clearStyleDeclaration(selector:String, update:Boolean):void Clears the CSSStyleDeclaration object that stores the rules for the specified CSS selector. | IStyleManager
|  | getColorName(colorName:Object):uint Returns the numeric RGB color value that corresponds to the specified color string. | IStyleManager
|  | getColorNames(colors:Array):void Converts each element of the colors Array from a color name to a numeric RGB color value. | IStyleManager
|  | getStyleDeclaration(selector:String):CSSStyleDeclaration Gets the CSSStyleDeclaration object that stores the rules for the specified CSS selector. | IStyleManager
|  | isColorName(colorName:String):Boolean Tests to see if the given String is an alias for a color value. | IStyleManager
|  | isInheritingStyle(styleName:String):Boolean Tests to see if a style is inheriting. | IStyleManager
|  | isInheritingTextFormatStyle(styleName:String):Boolean Test to see if a TextFormat style is inheriting. | IStyleManager
|  | 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. | IStyleManager
|  | isParentSizeInvalidatingStyle(styleName:String):Boolean Tests to see if the style changes the size of the component's parent container. | IStyleManager
|  | isSizeInvalidatingStyle(styleName:String):Boolean Tests to see if a style changes the size of a component. | IStyleManager
|  | isValidStyleValue(value:*):Boolean Determines if a specified parameter is a valid style property. | IStyleManager
|  | loadStyleDeclarations(url:String, update:Boolean = true, trustContent:Boolean = false, applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null):IEventDispatcher Loads a style SWF. | IStyleManager
|  | registerColorName(colorName:String, colorValue:uint):void Adds a color name to the list of aliases for colors. | IStyleManager
|  | registerInheritingStyle(styleName:String):void Adds to the list of styles that can inherit values from their parents. | IStyleManager
|  | registerParentDisplayListInvalidatingStyle(styleName:String):void Adds to the list of styles which may affect the appearance or layout of the component's parent container. | IStyleManager
|  | registerParentSizeInvalidatingStyle(styleName:String):void Adds to the list of styles which may affect the measured size of the component's parent container. | IStyleManager
|  | registerSizeInvalidatingStyle(styleName:String):void Adds to the list of styles which may affect the measured size of the component. | IStyleManager
|  | setStyleDeclaration(selector:String, styleDeclaration:CSSStyleDeclaration, update:Boolean):void Sets the CSSStyleDeclaration object that stores the rules for the specified CSS selector. | IStyleManager
|  | unloadStyleDeclarations(url:String, update:Boolean = true):void Unloads a style SWF. | IStyleManager

Method Detail

clearStyleDeclaration | () | method

`public 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.

See also

setStyleDeclaration()

getColorName | () | method |

`public 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.

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 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 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.

Returns

| `CSSStyleDeclaration` — The style declaration whose name matches the `selector` property.

isColorName | () | method |

`public 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.

Returns

| `Boolean` — Returns `true` if `colorName` is an alias for a color.

isInheritingStyle | () | method |

`public 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.

Returns

| `Boolean` — Returns `true` if the specified style is inheriting.

isInheritingTextFormatStyle | () | method |

`public 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.

Returns

| `Boolean` — Returns `true` if the specified TextFormat style is inheriting.

isParentDisplayListInvalidatingStyle | () | method |

`public 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.

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 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.

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 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.

Returns

| `Boolean` — Returns `true` if the specified style is one which may affect the measured size of the component.

isValidStyleValue | () | method |

`public 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.

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.

loadStyleDeclarations | () | method |

`public 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 4

Runtime Versions : | Flash Player 9, AIR 1.1

Loads a style SWF.

Parameters

| `url:String` — Location of the style SWF.
| `update:Boolean` (default = `true`)`` — 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.
| `trustContent:Boolean` (default = `false`)`` — Obsolete, no longer used. This parameter is optional and defaults to `false`.
| `applicationDomain:ApplicationDomain` (default = `null`)`` — The ApplicationDomain passed to the `load()` method of the IModuleInfo that loads the style SWF. This parameter is optional and defaults to `null`.
| `securityDomain:SecurityDomain` (default = `null`)`` — The SecurityDomain passed to the `load()` method of the IModuleInfo that loads the style SWF. This parameter is optional and defaults to `null`.

Returns

| `IEventDispatcher` — An IEventDispatcher implementation that supports StyleEvent.PROGRESS, StyleEvent.COMPLETE, and StyleEvent.ERROR.

See also

setStyleDeclaration()

registerColorName | () | method |

`public 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 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 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 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 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 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 `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`.

unloadStyleDeclarations | () | method |

`public 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`)`` — 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 also

setStyleDeclaration()

Sun Mar 5 2017, 03:42 PM +11:00