Package com.adobe.xfa

Class ListBase

java.lang.Object

com.adobe.xfa.Obj

com.adobe.xfa.ListBase

All Implemented Interfaces:

Peer

Direct Known Subclasses:

NodeList, XFAList

public abstract class ListBase
extends Obj

A base class for all lists that are used in the XFA scripting object model. That includes primarily node lists, but also lists of deltas. This class combined with XFAList correspond to the C++ XFAListImpl class.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
abstract void	append(Obj oObj)	Appends an object to the end of this list.
java.lang.String	getClassAtom()	Returns the atomic name of this element's class.
java.lang.String	getClassName()	Gets the name of this object's class.
ScriptTable	getScriptTable()
abstract void	insert(Obj newObj, Obj refObj)	Inserts an object before a specific node in this list.
boolean	isReadOnly()
void	isReadOnly(boolean bReadOnly)
abstract Obj	item(int n)	Gets this list's n'th object.
abstract int	length()	Returns the number of objects in this list.
abstract void	remove(Obj obj)	Removes an object from this list.

Methods inherited from class com.adobe.xfa.Obj

addPeer, addPeeredNode, clearPeers, deafen, getClassTag, getPeer, getScriptMethodInfo, getScriptProperty, getScriptThis, invokeFunction, isDeaf, isMute, isSameClass, isSameClass, isSameClass, mute, notifyPeers, peerRemoved, removePeer, removePeeredNode, sendMessenge, setClass, setClassTag, setScriptProperty, unDeafen, unMute, updateFromPeer, validateUsage, validateUsageFailedIsFatal

Methods inherited from class java.lang.Object

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

Method Detail

append

public abstract void append(Obj oObj)

Appends an object to the end of this list.

Parameters:

oObj - the node to be appended.

getClassAtom

public java.lang.String getClassAtom()

Description copied from class: Obj

Returns the atomic name of this element's class.

Overrides:

getClassAtom in class Obj

Returns:

the class name as an interned string.

See Also:

Obj.getClassAtom()

getClassName

public java.lang.String getClassName()

Description copied from class: Obj

Gets the name of this object's class. Overriden by derived classes such as Element that have a local name that may be returned instead.

Overrides:

getClassName in class Obj

Returns:

the class name.

See Also:

Obj.getClassName()

getScriptTable

public ScriptTable getScriptTable()

Overrides:

getScriptTable in class Obj

insert

public abstract void insert(Obj newObj,
                            Obj refObj)

Inserts an object before a specific node in this list.

Parameters:

newObj - the object to be inserted.

refObj - the object to insert before.

isReadOnly

public boolean isReadOnly()

isReadOnly

public void isReadOnly(boolean bReadOnly)

item

public abstract Obj item(int n)

Gets this list's n'th object.

Parameters:

n - the 0-based index of the node within this list.

Returns:

the n'th node.

length

public abstract int length()

Returns the number of objects in this list.

Returns:

the length of this list.

remove

public abstract void remove(Obj obj)

Removes an object from this list.

Parameters:

obj - the object to be removed.