oracle.ide.controls.elementtree

Class PageableChildren.ChildrenState

java.lang.Object

oracle.ide.controls.elementtree.PageableChildren.ChildrenState

Enclosing interface:

PageableChildren

public static final class PageableChildren.ChildrenState
extends java.lang.Object

Represents the state of currently provided children. The object is created and provided to getChildren(ChildrenState cookie) method when asking for the first children batch.

On the model side:

• when cookie.get() == null, provide the first children batch
• when more children are available, mark your state with cookie.set()
• when cookie.get() != null, based on the value provide another children
• when you know all the children were provided, call cookie.set(null)
to inform the tree that no more elements are available

On the tree side:

• empty ChildrenState instance created when asking for the first batch
• when cookie.get() != null there are another batch on the model side
• when cookie.get() == null we have already got all the children

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	get() Represents the state of already provided children from previous PageableChildren.getChildren(cookie) call.
void	set(java.lang.Object state) Provide an object which represents the current state of children.

Methods inherited from class java.lang.Object

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

Method Detail

set

public void set(java.lang.Object state)

Provide an object which represents the current state of children. Provide null parameter when all children were provided.

Parameters:

state - the current state of provided children or null when all children were obtained

get

public java.lang.Object get()

Represents the state of already provided children from previous PageableChildren.getChildren(cookie) call.

Returns:

object representing current state of shown children