de.esoco.process.step

Class SelectValues<T extends java.lang.Comparable<T>>

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.SelectValues<T>

All Implemented Interfaces:

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

public class SelectValues<T extends java.lang.Comparable<T>>
extends InteractionFragment

A fragment that allows to select a set of values of a certain comparable type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SelectValues.SelectValueListener An event listener interface that can receive notifications on selection changes in an instance of SelectValues.

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
SelectValues(java.lang.String sIdentifier, java.lang.Class<T> rValueDatatype, java.util.Collection<T> rAvailableValues, boolean bSortValues) Creates a new instance.
SelectValues(java.lang.String sIdentifier, java.lang.Class<T> rValueDatatype, java.util.Collection<T> rAvailableValues, java.util.Collection<T> rPreferredValues) Creates a new instance that sorts the list values and inserts a list of preferred values at the beginning of each list.The values will be sorted according to their natural order (i.e. their Comparable implementation).

Method Summary

Modifier and Type	Method and Description
void	enableEdit(boolean bEnable) Overridden to show only the selected values if editing is disabled.
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.
java.util.Collection<T>	getSelectedValues() Returns the values that have been selected in 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.
void	initFragmentParameter(org.obrel.core.RelationType<java.util.List<org.obrel.core.RelationType<?>>> rParam) Initializes a parameter for this fragment.
protected void	initProcessStep(Interaction rProcessStep) Will be invoked after the process step of this fragment has been set.
void	setAvailableValues(java.util.Collection<T> rValues) Sets the values that are available for selection.
void	setSelectedValues(java.util.Collection<T> rValues) Sets the currently selected values.
void	setSelectionListener(SelectValues.SelectValueListener rListener) Sets a listener that will be notified if the selection in this instance changes.
void	setVisibleRows(int nRows) Sets the number of rows that are visible in the value lists.

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

SelectValues

public SelectValues(java.lang.String sIdentifier,
                    java.lang.Class<T> rValueDatatype,
                    java.util.Collection<T> rAvailableValues,
                    boolean bSortValues)

Creates a new instance. The Identifier should be a singular description in camel case and unique in the context of the current process step. In the case of enum values it is recommended to use the simple name of the enum class as the identifier. If the sort parameter is TRUE the list values will be sorted on the client side after resource expansion if their datatype implements the Comparable interface.

Parameters:

sIdentifier - A process step-unique identifier of this instance

rValueDatatype - The datatype of the values

rAvailableValues - The available values to select from

bSortValues - TRUE to sort the list values

SelectValues

public SelectValues(java.lang.String sIdentifier,
                    java.lang.Class<T> rValueDatatype,
                    java.util.Collection<T> rAvailableValues,
                    java.util.Collection<T> rPreferredValues)

Creates a new instance that sorts the list values and inserts a list of preferred values at the beginning of each list.The values will be sorted according to their natural order (i.e. their Comparable implementation). They will also be sorted on the server side before resource expansion, therefore using this variant only makes sense with values that are not resources.

Parameters:

sIdentifier - A process step-unique identifier of this instance

rValueDatatype - The datatype of the values

rAvailableValues - The available values to select from

rPreferredValues - An optional list of preferred values that should be listed first (empty for none)

Method Detail

enableEdit

public void enableEdit(boolean bEnable)

Overridden to show only the selected values if editing is disabled.

Overrides:

enableEdit in class InteractionFragment

Parameters:

bEnable - TRUE to enable editing, FALSE to disable

See Also:

InteractionFragment.enableEdit(boolean)

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

getSelectedValues

public java.util.Collection<T> getSelectedValues()

Returns the values that have been selected in this fragment.

Returns:

A collection containing the selected values

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

initFragmentParameter

public void initFragmentParameter(org.obrel.core.RelationType<java.util.List<org.obrel.core.RelationType<?>>> rParam)

Initializes a parameter for this fragment. This sets a generic style name so that all fragments of this type can be styled similarly. This method should typically be invoked from the init() method of the parent fragment.

Parameters:

rParam - The parameter that will hold this fragment

setAvailableValues

public void setAvailableValues(java.util.Collection<T> rValues)

Sets the values that are available for selection.

Parameters:

rValues - The selectable values (can be NULL for none)

setSelectedValues

public void setSelectedValues(java.util.Collection<T> rValues)

Sets the currently selected values.

Parameters:

rValues - The selected values (may be NULL for none)

setSelectionListener

public void setSelectionListener(SelectValues.SelectValueListener rListener)

Sets a listener that will be notified if the selection in this instance changes.

Parameters:

rListener - The listener

setVisibleRows

public void setVisibleRows(int nRows)

Sets the number of rows that are visible in the value lists.

Parameters:

nRows - The number of visible rows

initProcessStep

protected void initProcessStep(Interaction rProcessStep)

Description copied from class: InteractionFragment

Will be invoked after the process step of this fragment has been set. Can be implemented by subclasses to initialize process step-specific parameters. The default implementation does nothing.

Overrides:

initProcessStep in class InteractionFragment

Parameters:

rProcessStep - The process step of this fragment

See Also:

ProcessFragment.initProgressParameter()