Packagecom.cyntaxic.cynmvc.view.interfaces
Interfacepublic interface ICynComposite

This interface is used to define a CynView object that has children that are views.


Public Methods
 MethodDefined By
  
add(child:CynView, props:Object = null):CynView
Adds a CynView to the display list.
ICynComposite
  
addAt(child:CynView, index:int, props:Object = null):CynView
Adds a CynView to the display list at the specified index.
ICynComposite
  
destroy(view:CynView):void
Destroys a CynView from the display list.
ICynComposite
  
destroyAt(index:int):void
Destroys a CynView from the display list at the specified index.
ICynComposite
  
remove(child:CynView, completely:Boolean = false):CynView
Removes a CynView from the display list.
ICynComposite
  
removeAt(index:int, completely:Boolean = false):CynView
Removes a CynView from the display list at the specified index.
ICynComposite
Method Detail
add()method
public function add(child:CynView, props:Object = null):CynView

Adds a CynView to the display list. An optional set of properties can be sent to the object at time of addition. These property names match the properties of other display objects.

Parameters

child:CynView — The view to be added to the display list.
 
props:Object (default = null) — An object with display object properties.

Returns
CynView — The view that was added.
addAt()method 
public function addAt(child:CynView, index:int, props:Object = null):CynView

Adds a CynView to the display list at the specified index. An optional set of properties can be sent to the object at time of addition. These property names match the properties of other display objects.

Parameters

child:CynView — The view to be added to the display list.
 
index:int — The index to add the object at.
 
props:Object (default = null) — An object with display object properties.

Returns
CynView — The view that was added.
destroy()method 
public function destroy(view:CynView):void

Destroys a CynView from the display list. All reference is destroyed and the object is nulled out the object as well as its children.

Parameters

view:CynView — The view to be destroyed.

destroyAt()method 
public function destroyAt(index:int):void

Destroys a CynView from the display list at the specified index. All reference is destroyed and the object is nulled out the object as well as its children.

Parameters

index:int — The index at which to destroy the view.


Throws
CynError — If object at index is not a CynView.
remove()method 
public function remove(child:CynView, completely:Boolean = false):CynView

Removes a CynView from the display list. When the completely flag is set the function completely destroys all reference and nulls out the object as well as its children.

Parameters

child:CynView — The view to be removed from the display list.
 
completely:Boolean (default = false) — Flag set to determine if it is removed or destroyed completely.

Returns
CynView — The view that has been removed.

See also

destroy()
removeAt()method 
public function removeAt(index:int, completely:Boolean = false):CynView

Removes a CynView from the display list at the specified index. When the completely flag is set the function completely destroys all reference and nulls out the object as well as its children.

Parameters

index:int — The index at which to remove the view.
 
completely:Boolean (default = false) — Flag set to determine if it is removed or destroyed completely.

Returns
CynView — The view that has been removed.

Throws
CynError — If object at index is not a CynView.




Sun Apr 29 2012, 05:03 PM -04:00