PRADO 3.0.6 : Vue détaillée de TValidationSummary.php

TValidationSummary class file

Author:	Qiang Xue <qiang.xue@gmail.com>
Copyright:	Copyright © 2005 PradoSoft
License:	http://www.pradosoft.com/license/
Version:	$Id: TValidationSummary.php 1397 2006-09-07 07:55:53Z wei $
Poids:	496 lignes (15 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Définit 4 classes

TValidationSummary:: (29 méthodes):
  __construct()
  getDisplay()
  setDisplay()
  getHeaderText()
  setHeaderText()
  getDisplayMode()
  setDisplayMode()
  getEnableClientScript()
  setEnableClientScript()
  getShowMessageBox()
  setShowMessageBox()
  getShowSummary()
  setShowSummary()
  getShowAnchor()
  setShowAnchor()
  getAutoUpdate()
  setAutoUpdate()
  getValidationGroup()
  setValidationGroup()
  addAttributesToRender()
  renderJsSummary()
  getClientScriptOptions()
  getClientSide()
  createClientScript()
  getErrorMessages()
  renderContents()
  renderList()
  renderSingleParagraph()
  renderBulletList()

TValidationSummaryClientScript:: (4 méthodes):
  getOnHideSummary()
  setOnHideSummary()
  setOnShowSummary()
  getOnShowSummary()

TValidationSummaryDisplayMode:: (0 méthodes):

TValidationSummaryDisplayStyle:: (0 méthodes):

Classe: TValidationSummary - X-Ref

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
{@link TBaseValidator::getErrorMessage ErrorMessage} of all failed validators
on the page. If {@link getValidationGroup ValidationGroup} 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 {@link setDisplayMode DisplayMode} property.
The messages shown can be prefixed with {@link setHeaderText HeaderText}.

The summary can be displayed on the Web page and in a message box by setting
the {@link setShowSummary ShowSummary} and {@link setShowMessageBox ShowMessageBox}
properties, respectively. Note, the latter is only effective when
{@link setEnableClientScript EnableClientScript} is true.

__construct() X-Ref

Constructor.
This method sets the foreground color to red.

getDisplay() X-Ref

return: TValidationSummaryDisplayStyle the style of displaying the error messages. Defaults to TValidationSummaryDisplayStyle::Fixed.

setDisplay($value) X-Ref

param: TValidationSummaryDisplayStyle the style of displaying the error messages

getHeaderText() X-Ref

return: string the header text displayed at the top of the summary

setHeaderText($value) X-Ref

Sets the header text to be displayed at the top of the summary

param: string the header text

getDisplayMode() X-Ref

return: TValidationSummaryDisplayMode the mode of displaying error messages. Defaults to TValidationSummaryDisplayMode::BulletList.

setDisplayMode($value) X-Ref

param: TValidationSummaryDisplayMode the mode of displaying error messages

getEnableClientScript() X-Ref

return: boolean whether the TValidationSummary component updates itself using client-side script. Defaults to true.

setEnableClientScript($value) X-Ref

param: boolean whether the TValidationSummary component updates itself using client-side script.

getShowMessageBox() X-Ref

return: boolean whether the validation summary is displayed in a message box. Defaults to false.

setShowMessageBox($value) X-Ref

param: boolean whether the validation summary is displayed in a message box.

getShowSummary() X-Ref

return: boolean whether the validation summary is displayed inline. Defaults to true.

setShowSummary($value) X-Ref

param: boolean whether the validation summary is displayed inline.

getShowAnchor() X-Ref

return: boolean whether the validation summary should be anchored. Defaults to false.

setShowAnchor($value) X-Ref

param: boolean whether the validation summary should be anchored.

getAutoUpdate() X-Ref

Gets the auto-update for this summary.

return: boolean automatic client-side summary updates. Defaults to true.

setAutoUpdate($value) X-Ref

Sets the summary to auto-update on the client-side

param: boolean true for automatic summary updates.

getValidationGroup() X-Ref

return: string the group which this validator belongs to

setValidationGroup($value) X-Ref

param: string the group which this validator belongs to

addAttributesToRender($writer) X-Ref

Pas de description

renderJsSummary() X-Ref

Render the javascript for validation summary.

param: array list of options for validation summary.

getClientScriptOptions() X-Ref

Get a list of options for the client-side javascript validation summary.

return: array list of options for the summary

getClientSide() X-Ref

return: TValidationSummaryClientScript client-side validation summary

createClientScript() X-Ref

return: TValidationSummaryClientScript javascript validation summary

getErrorMessages() X-Ref

Get the list of validation error messages.

return: array list of validator error messages.

renderContents($writer) X-Ref

Overrides parent implementation by rendering TValidationSummary-specific presentation.

return: string the rendering result

renderList($writer) X-Ref

Render the validation summary as a simple list.

param: array list of messages
param: string the header text
return: string summary list

renderSingleParagraph($writer) X-Ref

Render the validation summary as a paragraph.

param: array list of messages
param: string the header text
return: string summary paragraph

renderBulletList($writer) X-Ref

Render the validation summary as a bullet list.

param: array list of messages
param: string the header text
return: string summary bullet list

Classe: TValidationSummaryClientScript - X-Ref

TValidationSummaryClientScript class.

Client-side validation summary events such as {@link setOnHideSummary
OnHideSummary} and {@link setOnShowSummary OnShowSummary} can be modified
through the {@link TBaseValidator:: getClientSide ClientSide} property of a
validation summary.

The <tt>OnHideSummary</tt> event is raise when the validation summary
requests to hide the messages.

The <tt>OnShowSummary</tt> event is raised when the validation summary
requests to show the messages.

See the quickstart documentation for further details.

getOnHideSummary() X-Ref

return: string javascript code for client-side OnHideSummary event.

setOnHideSummary($javascript) X-Ref

Client-side OnHideSummary validation summary event is raise when all the
validators are valid. This will override the default client-side
validation summary behaviour.

param: string javascript code for client-side OnHideSummary event.

setOnShowSummary($javascript) X-Ref

Client-side OnShowSummary event is raise when one or more validators are
not valid. This will override the default client-side validation summary
behaviour.

param: string javascript code for client-side OnShowSummary event.

getOnShowSummary() X-Ref

return: string javascript code for client-side OnShowSummary event.

Classe: TValidationSummaryDisplayMode - X-Ref

TValidationSummaryDisplayMode class.
TValidationSummaryDisplayMode defines the enumerable type for the possible modes
that a {@link TValidationSummary} can organize and display the collected error messages.

The following enumerable values are defined:
- SimpleList: the error messages are displayed as a list without any decorations.
- SingleParagraph: the error messages are concatenated together into a paragraph.
- BulletList: the error messages are displayed as a bulleted list.

Classe: TValidationSummaryDisplayStyle - X-Ref

TValidationSummaryDisplay class.
TValidationSummaryDisplay defines the enumerable type for the possible styles
that a {@link TValidationSummary} can display the collected error messages.

The following enumerable values are defined:
- None: the error messages are not displayed
- Dynamic: the error messages are dynamically added to display as the corresponding validators fail
- Fixed: Similar to Dynamic except that the error messages physically occupy the page layout (even though they may not be visible)

Code source de PRADO 3.0.6

/framework/Web/UI/WebControls/ -> TValidationSummary.php (sommaire)

Définit 4 classes