org.fujion.component

Class BaseScriptComponent

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseSourcedComponent

org.fujion.component.BaseScriptComponent

All Implemented Interfaces:

IElementIdentifier

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.SubComponent

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.
BaseScriptComponent.ExecutionMode	getMode() Returns the execution mode.
String	getSelf() Returns the variable name for "this".
void	setMode(BaseScriptComponent.ExecutionMode mode) Sets the execution mode.

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, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterRemoveChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bringToFront, defaultify, destroy, destroyChildren, detach, finalize, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, getAncestor, getAncestor, getAttribute, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getController, getControllers, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasAttribute, hasEventListener, hasEventListener, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, notifyAncestors, notifyDescendants, nullify, onAttach, onDestroy, propertyChange, removeAttribute, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setAttribute, setContentSynced, setData, setIndex, setName, setParent, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validatePage, validateParent, wireController

Methods inherited from class java.lang.Object

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

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.

getSelf

public String getSelf()

Returns the variable name for "this".

Returns:

The variable name for "this".

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.

_execute

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