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:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, ERXExceptionHolder, Serializable, 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

Name	Description
object	object
displayGroup	displayGroup
dataSource	dataSource

D2W Keys

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ERMDActionButton.Keys

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

WOComponent._EventLoggingEnabler, WOComponent.Event

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

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

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

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

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

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_buttonClass
protected String	_buttonLabel
protected String	_updateContainer
protected Boolean	_useAjax
static String	BUTTON_PERFORMED_DELETE_ACTION
static String	BUTTON_PERFORMED_EDIT_ACTION
static String	BUTTON_PERFORMED_INSPECT_ACTION
static String	BUTTON_PERFORMED_SELECT_ACTION

Fields inherited from class er.directtoweb.components.ERDCustomComponent

extraBindings, FALSE, log, 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

Constructors

Constructor and Description
ERMDActionButton(WOContext context)

Method Summary

Modifier and Type	Method and Description
EODataSource	dataSource() The current data source.
WODisplayGroup	displayGroup() The current display group.
protected WOComponent	enclosingPageOfClass(Class<?> c) Utility to return the first enclosing component that matches the given class, if there is one.
protected EOEnterpriseObject	localInstanceOfObject() Utility method to return the local instance of the object as determined by the useNestedEditingContext binding
WOComponent	nextPageInPage(D2WPage parent) Utility to return the next page in the enclosing page.
EOEnterpriseObject	object() The current object.
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(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.
String	updateContainer() ID of the update container for this button's ajax update.
Boolean	useAjax() Utility method, returns whether shouldAllowInlineEditing and shouldUseAjax are true

Methods inherited from class er.directtoweb.components.ERDCustomComponent

appendToResponse, 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, takeValuesFromRequest

Methods inherited from class er.extensions.components.ERXComponent

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

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _childTemplate, _cleanUpStatelessComponent, _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, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

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 String BUTTON_PERFORMED_DELETE_ACTION

See Also:

Constant Field Values

BUTTON_PERFORMED_EDIT_ACTION

public static final String BUTTON_PERFORMED_EDIT_ACTION

See Also:

Constant Field Values

BUTTON_PERFORMED_SELECT_ACTION

public static final String BUTTON_PERFORMED_SELECT_ACTION

See Also:

Constant Field Values

BUTTON_PERFORMED_INSPECT_ACTION

public static final String BUTTON_PERFORMED_INSPECT_ACTION

See Also:

Constant Field Values

_buttonLabel

protected String _buttonLabel

_buttonClass

protected String _buttonClass

_updateContainer

protected String _updateContainer

_useAjax

protected Boolean _useAjax

Constructor Detail

ERMDActionButton

public ERMDActionButton(WOContext context)

Method Detail

updateContainer

public String updateContainer()

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

postNotification

public void postNotification(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

Returns:

false

object

public EOEnterpriseObject object()

The current object.

displayGroup

public WODisplayGroup displayGroup()

The current display group.

dataSource

public EODataSource dataSource()

The current data source.

localInstanceOfObject

protected EOEnterpriseObject localInstanceOfObject()

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

shouldAllowInlineEditing

public boolean shouldAllowInlineEditing()

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

shouldUseAjax

public boolean shouldUseAjax()

Utility method, returns the boolean value for the useAjax binding

useAjax

public Boolean useAjax()

Utility method, returns whether shouldAllowInlineEditing and shouldUseAjax are true

nextPageInPage

public WOComponent nextPageInPage(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 WOComponent enclosingPageOfClass(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 D2WPage parentD2WPage()

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