Packagetwaver
Classpublic class AlarmStatePropagator
InheritanceAlarmStatePropagator Inheritance PropertyPropagator Inheritance Object

This class is used to propagate alarm information to other related elements to spread the alarm influence. The alarm propagator is a part of ElementBox. Everytime alarm is occured, propagator will be triggered to spread alarm to other related elements. In the default implementation, the propagation rule is to spread alarm to element's parent.

However, you can create a new alarm propagator and set to ElementBox to spread alarm influence by your rules.



Public Properties
 PropertyDefined By
 InheriteddataBox : DataBox
[read-only] Get the connected data box.
PropertyPropagator
 Inheritedenable : Boolean
Get current enable status of this propagator.
PropertyPropagator
 InheritedpropertyName : String
[read-only] Get the property name that only this property changes the propagator will be triggered.
PropertyPropagator
 InheritedpropertyType : String
[read-only] Get the property type that only properties with this type changes the propagator will be triggered.
PropertyPropagator
Protected Properties
 PropertyDefined By
 Inherited_isPropagating : Boolean = false
PropertyPropagator
Public Methods
 MethodDefined By
  
Creator.
AlarmStatePropagator
Protected Methods
 MethodDefined By
 Inherited
Called when a data box has been changed.
PropertyPropagator
  
handleDataPropertyChange(e:PropertyChangeEvent):void
[override] Called when a property of a data has been changed.
AlarmStatePropagator
 Inherited
propagate(data:IData):void
Propagate property change to the specified data.
PropertyPropagator
  
propagateToParent(child:IData, parent:IData):void
[override] Called when need to propagate property change to specified data's parent.
AlarmStatePropagator
 Inherited
Propagate property change to the specified data's next level data.
PropertyPropagator
Constructor Detail
AlarmStatePropagator()Constructor
public function AlarmStatePropagator(dataBox:ElementBox)

Creator. Create propagator and connect to the specified element box.

Parameters
dataBox:ElementBox — the element box this propagator will work for.
Method Detail
handleDataPropertyChange()method
override protected function handleDataPropertyChange(e:PropertyChangeEvent):void

Called when a property of a data has been changed. This default implementation will propagate this change to parent data. Overwrite this method to do customized propagate action.

Parameters

e:PropertyChangeEvent — the property change event contains information of that change.

propagateToParent()method 
override protected function propagateToParent(child:IData, parent:IData):void

Called when need to propagate property change to specified data's parent.

Parameters

child:IData — child data, the change source.
 
parent:IData — parent data, the propagation target.