com.adobe.xfa.data

Class DataWindow

java.lang.Object

com.adobe.xfa.Obj

com.adobe.xfa.data.DataWindow

All Implemented Interfaces:

Peer

public final class DataWindow
extends Obj

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

Constructor Summary

Constructors

Constructor and Description
DataWindow()

Method Summary

Modifier and Type	Method and Description
void	addRecordGroup(DataNode dataGroup)
int	currentRecordNumber() Return the current record number.
String	getClassAtom() Returns the atomic name of this element's class.
String	getClassName() Gets the name of this object's class.
Arg	getScriptProperty(String sPropertyName)
ScriptTable	getScriptTable()
void	gotoRecord(int newRecord) Move the current record to a specific record.
boolean	isDefined() Determine if the data window is currently in a defined (valid) state.
boolean	isRecordGroup(DataNode dataGroup) Determine if a data group is a record.
boolean	isUpToDate()
void	moveCurrentRecord(int recordOffset) Move the current record by an amount relative to the current record.
DataNode	record(int recordOffset) Return a record relative to the current record.
int	recordAbsIndex(int recordOffset)
int	recordsAfter() Determine the number of records after the current record in this window.
int	recordsBefore() Determine the number of records before the current record in this window.
boolean	removeRecordGroup(DataNode dataGroup)
void	resetRecordDepth()
void	setScriptProperty(String sPropertyName, Arg propertyValue)
void	updateAfterLoad()

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

Constructor Detail

DataWindow

public DataWindow()

Method Detail

addRecordGroup

public void addRecordGroup(DataNode dataGroup)

currentRecordNumber

public int currentRecordNumber()

Return the current record number.

Returns:

the current record number.

getClassAtom

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

getClassName

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

getScriptProperty

public Arg getScriptProperty(String sPropertyName)

getScriptTable

public ScriptTable getScriptTable()

Overrides:

getScriptTable in class Obj

gotoRecord

public void gotoRecord(int newRecord)

Move the current record to a specific record.

Parameters:

newRecord - the absolute record number.

isDefined

public boolean isDefined()

Determine if the data window is currently in a defined (valid) state. A data window is in this state if the current record index indicates a valid record. A data window is not defined if there are no records, or if the current record index has been positioned beyond the end of the records.

Returns:

true if dataWindow is defined, false otherwise.

isRecordGroup

public boolean isRecordGroup(DataNode dataGroup)

Determine if a data group is a record.

Parameters:

dataGroup - the data group in question.

Returns:

true if dataGroup is a data group, false otherwise.

isUpToDate

public boolean isUpToDate()

moveCurrentRecord

public void moveCurrentRecord(int recordOffset)

Move the current record by an amount relative to the current record.

Parameters:

recordOffset - the number of records from the current record, positive or negative, by which the current record should move.

record

public DataNode record(int recordOffset)

Return a record relative to the current record.

Parameters:

recordOffset - the number of records from the current record, positive or negative (0 returns current record).

Returns:

the requested record.

recordAbsIndex

public int recordAbsIndex(int recordOffset)

recordsAfter

public int recordsAfter()

Determine the number of records after the current record in this window.

Returns:

the number of records after the current record.

recordsBefore

public int recordsBefore()

Determine the number of records before the current record in this window.

Returns:

the number of records before the current record.

removeRecordGroup

public boolean removeRecordGroup(DataNode dataGroup)

resetRecordDepth

public void resetRecordDepth()

setScriptProperty

public void setScriptProperty(String sPropertyName,
                              Arg propertyValue)

updateAfterLoad

public void updateAfterLoad()