er.directtoweb.components.buttons
Class ERDControllerButton

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          er.extensions.components.ERXComponent
              er.extensions.components.ERXNonSynchronizingComponent
                  er.directtoweb.components.ERDCustomComponent
                      er.directtoweb.components.buttons.ERDActionButton
                          er.directtoweb.components.buttons.ERDControllerButton

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, ERDBranchInterface, ERXExceptionHolder, java.io.Serializable, java.lang.Cloneable

public class ERDControllerButton
extends ERDActionButton
implements ERDBranchInterface

Action button that looks for the inner-most page with a pageController (which must be a ERDBranchDelegateInterface), collects all the actions from there and displays them as a menu with an activation button.

See Also:

Serialized Form

Author:

ak

Nested Class Summary

Nested classes/interfaces inherited from class er.directtoweb.components.buttons.ERDActionButton

ERDActionButton.Keys

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.Null, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

protected com.webobjects.foundation.NSDictionary	branch holds the chosen branch
protected com.webobjects.foundation.NSArray	branchChoices
protected ERDBranchDelegateInterface	branchDelegate

Fields inherited from class er.directtoweb.components.ERDCustomComponent

extraBindings, FALSE, TRUE

Fields inherited from class er.extensions.components.ERXComponent

_dynamicBindings

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

ERDControllerButton(com.webobjects.appserver.WOContext context)

Method Summary

com.webobjects.foundation.NSDictionary	branch() Cover method for getting the choosen branch.
java.lang.String	branchButtonLabel() Implementation of the ERDBranchDelegate.
com.webobjects.foundation.NSArray	branchChoices() Calculates the branch choices for the current page.
ERDBranchDelegateInterface	branchDelegate() find the next non-null NextPageDelegate in the component tree, break if there is a D2WPage found beforehand
java.lang.String	branchName() Implementation of the ERDBranchDelegate.
java.lang.String	cssForChoice()
boolean	hasBranchChoices() Determines if this message page should display branch choices.
java.lang.String	imageName()
boolean	isButton()
boolean	isFlyOver()
com.webobjects.appserver.WOComponent	nextPageFromParent()
com.webobjects.appserver.WOComponent	performAction() override this
void	reset() Used by stateless subclasses.
void	setBranch(com.webobjects.foundation.NSDictionary value) Sets the user chosen branch.
void	validationFailedWithException(java.lang.Throwable theException, java.lang.Object theValue, java.lang.String theKeyPath) Validation Support.

Methods inherited from class er.directtoweb.components.buttons.ERDActionButton

dataSource, displayGroup, enclosingPageOfClass, isStateless, nextPageInPage, object, parentD2WPage, parentEditPage, parentListPage, parentPickPage, parentQueryPage, parentSelectPage, synchronizesVariablesWithBindings, task, topLevelD2WPage

Methods inherited from class er.directtoweb.components.ERDCustomComponent

appendToResponse, booleanForBinding, clearValidationFailed, d2wComponentNameDebuggingEnabled, d2wContext, d2wContextFromBindings, d2wContextValueForBinding, d2wDebuggingEnabled, d2wPage, d2wPropertyKeyDebuggingEnabled, extraBindings, extraBindingsValueForBinding, hasBinding, integerBooleanForBinding, key, localContext, logDebugInfo, originalValueForBinding, parentValueForBinding, resetCachedBindingsInStatefulComponent, setD2wContext, setExtraBindings, setKey, setLocalContext, taskIsEdit, taskIsInspect, taskIsList, valueForBinding

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

invokeAction, takeValuesFromRequest

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, stringValueForBinding, stringValueForBinding, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

_associationWithName, _childTemplate, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasSession, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

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

Field Detail

branch

protected com.webobjects.foundation.NSDictionary branch

holds the chosen branch

branchChoices

protected com.webobjects.foundation.NSArray branchChoices

branchDelegate

protected ERDBranchDelegateInterface branchDelegate

Constructor Detail

ERDControllerButton

public ERDControllerButton(com.webobjects.appserver.WOContext context)

Method Detail

isFlyOver

public boolean isFlyOver()

isButton

public boolean isButton()

cssForChoice

public java.lang.String cssForChoice()

branchDelegate

public ERDBranchDelegateInterface branchDelegate()

find the next non-null NextPageDelegate in the component tree, break if there is a D2WPage found beforehand

nextPageFromParent

public com.webobjects.appserver.WOComponent nextPageFromParent()

performAction

public com.webobjects.appserver.WOComponent performAction()

override this

reset

public void reset()

Description copied from class: ERDCustomComponent

Used by stateless subclasses.

Overrides:

reset in class ERDCustomComponent

branch

public com.webobjects.foundation.NSDictionary branch()

Cover method for getting the choosen branch.

Returns:

user choosen branch.

setBranch

public void setBranch(com.webobjects.foundation.NSDictionary value)

Sets the user chosen branch.

Parameters:

value - branch chosen by user.

branchName

public java.lang.String branchName()

Implementation of the ERDBranchDelegate. Gets the user selected branch name.

Specified by:

branchName in interface ERDBranchInterface

Returns:

user selected branch name.

branchButtonLabel

public java.lang.String branchButtonLabel()

Implementation of the ERDBranchDelegate. Gets the user selected branch name.

Returns:

user selected branch name.

branchChoices

public com.webobjects.foundation.NSArray branchChoices()

Calculates the branch choices for the current page. This method is just a cover for calling the method branchChoicesForContext on the current ERDBranchDelegate.

Returns:

array of branch choices

hasBranchChoices

public boolean hasBranchChoices()

Determines if this message page should display branch choices.

Returns:

if the current delegate supports branch choices.

validationFailedWithException

public void validationFailedWithException(java.lang.Throwable theException,
                                          java.lang.Object theValue,
                                          java.lang.String theKeyPath)

Description copied from class: ERDCustomComponent

Validation Support. Passes errors to the parent.

Overrides:

validationFailedWithException in class ERDCustomComponent

imageName

public java.lang.String imageName()