er.modern.directtoweb.components.buttons
Class ERMDDeleteButton

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
                          er.modern.directtoweb.components.buttons.ERMDDeleteButton

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:

ERMDRemoveRelatedButton

public class ERMDDeleteButton
extends ERMDActionButton

Delete button for repetitions.

See Also:

Serialized Form

Author:

davidleber

Bindings

object	object
dataSource	dataSource
displayGroup	displayGroup
d2wContext	d2wContext

D2W Keys

deleteButtonLabel	deleteButtonLabel
classForDeleteObjButton	classForDeleteObjButton
classForDisabledDeleteObjButton	classForDisabledDeleteObjButton
cancelButtonLabel	cancelButtonLabel
classForCancelDialogButton	classForCancelDialogButton
classForDeleteDialogButton	classForDeleteDialogButton
confirmDeleteMessage	confirmDeleteMessage

Nested Class Summary

static interface

ERMDDeleteButton.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	_dialogMessage
protected java.lang.String	_disabledButtonClass
static java.lang.String	DisplayGroupObjectDeleted

Fields inherited from class er.modern.directtoweb.components.buttons.ERMDActionButton

_buttonClass, _buttonLabel, _updateContainer, _useAjax, BUTTON_PERFORMED_DELETE_ACTION, BUTTON_PERFORMED_EDIT_ACTION, BUTTON_PERFORMED_INSPECT_ACTION, 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

ERMDDeleteButton(com.webobjects.appserver.WOContext context)

Method Summary

java.lang.String	activeButtonClass() CSS class for the Delete button when active.
com.webobjects.appserver.WOActionResults	buttonAction() Deletes the current object.
java.lang.String	buttonClass() CSS class for the Delete button.
java.lang.String	buttonLabel() Label for the Delete button.
com.webobjects.appserver.WOActionResults	cancelAction() Reverts the ec, and purges the objectPendingDeletion in the d2wContext to hide the in-line confirmation dialog.
java.lang.String	cancelButtonClass() CSS class for the in-line dialog's Cancel button.
java.lang.String	cancelButtonLabel() Label for the Cancel button.
boolean	canDelete() Boolean used to hide/show the in-line confirm delete dialog.
com.webobjects.appserver.WOActionResults	deleteAction() Delete action for component button
java.lang.String	deleteButtonClass() CSS class for the in-line dialog's Delete button.
com.webobjects.appserver.WOActionResults	deleteObjectWithFinalCommit(boolean finalCommit) Performs the in-line delete and purges object pending deletion from the d2wContext to hide the in-line confirmation dialog.
java.lang.String	dialogMessage() String to display in the in-line confirmation dialog.
java.lang.String	disabledButtonClass() CSS class for the delete button when disabled.
java.lang.String	localUpdateContainer() Returns a unique id for this control's update container
void	postDeleteNotification() Utility method to post the delete notification to the parent component
boolean	showDialog() Used to show/hide the confirmation dialog
java.lang.Boolean	useAjax() Determines whether to use an in-line confirmation dialog with ajax behaviour or a separate confirmation page.

Methods inherited from class er.modern.directtoweb.components.buttons.ERMDActionButton

dataSource, displayGroup, enclosingPageOfClass, localInstanceOfObject, nextPageInPage, object, parentD2WPage, parentEditPage, parentListPage, parentPickPage, parentQueryPage, parentSelectPage, postNotification, shouldAllowInlineEditing, shouldUseAjax, synchronizesVariablesWithBindings, updateContainer

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

DisplayGroupObjectDeleted

public static final java.lang.String DisplayGroupObjectDeleted

See Also:

Constant Field Values

_dialogMessage

protected java.lang.String _dialogMessage

_disabledButtonClass

protected java.lang.String _disabledButtonClass

Constructor Detail

ERMDDeleteButton

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

Method Detail

buttonAction

public com.webobjects.appserver.WOActionResults buttonAction()

Deletes the current object. Behaviour is dependent on the d2wContext useAjaxControls flag. if true: Display an in-line confirmation dialog and update the pages main update container. if false: Take user to the confirmation page.

deleteAction

public com.webobjects.appserver.WOActionResults deleteAction()

Delete action for component button

Returns:

deleteObjectWithFinalCommit

public com.webobjects.appserver.WOActionResults deleteObjectWithFinalCommit(boolean finalCommit)

Performs the in-line delete and purges object pending deletion from the d2wContext to hide the in-line confirmation dialog. Calls saveChanges on the parent ec if the finalCommit flag is true.

Returns:

cancelAction

public com.webobjects.appserver.WOActionResults cancelAction()

Reverts the ec, and purges the objectPendingDeletion in the d2wContext to hide the in-line confirmation dialog.

Returns:

postDeleteNotification

public void postDeleteNotification()

Utility method to post the delete notification to the parent component

canDelete

public boolean canDelete()

Boolean used to hide/show the in-line confirm delete dialog.

buttonLabel

public java.lang.String buttonLabel()

Label for the Delete button.

Defaults to "Delete"

Returns:

cancelButtonLabel

public java.lang.String cancelButtonLabel()

Label for the Cancel button.

Defaults to "Cancel"

Returns:

buttonClass

public java.lang.String buttonClass()

CSS class for the Delete button.

Returns:

activeButtonClass

public java.lang.String activeButtonClass()

CSS class for the Delete button when active.

Defaults to "Button ObjButton DeleteObjButton"

Returns:

disabledButtonClass

public java.lang.String disabledButtonClass()

CSS class for the delete button when disabled.

Defaults to "Button ObjButton DisabledObjButton DisabledDeleteObjButton"

Returns:

cancelButtonClass

public java.lang.String cancelButtonClass()

CSS class for the in-line dialog's Cancel button.

Defaults to "Button DialogButton CancelDialogButton"

Returns:

deleteButtonClass

public java.lang.String deleteButtonClass()

CSS class for the in-line dialog's Delete button.

Defaults to "Button DialogButton DeleteDialogButton"

Returns:

showDialog

public boolean showDialog()

Used to show/hide the confirmation dialog

Returns:

useAjax

public java.lang.Boolean useAjax()

Determines whether to use an in-line confirmation dialog with ajax behaviour or a separate confirmation page. Based on the value of the useAjax binding (or d2wContext key).

Overrides:

useAjax in class ERMDActionButton

Returns:

localUpdateContainer

public java.lang.String localUpdateContainer()

Returns a unique id for this control's update container

dialogMessage

public java.lang.String dialogMessage()

String to display in the in-line confirmation dialog. Obtained from the bindings or d2wContext via this key: confirmDeleteMessage

Returns: