Package | de.popforge.fui.core |
Class | public class Group |
Implements | IParameterBindable |
true
when the paramter value of the group is changed to the
asociated value for the IParameterBindable.
Property | Defined by | ||
---|---|---|---|
components : Array
Componets in the group.
| Group | ||
fui : Fui
The Fui object where the current Group object belongs to.
| Group | ||
internalChange : Boolean
A helping varibable that makres if a change to a proxy parameter has been made
internally or comes from a different source (e.g.
| Group | ||
parameter : Parameter
The binded parameter.
| Group | ||
parameters : Array
Proxy parameters for the components that belong to the group.
| Group | ||
values : Array
Values that are asociated with the components.
| Group |
Method | Defined by | ||
---|---|---|---|
Creates a new Group object.
| Group | ||
addComponent(name:String, value:*):Boolean
Adds a FuiComponent to the group.
| Group | ||
Connects a Parameter object.
| Group | ||
disconnect():void
Releases the Parameter object.
| Group | ||
removeComponent(name:String):Boolean
Removes a FuiComponent from the group.
| Group | ||
toString():String
Creates and returns the string representation of the current object.
| Group |
Method | Defined by | ||
---|---|---|---|
initGroup():void
Initializes the group.
| Group | ||
onGroupParameterChanged(parameter:Parameter, oldValue:*, newValue:*):void
Listener for changes of proxy parameters.
| Group | ||
onParameterChanged(parameter:Parameter, oldValue:*, newValue:*):void
Listener for changes of the binded parameter.
| Group | ||
releaseParameter():void
Releases the paramter and removes the listener.
| Group |
components | property |
protected var components:Array
Componets in the group.
fui | property |
protected var fui:Fui
The Fui object where the current Group object belongs to.
internalChange | property |
protected var internalChange:Boolean
A helping varibable that makres if a change to a proxy parameter has been made internally or comes from a different source (e.g. user pressing a SwitchButton).
parameter | property |
protected var parameter:Parameter
The binded parameter.
parameters | property |
protected var parameters:Array
Proxy parameters for the components that belong to the group.
values | property |
protected var values:Array
Values that are asociated with the components.
Group | () | constructor |
public function Group(fui:Fui)
Creates a new Group object.
Parametersfui:Fui — The Fui object the Group belongs to.
|
addComponent | () | method |
public function addComponent(name:String, value:*):Boolean
Adds a FuiComponent to the group. The FuiComponent has to be able to bind paramters.
Parametersname:String — The name of the FuiComponent in the belonging Fui object.
|
|
value:* — The value belonging to the FuiComponent.
|
Boolean — true if the FuiComponent has been added; false otherwise.
|
— If the FuiComponent does not implement IParameterBindable.
|
connect | () | method |
public function connect(parameter:Parameter):void
Connects a Parameter object.
Parametersparameter:Parameter — The Parameter to bind.
|
disconnect | () | method |
public function disconnect():void
Releases the Parameter object.
initGroup | () | method |
protected function initGroup():void
Initializes the group.
Should be called only once when connect()
is called.
onGroupParameterChanged | () | method |
protected function onGroupParameterChanged(parameter:Parameter, oldValue:*, newValue:*):void
Listener for changes of proxy parameters.
Parametersparameter:Parameter — The parameter that has been changed.
|
|
oldValue:* — The old value of the parameter.
|
|
newValue:* — The new value of the parameter.
|
onParameterChanged | () | method |
protected function onParameterChanged(parameter:Parameter, oldValue:*, newValue:*):void
Listener for changes of the binded parameter.
Parametersparameter:Parameter — The parameter that has been changed.
|
|
oldValue:* — The old value of the parameter.
|
|
newValue:* — The new value of the parameter.
|
releaseParameter | () | method |
protected function releaseParameter():void
Releases the paramter and removes the listener.
removeComponent | () | method |
public function removeComponent(name:String):Boolean
Removes a FuiComponent from the group.
Parametersname:String — The name of the FuiComponent in the belonging Fui object.
|
Boolean — true if the FuiComponent has been removed; false otherwise.
|
toString | () | method |
public function toString():String
Creates and returns the string representation of the current object.
ReturnsString — The string representation of the current object.
|