de.esoco.process

Class ViewFragment

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.ViewFragment

All Implemented Interfaces:

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

Direct Known Subclasses:

DialogFragment

public class ViewFragment
extends InteractionFragment

A process interaction fragment that can be displayed in a dialog view.

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
ViewFragment(java.lang.String sParamNameTemplate, InteractionFragment rContentFragment, de.esoco.lib.property.ViewDisplayType eViewDisplayType) Creates a new view fragment with a certain name and optional content fragment.

Method Summary

Modifier and Type	Method and Description
protected void	addExtraViewInteractionParams(java.lang.String sParamBaseName) This method can be overridden by subclasses to add additional interaction parameters to this instance.
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.
protected java.lang.String	getResourceBaseName() Returns the base name for resource IDs as a camel case identifier.
org.obrel.core.RelationType<java.util.List<org.obrel.core.RelationType<?>>>	getViewContentParam() Returns the parameter that holds the view content.
protected java.lang.String	getViewType(boolean bUpperCase) Returns the type of this view fragment.
void	handleInteraction(org.obrel.core.RelationType<?> rInteractionParam) Must be implemented by subclasses to handle interactions for this fragment.
void	hide() Hides this view.
void	init() Must be implemented to initialize the interaction parameters of this fragment.
protected void	initComplete() Overridden to transfer properties from the content fragment parameter to the view parameter after all child fragments have been initialized.
void	show(InteractionFragment rParent) Initializes the parameters of the parent fragment to display the dialog for this fragment.

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

abort, 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, 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, setup, 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

ViewFragment

public ViewFragment(java.lang.String sParamNameTemplate,
                    InteractionFragment rContentFragment,
                    de.esoco.lib.property.ViewDisplayType eViewDisplayType)

Creates a new view fragment with a certain name and optional content fragment. The parameter name template must contain a string formatting pattern with a single '%s' placeholder that will be replaced with the view type. The remaining string should define an uppercase identifier that is separated by underscores. If the pattern doesn't contain a placeholder it will be used as a prefix.

Parameters:

sParamNameTemplate - The string format pattern for the generation of the view fragment parameter names. If NULL a template will be generated from the class name of the content fragment

rContentFragment - The fragment that contains the view content

eViewDisplayType - How the view should be displayed

Method Detail

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

getViewContentParam

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

Returns the parameter that holds the view content.

Returns:

The view content parameter

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

hide

public void hide()

Hides this view.

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

show

public void show(InteractionFragment rParent)

Initializes the parameters of the parent fragment to display the dialog for this fragment.

Parameters:

rParent - The parent fragment to display the dialog in

Throws:

java.lang.Exception

addExtraViewInteractionParams

protected void addExtraViewInteractionParams(java.lang.String sParamBaseName)

This method can be overridden by subclasses to add additional interaction parameters to this instance. The default implementation does nothing.

Parameters:

sParamBaseName - The base name for temporary parameters of this instance

getResourceBaseName

protected java.lang.String getResourceBaseName()

Returns the base name for resource IDs as a camel case identifier. The default implementation returns the simple name of the content fragment's class. If no content fragment has been set the view type returned by getViewType(boolean) will be used.

Returns:

The resource ID base name

getViewType

protected java.lang.String getViewType(boolean bUpperCase)

Returns the type of this view fragment. By default this will be the name of the view implementation class without any 'Fragment' suffix.

Parameters:

bUpperCase - TRUE to return an upper case identifier, FALSE for camel case

Returns:

The view type string

initComplete

protected void initComplete()
                     throws java.lang.Exception

Overridden to transfer properties from the content fragment parameter to the view parameter after all child fragments have been initialized.

Overrides:

initComplete in class InteractionFragment

Throws:

java.lang.Exception - If the post-initialization code fails

See Also:

InteractionFragment.initComplete()