Packagemx.states
Classpublic class SetStyle
InheritanceSetStyle Inheritance OverrideBase
Implements IOverride

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The SetStyle class specifies a style that is in effect only during the parent view state. You use this class in the overrides property of the State class.

MXML SyntaxexpandedHide MXML Syntax

The <mx:SetStyle> tag has the following attributes:

  <mx:SetStyle
   Properties
   name="null"
   target="null"
   value"null"
  />
  

See also

mx.states.State
mx.states.SetEventHandler
mx.states.SetProperty
mx.effects.SetStyleAction


Public Properties
 PropertyDefined By
  name : String
The name of the style to change.
SetStyle
  target : Object
The object whose style is being changed.
SetStyle
  value : Object
The new value for the style.
SetStyle
Public Methods
 MethodDefined By
  
SetStyle(target:IStyleClient = null, name:String = null, value:Object = null)
Constructor.
SetStyle
  
Applies the override.
SetStyle
  
Initializes the override.
SetStyle
  
Removes the override.
SetStyle
Property Detail
nameproperty
public var name:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The name of the style to change. You must set this property, either in the SetStyle constructor or by setting the property value directly.

targetproperty 
public var target:Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The object whose style is being changed. If the property value is null, Flex uses the immediate parent of the State object.

The default value is null.

valueproperty 
value:Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The new value for the style.

The default value is undefined.



Implementation
    public function get value():Object
    public function set value(value:Object):void
Constructor Detail
SetStyle()Constructor
public function SetStyle(target:IStyleClient = null, name:String = null, value:Object = null)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
target:IStyleClient (default = null) — The object whose style is being set. By default, Flex uses the immediate parent of the State object.
 
name:String (default = null) — The style to set.
 
value:Object (default = null) — The value of the style in the view state.
Method Detail
apply()method
public function apply(parent:UIComponent):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Applies the override. Flex retains the original value, so that it can restore the value later in the remove() method.

This method is called automatically when the state is entered. It should not be called directly.

Parameters

parent:UIComponent — The parent of the state object containing this override. The override should use this as its target if an explicit target was not specified.

initialize()method 
public function initialize():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Initializes the override. Flex calls this method before the first call to the apply() method, so you put one-time initialization code for the override in this method.

Flex calls this method automatically when the state is entered. It should not be called directly.

IOverride interface method; this class implements it as an empty method.

remove()method 
public function remove(parent:UIComponent):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Removes the override. The value remembered in the apply() method is restored.

This method is called automatically when the state is entered. It should not be called directly.

Parameters

parent:UIComponent — The parent of the state object containing this override. The override should use this as its target if an explicit target was not specified.