public class GridRemoveSelectedDataTask extends ComponentTask
ListGrid.removeSelectedData()config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
GridRemoveSelectedDataTask() |
GridRemoveSelectedDataTask(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.Boolean |
getAllowMultiRecordRemove()
Can multiple records be removed? If not and multiple records are selected, the
refuseMultiRemoveMessage is
shown as a warning and the workflow is terminated. |
java.lang.String |
getConfirmationMessage()
Message shown to user to confirm deleting a single record on a bound grid.
|
java.lang.String |
getFailureElement()
ID of the next sequence or element to proceed to if a failure condition arises from operation.
|
java.lang.String |
getMultipleConfirmationMessage()
Message shown to user to confirm deleting a group of records on a bound grid.
|
static GridRemoveSelectedDataTask |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getRefuseMultiRemoveMessage()
Message to be shown when multiple records are selected for removal but
allowMultiRecordRemove is not
set. |
DSRequest |
getRequestProperties()
Additional properties to set on the
removeSelectedData call to perform removal. |
java.lang.Boolean |
getShowConfirmation()
Should we show a confirmation message before removal and allow the user to cancel the operation? If user cancels the
removal the workflow is terminated.
|
java.lang.String |
getUnboundConfirmationMessage()
Message shwon to user to confirm deleting a single record on an unbound grid.
|
java.lang.String |
getUnboundMultipleConfirmationMessage()
Message shown to user to confirm deleting a group of records on an unbound grid.
|
GridRemoveSelectedDataTask |
setAllowMultiRecordRemove(java.lang.Boolean allowMultiRecordRemove)
Can multiple records be removed? If not and multiple records are selected, the
refuseMultiRemoveMessage is
shown as a warning and the workflow is terminated. |
GridRemoveSelectedDataTask |
setConfirmationMessage(java.lang.String confirmationMessage)
Message shown to user to confirm deleting a single record on a bound grid.
|
GridRemoveSelectedDataTask |
setFailureElement(java.lang.String failureElement)
ID of the next sequence or element to proceed to if a failure condition arises from operation.
|
GridRemoveSelectedDataTask |
setMultipleConfirmationMessage(java.lang.String multipleConfirmationMessage)
Message shown to user to confirm deleting a group of records on a bound grid.
|
GridRemoveSelectedDataTask |
setRefuseMultiRemoveMessage(java.lang.String refuseMultiRemoveMessage)
Message to be shown when multiple records are selected for removal but
allowMultiRecordRemove is not
set. |
GridRemoveSelectedDataTask |
setRequestProperties(DSRequest requestProperties)
Additional properties to set on the
removeSelectedData call to perform removal. |
GridRemoveSelectedDataTask |
setShowConfirmation(java.lang.Boolean showConfirmation)
Should we show a confirmation message before removal and allow the user to cancel the operation? If user cancels the
removal the workflow is terminated.
|
GridRemoveSelectedDataTask |
setUnboundConfirmationMessage(java.lang.String unboundConfirmationMessage)
Message shwon to user to confirm deleting a single record on an unbound grid.
|
GridRemoveSelectedDataTask |
setUnboundMultipleConfirmationMessage(java.lang.String unboundMultipleConfirmationMessage)
Message shown to user to confirm deleting a group of records on an unbound grid.
|
getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, getTargetComponent, getTargetComponent, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSourcecompleteElement, convertToJavaScriptArray, executeElement, getBindOutput, getClassDescription, getDescription, getDynamicValue, getEditorType, getElementDescription, getForceSingle, getID, getJsObj, getMockMode, getNextElement, getOrCreateJsObj, getPassThruOutput, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, isCreated, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, setNextElement, setPassThruOutput, setSupportsMultipleInputRecords, setTypeTitle, updateGlobalIDInCriteria, updateGlobalIDInValueProperty, updateGlobalIDInValues, updateGlobalIDReferences, updateLastElementBindingReferences, updateLastElementInCriteria, updateLastElementInValueProperty, updateLastElementInValuesaddDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassNamepublic GridRemoveSelectedDataTask()
public GridRemoveSelectedDataTask(com.google.gwt.core.client.JavaScriptObject jsObj)
public static GridRemoveSelectedDataTask getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public com.google.gwt.core.client.JavaScriptObject create()
create in class ComponentTaskpublic GridRemoveSelectedDataTask setAllowMultiRecordRemove(java.lang.Boolean allowMultiRecordRemove) throws java.lang.IllegalStateException
refuseMultiRemoveMessage is
shown as a warning and the workflow is terminated. Default is true unless set to false.
allowMultiRecordRemove - New allowMultiRecordRemove value. Default value is nullGridRemoveSelectedDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getAllowMultiRecordRemove()
refuseMultiRemoveMessage is
shown as a warning and the workflow is terminated. Default is true unless set to false.
public GridRemoveSelectedDataTask setConfirmationMessage(java.lang.String confirmationMessage) throws java.lang.IllegalStateException
This is a dynamic string - text within
${...} are dynamic variables and will be evaluated as JS code when the message is displayed.
Only
three dynamic variables, dsTitle; dsPluralTitle and recordTitle, are available and represent the bound DataSource.title and DataSource.pluralTitle and the value of the DataSource.titleField from the first selected record.
confirmationMessage - New confirmationMessage value. Default value is "Delete ${dsTitle} ${recordTitle}"GridRemoveSelectedDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getConfirmationMessage()
This is a dynamic string - text within
${...} are dynamic variables and will be evaluated as JS code when the message is displayed.
Only
three dynamic variables, dsTitle; dsPluralTitle and recordTitle, are available and represent the bound DataSource.title and DataSource.pluralTitle and the value of the DataSource.titleField from the first selected record.
public GridRemoveSelectedDataTask setFailureElement(java.lang.String failureElement) throws java.lang.IllegalStateException
failureElement - New failureElement value. Default value is nullGridRemoveSelectedDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getFailureElement()
public GridRemoveSelectedDataTask setMultipleConfirmationMessage(java.lang.String multipleConfirmationMessage) throws java.lang.IllegalStateException
This is a dynamic string - text within
${...} are dynamic variables and will be evaluated as JS code when the message is displayed.
Only
two dynamic variables, dsTitle and dsPluralTitle, are available and represent the bound DataSource.title and DataSource.pluralTitle .
multipleConfirmationMessage - New multipleConfirmationMessage value. Default value is "Delete multiple ${dsPluralTitle}?"GridRemoveSelectedDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getMultipleConfirmationMessage()
This is a dynamic string - text within
${...} are dynamic variables and will be evaluated as JS code when the message is displayed.
Only
two dynamic variables, dsTitle and dsPluralTitle, are available and represent the bound DataSource.title and DataSource.pluralTitle .
public GridRemoveSelectedDataTask setRefuseMultiRemoveMessage(java.lang.String refuseMultiRemoveMessage) throws java.lang.IllegalStateException
allowMultiRecordRemove is not
set.refuseMultiRemoveMessage - New refuseMultiRemoveMessage value. Default value is "Only one record may be removed at a time"GridRemoveSelectedDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getRefuseMultiRemoveMessage()
allowMultiRecordRemove is not
set.public GridRemoveSelectedDataTask setRequestProperties(DSRequest requestProperties) throws java.lang.IllegalStateException
removeSelectedData call to perform removal. Note that willHandleError will always be set
true.
requestProperties - New requestProperties value. Default value is nullGridRemoveSelectedDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic DSRequest getRequestProperties()
removeSelectedData call to perform removal. Note that willHandleError will always be set
true.
public GridRemoveSelectedDataTask setShowConfirmation(java.lang.Boolean showConfirmation) throws java.lang.IllegalStateException
Message to be shown is defined in the properties: confirmationMessage, unboundConfirmationMessage,
multipleConfirmationMessage and unboundMultipleConfirmationMessage. The appropriate message is chosen based on the grid configuration and the number of
records being removed.
showConfirmation - New showConfirmation value. Default value is nullGridRemoveSelectedDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getShowConfirmation()
Message to be shown is defined in the properties: confirmationMessage, unboundConfirmationMessage,
multipleConfirmationMessage and unboundMultipleConfirmationMessage. The appropriate message is chosen based on the grid configuration and the number of
records being removed.
public GridRemoveSelectedDataTask setUnboundConfirmationMessage(java.lang.String unboundConfirmationMessage) throws java.lang.IllegalStateException
This is a dynamic string - text within
${...} are dynamic variables and will be evaluated as JS code when the message is displayed.
Only
one dynamic variable, recordTitle, is available and represents the value of the DataSource.titleField from the first selected record.
unboundConfirmationMessage - New unboundConfirmationMessage value. Default value is "Delete record?"GridRemoveSelectedDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getUnboundConfirmationMessage()
This is a dynamic string - text within
${...} are dynamic variables and will be evaluated as JS code when the message is displayed.
Only
one dynamic variable, recordTitle, is available and represents the value of the DataSource.titleField from the first selected record.
public GridRemoveSelectedDataTask setUnboundMultipleConfirmationMessage(java.lang.String unboundMultipleConfirmationMessage) throws java.lang.IllegalStateException
This is a dynamic string - text
within ${...} are dynamic variables and will be evaluated as JS code when the message is displayed.
Only one dynamic variable, recordTitle, is available and represents the value of the DataSource.titleField from the first selected record.
unboundMultipleConfirmationMessage - New unboundMultipleConfirmationMessage value. Default value is "Delete multiple records?"GridRemoveSelectedDataTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getUnboundMultipleConfirmationMessage()
This is a dynamic string - text
within ${...} are dynamic variables and will be evaluated as JS code when the message is displayed.
Only one dynamic variable, recordTitle, is available and represents the value of the DataSource.titleField from the first selected record.