lumis.doui.control
Class ErrorSummaryControl

Package class diagram package ErrorSummaryControl
java.lang.Object
  extended by lumis.doui.control.Control
      extended by lumis.doui.control.DataControl
          extended by lumis.doui.control.ErrorSummaryControl
All Implemented Interfaces:
VariableResolver, IControl, IDataControl, IErrorSummaryControl, IRenderer

public class ErrorSummaryControl
extends DataControl
implements IErrorSummaryControl

Control that renders the error message to the end user

Since:
4.0.0

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, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE
 
Constructor Summary
ErrorSummaryControl()
           
 
Method Summary
 void addErrorMessage(String errorMessage)
          Add an error message on the server side.
 String getScriptAddErrorMessage(String errorMessage)
          Returns the script that will add the given message to the error message list on the client side.
 String getScriptClear()
          Returns the script that will clear the error summary
 String getScriptShow()
          Returns a client side script that shows the error summary
 void init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
           
 void loadFromRequest()
           
 void setRenderData()
           
 
Methods inherited from class lumis.doui.control.DataControl
convertValueToControlValue, createConverter, createDataType, getConverter, getDataType, getDefaultValue, getParameterValue, getProcessActionHandlerParameterName, getProcessActionIds, getRequestParameterName, getValue, getValue, getValueClass, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setDefaultValue, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setRawValue, setTrim, setValue, valueIsArray
 
Methods inherited from class lumis.doui.control.Control
appendSubControl, appendSubControls, applyOnEventScripts, buildSubControls, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getRuntimeDefaultSource, getScriptActionValidation, getScriptGetValues, getScriptGetValuesFunctionImplementation, getScriptGetValuesFunctionName, getScriptGetValuesRegistration, getSourceContext, getStringsToLocalize, getType, getValidationScript, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, 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, getControlResource, getId, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes, setValid
 
Methods inherited from interface lumis.doui.render.IRenderer
getResources, getSourceContext
 

Constructor Detail

ErrorSummaryControl

public ErrorSummaryControl()
                    throws PortalException
Throws:
PortalException
Method Detail

getScriptShow

public String getScriptShow()
                     throws PortalException
Description copied from interface: IErrorSummaryControl
Returns a client side script that shows the error summary

Specified by:
getScriptShow in interface IErrorSummaryControl
Returns:
a String.
Throws:
PortalException

getScriptAddErrorMessage

public String getScriptAddErrorMessage(String errorMessage)
                                throws PortalException
Description copied from interface: IErrorSummaryControl
Returns the script that will add the given message to the error message list on the client side.

Specified by:
getScriptAddErrorMessage in interface IErrorSummaryControl
Returns:
a String.
Throws:
PortalException

getScriptClear

public String getScriptClear()
                      throws PortalException
Description copied from interface: IErrorSummaryControl
Returns the script that will clear the error summary

Specified by:
getScriptClear in interface IErrorSummaryControl
Returns:
a String.
Throws:
PortalException

addErrorMessage

public void addErrorMessage(String errorMessage)
                     throws PortalException
Description copied from interface: IErrorSummaryControl
Add an error message on the server side.

Specified by:
addErrorMessage in interface IErrorSummaryControl
Throws:
PortalException

setRenderData

public void setRenderData()
                   throws PortalException
Specified by:
setRenderData in interface IControl
Overrides:
setRenderData in class Control
Throws:
PortalException

loadFromRequest

public void loadFromRequest()
                     throws PortalException
Specified by:
loadFromRequest in interface IDataControl
Overrides:
loadFromRequest in class DataControl
Throws:
PortalException

init

public void init(Node controlDefinitionNode,
                 ControlContainer controlContainer,
                 IControl parentControl)
          throws PortalException
Specified by:
init in interface IControl
Overrides:
init in class DataControl
Throws:
PortalException


Lumisportal  6.2.0.120405 - Copyright © 2006–2012 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.