Package lumis.doui.control.autorefresh

Class AutoRefreshControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

lumis.doui.control.autorefresh.AutoRefreshControl

All Implemented Interfaces:

javax.servlet.jsp.el.VariableResolver, IControl, IDataControl, IRenderer

public class AutoRefreshControl
extends DataControl

Used to refresh the page at the given interval period.

Example use: <control:lum_autoRefresh id="autoRefresh" refreshRate="10" /> xml data available for xsl rendering: <control id="autoRefresh" type="lum_autoRefresh"> <data> <value>true</value> <text>Enable auto-refresh</text> <formName>Form_8A488A03114CA81B01114CFD0210021D</formName> <serviceInterfaceInstanceId>8A488A03114CA81B01114CFD0210021D</serviceInterfaceInstanceId> <refreshRate>10</refreshRate> </data> </control>

Since:

4.0.5

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

Method Summary

Modifier and Type	Method	Description
IResource	getControlResource()
IDataControlRequestHelpDefinition	getRequestHelpDefinition()	Returns the request parameters help definition.
void	loadFromRequest()
protected void	setDefaultValue()
void	setRenderData()

Methods inherited from class lumis.doui.control.DataControl

convertValueToControlValue, createConverter, createDataType, getConverter, getDataType, getDefaultValue, getParameterValue, getProcessActionHandlerParameterName, getProcessActionIds, getRequestParameterName, getValue, getValue, getValueClass, init, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setRawValue, setSourceParameter, setSourceParameter, setSourceParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, buildSubControls, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getRuntimeDefaultSource, getScriptActionValidation, getSourceContext, 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

Methods inherited from interface lumis.doui.control.IControl

buildSubControls, createContainer, disconnect, getChildControls, getId, getName, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes, setValid

Methods inherited from interface lumis.doui.render.IRenderer

getResources, getSourceContext

Constructor Detail

AutoRefreshControl

public AutoRefreshControl()

Method Detail

loadFromRequest

public void loadFromRequest()
                     throws PortalException

Specified by:

loadFromRequest in interface IDataControl

Overrides:

loadFromRequest in class DataControl

Throws:

PortalException

setDefaultValue

protected void setDefaultValue()
                        throws PortalException

Overrides:

setDefaultValue in class DataControl

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class Control

Throws:

PortalException

getControlResource

public IResource getControlResource()
                             throws PortalException

Specified by:

getControlResource in interface IControl

Overrides:

getControlResource in class Control

Throws:

PortalException

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.

Returns:

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

Throws:

PortalException