Class TListControlValidator

Description

TListControlValidator class.

TListControlValidator checks the number of selection and their values for a TListControl that allows multiple selection.

You can specify the minimum or maximum (or both) number of selections required using the MinSelection and MaxSelection properties, respectively. In addition, you can specify a comma separated list of required selected values via the RequiredSelections property.

Examples

  • At least two selections
    1. <com:TListBox ID="listbox" SelectionMode="Multiple">
    2. <com:TListItem Text="item1" Value="value1" />
    3. <com:TListItem Text="item2" Value="value2" />
    4. <com:TListItem Text="item3" Value="value3" />
    5. </com:TListBox>
    6.  
    7. <com:TListControlValidator
    8. ControlToValidate="listbox"
    9. MinSelection="2"
    10. ErrorMessage="Please select at least 2" />
  • "value1" must be selected and at least 1 other
    1. <com:TCheckBoxList ID="checkboxes">
    2. <com:TListItem Text="item1" Value="value1" />
    3. <com:TListItem Text="item2" Value="value2" />
    4. <com:TListItem Text="item3" Value="value3" />
    5. </com:TCheckBoxList>
    6.  
    7. <com:TListControlValidator
    8. ControlToValidate="checkboxes"
    9. RequiredSelections="value1"
    10. MinSelection="2"
    11. ErrorMessage="Please select 'item1' and at least 1 other" />

  • since: 3.0
  • version: $Id: TListControlValidator.php 1398 2006-09-08 19:31:03Z xue $
  • author: Xiang Wei Zhuo <weizhuo[at]gmail.com>

Located in /Web/UI/WebControls/TListControlValidator.php (line 64)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TLabel
               |
               --TBaseValidator
                  |
                  --TListControlValidator
Method Summary
boolean evaluateIsValid ()
string getClientClassName ()
integer getMaxSelection ()
integer getMinSelection ()
array getSelection (TListControl $control)
void setMaxSelection (integer $value)
void setMinSelection (integer $value)
void setRequiredSelections (string $value)
Methods
evaluateIsValid (line 136)

This method overrides the parent's implementation.

The validation succeeds if the input component changes its data from the InitialValue or the input component is not given.

  • return: whether the validation succeeds
  • access: protected
boolean evaluateIsValid ()

Redefinition of:
TBaseValidator::evaluateIsValid()
This is the major method for validation.
getClientClassName (line 71)

Gets the name of the javascript class responsible for performing validation for this control.

This method overrides the parent implementation.

  • return: the javascript class name
  • access: protected
string getClientClassName ()

Redefinition of:
TBaseValidator::getClientClassName()
Gets the name of the javascript class responsible for performing validation for this control.
getClientScriptOptions (line 200)

Returns an array of javascript validator options.

  • return: javascript validator options.
  • access: protected
array getClientScriptOptions ()

Redefinition of:
TBaseValidator::getClientScriptOptions()
Returns an array of javascript validator options.
getMaxSelection (line 97)
  • return: max number of selections. Defaults to -1, meaning not set.
  • access: public
integer getMaxSelection ()
getMinSelection (line 79)
  • return: min number of selections. Defaults to -1, meaning not set.
  • access: public
integer getMinSelection ()
getRequiredSelections (line 116)

Get a comma separated list of required selected values.

  • return: comma separated list of required values.
  • access: public
string getRequiredSelections ()
getRequiredValues (line 187)
  • return: list of required values.
  • access: protected
array getRequiredValues ()
getSelection (line 171)
  • return: number of selected values and its values.
  • access: protected
array getSelection (TListControl $control)
setMaxSelection (line 105)
  • access: public
void setMaxSelection (integer $value)
  • integer $value: max number of selections.
setMinSelection (line 87)
  • access: public
void setMinSelection (integer $value)
  • integer $value: minimum number of selections.
setRequiredSelections (line 125)

Set the list of required values, using aa comma separated list.

  • access: public
void setRequiredSelections (string $value)
  • string $value: comma separated list of required values.

Inherited Methods

Inherited From TBaseValidator

TBaseValidator::__construct()
TBaseValidator::addAttributesToRender()
TBaseValidator::createClientSide()
TBaseValidator::evaluateIsValid()
TBaseValidator::getClientClassName()
TBaseValidator::getClientScriptOptions()
TBaseValidator::getClientSide()
TBaseValidator::getControlCssClass()
TBaseValidator::getControlToValidate()
TBaseValidator::getDisplay()
TBaseValidator::getEnableClientScript()
TBaseValidator::getErrorMessage()
TBaseValidator::getFocusElementID()
TBaseValidator::getFocusOnError()
TBaseValidator::getIsValid()
TBaseValidator::getValidationGroup()
TBaseValidator::getValidationTarget()
TBaseValidator::getValidationValue()
TBaseValidator::onInit()
TBaseValidator::onPreRender()
TBaseValidator::onUnload()
TBaseValidator::onValidate()
TBaseValidator::onValidationError()
TBaseValidator::onValidationSuccess()
TBaseValidator::registerClientScriptValidator()
TBaseValidator::renderClientControlScript()
TBaseValidator::renderContents()
TBaseValidator::setControlCssClass()
TBaseValidator::setControlToValidate()
TBaseValidator::setDisplay()
TBaseValidator::setEnableClientScript()
TBaseValidator::setEnabled()
TBaseValidator::setErrorMessage()
TBaseValidator::setFocusElementID()
TBaseValidator::setFocusOnError()
TBaseValidator::setForControl()
TBaseValidator::setIsValid()
TBaseValidator::setValidationGroup()
TBaseValidator::updateControlCssClass()
TBaseValidator::validate()

Inherited From TLabel

TLabel::addAttributesToRender()
TLabel::getData()
TLabel::getForControl()
TLabel::getTagName()
TLabel::getText()
TLabel::render()
TLabel::renderContents()
TLabel::setData()
TLabel::setForControl()
TLabel::setText()

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::clearStyle()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getDisplay()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
TControl::getID()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Class Constants

Documentation generated on Mon, 21 Apr 2008 11:35:29 -0400 by phpDocumentor 1.3.0RC4