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.
- Since:
- 4.0.0
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 |
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, getRequestParameterName, getValue, getValue, getValueClass, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setTrim, setValue, valueIsArray |
Methods inherited from class lumis.doui.control.Control |
appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, generateControlId, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, 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.IControl |
createContainer, disconnect, getChildControls, getControlResource, getId, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes |
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
FilterControl
public FilterControl()
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
Lumisportal 4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.