oracle.cabo.ui.data.tree
Interface HGridDataProxy

All Superinterfaces:

TreeDataProxy

All Known Implementing Classes:

BaseHGridDataProxy, ClientStateHGridDataProxy, DynamicHGridDataProxy

public interface HGridDataProxy

extends TreeDataProxy

This DataProxy sits between an HGrid renderer and its data. It is used to produce dynamic views of the static tree that is rendered by HGrid. A DataProxy object must be created for each view of the data.

Method Summary

DataObjectList	getBreadCrumbs(RenderingContext context, DataObject root)
java.lang.String	getCollapseAllDestination(RenderingContext context, DataObject focusRoot) Gets the destination of the collapse-all link in an HGrid.
java.lang.String	getEventDestination(RenderingContext context, java.lang.String event, DataObject node, int index) Gets the destination of the link for the given event in an HGrid row.
java.lang.String	getExpandAllDestination(RenderingContext context, DataObject focusRoot) Gets the destination of the expand-all link in an HGrid.
java.lang.String	getFocusDestination(RenderingContext context, DataObject node, int index) Gets the destination of the focus link in an HGrid row.
DataObject	getFocusRoot(RenderingContext context, DataObject root) Gets the tree node that has the focus.
int	getViewNumber(RenderingContext context, int index) For large record sets it's expensive to display every row.
boolean	isExpandAllEnabled(RenderingContext context, DataObject focusRoot) checks to see if the expand/collapse-all links on this HGrid are enabled.

Methods inherited from interface oracle.cabo.ui.data.tree.TreeDataProxy

doPostRender, getChildren, getCollapseDestination, getExpandable, getExpandDestination, isSelected, selectionEnabled, setFormName

Method Detail

getFocusRoot

public DataObject getFocusRoot(RenderingContext context,
                               DataObject root)

Gets the tree node that has the focus.

Parameters:

root - the root of the tree.

Returns:

the focus root.

getBreadCrumbs

public DataObjectList getBreadCrumbs(RenderingContext context,
                                     DataObject root)

Returns:

each DataObject is querried with the UIConstants TEXT_KEY and DESTINATION_KEY for the text and destination of the corresponding crumb.

See Also:

DataObject, UIConstants.TEXT_KEY, UIConstants.DESTINATION_KEY

isExpandAllEnabled

public boolean isExpandAllEnabled(RenderingContext context,
                                  DataObject focusRoot)

checks to see if the expand/collapse-all links on this HGrid are enabled. If an expand-all operation on the focus root (the tree node that has the focus) would result in too many rows, then this method must return false.

Parameters:

focusRoot - the tree node that has the focus.

Returns:

true if expand/collapse-all links must be rendered.

getExpandAllDestination

public java.lang.String getExpandAllDestination(RenderingContext context,
                                                DataObject focusRoot)

Gets the destination of the expand-all link in an HGrid. This method is called only if the expand-all operation is permitted.

Parameters:

focusRoot - the tree node that has the focus.

See Also:

isExpandAllEnabled(RenderingContext, DataObject)

getCollapseAllDestination

public java.lang.String getCollapseAllDestination(RenderingContext context,
                                                  DataObject focusRoot)

Gets the destination of the collapse-all link in an HGrid. This method is called only if the expand-all operation is permitted.

Parameters:

focusRoot - the tree node that has the focus.

See Also:

isExpandAllEnabled(RenderingContext, DataObject)

getFocusDestination

public java.lang.String getFocusDestination(RenderingContext context,
                                            DataObject node,
                                            int index)

Gets the destination of the focus link in an HGrid row.

Parameters:

node - the tree node

index - the corresponding row index of the tree node. this is zero based.

Returns:

the destination of the focus link

See Also:

TreeDataProxy.getExpandDestination(RenderingContext, DataObject, int)

getEventDestination

public java.lang.String getEventDestination(RenderingContext context,
                                            java.lang.String event,
                                            DataObject node,
                                            int index)

Gets the destination of the link for the given event in an HGrid row.

Parameters:

event - the name of the event for which a destination is desired Currently supported values are: Exapnd, Collapse, Previous, and Next.

node - the tree node

index - the corresponding row index of the tree node. this is zero based.

Returns:

the destination of the focus link

See Also:

TreeDataProxy.getExpandDestination(RenderingContext, DataObject, int)

getViewNumber

public int getViewNumber(RenderingContext context,
                         int index)

For large record sets it's expensive to display every row. Instead we implement a view on the child rows. The views are of a fixed size known to the renderer. This method returns the number of the view that should be displayed (so row getViewNum(...) * viewSize is the row number).

Parameters:

node - the tree node

index - the corresponding row index of the tree node. this is zero based.

Returns:

the view number