setComponentState
Sets the state of a component on the page.
Syntax
setComponentState(String componentType, String id, Object state) : void
Parameters
- componentType – The type of the component setting state information. Pre-defined BrainHoney components specify
types defined in Defining Component Types and IDs.
Custom components, which you create, should specify a unique value so that other components can
communicate with your component.
- id – The ID of the component for which you are setting state
information. This is the identifier passed in as the ID attribute in
the <%Render%> replacement tag and is accessible
from a component in the variable $ID$. If
id is "FrameContent", it also updates
the contentState property of the Frame API.
- state – A ComponentState object that is the new state. This parameter is additive. That is, if you supply only a few properties in the component state object, all other currently set properties retain their current values.
Returns
void
See Also