com.goldencode.p2j.util

Interface IterableResource

All Known Subinterfaces:

Buffer, CommonFrame, DynamicFrameTemplate, EmptyBuffer, FrameInterface, HandleCommon, TempTableBuffer

All Known Implementing Classes:

BufferImpl, FrameWidget, GenericFrame

public interface IterableResource

Defines an API for access to attributes and methods of iterable components such as Buffer or Frame or Dialog.

Method Summary

Modifier and Type	Method and Description
handle	currentIteration() Conversion of CURRENT-ITERATION attribute (KW_CUR_ITER).
handle	getIteration(int level) Implements the GET-ITERATION() widget or buffer method.
default handle	getIteration(NumberType level) Implements the GET-ITERATION() widget or buffer method.
void	setCurrentIteration(handle newIter) Set the CURRENT-ITERATION widget handle for this frame.

Method Detail

currentIteration

handle currentIteration()

Conversion of CURRENT-ITERATION attribute (KW_CUR_ITER). Getter of CURRENT-ITERATION attribute.

Returns:

current value of CURRENT-ITERATION attribute.

setCurrentIteration

void setCurrentIteration(handle newIter)

Set the CURRENT-ITERATION widget handle for this frame. This attribute is writable only for frames.

Parameters:

newIter - A handle for the current iteration of the frame.

getIteration

default handle getIteration(NumberType level)

Implements the GET-ITERATION() widget or buffer method.

Parameters:

level - The level of the iteration to get.

Returns:

The handle of the iteration, field-group or buffer.

getIteration

handle getIteration(int level)

Implements the GET-ITERATION() widget or buffer method.

Parameters:

level - The level of the iteration to get.

Returns:

The handle of the iteration, field-group or buffer.