ERDBranchDelegate (Project Wonder Reference Documentation)

java.lang.Object
- er.directtoweb.delegates.ERDBranchDelegate

All Implemented Interfaces:

com.webobjects.directtoweb.NextPageDelegate, ERDBranchDelegateInterface, Serializable

Direct Known Subclasses:

ERD2WControllerFactory.ERD2WController
```
public abstract class ERDBranchDelegate
extends Object
implements ERDBranchDelegateInterface
```
The branch delegate is used in conjunction with the ERDMessagePageInterface to allow flexible branching for message pages. Branch delegates can only be used with templates that implement the ERDBranchInterface.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ERDBranchDelegate.D2WDelegate
Runtime flags for the delegate, so you can have one delegate for all tasks.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ERDBranchDelegate.D2WDelegate` Runtime flags for the delegate, so you can have one delegate for all tasks.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BRANCH_BUTTON_ID`
`static String`	`BRANCH_CHOICES`
`static String`	`BRANCH_LABEL`
`static String`	`BRANCH_NAME`
`static String`	`BRANCH_PREFIX`
`static Logger`	`log` logging support
`static Class[]`	`WOComponentClassArray` holds the WOComponent class array used to lookup branch delegate methods

Constructor Summary

Constructors
Constructor and Description

ERDBranchDelegate()

Constructors
Constructor and Description
`ERDBranchDelegate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected NSDictionary`	`branchChoiceDictionary(String method, String label)` Utility to build branch choice dictionaries in code.
`NSArray`	`branchChoicesForContext(com.webobjects.directtoweb.D2WContext context)` Calculates which branches to show in the display first asking the context for the key branchChoices.
`protected NSArray`	`choiceByLeavingKeys(NSArray keys, NSArray choices)` Utility to leave entries based on an array of keys
`protected NSArray`	`choiceByRemovingKeys(NSArray keys, NSArray choices)` Utility to remove entries based on an array of keys
`protected com.webobjects.directtoweb.D2WContext`	`d2wContext(com.webobjects.appserver.WOComponent sender)` Gets the D2W context from the innermost enclosing D2W component of the sender.
`protected NSArray`	`defaultBranchChoices(com.webobjects.directtoweb.D2WContext context)` Uses reflection to find all of the public methods that don't start with an underscore and take a single WOComponent as a parameter are returned.
`com.webobjects.appserver.WOComponent`	`nextPage(com.webobjects.appserver.WOComponent sender)` Implementation of the `NextPageDelegate` interface.
`protected com.webobjects.eocontrol.EOEnterpriseObject`	`object(com.webobjects.directtoweb.D2WContext context)` Returns the current object form the d2w context
`protected com.webobjects.eocontrol.EOEnterpriseObject`	`object(com.webobjects.appserver.WOComponent sender)` return the innermost object which might be of interest

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
public static final Logger log
```
    logging support
  - WOComponentClassArray
```
public static final Class[] WOComponentClassArray
```
    holds the WOComponent class array used to lookup branch delegate methods
  - BRANCH_CHOICES
```
public static final String BRANCH_CHOICES
```
    See Also:
    
    Constant Field Values
  - BRANCH_BUTTON_ID
```
public static final String BRANCH_BUTTON_ID
```
    See Also:
    
    Constant Field Values
  - BRANCH_NAME
```
public static final String BRANCH_NAME
```
    See Also:
    
    Constant Field Values
  - BRANCH_LABEL
```
public static final String BRANCH_LABEL
```
    See Also:
    
    Constant Field Values
  - BRANCH_PREFIX
```
public static final String BRANCH_PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ERDBranchDelegate
```
public ERDBranchDelegate()
```
- Method Detail
  - nextPage
```
public final com.webobjects.appserver.WOComponent nextPage(com.webobjects.appserver.WOComponent sender)
```
    Implementation of the NextPageDelegate interface. This method provides the dynamic dispatch based on the selected branch provided by the sender. Will call the method <branchName>(WOComponent) on itself returning the result.
    
    Specified by:
    
    nextPage in interface com.webobjects.directtoweb.NextPageDelegate
    
    Parameters:
    
    sender - template invoking the branch delegate
    
    Returns:
    
    result of dynamic method lookup and execution on itself.
  - branchChoiceDictionary
```
protected NSDictionary branchChoiceDictionary(String method,
                                              String label)
```
    Utility to build branch choice dictionaries in code.
    
    Parameters:
    
    method - name of the method in question
    
    label - label for the button, a beautified method name will be used if set to null.
    
    Returns:
    
    NSDictionary suitable as a branch choice.
  - branchChoicesForContext
```
public NSArray branchChoicesForContext(com.webobjects.directtoweb.D2WContext context)
```
    Calculates which branches to show in the display first asking the context for the key branchChoices. If this returns null then
    
    Specified by:
    
    branchChoicesForContext in interface ERDBranchDelegateInterface
    
    Parameters:
    
    context - current D2W context
    
    Returns:
    
    array of branch names.
  - defaultBranchChoices
```
protected NSArray defaultBranchChoices(com.webobjects.directtoweb.D2WContext context)
```
    Uses reflection to find all of the public methods that don't start with an underscore and take a single WOComponent as a parameter are returned. The methods are sorted by this key.
    
    Parameters:
    
    context - current D2W context
  - d2wContext
```
protected com.webobjects.directtoweb.D2WContext d2wContext(com.webobjects.appserver.WOComponent sender)
```
    Gets the D2W context from the innermost enclosing D2W component of the sender.
    
    Parameters:
    
    sender -
  - object
```
protected com.webobjects.eocontrol.EOEnterpriseObject object(com.webobjects.appserver.WOComponent sender)
```
    return the innermost object which might be of interest
    
    Parameters:
    
    sender -
  - object
```
protected com.webobjects.eocontrol.EOEnterpriseObject object(com.webobjects.directtoweb.D2WContext context)
```
    Returns the current object form the d2w context
    
    Parameters:
    
    context -
  - choiceByRemovingKeys
```
protected NSArray choiceByRemovingKeys(NSArray keys,
                                       NSArray choices)
```
    Utility to remove entries based on an array of keys
    
    Parameters:
    
    keys -
    
    choices -
  - choiceByLeavingKeys
```
protected NSArray choiceByLeavingKeys(NSArray keys,
                                      NSArray choices)
```
    Utility to leave entries based on an array of keys
    
    Parameters:
    
    keys -
    
    choices -

Class ERDBranchDelegate

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

WOComponentClassArray

BRANCH_CHOICES

BRANCH_BUTTON_ID

BRANCH_NAME

BRANCH_LABEL

BRANCH_PREFIX

Constructor Detail

ERDBranchDelegate

Method Detail

nextPage

branchChoiceDictionary

branchChoicesForContext

defaultBranchChoices

d2wContext

object

object

choiceByRemovingKeys

choiceByLeavingKeys