//////////////////////////////////////////////////////////////////////////////// // // Licensed to the Apache Software Foundation (ASF) under one or more // contributor license agreements. See the NOTICE file distributed with // this work for additional information regarding copyright ownership. // The ASF licenses this file to You under the Apache License, Version 2.0 // (the "License"); you may not use this file except in compliance with // the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // //////////////////////////////////////////////////////////////////////////////// package mx.validators { import mx.events.ValidationResultEvent; /** * This interface specifies the methods and properties that a Validator * object must implement. *
This interface allows to validate multiple data * types like numbers, currency, phone numbers, zip codes etc that * are defined in both mx and spark namespaces. The classes * mx:Validator and spark:GlobaliationValidatorBase * implement this interface. The validateAll() method in these classes use * this interface type to call the validate() method on * multiple validator objects.
* * * @see mx.validators.Validator * @see spark.validators.GlobalizationValidatorBase * * @langversion 3.0 * @playerversion Flash 10 * @playerversion AIR 1.5 * @productversion Flex 4.5 */ public interface IValidator { //---------------------------------------------------------------------- // // Properties // //---------------------------------------------------------------------- //---------------------------------- // enabled //---------------------------------- /** * Property to enable/disable validation process. *Setting this value to false
will stop the validator
* from performing validation.
* When a validator is disabled, it dispatches no events,
* and the validate()
method returns null.
source
and
* property
properties to determine the value.
* If you specify this argument, you should also set the
* listener
property to specify the target component
* for any validation error messages.
*
* @param suppressEvents If false
, then after validation,
* the validator will notify the listener of the result.
*
* @return A ValidationResultEvent object
* containing the results of the validation.
* For a successful validation, the
* ValidationResultEvent.results
Array property is empty.
* For a validation failure, the
* ValidationResultEvent.results
Array property contains
* one ValidationResult object for each field checked by the validator,
* both for fields that failed the validation and for fields that passed.
* Examine the ValidationResult.isError
* property to determine if the field passed or failed the validation.
*
* @see mx.events.ValidationResultEvent
* @see mx.validators.ValidationResult
*
* @langversion 3.0
* @playerversion Flash 10.1
* @playerversion AIR 2.5
* @productversion Flex 4.5
*/
function validate(value:Object = null,
suppressEvents:Boolean = false):ValidationResultEvent
}
}