er.modern.directtoweb.components.buttons
Class ERMDActionButton

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ERMDDeleteButton, ERMDEditButton, ERMDInspectButton, ERMDSelectButton

public abstract class ERMDActionButton
extends ERDCustomComponent

Base Class for the ERM action buttons

See Also:

Serialized Form

Author:

davidleber

Bindings

object	object
displayGroup	displayGroup
dataSource	dataSource

D2W Keys

task	task
allowInlineEditing	allowInlineEditing
idForMainContainer	idForMainContainer
useAjaxControls	useAjaxControls
objectBeingEdited	objectBeingEdited
inlineTask	inlineTask
useNestedEditingContext	useNestedEditingContext
isEntityEditable	isEntityEditable
pageConfiguration	pageConfiguration

Nested Class Summary

static interface

ERMDActionButton.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 java.lang.String	_buttonClass
protected java.lang.String	_buttonLabel
protected java.lang.String	_updateContainer
protected java.lang.Boolean	_useAjax
static java.lang.String	BUTTON_PERFORMED_DELETE_ACTION
static java.lang.String	BUTTON_PERFORMED_EDIT_ACTION
static java.lang.String	BUTTON_PERFORMED_INSPECT_ACTION
static java.lang.String	BUTTON_PERFORMED_SELECT_ACTION

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

ERMDActionButton(com.webobjects.appserver.WOContext context)

Method Summary

com.webobjects.eocontrol.EODataSource	dataSource() The current data source.
com.webobjects.appserver.WODisplayGroup	displayGroup() The current display group.
protected com.webobjects.appserver.WOComponent	enclosingPageOfClass(java.lang.Class<?> c) Utility to return the first enclosing component that matches the given class, if there is one.
protected com.webobjects.eocontrol.EOEnterpriseObject	localInstanceOfObject() Utility method to return the local instance of the object as determined by the useNestedEditingContext binding
com.webobjects.appserver.WOComponent	nextPageInPage(com.webobjects.directtoweb.D2WPage parent) Utility to return the next page in the enclosing page.
com.webobjects.eocontrol.EOEnterpriseObject	object() The current object.
com.webobjects.directtoweb.D2WPage	parentD2WPage() Utility to return the enclosing D2W page, if there is one.
protected com.webobjects.directtoweb.EditPageInterface	parentEditPage() Utility to return the enclosing edit page, if there is one.
protected com.webobjects.directtoweb.ListPageInterface	parentListPage() Utility to return the enclosing list page, if there is one.
protected ERDPickPageInterface	parentPickPage() Utility to return the enclosing pick page, if there is one.
protected com.webobjects.directtoweb.QueryPageInterface	parentQueryPage() Utility to return the enclosing query page, if there is one.
protected com.webobjects.directtoweb.SelectPageInterface	parentSelectPage() Utility to return the enclosing select page, if there is one.
void	postNotification(java.lang.String note) Utility method to help post button action notification
boolean	shouldAllowInlineEditing() Utility method returns the boolean value for the allowInlineEditing binding.
boolean	shouldUseAjax() Utility method, returns the boolean value for the useAjax binding
boolean	synchronizesVariablesWithBindings() Action buttons do not synchronize their variables.
java.lang.String	updateContainer() ID of the update container for this button's ajax update.
java.lang.Boolean	useAjax() Utility method, returns whether shouldAllowInlineEditing and shouldUseAjax are true

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, reset, resetCachedBindingsInStatefulComponent, setD2wContext, setExtraBindings, setKey, setLocalContext, task, taskIsEdit, taskIsInspect, taskIsList, validationFailedWithException, valueForBinding

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

invokeAction, isStateless, 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

BUTTON_PERFORMED_DELETE_ACTION

public static final java.lang.String BUTTON_PERFORMED_DELETE_ACTION

See Also:

Constant Field Values

BUTTON_PERFORMED_EDIT_ACTION

public static final java.lang.String BUTTON_PERFORMED_EDIT_ACTION

See Also:

Constant Field Values

BUTTON_PERFORMED_SELECT_ACTION

public static final java.lang.String BUTTON_PERFORMED_SELECT_ACTION

See Also:

Constant Field Values

BUTTON_PERFORMED_INSPECT_ACTION

public static final java.lang.String BUTTON_PERFORMED_INSPECT_ACTION

See Also:

Constant Field Values

_buttonLabel

protected java.lang.String _buttonLabel

_buttonClass

protected java.lang.String _buttonClass

_updateContainer

protected java.lang.String _updateContainer

_useAjax

protected java.lang.Boolean _useAjax

Constructor Detail

ERMDActionButton

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

Method Detail

updateContainer

public java.lang.String updateContainer()

ID of the update container for this button's ajax update. Defaults to the idForMainContainer value

Returns:

postNotification

public void postNotification(java.lang.String note)

Utility method to help post button action notification

Parameters:

note -

synchronizesVariablesWithBindings

public final boolean synchronizesVariablesWithBindings()

Action buttons do not synchronize their variables.

Overrides:

synchronizesVariablesWithBindings in class ERDCustomComponent

object

public com.webobjects.eocontrol.EOEnterpriseObject object()

The current object.

displayGroup

public com.webobjects.appserver.WODisplayGroup displayGroup()

The current display group.

dataSource

public com.webobjects.eocontrol.EODataSource dataSource()

The current data source.

localInstanceOfObject

protected com.webobjects.eocontrol.EOEnterpriseObject localInstanceOfObject()

Utility method to return the local instance of the object as determined by the useNestedEditingContext binding

Returns:

shouldAllowInlineEditing

public boolean shouldAllowInlineEditing()

Utility method returns the boolean value for the allowInlineEditing binding. Used to determine whether inline behaviour is used.

Returns:

shouldUseAjax

public boolean shouldUseAjax()

Utility method, returns the boolean value for the useAjax binding

Returns:

useAjax

public java.lang.Boolean useAjax()

Utility method, returns whether shouldAllowInlineEditing and shouldUseAjax are true

Returns:

nextPageInPage

public com.webobjects.appserver.WOComponent nextPageInPage(com.webobjects.directtoweb.D2WPage parent)

Utility to return the next page in the enclosing page.

parentSelectPage

protected com.webobjects.directtoweb.SelectPageInterface parentSelectPage()

Utility to return the enclosing select page, if there is one.

enclosingPageOfClass

protected com.webobjects.appserver.WOComponent enclosingPageOfClass(java.lang.Class<?> c)

Utility to return the first enclosing component that matches the given class, if there is one.

parentListPage

protected com.webobjects.directtoweb.ListPageInterface parentListPage()

Utility to return the enclosing list page, if there is one.

parentEditPage

protected com.webobjects.directtoweb.EditPageInterface parentEditPage()

Utility to return the enclosing edit page, if there is one.

parentQueryPage

protected com.webobjects.directtoweb.QueryPageInterface parentQueryPage()

Utility to return the enclosing query page, if there is one.

parentPickPage

protected ERDPickPageInterface parentPickPage()

Utility to return the enclosing pick page, if there is one.

parentD2WPage

public com.webobjects.directtoweb.D2WPage parentD2WPage()

Utility to return the enclosing D2W page, if there is one.