asdoc/mx/validators/IValidatorListener.swf.json

{ "type": "interface",
  "qname": "mx.validators.IValidatorListener",
    "description": "The interface that components implement to support the Flex data validation mechanism. The UIComponent class implements this interface. Therefore, any subclass of UIComponent also implements it.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "accessor",
    "access": "read-write",
    "return": "String",
    "qname": "errorString",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.  <p>You can use the <code>errorString</code> property to show a validation error for a component, without actually using a validator class. When you write a String value to the <code>errorString</code> property, Flex draws a red border around the component to indicate the validation error, and the String appears in a tooltip as the validation error message when you move  the mouse over the component, just as if a validator detected a validation error.</p>  <p>To clear the validation error, write an empty String, &quot;&quot;, to the <code>errorString</code> property.</p>  <p>Note that writing a value to the <code>errorString</code> property does not trigger the valid or invalid events; it only changes the border color and displays the validation error message.</p>",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "String",
    "qname": "validationSubField",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Used by a validator to assign a subfield.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "method",
    "qname": "validationResultHandler",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Handles both the <code>valid</code> and <code>invalid</code> events from a  validator assigned to this component.  <p>You typically handle the <code>valid</code> and <code>invalid</code> events dispatched by a validator by assigning event listeners to the validators. If you want to handle validation events directly in the component that is being validated, you can override this method to handle the <code>valid</code> and <code>invalid</code> events. From within your implementation, you can use the <code>dispatchEvent()</code> method to dispatch the <code>valid</code> and <code>invalid</code> events in the case where a validator is also listening for them.</p>",
    "tags": [
    {  "tagName": "see",
           "values": ["mx.events.ValidationResultEvent"]},
        {  "tagName": "param",
           "values": ["event The event object for the validation."]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "event", "type": "mx.events.ValidationResultEvent"}]}
  ]
  }