ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.guides.control 

IGuideErrors  - AS3 ADEP Guides

Packagecom.adobe.guides.control
Interfacepublic interface IGuideErrors

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 10
Runtime Versions: AIR 1.0, Flash Player 10.2

The IGuideErrors interface provides access to properties and methods which assist with dealing with validations and error states. "validate(node)" will validate the IGuideNode provided, the whole Guide if nothing provided, a single Panel if a Panel Node is provided. "errors" property is an IList of GuideNodes that currently contain validation errors.



Public Properties
 PropertyDefined By
  errors : IList
[read-only] errors is an IList of GuideNodes that currently contain validation errors.
IGuideErrors
Public Methods
 MethodDefined By
  
validate will validate the GuideNode provided, the whole Guide if nothing provided, a single Panel if a Panel Node is provided.
IGuideErrors
Property Detail

errors

property
errors:IList  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 10
Runtime Versions: AIR 1.0, Flash Player 10.2

errors is an IList of GuideNodes that currently contain validation errors.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get errors():IList
Method Detail

validate

()method
public function validate(node:IGuideNode = null):Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Guides 10
Runtime Versions: AIR 1.0, Flash Player 10.2

validate will validate the GuideNode provided, the whole Guide if nothing provided, a single Panel if a Panel Node is provided.

Parameters

node:IGuideNode (default = null) — the Guide object to validate, may be one of the following guide node types: guide, section, panel or item.

Returns
Boolean — Boolean