Class \Prado\Web\UI\WebControls\TValidationSummary

TValidationSummary class

TValidationSummary displays a summary of validation errors inline on a Web page, in a message box, or both. By default, a validation summary will collect \Prado\Web\UI\WebControls\TBaseValidator::getErrorMessage of all failed validators on the page. If \Prado\Web\UI\WebControls\getValidationGroup is not empty, only those validators who belong to the group will show their error messages in the summary.

The summary can be displayed as a list, as a bulleted list, or as a single paragraph based on the \Prado\Web\UI\WebControls\setDisplayMode property. The messages shown can be prefixed with \Prado\Web\UI\WebControls\setHeaderText.

The summary can be displayed on the Web page and in a message box by setting the \Prado\Web\UI\WebControls\setShowSummary and \Prado\Web\UI\WebControls\setShowMessageBox properties, respectively. Note, the latter is only effective when \Prado\Web\UI\WebControls\setEnableClientScript is true.

Class hierarchy

\Prado\Web\UI\WebControls\TValidationSummary

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`__construct() : mixed` Constructor. This method sets the foreground color to red.
`public`	`getAutoUpdate() : bool` Gets the auto-update for this summary.
`public`	`getClientSide() : TClientSideValidationSummaryOptions`
`public`	`getDisplay() : TValidationSummaryDisplayStyle`
`public`	`getDisplayMode() : TValidationSummaryDisplayMode`
`public`	`getEnableClientScript() : bool`
`public`	`getHeaderText() : string`
`public`	`getScrollToSummary() : bool`
`public`	`getShowAnchor() : bool`
`public`	`getShowMessageBox() : bool`
`public`	`getShowSummary() : bool`
`public`	`getValidationGroup() : string`
`public`	`renderContents(mixed $writer) : mixed` Overrides parent implementation by rendering TValidationSummary-specific presentation.
`public`	`setAutoUpdate(bool $value) : mixed` Sets the summary to auto-update on the client-side
`public`	`setDisplay(TValidationSummaryDisplayStyle $value) : mixed`
`public`	`setDisplayMode(TValidationSummaryDisplayMode $value) : mixed`
`public`	`setEnableClientScript(bool $value) : mixed`
`public`	`setHeaderText(string $value) : mixed` Sets the header text to be displayed at the top of the summary
`public`	`setScrollToSummary(bool $value) : mixed`
`public`	`setShowAnchor(bool $value) : mixed`
`public`	`setShowMessageBox(bool $value) : mixed`
`public`	`setShowSummary(bool $value) : mixed`
`public`	`setValidationGroup(string $value) : mixed`
`protected`	`addAttributesToRender(mixed $writer) : mixed` Adds attribute name-value pairs to renderer. By default, the method will render 'id', 'accesskey', 'disabled', 'tabindex', 'title' and all custom attributes. The method can be overriden to provide customized attribute rendering.
`protected`	`createClientScript() : TClientSideValidationSummaryOptions`
`protected`	`getClientScriptOptions() : array<string\|int, mixed>` Get a list of options for the client-side javascript validation summary.
`protected`	`getErrorMessages() : array<string\|int, mixed>` Get the list of validation error messages.
`protected`	`getValidationFailed() : bool` Checked if at least one validator failed.
`protected`	`renderBulletList(mixed $writer) : mixed` Render the validation summary as a bullet list.
`protected`	`renderHeaderOnly(THtmlWriter $writer) : mixed` Render the validation summary header text only.
`protected`	`renderJsSummary() : mixed` Render the javascript for validation summary.
`protected`	`renderList(mixed $writer) : mixed` Render the validation summary as a simple list.
`protected`	`renderSingleParagraph(mixed $writer) : mixed` Render the validation summary as a paragraph.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TValidationSummary

Class hierarchy