com.adobe.xfa.template.automation

Class EventTag

java.lang.Object

com.adobe.xfa.Obj

com.adobe.xfa.Node

com.adobe.xfa.Element

com.adobe.xfa.ProtoableNode

com.adobe.xfa.template.automation.EventTag

All Implemented Interfaces:

Peer

public final class EventTag
extends ProtoableNode

Nested Class Summary

Nested classes/interfaces inherited from class com.adobe.xfa.Element

Element.DualDomNode, Element.ReplaceContent

Nested classes/interfaces inherited from class com.adobe.xfa.Node

Node.ChangeLogger

Field Summary

Fields inherited from class com.adobe.xfa.Element

AttrIsDefault, AttrIsFragment, AttrIsTransient, CREATEACTION

Fields inherited from class com.adobe.xfa.Node

CREATE_ALWAYS_NEW, CREATE_IF_NOT_EXIST, CREATE_MUST_NOT_EXIST, CREATE_REPLACE, gsXFANamespacePrefix

Fields inherited from interface com.adobe.xfa.ut.Peer

ATTR_CHANGED, CHILD_ADDED, CHILD_REMOVED, DESCENDENT_ADDED, DESCENDENT_ATTR_CHANGED, DESCENDENT_REMOVED, DESCENDENT_VALUE_CHANGED, PARENT_CHANGED, PERMS_LOCK_CLEARED, PERMS_LOCK_SET, PROTO_ATTR_CHANGED, PROTO_CHILD_ADDED, PROTO_CHILD_REMOVED, PROTO_DESCENDENT_ADDED, PROTO_DESCENDENT_ATTR_CHANGED, PROTO_DESCENDENT_REMOVED, PROTO_DESCENDENT_VALUE_CHANGED, PROTO_VALUE_CHANGED, UPDATED, VALUE_CHANGED

Constructor Summary

Constructors

Constructor and Description
EventTag(Element pParent, Node prevSibling)

Method Summary

Modifier and Type	Method and Description
static EventTag	createEvent(Model model, String sActivity, String sRef) Factory method.
int	defaultElement() Returns the class tag of the default one-of child (if there is one)
String	getActivity() Get the activity (ie: OnEnter, OnClick, etc.) for this event.
String	getContentType() Get the contentType for this event's script (eg.
String	getLanguage() Get the language for this event's script.
String	getRef() Get the reference of the activity (ie: $form, $layout, etc.) for this event.
String	getRunAt() Get the run location (client or server) for this event.
Script	getScript()
String	getScriptText() Get the content of the script for this event.
Script	peekScript() Get the script for this event.
void	setActivity(String sActivity) Set the activity (ie: OnEnter, OnClick, etc.) for this event.
void	setContentType(String sContentType) Set the contentType for this event's script (eg.
void	setLanguage(String sLanguage) Set the language for this event's script.
void	setRef(String sRef) Set the reference of the activity (ie: $form, $layout, etc.) for this event.
void	setRunAt(String sTarget) Set the run location (client or server) for this event.
void	setScript(Script script) Set the script for this event.
void	setScriptText(String sScript) Set the content of the script for this event.

Methods inherited from class com.adobe.xfa.ProtoableNode

clone, createProto, elementGetAttribute, externalProtoFailed, fetchIDValues, getAttribute, getAttributeByName, getElement, getExternalProtoSource, getOneOfChild, getPI, getPI, getProto, getProtoed, getScriptTable, getText, hasExternalProto, hasProto, isContextSensitiveAttribute, isDefault, isSpecified, notifyPeers, performResolveProtos, preSave, releaseExternalProtos, reResolveProto, resolveProto, setAttribute, setElement, setOneOfChild, setPermsLock, setProto, updateIDValues

Methods inherited from class com.adobe.xfa.Element

appendChild, appendChild, appendPI, appendPI, assignNode, clone, connectPeerToDocument, constructKey, constructKeys, copyContent, defaultAttribute, defaultElement, establishID, evaluate, explodeQName, findAttr, findSchemaAttr, foundBadAttribute, foundBadAttribute, getAll, getAppModel, getAtom, getAttr, getAttribute, getAttrIndex, getAttrName, getAttrNS, getAttrProp, getAttrQName, getAttrVal, getChildReln, getClassAll, getClassIndex, getClassName, getDeltas, getElement, getElementClass, getElementLocal, getEnum, getEnum, getEventTable, getFirstXFAChild, getFirstXMLChild, getID, getIndex, getInheritedNS, getInstalledLocale, getIsNull, getLastXMLChild, getLineNumber, getLocalName, getModel, getName, getNode, getNodes, getNodeSchema, getNS, getNumAttrs, getOneOfChild, getPrefix, getProperty, getProperty, getSaveXMLSaveTransient, getSchemaType, getScriptMethodInfo, getSibling, getXFAChild, getXMLChild, getXMLName, getXPath, getXsiNilAttribute, inhibitPrettyPrint, inhibitPrettyPrint, insertChild, isContainer, isFragment, isHidden, isHidden, isIndexed, isInstalledLocaleAmbient, isLeaf, isNameSpaceAttr, isPropertySpecified, isPropertySpecified, isPropertyValid, isSpecified, isSpecified, isTransient, isTransparent, isValidAttr, isValidChild, isValidElement, loadXML, loadXML, makeDefault, makeNonDefault, newAttribute, optimizeNameSpace, peekAttribute, peekElement, peekOneOfChild, peekProperty, peekProperty, postSave, privateSetName, processTextChildrenDuringParse, removeAttr, removeAttr, removeChild, removePI, removePI, removeWhiteSpace, removeXsiNilAttribute, replaceChild, resetPostLoadXML, resolveAndEnumerateChildren, resolveNodeCreate, resolvePrefix, saveFilteredXML, saveXML, saveXML, serialize, setAttribute, setAttribute, setAttribute, setAttrProp, setDefaultFlag, setDOMProperties, setIsDataWindowRoot, setIsIndexed, setLineNumber, setLocalName, setModel, setName, setNS, setProperty, setProperty, setQName, setSaveXMLSaveTransient, setTransparent, setXMLName, setXsiNilAttribute, updateFromPeer

Methods inherited from class com.adobe.xfa.Node

checkAncestorPerms, checkDescendentPerms, checkPerms, cleanDirtyFlags, compareVersions, getData, getFirstXMLChildElement, getLocked, getNextXFASibling, getNextXMLSibling, getNextXMLSiblingElement, getNodeAsXML, getOwnerDocument, getPIAsXML, getPIName, getPreviousXMLSibling, getPrivateName, getPropName, getSOMExpression, getSOMExpression, getSomName, getUniqueSOMName, getWillDirty, getXFAChildCount, getXFAParent, getXfaPeer, getXMLChildCount, getXMLParent, hasChanged, isDirty, isMapped, isPermsLockSet, isTransient, locateChildByClass, locateChildByName, logValueChangeHelper, performSOMAssignment, remove, resolveNode, resolveNode, resolveNode, resolveNodes, resolveNodes, sendMessenge, setDirty, setDocument, setLocked, setMapped, setPrivateName, setWillDirty, setXfaPeer, unLock, validateSchema, validateUsage, validateUsageFailedIsFatal

Methods inherited from class com.adobe.xfa.Obj

addPeer, addPeeredNode, clearPeers, deafen, getClassAtom, getClassTag, getPeer, getScriptProperty, getScriptThis, invokeFunction, isDeaf, isMute, isSameClass, isSameClass, isSameClass, mute, peerRemoved, removePeer, removePeeredNode, setClass, setClassTag, setScriptProperty, unDeafen, unMute

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventTag

public EventTag(Element pParent,
                Node prevSibling)

Method Detail

createEvent

public static EventTag createEvent(Model model,
                                   String sActivity,
                                   String sRef)

Factory method. Creates either a new <calculate>, <validate>, or <event> tag, depending on the activity.

defaultElement

public int defaultElement()

Description copied from class: Element

Returns the class tag of the default one-of child (if there is one)

Overrides:

defaultElement in class Element

Returns:

the integer tag for the default element.

getActivity

public String getActivity()

Get the activity (ie: OnEnter, OnClick, etc.) for this event.

getContentType

public String getContentType()

Get the contentType for this event's script (eg. "javascript" or "formcalc").

getLanguage

public String getLanguage()

Get the language for this event's script. While the "language" isn't as well-specified as the contentType, it is a useful shortcut for those clients supporting the primary languages (that is, JavaScript and FormCalc). "application/x-formcalc" -. "FormCalc" "application/x-javascript" -. "JavaScript" Others are copied straight across.

getRef

public String getRef()

Get the reference of the activity (ie: $form, $layout, etc.) for this event.

getRunAt

public String getRunAt()

Get the run location (client or server) for this event.

getScript

public Script getScript()

getScriptText

public String getScriptText()

Get the content of the script for this event.

peekScript

public Script peekScript()

Get the script for this event.

setActivity

public void setActivity(String sActivity)

Set the activity (ie: OnEnter, OnClick, etc.) for this event.

Parameters:

sActivity - - the name of the event to set,

setContentType

public void setContentType(String sContentType)

Set the contentType for this event's script (eg. "javascript" or "formcalc").

Parameters:

sContentType - - the content type to set for this element.

setLanguage

public void setLanguage(String sLanguage)

Set the language for this event's script.

While the "language" isn't as well-specified as the contentType, it is a useful shortcut for those clients supporting the primary languages (that is, JavaScript and FormCalc). "FormCalc" -. "application/x-formcalc" "JavaScript" -. "application/x-javascript" Others are copied straight across.

setRef

public void setRef(String sRef)

Set the reference of the activity (ie: $form, $layout, etc.) for this event.

Parameters:

sRef - - The object this event refers to.

setRunAt

public void setRunAt(String sTarget)

Set the run location (client or server) for this event.

Parameters:

sTarget - - The target: client, server etc.

setScript

public void setScript(Script script)

Set the script for this event.

setScriptText

public void setScriptText(String sScript)

Set the content of the script for this event.