UIX 2.2.16

oracle.cabo.ui.data.tree
Class BaseHGridDataProxy

java.lang.Object
  |
  +--oracle.cabo.ui.data.tree.BaseTreeDataProxy
        |
        +--oracle.cabo.ui.data.tree.BaseHGridDataProxy
All Implemented Interfaces:
HGridDataProxy, TreeDataProxy

public class BaseHGridDataProxy
extends BaseTreeDataProxy
implements HGridDataProxy


Constructor Summary
BaseHGridDataProxy()
           
 
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 class oracle.cabo.ui.data.tree.BaseTreeDataProxy
doPostRender, getChildren, getCollapseDestination, getExpandable, getExpandDestination, isSelected, selectionEnabled, setFormName, sharedInstance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.cabo.ui.data.tree.TreeDataProxy
doPostRender, getChildren, getCollapseDestination, getExpandable, getExpandDestination, isSelected, selectionEnabled, setFormName
 

Constructor Detail

BaseHGridDataProxy

public BaseHGridDataProxy()
Method Detail

getFocusRoot

public DataObject getFocusRoot(RenderingContext context,
                               DataObject root)
Description copied from interface: HGridDataProxy
Gets the tree node that has the focus.
Specified by:
getFocusRoot in interface HGridDataProxy
Returns:
the root

getBreadCrumbs

public DataObjectList getBreadCrumbs(RenderingContext context,
                                     DataObject root)
Specified by:
getBreadCrumbs in interface HGridDataProxy
Returns:
null

isExpandAllEnabled

public boolean isExpandAllEnabled(RenderingContext context,
                                  DataObject focusRoot)
Description copied from interface: HGridDataProxy
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.
Specified by:
isExpandAllEnabled in interface HGridDataProxy
Returns:
false

getExpandAllDestination

public java.lang.String getExpandAllDestination(RenderingContext context,
                                                DataObject focusRoot)
Description copied from interface: HGridDataProxy
Gets the destination of the expand-all link in an HGrid. This method is called only if the expand-all operation is permitted.
Specified by:
getExpandAllDestination in interface HGridDataProxy
Returns:
null

getCollapseAllDestination

public java.lang.String getCollapseAllDestination(RenderingContext context,
                                                  DataObject focusRoot)
Description copied from interface: HGridDataProxy
Gets the destination of the collapse-all link in an HGrid. This method is called only if the expand-all operation is permitted.
Specified by:
getCollapseAllDestination in interface HGridDataProxy
Returns:
null

getFocusDestination

public java.lang.String getFocusDestination(RenderingContext context,
                                            DataObject node,
                                            int index)
Description copied from interface: HGridDataProxy
Gets the destination of the focus link in an HGrid row.
Specified by:
getFocusDestination in interface HGridDataProxy
Returns:
null

getEventDestination

public java.lang.String getEventDestination(RenderingContext context,
                                            java.lang.String event,
                                            DataObject node,
                                            int index)
Description copied from interface: HGridDataProxy
Gets the destination of the link for the given event in an HGrid row.
Specified by:
getEventDestination in interface HGridDataProxy
Returns:
null

getViewNumber

public int getViewNumber(RenderingContext context,
                         int index)
Description copied from interface: HGridDataProxy
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).
Specified by:
getViewNumber in interface HGridDataProxy
Returns:
0

UIX 2.2.16