lumis.doui.control.tabulardata
Class TabularDataControl

Package class diagram package TabularDataControl
java.lang.Object
  extended by lumis.doui.control.Control
      extended by lumis.doui.control.DataControl
          extended by lumis.doui.control.DataBoundControl<TabularSource<?>>
              extended by lumis.doui.control.tabulardata.TabularDataControl
All Implemented Interfaces:
Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer
Direct Known Subclasses:
AdvancedTabularDataControl, AnnouncementTabularDataControl, DetailsControl, 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> </data> </control>

Since:
4.0.6

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_SCRIPT, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE
 
Constructor Summary
TabularDataControl()
           
 
Method Summary
 IResource getControlResource()
           
 IConverter getConverter()
          Tabular data control uses no converter.
protected  String getFieldHyperlink(TabularSource source, ISourceData row, String fieldId, String compositePrimaryKey, int rowIndex)
           
protected  String getRowHyperlink(TabularSource source, ISourceData row, String compositePrimaryKey, int rowIndex)
           
protected  Map<String,String> getStringsToLocalize()
           
 void loadFromRequest()
           
 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, getUnboundedConverter, init, setDefaultValue, setRawValue, setReload, setSourceParameter, setSourceParameters, setsSourceParameters, 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, setTrim, setValue, valueIsArray
 
Methods inherited from class lumis.doui.control.Control
appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getScriptGetValues, getScriptGetValuesFunctionImplementation, getScriptGetValuesFunctionName, getScriptGetValuesRegistration, getSourceContext, getType, getValidationScript, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, 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, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes
 
Methods inherited from interface lumis.doui.render.IRenderer
getResources, getSourceContext
 

Constructor Detail

TabularDataControl

public TabularDataControl()
Method Detail

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

getStringsToLocalize

protected Map<String,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 String getRowHyperlink(TabularSource source,
                                 ISourceData row,
                                 String compositePrimaryKey,
                                 int rowIndex)
                          throws PortalException
Throws:
PortalException

getFieldHyperlink

protected String getFieldHyperlink(TabularSource source,
                                   ISourceData row,
                                   String fieldId,
                                   String compositePrimaryKey,
                                   int rowIndex)
                            throws PortalException
Throws:
PortalException

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


Lumisportal  5.5.0.091130 - Copyright © 2001-2007, Lumis. All Rights Reserved.