Package lumis.doui.control.tabulardata

Class TabularDataControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

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

lumis.doui.control.tabulardata.TabularDataControl

All Implemented Interfaces:

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

Direct Known Subclasses:

AddHtmlSnippetTabularDataControl, AdvancedTabularDataControl, AnnouncementTabularDataControl, AssociationTabularDataControl, CommunityTabularDataControl, DetailsControl, HierarchicalTabularDataControl, LinkTabularDataControl, SelectItemTabularDataControl

public class TabularDataControl
extends DataBoundControl<TabularSource<?>>

Used to render data from a tabular data source.

Example use: <control:lum_tabularData sourceId="voteOption"/> xml data available for xsl rendering: <control id="8A488A0311570496011157BFD84114F0" sourceId="voteOption" type="lum_tabularData"> <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="string" display="false" id="optionId" includeAlways="true" isPrimaryKey="true" maxLength="32" name="ID" required="true" requiredWhenVisible="true"/> <field dataType="string" display="false" id="questionId" maxLength="32" name="STR_QUESTION_ID" required="true"/> <field dataType="string" id="optionTitle" isPrimaryName="true" maxLength="255" name="Option" required="true" requiredWhenVisible="true"/> <field dataType="integer" defaultValue="0" display="true" id="numberOfVotes" name="Votes" required="true"/> <field dataType="string" display="true" externalData="true" id="votePercentValue" name="Percent"/> <field dataType="double" display="true" externalData="true" id="votePercentDisplay" name="Percent" pattern="0.0"/> <field dataType="integer" id="position" isRowNumber="true" name="STR_POSITION" required="true"/> <field columnName="questionId" dataType="string" display="true" doLookup="true" id="totalVotes" lookupFieldId="numberOfVotes" lookupRelationId="voteQuestion" name="Total" readOnly="true"/> </fields> <data> <formName>Form_8A488A0311570496011157AECA8D10BA</formName> <row primaryKey="8A488A0311570496011157BFAC23148F"> <optionId>8A488A0311570496011157BFAC23148F</optionId> <questionId>8A488A0311570496011157BFA672148A</questionId> <optionTitle>Option 1</optionTitle> <numberOfVotes>1</numberOfVotes> <votePercentValue>100.0</votePercentValue> <votePercentDisplay>100.0</votePercentDisplay> <position>1</position> <totalVotes>1</totalVotes> </row> <row primaryKey="8A488A0311570496011157BFAC611490"> <optionId>8A488A0311570496011157BFAC611490</optionId> <questionId>8A488A0311570496011157BFA672148A</questionId> <optionTitle>Option 2</optionTitle> <numberOfVotes>0</numberOfVotes> <votePercentValue>0.0</votePercentValue> <votePercentDisplay>0.0</votePercentDisplay> <position>2</position> <totalVotes>1</totalVotes> </row> <rowActions> <rowAction> <name>Edit</name> <controlId>lum_402809813A929400013A937DA69510D0.editButton</controlId> </rowAction> <rowAction> <name>Delete</name> <controlId>lum_402809813A929400013A937DA69510D0.deleteButton</controlId> </rowAction> <rowAction> <name>(Un)Lock</name> <controlId>lum_402809813A929400013A937DA69510D0.lockButton</controlId> </rowAction> <rowAction> <name>Versions</name> <controlId>versionsButton</controlId> </rowAction> <rowAction> <name>Preview</name> <controlId>previewButton</controlId> </rowAction> </rowActions> </data> </control>

Since:

4.0.6

Version:

$Revision$ $Date$

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
TabularDataControl()

Method Summary

Modifier and Type	Method	Description
void	addRowAction(org.w3c.dom.Node rowActionNode, java.lang.String actionName, java.lang.String actionControlId)	Adds a new row action in this control.
IResource	getControlResource()
IConverter	getConverter()	Tabular data control uses no converter.
protected java.lang.String	getFieldHyperlink(TabularSource source, ISourceData row, java.lang.String fieldId, java.lang.String compositePrimaryKey, int rowIndex)
protected java.lang.String	getFieldRenderValue(ITabularSourceField field, java.lang.Object value)	Returns the render value for the given field.
IDataControlRequestHelpDefinition	getRequestHelpDefinition()	Returns the request parameters help definition.
protected java.lang.String	getRowHyperlink(TabularSource source, ISourceData row, java.lang.String compositePrimaryKey, int rowIndex)
protected java.lang.String	getRowOnClick(TabularSource<?> source, ISourceData row, java.lang.String compositePrimaryKey, int rowIndex)
protected java.util.Map<java.lang.String,java.lang.String>	getStringsToLocalize()
protected boolean	isContentSource(TabularSource<?> source)	Returns whether the given source is a content table one.
protected boolean	isCurrentPrimaryContent(TabularSource<?> source, java.lang.String parameterValue)	Returns whether the given value is the primary content of the given source.
void	loadFromRequest()
protected boolean	mayAddHyperlinkValue(TabularSource<?> source, java.lang.String fieldId, java.lang.String parameterName, java.lang.String parameterValue)	Returns whether the given parameter may be added to the hyperlink generated by getFieldHyperlink(TabularSource, ISourceData, String, String, int).
void	setRenderData()

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

TabularDataControl

public TabularDataControl()

Method Detail

addRowAction

public void addRowAction(org.w3c.dom.Node rowActionNode,
                         java.lang.String actionName,
                         java.lang.String actionControlId)

Adds a new row action in this control.

Parameters:

rowActionNode - the row action node.

actionName - the action name.

actionControlId - the action control identifier.

Since:

7.0.0

loadFromRequest

public void loadFromRequest()
                     throws PortalException

Specified by:

loadFromRequest in interface IDataControl

Overrides:

loadFromRequest in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl<TabularSource<?>>

Throws:

PortalException

getFieldRenderValue

protected java.lang.String getFieldRenderValue(ITabularSourceField field,
                                               java.lang.Object value)
                                        throws PortalException

Returns the render value for the given field.

Parameters:

field - the field

value - the value

Returns:

the render value

Throws:

PortalException

Since:

17.0.0

getStringsToLocalize

protected java.util.Map<java.lang.String,java.lang.String> getStringsToLocalize()

Overrides:

getStringsToLocalize in class Control

getControlResource

public IResource getControlResource()
                             throws PortalException

Specified by:

getControlResource in interface IControl

Overrides:

getControlResource in class Control

Throws:

PortalException

getRowHyperlink

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

Throws:

PortalException

getRowOnClick

protected java.lang.String getRowOnClick(TabularSource<?> source,
                                         ISourceData row,
                                         java.lang.String compositePrimaryKey,
                                         int rowIndex)
                                  throws PortalException

Throws:

PortalException

getFieldHyperlink

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

Throws:

PortalException

mayAddHyperlinkValue

protected boolean mayAddHyperlinkValue(TabularSource<?> source,
                                       java.lang.String fieldId,
                                       java.lang.String parameterName,
                                       java.lang.String parameterValue)
                                throws PortalException

Returns whether the given parameter may be added to the hyperlink generated by getFieldHyperlink(TabularSource, ISourceData, String, String, int).

Parameters:

source - the source

fieldId - the field

parameterName - the parameter name

parameterValue - the parameter value

Returns:

whether the given parameter may be added to the generated hyperlink

Throws:

PortalException

Since:

15.0.0

isContentSource

protected boolean isContentSource(TabularSource<?> source)

Returns whether the given source is a content table one.

Parameters:

source - the source

Returns:

whether the given source is a content table one.

Since:

15.0.0

isCurrentPrimaryContent

protected boolean isCurrentPrimaryContent(TabularSource<?> source,
                                          java.lang.String parameterValue)
                                   throws PortalException

Returns whether the given value is the primary content of the given source.

Parameters:

source - the source

parameterValue - the value

Returns:

whether the given value is the primary content of the given source.

Throws:

PortalException

Since:

15.0.0

getConverter

public IConverter getConverter()
                        throws PortalException

Tabular data control uses no converter.

Specified by:

getConverter in interface IDataControl

Specified by:

getConverter in interface IRenderer

Overrides:

getConverter in class DataControl

Returns:

the converter or null if this control has no converter.

Throws:

PortalException

Since:

4.0.4

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 DataBoundControl<TabularSource<?>>

Returns:

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

Throws:

PortalException