Package lumis.doui.control.itempicker

Class SelectItemTabularDataControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

lumis.doui.control.DataBoundControl<TabularSource<?>>

lumis.doui.control.tabulardata.TabularDataControl

lumis.doui.control.itempicker.SelectItemTabularDataControl

All Implemented Interfaces:

java.util.Observer, javax.servlet.jsp.el.VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

public class SelectItemTabularDataControl
extends TabularDataControl

Used to render data from a tabular data source with item selection functionality.
Once the user selects an item, a provided callback function is called in the window opener before closing the current window.
Example use: <control:lum_selectItemTabularData sourceId="voteOption"/> xml data available for xsl rendering: <control id="8A488A0311570496011157BFD84114F0" sourceId="voteOption" type="lum_selectItemTabularData"> <!-- same as lum_tabularData control --> <data> <!-- same as lum_tabularData control --> <callbackFunction>callbackFunctionName</callbackFunction> </data> </control>

Since:

4.1.0

Version:

$Revision$ $Date$

See Also:

TabularDataControl

Field Summary

Fields inherited from class lumis.doui.control.DataControl

FORCE_CASE_LOWER, FORCE_CASE_NONE, FORCE_CASE_UPPER, forceCase, requestParameterName, UNKNOWN_DATA_TYPE, value, valuePreviouslySet

Fields inherited from class lumis.doui.control.Control

childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_REPLACE_INTERFACE, ON_EVENT_SCRIPT, ON_EVENT_VALIDATE, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

Constructors

Constructor	Description
SelectItemTabularDataControl()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCallbackFunction()
java.lang.String	getCallbackFunctionRequestParameterName()
java.lang.String	getPrimaryKeyFieldId()
java.lang.String	getPrimaryNameFieldId()
protected java.lang.String	getRowHyperlink(TabularSource source, ISourceData row, java.lang.String compositePrimaryKey, int rowIndex)
void	init(org.w3c.dom.Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void	loadFromRequest()
void	setCallbackFunction(java.lang.String callbackFunction)
void	setCallbackFunctionRequestParameterName(java.lang.String callbackFunctionRequestParameterName)
void	setPrimaryKeyFieldId(java.lang.String primaryKeyFieldId)
void	setPrimaryNameFieldId(java.lang.String primaryNameFieldId)
void	setRenderData()

Methods inherited from class lumis.doui.control.tabulardata.TabularDataControl

addRowAction, getControlResource, getConverter, getFieldHyperlink, getFieldRenderValue, getRequestHelpDefinition, getRowOnClick, getStringsToLocalize, isContentSource, isCurrentPrimaryContent, mayAddHyperlinkValue

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, buildSubControls, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRuntimeDefaultSource, getSource, getSourceById, getSourceContext, getUnboundedConverter, setDefaultValue, setRawValue, setReload, setSourceParameter, setValid, setValueFromSource, setValueFromSource, update

Methods inherited from class lumis.doui.control.DataControl

convertValueToControlValue, getDataType, getDefaultValue, getParameterValue, getProcessActionIds, getRequestParameterName, getValue, getValue, getValueClass, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setSourceParameter, setSourceParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getType, getValidationScript, getWindowProperties, getWindowProperties, isRequired, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setName, setRuntimeAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.doui.control.IControl

createContainer, disconnect, getChildControls, getId, getName, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes

Methods inherited from interface lumis.doui.control.IDataControl

getProcessActionIds, getValue, getValue, setProcessActionHandlerParameters, setValue

Methods inherited from interface lumis.doui.render.IRenderer

getResources

Constructor Detail

SelectItemTabularDataControl

public SelectItemTabularDataControl()

Method Detail

init

public void init(org.w3c.dom.Node controlDefinitionNode,
                 ControlContainer controlContainer,
                 IControl parentControl)
          throws PortalException

Specified by:

init in interface IControl

Overrides:

init in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

loadFromRequest

public void loadFromRequest()
                     throws PortalException

Specified by:

loadFromRequest in interface IDataControl

Overrides:

loadFromRequest in class TabularDataControl

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class TabularDataControl

Throws:

PortalException

getRowHyperlink

protected java.lang.String getRowHyperlink(TabularSource source,
                                           ISourceData row,
                                           java.lang.String compositePrimaryKey,
                                           int rowIndex)
                                    throws PortalException

Overrides:

getRowHyperlink in class TabularDataControl

Throws:

PortalException

getCallbackFunction

public java.lang.String getCallbackFunction()

setCallbackFunction

public void setCallbackFunction(java.lang.String callbackFunction)

getCallbackFunctionRequestParameterName

public java.lang.String getCallbackFunctionRequestParameterName()

setCallbackFunctionRequestParameterName

public void setCallbackFunctionRequestParameterName(java.lang.String callbackFunctionRequestParameterName)

getPrimaryKeyFieldId

public java.lang.String getPrimaryKeyFieldId()

setPrimaryKeyFieldId

public void setPrimaryKeyFieldId(java.lang.String primaryKeyFieldId)

getPrimaryNameFieldId

public java.lang.String getPrimaryNameFieldId()

setPrimaryNameFieldId

public void setPrimaryNameFieldId(java.lang.String primaryNameFieldId)