org.fujion.component

Class BaseScriptComponent

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseSourcedComponent

org.fujion.component.BaseScriptComponent

All Implemented Interfaces:

IElementIdentifier, IClientTransform, IAttributeMap<String,Object>

Direct Known Subclasses:

ClientScript, ServerScript

public abstract class BaseScriptComponent
extends BaseSourcedComponent

Base for components that implement scripting support.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseScriptComponent.ExecutionMode Controls timing of script execution.

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

BaseComponent.ComponentReference<T extends BaseComponent>, BaseComponent.SubComponent

Field Summary

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseScriptComponent(boolean contentSynced)
protected	BaseScriptComponent(String content, boolean contentSynced)

Method Summary

Modifier and Type	Method and Description
protected abstract Object	_execute(Map<String,Object> variables)
Object	execute() Execute the script with the default variable values.
Object	execute(Map<String,Object> variables) Execute the script with the specified variable values.
boolean	getIncludeNamedComponents() If true, any named components within the namespace occupied by "self" will be passed as arguments to the script.
BaseScriptComponent.ExecutionMode	getMode() Returns the execution mode.
BaseComponent	getSelf() Returns the component referenced by the script language's "self" variable.
String	getSelfName() Returns the script language's variable name corresponding to "this".
protected void	onAttach(Page page) Triggers script execution.
void	setIncludeNamedComponents(boolean includeNamedComponents) If true, any named components within the namespace occupied by "self" will be passed as arguments to the script.
void	setMode(BaseScriptComponent.ExecutionMode mode) Sets the execution mode.
void	setSelf(BaseComponent self) Sets the component to be referenced by the script language's "self" variable.

Methods inherited from class org.fujion.component.BaseSourcedComponent

getSrc, setContent, setSrc

Methods inherited from class org.fujion.component.BaseComponent

_attach, _initProps, addChild, addChild, addChild, addChildren, addComposite, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterRemoveChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bind, bringToFront, defaultify, destroy, destroyChildren, detach, detachChildren, finalize, findAllNamed, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, fireEventToClient, fireEventToClient, getAncestor, getAncestor, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getController, getControllers, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getLastController, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasChildren, hasEventListener, hasEventListener, invoke, invoke, invoke, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, isRendered, loadModule, loadModule, notifyAncestors, notifyDescendants, nullify, onDestroy, propertyChange, propertyChange, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setContentSynced, setData, setIndex, setName, setNamespace, setParent, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validateName, validatePage, validateParent, wireController, wireController

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.IElementIdentifier

transformForClient

Methods inherited from interface org.fujion.common.IAttributeMap

getAttribute, hasAttribute, removeAttribute, setAttribute

Constructor Detail

BaseScriptComponent

protected BaseScriptComponent(boolean contentSynced)

BaseScriptComponent

protected BaseScriptComponent(String content,
                              boolean contentSynced)

Method Detail

getMode

@Component.PropertyGetter(value="mode",
                          description="The script\'s execution mode.")
public BaseScriptComponent.ExecutionMode getMode()

Returns the execution mode.

Returns:

The execution mode.

setMode

@Component.PropertySetter(value="mode",
                          description="The script\'s execution mode.")
public void setMode(BaseScriptComponent.ExecutionMode mode)

Sets the execution mode.

Parameters:

mode - The execution mode.

getSelfName

public String getSelfName()

Returns the script language's variable name corresponding to "this".

Returns:

The script language's variable name corresponding to "this".

getSelf

@Component.PropertyGetter(value="self",
                          description="The component to be referenced by the script language\'s \"self\" variable.")
public BaseComponent getSelf()

Returns the component referenced by the script language's "self" variable. By default, it is the script component itself. If "self" is explicitly included in the variable map passed to execute(Map), that value will be used instead.

Returns:

The component referenced by the script language's "self" variable.

setSelf

@Component.PropertySetter(value="self",
                          description="The component to be referenced by the script language\'s \"self\" variable.")
public void setSelf(BaseComponent self)

Sets the component to be referenced by the script language's "self" variable. If "self" is explicitly included in the variable map passed to execute(Map), that value will be used instead.

Parameters:

self - The component to be referenced by the script language's "self" variable.

getIncludeNamedComponents

@Component.PropertyGetter(value="includeNamedComponents",
                          description="If true, any named components within the namespace occupied by \"self\" will be passed as arguments to the script.")
public boolean getIncludeNamedComponents()

If true, any named components within the namespace occupied by "self" will be passed as arguments to the script.

Returns:

True if named components are to be passed as arguments to the script.

setIncludeNamedComponents

@Component.PropertySetter(value="includeNamedComponents",
                          defaultValue="true",
                          description="If true, any named components within the namespace occupied by \"self\" will be passed as arguments to the script.")
public void setIncludeNamedComponents(boolean includeNamedComponents)

If true, any named components within the namespace occupied by "self" will be passed as arguments to the script.

Parameters:

includeNamedComponents - Set to true if named components are to be passed as arguments to the script.

execute

public Object execute(Map<String,Object> variables)

Execute the script with the specified variable values.

Parameters:

variables - A mapped of named variable values.

Returns:

Result of the script execution.

execute

public Object execute()

Execute the script with the default variable values.

Returns:

Result of the script execution.

onAttach

protected void onAttach(Page page)

Triggers script execution. If not deferred, execution is immediate. Otherwise, a event is posted, deferring script execution until the end of the execution cycle.

Overrides:

onAttach in class BaseComponent

Parameters:

page - The attached page.

See Also:

BaseComponent.onAttach(org.fujion.component.Page)

_execute

protected abstract Object _execute(Map<String,Object> variables)