lumis.doui.control.tabulardata

Class AdvancedTabularDataControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

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

lumis.doui.control.tabulardata.TabularDataControl

lumis.doui.control.tabulardata.AdvancedTabularDataControl

All Implemented Interfaces:

Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

Direct Known Subclasses:

BusinessContextForCacheAdvancedTabularDataControl, FileSystemTabularData, LinkToRuntimeTabularDataControl, LinkToRuntimeTabularDataControl, ProducerAdminListTabularDataControl, SelectAccountServiceInstanceAdvancedTabularDataControl, WorkflowStatusAdvancedTabularDataControl

public class AdvancedTabularDataControl
extends TabularDataControl

Used to render data from a tabular data source. This control is an extension of the lum_tabularData control. In addition to the rendering tabular data, the control includes information for ordering and including multi-select/single-select using checkboxes/radio buttons for each row of the result set.

Example use: <control:lum_advancedTabularData> <allowSelectRow type="none"/> </control:lum_advancedTabularData> xml data available for xsl rendering: <control id="8A488A0311570496011157C750CA1552" type="lum_advancedTabularData"> <allowSelectRow type="none" /> <control id="8A488A0311570496011157C750CA1552.orderByField" type="lum_inputHidden" ... /> <control id="8A488A0311570496011157C750CA1552.orderByDir" type="lum_inputHidden" ... /> <strings> <string id="STR_ORDER_ASC">Sort ascending</string> <string id="STR_ORDER">Sort</string> <string id="STR_ORDER_DESC">Sort descending</string> </strings> <fields> <field dataType="guid" display="true" doLookup="true" id="targetMetaDataId" lookupFieldId="primaryName" lookupRelationId="metaData" maxLength="32" name="Content" orderByOnclick="*orderby onclick javascript*" required="true" /> <field dataType="double" display="true" id="averageGrade" name="Average grade" orderByOnclick="*orderby onclick javascript*" required="true" /> <field dataType="integer" display="true" id="numberOfComments" name="Number of votes" orderByOnclick="*orderby onclick javascript*" required="true" /> <field columnName="targetMetaDataId" display="false" id="targetMetaDataId_Value" name="Metadata id" orderByOnclick="*orderby onclick javascript*" /> </fields> <data> <formName>Form_8A488A03110888AC011108A81E170B28</formName> <row primaryKey=""> <targetMetaDataId>Gabriel</targetMetaDataId> <averageGrade>4</averageGrade> <numberOfComments>2</numberOfComments> <targetMetaDataId_Value>8A488A0311319E7F011131C54D04025F</targetMetaDataId_Value> </row> <row primaryKey=""> <targetMetaDataId>Logo_Lumis</targetMetaDataId> <averageGrade>3.333333</averageGrade> <numberOfComments>6</numberOfComments> <targetMetaDataId_Value>8A488A03110888AC0111088BA2140131</targetMetaDataId_Value> </row> <orderBy> <field direction="descending" id="averageGrade" /> </orderBy> </data> </control>

Since:

4.0.0

Version:

$Revision: 20825 $ $Date: 2017-12-11 16:43:21 +0000 (Mon, 11 Dec 2017) $

See Also:

InputHiddenControl

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_SELECT_ROW_TYPE_MULTIPLE
static String	ALLOW_SELECT_ROW_TYPE_NONE
static String	ALLOW_SELECT_ROW_TYPE_SINGLE
protected String	allowSelectRowType
protected String	orderByDir
protected String	orderByField

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 and Description
AdvancedTabularDataControl()

Method Summary

Modifier and Type	Method and Description
void	buildSubControls()
IDataControlRequestHelpDefinition	getRequestHelpDefinition() Returns the request parameters help definition.
void	init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void	loadFromRequest()
protected void	setFieldData()
protected void	setOrderByRenderData()
void	setRenderData()
protected void	setSelectedElementsRenderData()
protected void	setValueFromSource()

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

addRowAction, getControlResource, getConverter, getFieldHyperlink, getRowHyperlink, getRowOnClick, getStringsToLocalize

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRuntimeDefaultSource, getSource, getSourceById, getSourceContext, getUnboundedConverter, setDefaultValue, setRawValue, setReload, setSourceParameter, setValid, 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.IDataControl

getProcessActionIds, getValue, getValue, setProcessActionHandlerParameters, setValue

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.render.IRenderer

getResources

Field Detail

ALLOW_SELECT_ROW_TYPE_NONE

public static final String ALLOW_SELECT_ROW_TYPE_NONE

See Also:

Constant Field Values

ALLOW_SELECT_ROW_TYPE_SINGLE

public static final String ALLOW_SELECT_ROW_TYPE_SINGLE

See Also:

Constant Field Values

ALLOW_SELECT_ROW_TYPE_MULTIPLE

public static final String ALLOW_SELECT_ROW_TYPE_MULTIPLE

See Also:

Constant Field Values

allowSelectRowType

protected String allowSelectRowType

orderByField

protected String orderByField

orderByDir

protected String orderByDir

Constructor Detail

AdvancedTabularDataControl

public AdvancedTabularDataControl()

Method Detail

init

public void init(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

buildSubControls

public void buildSubControls()
                      throws PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class TabularDataControl

Throws:

PortalException

setSelectedElementsRenderData

protected void setSelectedElementsRenderData()
                                      throws PortalException

Throws:

PortalException

setFieldData

protected void setFieldData()
                     throws PortalException

Throws:

PortalException

setOrderByRenderData

protected void setOrderByRenderData()
                             throws PortalException

Throws:

PortalException

setValueFromSource

protected void setValueFromSource()
                           throws PortalException

Overrides:

setValueFromSource in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

getRequestHelpDefinition

public IDataControlRequestHelpDefinition getRequestHelpDefinition()
                                                           throws PortalException

Description copied from interface: IDataControl

Returns the request parameters help definition. Used in process action REST API help. Must not return null.

Specified by:

getRequestHelpDefinition in interface IDataControl

Overrides:

getRequestHelpDefinition in class TabularDataControl

Returns:

the request parameters help definition. Used in process action REST API help. Must not return null.

Throws:

PortalException