weavejs.api.core.ILinkableCompositeObject

Package	weavejs.api.core
Interface	public interface ILinkableCompositeObject extends ILinkableObject

This is an interface to a composite object with dynamic state, meaning child objects can be dynamically added or removed. The session state for this type of object is defined as an Array of DynamicState objects. DynamicState objects are defined as having exactly three properties: objectName, className, and sessionState.

	Method	Defined By
		getSessionState():Array This gets the session state of this composite object.	ILinkableCompositeObject
		setSessionState(newState:Array, removeMissingDynamicObjects:Boolean):void This sets the session state of this composite object.	ILinkableCompositeObject

See also

weave.api.core.DynamicState

setSessionState

()

method

public function setSessionState(newState:Array, removeMissingDynamicObjects:Boolean):void

This sets the session state of this composite object.

Parameters

	`newState:Array` — An Array of child name Strings or DynamicState objects containing the new values and types for child ILinkableObjects.

	`removeMissingDynamicObjects:Boolean` — If true, this will remove any child objects that do not appear in the session state. As a special case, a null session state will result in no change regardless of the removeMissingDynamicObjects value.

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
ILinkableCompositeObject	Methods