de.esoco.process.step

Class EditText

java.lang.Object

org.obrel.core.RelatedObject

org.obrel.core.SerializableRelatedObject

de.esoco.process.ProcessElement

de.esoco.process.ProcessFragment

de.esoco.process.step.InteractionFragment

de.esoco.process.step.EditText

All Implemented Interfaces:

de.esoco.lib.manage.Initializable, java.io.Serializable, org.obrel.core.Relatable

public class EditText
extends InteractionFragment

A fragment that displays a text from a certain parameter and allows to edit it.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.esoco.process.step.InteractionFragment

MESSAGE_BOX_ERROR_ICON, MESSAGE_BOX_INFO_ICON, MESSAGE_BOX_QUESTION_ICON, MESSAGE_BOX_WARNING_ICON

Fields inherited from class de.esoco.process.ProcessElement

MSG_PARAM_NOT_SET

Constructor Summary

Constructors

Constructor and Description
EditText(org.obrel.core.RelationType<java.lang.String> rValueParam, de.esoco.lib.event.EditListener<java.lang.String> rEditListener, boolean bAllowCreate, boolean bAllowEdit) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	abort() This method will be invoked if the current execution of this fragment is aborted before it has finished. and can be overridden by subclasses to perform data resets similar to the InteractionFragment.rollback() method which will be invoked if the execution of a finished fragment is to be reverted.
<E extends java.lang.Enum<E>> void	addAction(org.obrel.core.RelationType<E> rActionParam, de.esoco.lib.expression.Action<E> fHandler) Adds an additional action that should be displayed in this fragment.
void	allowEdit(boolean bAllow) Activates or deactivates the possibility to edit the text.
java.util.List<org.obrel.core.RelationType<?>>	getInputParameters() Returns the collection of input parameters of this fragment.
java.util.List<org.obrel.core.RelationType<?>>	getInteractionParameters() Returns the list of interaction parameters for this fragment.
void	handleInteraction(org.obrel.core.RelationType<?> rInteractionParam) Must be implemented by subclasses to handle interactions for this fragment.
void	init() Must be implemented to initialize the interaction parameters of this fragment.
boolean	isEditing() Checks whether this instance is currently in edit mode.
void	setEditInfo(java.lang.String sInfo) Sets an info string that describes the currently displayed or edited data.
void	setup() Creates the temporary interaction parameters of this instance.
void	startEditing(boolean bNewValue) Starts editing the text.
void	stopEditing(de.esoco.lib.event.EditListener.EditAction eAction) Starts editing the value.

Methods inherited from class de.esoco.process.step.InteractionFragment

abortFragment, addDisplayParameters, addInputParameters, addInputParameters, addPanelParameters, addParameterUpdateListener, addSubFragment, addSubFragment, addSubFragment, addSubFragment, addViewFragment, afterInteraction, applyAllCoupledParameters, attach, button, buttons, buttons, canRollback, chart, checkBox, checkBox, checkBoxes, cleanup, clearInteractionParameters, clearSelection, comboBox, dateParam, deleteRelation, display, dropDown, dropDown, enableEdit, entityParam, entityParam, enumParam, executeCleanupActions, finish, finishFragment, flagParam, fragmentParam, get, getFragmentParameter, getParameterInteractionHandler, getParameterValidations, getParent, getProcess, getProcessStep, getRelation, getRelations, getRoot, getTemporaryParameterId, getValueDatatype, hasInteraction, icon, iconButtons, iconButtons, image, imageButtons, initComplete, initProcessStep, initQueryParameter, input, input, input, inputAttr, inputAttr, inputDate, inputTags, inputText, inputTextLines, insertInputParameters, insertInputParameters, intParam, isAttached, isInitialized, label, label, layout, listParam, lockEntityForProcess, lockEntityForStep, markFragmentInputParams, markInputParams, markParameterHierarchyAsModified, notifyParameterUpdateListeners, panel, panel, panel, panel, panel, panel, param, param, param, paramLike, prepareInteraction, prepareUpload, prepareUpload, radioButtons, reloadEntity, removeInteractionParameters, removeSubFragment, removeViewFragment, rollback, set, setContinueOnInteraction, setParam, setParameterInteractionHandler, setParameterValuesFromEntity, setParameterValuesFromEntity, setParent, showConfirmationMessage, showDialog, showDialog, showDialog, showErrorMessage, showInfoMessage, showMessageBox, showMessageBox, showModalDialog, showView, showWarningMessage, structureModified, textParam, title, updateAllCoupledParameters, updateEntityFromParameterValues, updateUserInterface, validateFragmentParameters, validateParameters, validationError

Methods inherited from class de.esoco.process.ProcessFragment

addCleanupAction, addLayoutFiller, addPanel, addPanel, addProcessStepMessage, addSelectionDependency, addSelectionDependency, addStackPanel, addTabPanel, annotateForEntityQuery, annotateForEntityQuery, annotateParameter, applyDerivedParameter, applyDerivedParameters, applyExtraAttribute, changeDate, checkParameter, clearUIFlag, clearUIFlag, collectDerivedParameter, collectDerivedParameters, deleteParameters, disableElements, disableElements, disableElements, disableMultiSelectionElements, displayHistoryValue, enableAllElements, getAbsoluteFilePath, getAllowedElements, getAllowedValues, getCurrentQuery, getDerivedParameterValue, getFragmentId, getInputMode, getInteractiveInputParameter, getNamedTmpListType, getNamedTmpParameterType, getParameter, getParameterAnnotation, getParameterRelation, getProcessUser, getSelectionIndex, getSubFragment, getSubFragments, getTemporaryListType, getTemporaryListType, getTemporaryParameterName, getTemporaryParameterPackage, getTemporaryParameterType, getTemporaryParameterType, getTemporaryParameterType, getTemporarySetType, getUIProperties, getUIProperties, getUIProperty, getUserSetting, getUserSettings, hasFlagParameter, hasParameter, hasUIFlag, hasUserSetting, initChartParameter, initCountChartParameter, initProgressParameter, isInteractiveInput, isPanelParameter, lockEntity, markParameterAsModified, performParameterValidations, prepareDateInput, prepareDownload, prepareDownload, removeAllSubFragments, removeAllUIProperties, removeAllUIProperties, removeCleanupAction, removePanel, removeParameterAnnotation, removeSubFragment, removeTemporaryParameterType, removeUIProperties, setAllowedElements, setAllowedValues, setAllowedValues, setDatePeriod, setEnabled, setEnabled, setHtmlSize, setImmediateAction, setImmediateAction, setImmediateAction, setInteractive, setInteractive, setInteractive, setInteractive, setInteractive, setLayout, setParameter, setParameter, setParameterBounds, setProcessStepInfo, setProcessStepMessage, setProgressIndicator, setSelectionDependency, setSelectionDependency, setUIFlag, setUIFlag, setUIProperty, setUIProperty, setUIProperty, setUIProperty, setVisible, setVisible, spawnProcess, storeEntity, throwMissingParameterException, unlockEntity

Methods inherited from class de.esoco.process.ProcessElement

addDisplayParameters, continueOnInteraction, hasInteractionParameter, markInputParams, params, removeAllParameterValidations, removeInteractionParameters, removeParameterValidations, removeParameterValidations, setMandatory, setParameterNotEmptyValidations, setParameterNotEmptyValidations, setParameterNotNullValidations, setParameterNotNullValidations, setParameterValidation, setParameterValidation, staticParams

Methods inherited from class org.obrel.core.RelatedObject

notifyRelationListeners, readRelations, relationsEqual, relationsHashCode, relationsString, set, toString, transform, writeRelations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.obrel.core.Relatable

deleteRelation, deleteRelations, getAll, getOption, getRelationCount, getRelations, hasFlag, hasRelation, hasRelations, init, set, set, set, setOption, streamRelations

Constructor Detail

EditText

public EditText(org.obrel.core.RelationType<java.lang.String> rValueParam,
                de.esoco.lib.event.EditListener<java.lang.String> rEditListener,
                boolean bAllowCreate,
                boolean bAllowEdit)

Creates a new instance.

Parameters:

rValueParam - The parameter that stores the edited value

rEditListener - An optional listener for edit events or NULL for none

bAllowCreate - TRUE to add an action to create new values, FALSE for edit only

bAllowEdit - TRUE to allow the editing of the displayed value

Method Detail

addAction

public <E extends java.lang.Enum<E>> void addAction(org.obrel.core.RelationType<E> rActionParam,
                                                    de.esoco.lib.expression.Action<E> fHandler)

Adds an additional action that should be displayed in this fragment. The initialization of the action parameter and the handling of occurring actions must be performed by the code that defines the action. The second argument is an action function that will be invoked to handle the action parameter. This may be NULL if the action is handled in a subsequent process step because it is defined as a continuation parameter.

Action parameters should be added immediately after creating an instance of this class but latest before it's setup() method is invoked.

Parameters:

rActionParam - The parameter relation type for the action enum

fHandler - The handler for the action or NULL for none

allowEdit

public void allowEdit(boolean bAllow)

Activates or deactivates the possibility to edit the text.

Parameters:

bAllow - TRUE to allow editing, FALSE to disable the action

getInputParameters

public java.util.List<org.obrel.core.RelationType<?>> getInputParameters()

Returns the collection of input parameters of this fragment. These must be a subset of InteractionFragment.getInteractionParameters(). The default implementation returns a mutable collection that can been modified directly by a subclass. Or it can be overridden by subclasses to return their own input parameter collection.

Overrides:

getInputParameters in class InteractionFragment

Returns:

The list of this fragment's input parameters

getInteractionParameters

public java.util.List<org.obrel.core.RelationType<?>> getInteractionParameters()

Returns the list of interaction parameters for this fragment. The default implementation returns a mutable list that can been modified directly by a subclass. Or it can be overridden by subclasses to return their own interaction parameter list.

Overrides:

getInteractionParameters in class InteractionFragment

Returns:

The list of this fragment's interaction parameters

handleInteraction

public void handleInteraction(org.obrel.core.RelationType<?> rInteractionParam)
                       throws java.lang.Exception

Must be implemented by subclasses to handle interactions for this fragment. The default implementation does nothing.

Overrides:

handleInteraction in class InteractionFragment

Parameters:

rInteractionParam - The interaction parameter

Throws:

java.lang.Exception - Any kind of exception may be thrown in case of errors

init

public void init()
          throws java.lang.Exception

Must be implemented to initialize the interaction parameters of this fragment.

Specified by:

init in interface de.esoco.lib.manage.Initializable

Specified by:

init in class InteractionFragment

Throws:

java.lang.Exception - Any kind of exception may be thrown in case of errors

isEditing

public boolean isEditing()

Checks whether this instance is currently in edit mode.

Returns:

TRUE if edit mode is active

setEditInfo

public void setEditInfo(java.lang.String sInfo)

Sets an info string that describes the currently displayed or edited data.

Parameters:

sInfo - The info string (empty to clear)

setup

public void setup()

Creates the temporary interaction parameters of this instance.

Overrides:

setup in class InteractionFragment

startEditing

public void startEditing(boolean bNewValue)

Starts editing the text.

Parameters:

bNewValue - TRUE if a new value should be created

stopEditing

public void stopEditing(de.esoco.lib.event.EditListener.EditAction eAction)

Starts editing the value.

Parameters:

eAction - The action to stop the editing with

abort

protected void abort()

This method will be invoked if the current execution of this fragment is aborted before it has finished. and can be overridden by subclasses to perform data resets similar to the InteractionFragment.rollback() method which will be invoked if the execution of a finished fragment is to be reverted.

Overrides:

abort in class InteractionFragment