lumis.doui.control.filter
Class FilterControl<S extends Source>

java.lang.Object
  lumis.doui.control.Control
      lumis.doui.control.DataControl
          lumis.doui.control.DataBoundControl<S>
              lumis.doui.control.filter.FilterControl<S>

Type Parameters:

S - the filter's source type.

All Implemented Interfaces:

Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

Direct Known Subclasses:

ParentFilterControl

public class FilterControl<S extends Source>
extends DataBoundControl<S>

Generic filter control. Renders the frontend for the user to choose between the available filters.

Example use:

<control:lum_filter id="filters.id" filterId="id" sourceId="contentLocale" /> xml data available for xsl rendering: <control filterId="id" id="filters.id" sourceId="contentLocale" type="lum_filter"> <control id="filters.id.value" type="lum_inputHidden" ... /> </control>

Since:

4.0.0

See Also:

InputHiddenControl

Field Summary

protected String	filteredFieldDataType
protected String	filteredFieldId
protected Node	filteredFieldNode
protected String	filteredFieldPattern
protected String	filterId
protected String	filterInputControlType
protected String	filterInputRequestParameterName
protected String	filterNodeDefaultValue
protected String	filterNodeValue
protected boolean	filterRenderBlankOption
protected Node	sourceFilterNode

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

FilterControl()

Method Summary

protected String	buildHiddenSubControls()
void	buildSubControls()
protected String	buildVisibleSubControls() Builds all visible children controls of the filter.
protected boolean	fixedIdentifierRequired()
protected String	getFilterName()
void	init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)

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, getUnboundedConverter, loadFromRequest, setDefaultValue, setRawValue, setReload, setRenderData, setSourceParameter, setSourceParameters, setsSourceParameters, setValid, setValueFromSource, setValueFromSource, update

Methods inherited from class lumis.doui.control.DataControl

convertValueToControlValue, getConverter, 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, generateControlId, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getScriptGetValues, getScriptGetValuesFunctionImplementation, getScriptGetValuesFunctionName, getScriptGetValuesRegistration, getSourceContext, getStringsToLocalize, 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

getConverter, getProcessActionIds, getValue, getValue, setProcessActionHandlerParameters, setValue

Methods inherited from interface lumis.doui.control.IControl

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

Methods inherited from interface lumis.doui.render.IRenderer

getResources, getSourceContext

Field Detail

filterId

protected String filterId

filterNodeValue

protected String filterNodeValue

filterNodeDefaultValue

protected String filterNodeDefaultValue

filteredFieldId

protected String filteredFieldId

filteredFieldDataType

protected String filteredFieldDataType

filteredFieldPattern

protected String filteredFieldPattern

filterInputRequestParameterName

protected String filterInputRequestParameterName

filterInputControlType

protected String filterInputControlType

filterRenderBlankOption

protected boolean filterRenderBlankOption

sourceFilterNode

protected Node sourceFilterNode

filteredFieldNode

protected Node filteredFieldNode

Constructor Detail

FilterControl

public FilterControl()

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<S extends Source>

Throws:

PortalException

fixedIdentifierRequired

protected boolean fixedIdentifierRequired()

Overrides:

fixedIdentifierRequired in class Control

buildSubControls

public void buildSubControls()
                      throws ControlException,
                             PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl<S extends Source>

Throws:

ControlException

PortalException

getFilterName

protected String getFilterName()
                        throws PortalException

Returns:

the name for the filter, or the name of the filtered field.

Throws:

PortalException

buildVisibleSubControls

protected String buildVisibleSubControls()
                                  throws PortalException

Builds all visible children controls of the filter. Based on the filter properties these sub controls could be labels, inputboxes, dropdown boxes, date picker controls etc.

Returns:

Throws:

PortalException

buildHiddenSubControls

protected String buildHiddenSubControls()
                                 throws PortalException

Throws:

PortalException