public abstract class Obj extends Object implements 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 and Description |
---|
Obj() |
Modifier and Type | Method and Description |
---|---|
void |
addPeer(Peer poPeerNode)
Add a peer node to be notified of state changes.
|
void |
addPeeredNode(Peer poPeer) |
void |
clearPeers()
Removes this node from all peer relationships.
|
void |
deafen()
Makes this peer deaf to any updateFromPeer calls made by notifyPeers
|
String |
getClassAtom()
Returns the atomic name of this element's class.
|
String |
getClassName()
Gets the name of this object's class.
|
int |
getClassTag() |
Peer |
getPeer(int nPeer)
Gets the requested peer.
|
ScriptFuncObj |
getScriptMethodInfo(String sName)
Gets the information on a script method.
|
boolean |
getScriptProperty(Arg retValue,
String sPropertyName,
DependencyTracker dependencyTracker,
boolean bPeek,
boolean bSuppressExceptions) |
ScriptTable |
getScriptTable() |
Obj |
getScriptThis()
Gets the object to be used in concert with getScriptTable() etc.
|
boolean |
invokeFunction(Arg retValue,
String sFunctionName,
Arg[] parameters,
DependencyTracker dependencyTracker,
boolean bSuppressExceptions)
Call a scripting function (method).
|
boolean |
isDeaf()
Checks if this peer is deaf.
|
boolean |
isMute()
Checks if this peer is mute.
|
boolean |
isSameClass(int eClassTag)
Determine if the class of this object is the same as the class tag.
|
boolean |
isSameClass(Obj oClass)
Determine if the class of this object is the same as the Obj class.
|
boolean |
isSameClass(String aClass)
Determine if the class of this object is the same as the String sClass.
|
void |
mute()
Makes this peer no longer notify its peers when notifyPeers is called
|
void |
notifyPeers(int eventType,
String arg1,
Object arg2)
Sends notification to the peer nodes that this object has changed.
|
void |
peerRemoved(Peer peer)
Called when this Peer is removed from
peer . |
void |
removePeer(Peer peerNode)
Remove a peer node from the notification list.
|
void |
removePeeredNode(Peer peer) |
void |
sendMessenge(ExFull error,
int eSeverity)
Send message to host so it can be logged
|
void |
setClass(String sClassName,
int eClassTag)
Set the class name and class tag for this node instance.
|
void |
setClassTag(int eClassTag) |
boolean |
setScriptProperty(String sPropertyName,
Arg propertyValue,
boolean bSuppressExceptions) |
void |
unDeafen()
Allows this peer to receive updateFromPeer calls
|
void |
unMute()
Allows this peer to notify its peers when notifyPeers is called.
|
void |
updateFromPeer(Object peerNode,
int eventType,
String arg1,
Object arg2)
This method will be called by the peer whenever its
state changes.
|
boolean |
validateUsage(int nXFAVersion,
int nAvailability,
boolean bUpdateVersion)
Validate if the given Version and Availability flags are valid for the
current document
|
boolean |
validateUsageFailedIsFatal(int nXFAVersion,
int nAvailability)
Determines if disallowing a version should be considered a fatal error.
|
public final void addPeer(Peer poPeerNode)
Peer
public final void addPeeredNode(Peer poPeer)
addPeeredNode
in interface Peer
public final void clearPeers()
Peer
clearPeers
in interface Peer
public final void deafen()
Peer
public final void setClass(String sClassName, int eClassTag)
sClassName
- This String must be interned.eClassTag
- public final void setClassTag(int eClassTag)
public final int getClassTag()
public String getClassAtom()
public String getClassName()
public final Peer getPeer(int nPeer)
public ScriptFuncObj getScriptMethodInfo(String sName)
sName
- the name of the methodpublic boolean getScriptProperty(Arg retValue, String sPropertyName, DependencyTracker dependencyTracker, boolean bPeek, boolean bSuppressExceptions)
public ScriptTable getScriptTable()
public Obj getScriptThis()
public boolean invokeFunction(Arg retValue, String sFunctionName, Arg[] parameters, DependencyTracker dependencyTracker, boolean bSuppressExceptions)
sFunctionName
- The name of the function/method to call. If this parameter is
an empty string, then an attempt is made to invoke a default
function.parameters
- an array of parameters to the method.ResId.InvalidMethodException
- if the function name is unknown.ResId.BadParamCountException
- if the number of parameters in nParamCount is not valid
for the specified fucntion.ResId.ArgumentMismatchException
- if one or more of the argument types in pParameters is
incorrect for the specified function.ResId.NoDefaultMethodException
- if sFunctionName is an empty string, and the object
doesn't have a default function.public final boolean isDeaf()
Peer
public final boolean isMute()
Peer
public final boolean isSameClass(Obj oClass)
oClass
- Obj to check the class with.public final boolean isSameClass(String aClass)
SharesImpl
method of String
.aClass
- string from the XFA namespace. This String must be interned.public final boolean isSameClass(int eClassTag)
eClassTag
- string from the XFA namespace.public final void mute()
Peer
public void notifyPeers(int eventType, String arg1, Object arg2)
Peer
notifyPeers
in interface Peer
eventType
- the event type as enumerated in this classarg1
- additional event informationarg2
- additional event informationpublic final void removePeer(Peer peerNode)
removePeer
in interface Peer
peerNode
- The reference to the peer object to be removed.public final void removePeeredNode(Peer peer)
removePeeredNode
in interface Peer
public void sendMessenge(ExFull error, int eSeverity)
error
- contains message Id and texteSeverity
- the message severitypublic boolean setScriptProperty(String sPropertyName, Arg propertyValue, boolean bSuppressExceptions)
sPropertyName
- The name of the property to set. If this parameter is an empty
string, then an attempt is made to set the default property.propertyValue
- The value of assign to this property.bSuppressExceptions
- If true, quietly return false on error, else throw an exception for any errors.NoDefaultSetPropertyException
- if sPropertyName is an empty string, and the object does
not have a default property.InvalidSetPropertyException
- if sPropertyName is not a valid property for the object.public final void unDeafen()
Peer
public final void unMute()
Peer
public void updateFromPeer(Object peerNode, int eventType, String arg1, Object arg2)
Peer
eventType (String)arg1 (Object)arg2 UPDATED update type (optional) ATTR_CHANGED attr name (optional) CHILD_ADDED (optional) added node CHILD_REMOVED (optional) removed node VALUE_CHANGED new data (optional) PARENT_CHANGED (optional) new parent DESCENDENT_ATTR_CHANGED attr name changed node DESCENDENT_VALUE_CHANGED (optional) changed node DESCENDENT_ADDED (optional) added node DESCENDENT_REMOVED (optional) removed node PERMS_LOCK_SET (optional) (optional) PERMS_LOCK_CLEARED (optional) (optional) PROTO_ATTR_CHANGED attr name changed node PROTO_CHILD_ADDED (optional) added node of the protoype PROTO_CHILD_REMOVED (optional) removed node from the prototype PROTO_VALUE_CHANGED new data prototype node PROTO_DESCENDENT_ATTR_CHANGED attr name changed prototype node PROTO_DESCENDENT_VALUE_CHANGED (optional) changed prototype node PROTO_DESCENDENT_ADDED (optional) added node to the prototype PROTO_DESCENDENT_REMOVED (optional) removed node from the prototype
updateFromPeer
in interface Peer
peerNode
- the peer to this object.eventType
- the event type as enumerated in this classarg1
- additional event informationarg2
- additional event informationpublic void peerRemoved(Peer peer)
Peer
peer
.
Derived classes can override this method to receive direct notifications
when a peer is removed.peerRemoved
in interface Peer
peer
- the Peer from which this Peer has been removed from notification.public boolean validateUsage(int nXFAVersion, int nAvailability, boolean bUpdateVersion)
nXFAVersion
- The target XFA VersionnAvailability
- The target Availability flags, this indicates for what clients
the script is availablebUpdateVersion
- indicates if the model version can be updated by the calling
codepublic boolean validateUsageFailedIsFatal(int nXFAVersion, int nAvailability)
This method is called after calling
validateUsage(int, int, boolean)
when that method returns false.
nXFAVersion
- The target XFA VersionnAvailability
- The target Availability flags, this indicates for what clients
the script is availablevalidateUsage(int, int, boolean)
Copyright © 2010 - 2020 Adobe. All Rights Reserved