Package lumis.doui.control.filter

Class FilterControl<S extends Source<?>>

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.SourceBoundControl<S>

lumis.doui.control.filter.FilterControl<S>

Type Parameters:

S - the filter's source type.

All Implemented Interfaces:

VariableResolver, IControl

Direct Known Subclasses:

ParentFilterControl

public class FilterControl<S extends Source<?>>
extends SourceBoundControl<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

Version:

$Revision: 23038 $ $Date: 2019-08-06 10:20:42 -0300 (Tue, 06 Aug 2019) $

See Also:

InputHiddenControl

Field Summary

Fields

Modifier and Type	Field	Description
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.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
FilterControl()

Method Summary

Modifier and Type	Method	Description
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)
void	setRenderData()

Methods inherited from class lumis.doui.control.SourceBoundControl

getRuntimeDefaultSource, getSource, getSourceContext

Methods inherited from class lumis.doui.control.Control

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

Methods inherited from class java.lang.Object

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

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 Control

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class Control

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 Control

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