PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TListControlValidator

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 setMinSelection MinSelection and setMaxSelection MaxSelection properties, respectively. In addition, you can specify a comma separated list of required selected values via the setRequiredSelections RequiredSelections property.

Examples

  • At least two selections
<com:TListBox ID="listbox" SelectionMode="Multiple">
        <com:TListItem Text="item1" Value="value1" />
        <com:TListItem Text="item2" Value="value2" />
        <com:TListItem Text="item3" Value="value3" />
</com:TListBox>

<com:TListControlValidator
        ControlToValidate="listbox"
        MinSelection="2"
        ErrorMessage="Please select at least 2" />
  • "value1" must be selected and at least 1 other
<com:TCheckBoxList ID="checkboxes">
        <com:TListItem Text="item1" Value="value1" />
        <com:TListItem Text="item2" Value="value2" />
        <com:TListItem Text="item3" Value="value3" />
</com:TCheckBoxList>

<com:TListControlValidator
        ControlToValidate="checkboxes"
        RequiredSelections="value1"
        MinSelection="2"
        ErrorMessage="Please select 'item1' and at least 1 other" />
TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TLabel implements IDataRenderer
Extended by TBaseValidator implements IValidator
Extended by TListControlValidator
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Xiang Wei Zhuo <weizhuo[at]gmail.com>
Since: 3.0
Located at Web/UI/WebControls/TListControlValidator.php
Methods summary
protected string
# getClientClassName( )

Gets the name of the javascript class responsible for performing validation for this control. This method overrides the parent implementation.

Gets the name of the javascript class responsible for performing validation for this control. This method overrides the parent implementation.

Returns

string
the javascript class name
public integer
# getMinSelection( )

Returns

integer
min number of selections. Defaults to -1, meaning not set.
public
# setMinSelection( integer $value )

Parameters

$value
integer
minimum number of selections.
public integer
# getMaxSelection( )

Returns

integer
max number of selections. Defaults to -1, meaning not set.
public
# setMaxSelection( integer $value )

Parameters

$value
integer
max number of selections.
public string
# getRequiredSelections( )

Get a comma separated list of required selected values.

Get a comma separated list of required selected values.

Returns

string
comma separated list of required values.
public
# setRequiredSelections( string $value )

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

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

Parameters

$value
string
comma separated list of required values.
protected boolean
# evaluateIsValid( )

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.

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.

Returns

boolean
whether the validation succeeds
protected array
# getSelection( TListControl $control )

Parameters

$control
TListControl
control to validate

Returns

array
number of selected values and its values.
protected array
# getRequiredValues( )

Returns

array
list of required values.
protected array
# getClientScriptOptions( )

Returns an array of javascript validator options.

Returns an array of javascript validator options.

Returns

array
javascript validator options.

Overrides

TBaseValidator::getClientScriptOptions()
Methods inherited from TBaseValidator
__construct(), addAttributesToRender(), createClientSide(), getClientSide(), getControlCssClass(), getControlToValidate(), getDisplay(), getEnableClientScript(), getErrorMessage(), getFocusElementID(), getFocusOnError(), getIsValid(), getValidationGroup(), getValidationTarget(), getValidationValue(), onInit(), onPreRender(), onUnload(), onValidate(), onValidationError(), onValidationSuccess(), registerClientScriptValidator(), renderClientControlScript(), renderContents(), setControlCssClass(), setControlToValidate(), setDisplay(), setEnableClientScript(), setEnabled(), setErrorMessage(), setFocusElementID(), setFocusOnError(), setForControl(), setIsValid(), setValidationGroup(), updateControlCssClass(), validate()
Methods inherited from TLabel
getData(), getForControl(), getTagName(), getText(), render(), setData(), setText()
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), createStyle(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), renderBeginTag(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__get(), addParsedObject(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBind(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadState(), loadStateRecursive(), onDataBinding(), onLoad(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveState(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Properties inherited from TWebControl
$_decorator
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO