ADF Designtime

oracle.adf.dt.controls
Interface DataControlTreeNode

All Superinterfaces:
BasicTreeNode, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode
All Known Subinterfaces:
DataControlAccessorNode
All Known Implementing Classes:
BC4JObjectAttributeAccessorTreeNode, BeanModelAccessorTreeNode, DefaultDataControlAccessorNode, DefaultDataControlTreeNode, ToplinkModelQueryTreeNode

public interface DataControlTreeNode
extends BasicTreeNode


Field Summary
static int ACCESSOR_NODE
           
static int ACTION_NODE
           
static int APPLICATION_MODULE
           
static int ATTRIBUTE_NODE
           
static int COLLECTION_NODE
          Node types returned be getNodeType
static int DATA_CONTROL_NODE
           
static int JAVA_BEAN
           
static int METHOD_NODE
           
 
Method Summary
 boolean actionRepresentsNode(JUDTCtrlAction action)
          Allows the tree node to decide if the passed in action represents the action that the tree node requires.
 java.lang.String getActualBindingType(java.lang.String sBindingType)
          This function is called prior to creating a binding via the binding factory.
 java.util.ArrayList getAttributeBindings()
           
 AttributeInfo getAttributeInfo()
          Only call this function if getNodeType() returns ATTRIBUTE_NODE
 java.lang.String getBindingNameSuffix()
          Returns the binding name suffix used in generating the control id.
 JUDTDataControl getDataControl()
          Returns the DataControl parent of this node.
 java.lang.String getDefaultBindingName()
           
 java.lang.String getInstanceName()
           
 DataControlAccessorNode getIteratorSourceNode()
          If the requiresIterator() function returns true, the getIteratorSourceNode return the node that provides the iterator information for initialization purposes.
 MethodReturnNode getMethodReturnNode()
          Returns the method return node.
 java.lang.String getModelObjectName()
           
 java.lang.String getModelObjectType()
           
 int getNodeType()
           
 void initializeActionBinding(JUDTCtrlAction action)
          Allows the tree node to initialize the action that is bound to it.
 boolean isMethodReturnChildNode()
          Returns True if this node is contained within a method return node.
 boolean isOperationSupported(int nOperation)
          Checks with the node if the operation is supported.
 boolean isReadyForBinding()
           
 boolean isRuntimeEditable()
          Returns true if the service objects supports editing
 boolean isRuntimeVisible()
          return true if this node has the visible hint on, it is possible to hide nodes such as attributes from being generated in the user interface.
 boolean isScalarMethodReturnNode()
          Returns true if we have a scalar method return node
 boolean isViewObjectMethod()
          Returns true if we have a View Object method node
 boolean requiresIterator()
           
 void setInstanceName(java.lang.String sName)
           
 
Methods inherited from interface oracle.adf.dt.controls.BasicTreeNode
getNodeIcon, getNodeText, getTooltipText, getUserObject, setShouldExpand, shouldExpandNode
 
Methods inherited from interface javax.swing.tree.MutableTreeNode
insert, remove, remove, removeFromParent, setParent, setUserObject
 
Methods inherited from interface javax.swing.tree.TreeNode
children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf
 

Field Detail

COLLECTION_NODE

public static final int COLLECTION_NODE
Node types returned be getNodeType

See Also:
Constant Field Values

ACCESSOR_NODE

public static final int ACCESSOR_NODE
See Also:
Constant Field Values

ACTION_NODE

public static final int ACTION_NODE
See Also:
Constant Field Values

METHOD_NODE

public static final int METHOD_NODE
See Also:
Constant Field Values

ATTRIBUTE_NODE

public static final int ATTRIBUTE_NODE
See Also:
Constant Field Values

DATA_CONTROL_NODE

public static final int DATA_CONTROL_NODE
See Also:
Constant Field Values

APPLICATION_MODULE

public static final int APPLICATION_MODULE
See Also:
Constant Field Values

JAVA_BEAN

public static final int JAVA_BEAN
See Also:
Constant Field Values
Method Detail

getNodeType

public int getNodeType()

getDataControl

public JUDTDataControl getDataControl()
Returns the DataControl parent of this node.

Returns:

getModelObjectName

public java.lang.String getModelObjectName()
Returns:
model object name.

getInstanceName

public java.lang.String getInstanceName()
Returns:
instance name for runtime use via expression language

setInstanceName

public void setInstanceName(java.lang.String sName)
Parameters:
sName - - new instance name to be used for node

getAttributeBindings

public java.util.ArrayList getAttributeBindings()
Returns:
list of attributes that this node exposes for binding.

getModelObjectType

public java.lang.String getModelObjectType()
Returns:
java type for model object

getAttributeInfo

public AttributeInfo getAttributeInfo()
Only call this function if getNodeType() returns ATTRIBUTE_NODE

Returns:

requiresIterator

public boolean requiresIterator()
Returns:
true if this node requires an iterator definition to be created.

getIteratorSourceNode

public DataControlAccessorNode getIteratorSourceNode()
If the requiresIterator() function returns true, the getIteratorSourceNode return the node that provides the iterator information for initialization purposes. The most common scenario is to return your own reference. This is necessary to point to the accessor node that is to initiallize its own iterator.

Returns:

isRuntimeEditable

public boolean isRuntimeEditable()
Returns true if the service objects supports editing


isRuntimeVisible

public boolean isRuntimeVisible()
return true if this node has the visible hint on, it is possible to hide nodes such as attributes from being generated in the user interface. This is only a hint, it is not required that it be respected by the snippets or controls being generated.


isMethodReturnChildNode

public boolean isMethodReturnChildNode()
Returns True if this node is contained within a method return node. This means that it is a prt of a method result.


getMethodReturnNode

public MethodReturnNode getMethodReturnNode()
Returns the method return node. This will be null if isMethodReturnChildNode returns false.


isViewObjectMethod

public boolean isViewObjectMethod()
Returns true if we have a View Object method node


isScalarMethodReturnNode

public boolean isScalarMethodReturnNode()
Returns true if we have a scalar method return node


getBindingNameSuffix

public java.lang.String getBindingNameSuffix()
Returns the binding name suffix used in generating the control id.


getDefaultBindingName

public java.lang.String getDefaultBindingName()
Returns:
The default name for a binding the is created to access this node. This allows the node creators to control the generated names.

isReadyForBinding

public boolean isReadyForBinding()
Returns:
false if this node is not fully defined. An example of this is a collection without the beanClass attribute set. If the node returns false, dragging from this node is disabled.

getActualBindingType

public java.lang.String getActualBindingType(java.lang.String sBindingType)
This function is called prior to creating a binding via the binding factory. It allows the node to decide the actual binding type to be passed into the binding factory. This allows the tree node to look at the binding type passed in by the client and make a substitution if necessary. One example of this is in Toplink, the ADF client will ask for a DCAction binding, but the Toplink node want a subclass name such as 'DCToplinkAction' to be passed into the factory. This gives the node that level of control.

Returns:
the real binding type to use if is to be substituted

initializeActionBinding

public void initializeActionBinding(JUDTCtrlAction action)
Allows the tree node to initialize the action that is bound to it. The default implementation provides initialization for the known method types.

Parameters:
action -

actionRepresentsNode

public boolean actionRepresentsNode(JUDTCtrlAction action)
Allows the tree node to decide if the passed in action represents the action that the tree node requires. Since the comparison is data control specific, the tree node needs to decide if the action that already exists in the binding container matches the node's requirements.

Parameters:
action -
Returns:

isOperationSupported

public boolean isOperationSupported(int nOperation)
Checks with the node if the operation is supported. If false is returned, the action node will not be added. Most node types are not concerned with this function. Only data control and accessor nodes would be expected to override this function.

Parameters:
nOperation -
Returns:

ADF Designtime

 

Copyright © 1997, 2004, Oracle. All rights reserved.