SilverStream
Application Server 3.5

com.sssw.rt.util
Interface AgiRowCursorViewSupport

All Known Implementing Classes:
AgcData, com.sssw.rt.util.AgoRowCursor

public interface AgiRowCursorViewSupport

This interface includes a set of methods that are required for proper behavior when an AgiRowCursor that provides a hierarchical set of data is used in a hierarchical AgcView.


Method Summary
 int getChildEntryCount()
          This method returns the number of rows managed by the row cursor.
 int getDisplayEntryNumber()
          This method is used by the TView control in conjunction with setDisplayEntryNumber The implementor of this method should return the value specified by setDisplayEntryNumber.
 void setDisplayEntryNumber(int entrynumber)
          This method is used by the TView control in conjunction with getDisplayEntryNumber The implementor of this method should preserve the value specified by this call.
 

Method Detail

getChildEntryCount

public int getChildEntryCount()
This method returns the number of rows managed by the row cursor. Since this row cursor is sortable, it is able to get all of its rows, and therefore should be able to respond to this request.

If all rows have not yet been fetched and the row cursor does not know the final count, then it may return the negative of the number of rows already fetched.

In order to ensure that the row count is known, the caller may invoke gotoLast() before calling this method.


getDisplayEntryNumber

public int getDisplayEntryNumber()
This method is used by the TView control in conjunction with setDisplayEntryNumber The implementor of this method should return the value specified by setDisplayEntryNumber. If setDisplayEntryNumber has never been called for this entry, then the return valud should be this entry's row number; that is, the ordinal count of this row from the first row at its hierarchical level.

setDisplayEntryNumber

public void setDisplayEntryNumber(int entrynumber)
This method is used by the TView control in conjunction with getDisplayEntryNumber The implementor of this method should preserve the value specified by this call.
Parameters:
entrynumber - the value for the row to retain
See Also:
AgiRowCursorViewSupport.getDisplayEntryNumber()

SilverStream
Application Server 3.5