info.magnolia.ui.framework.action

Class EditorCallbackActionDefinition

java.lang.Object

info.magnolia.ui.api.action.ConfiguredActionDefinition

info.magnolia.ui.framework.action.EditorCallbackActionDefinition

All Implemented Interfaces:

ActionDefinition

Deprecated.

since 6.2 - without direct replacement.

@Deprecated
public class EditorCallbackActionDefinition
extends ConfiguredActionDefinition

Configures an action which simply delegates to an EditorCallback, optionally performing validation beforehand.

This action is typically configured as a dialog/editor's 'commit' action (instead of a plain save action). It allows to keep the callback code close to that of the dialog/editor opening action.

See Also:

Upgrading to Magnolia 6.2.x

Constructor Summary

Constructors

Constructor and Description
EditorCallbackActionDefinition() Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getSuccessActionName() Deprecated. Defines the success string to pass to the success callback when executed.
boolean	isCallSuccess() Deprecated. Defines whether the action will invoke the success callback when executed (or alternatively the cancel callback).
boolean	isValidationEnabled() Deprecated. Defines whether validation should be performed before invoking the callback.
void	setCallSuccess(boolean callSuccess) Deprecated.
void	setSuccessActionName(String successActionName) Deprecated.
void	setValidationEnabled(boolean isValidationEnabled) Deprecated.

Methods inherited from class info.magnolia.ui.api.action.ConfiguredActionDefinition

getAvailability, getDescription, getErrorMessage, getFailureMessage, getI18nBasename, getIcon, getImplementationClass, getLabel, getName, getSuccessMessage, setAvailability, setDescription, setErrorMessage, setFailureMessage, setI18nBasename, setIcon, setImplementationClass, setLabel, setName, setSuccessMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.ui.api.action.ActionDefinition

getShortcut

Constructor Detail

EditorCallbackActionDefinition

public EditorCallbackActionDefinition()

Deprecated.

Method Detail

isCallSuccess

public boolean isCallSuccess()

Deprecated.

Defines whether the action will invoke the success callback when executed (or alternatively the cancel callback). Default is true, i.e. success.

See Also:

getSuccessActionName(), EditorCallback.onSuccess(String)

setCallSuccess

public void setCallSuccess(boolean callSuccess)

Deprecated.

getSuccessActionName

public String getSuccessActionName()

Deprecated.

Defines the success string to pass to the success callback when executed. Default is "success".

See Also:

isCallSuccess(), EditorCallback.onSuccess(String)

setSuccessActionName

public void setSuccessActionName(String successActionName)

Deprecated.

isValidationEnabled

public boolean isValidationEnabled()

Deprecated.

Defines whether validation should be performed before invoking the callback. Default is false, i.e. non-validated.

See Also:

EditorValidator

setValidationEnabled

public void setValidationEnabled(boolean isValidationEnabled)

Deprecated.