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.domain 

IGuideNode  - AS3 ADEP Guides
Packagecom.adobe.guides.domain
Interfacepublic interface IGuideNode

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 IGuideNode interface is used to manage the shared structure of a guide with the Guide Component.


Public Properties
 PropertyDefined By
  children : Array
[read-only] children is used to get an Array of the GuideNode's children.
IGuideNode
  dataValue : Object
[read-only] dataValue is the current raw value, from the model, of the associated PanelItem type Guide Node.
IGuideNode
  displayValue : String
[read-only] displayValue is the current formatted display value of the associated PanelItem type Guide Node.
IGuideNode
  error : IGuideNodeMessage
[read-only] error is used to get the last validation error information available for the given GuideNode.
IGuideNode
  errorString : String
[read-only] errorString contains the last validation error information available for the given GuideNode.
IGuideNode
  label : String
[read-only] label is used to get the diaplay name for the given GuideNode.
IGuideNode
  parent : IGuideNode
[read-only] parent is used to get the parent node for the given GuideNode.
IGuideNode
  type : String
[read-only] type is used to identify what the GuideNode represents, one of: GuideNodeType.
IGuideNode
  uniqueId : String
[read-only] uniqueId is a utility function that returns a unique Identifier that can be used for tracking purposes.
IGuideNode
Public Methods
 MethodDefined By
  
getDataReference():String
getDataReference returns the model reference instance of the associated Guide PanelItem, Panel or Section.
IGuideNode
Property Detail

children

property
children:Array  [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

children is used to get an Array of the GuideNode's children.

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 children():Array

dataValue

property 
dataValue:Object  [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

dataValue is the current raw value, from the model, of the associated PanelItem type Guide Node. dataValue for Section and Panel nodes is indetermiate.

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 dataValue():Object

displayValue

property 
displayValue:String  [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

displayValue is the current formatted display value of the associated PanelItem type Guide Node. displayValue for Section and Panel nodes is indetermiate.

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 displayValue():String

error

property 
error:IGuideNodeMessage  [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

error is used to get the last validation error information available for the given GuideNode.

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 error():IGuideNodeMessage

errorString

property 
errorString:String  [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

errorString contains the last validation error information available for the given GuideNode.

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 errorString():String

label

property 
label:String  [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

label is used to get the diaplay name for the given GuideNode.

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 label():String

parent

property 
parent:IGuideNode  [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

parent is used to get the parent node for the given GuideNode. The rootNode parent is null.



Implementation
    public function get parent():IGuideNode

type

property 
type:String  [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

type is used to identify what the GuideNode represents, one of: GuideNodeType. GUIDE, SECTION, PANEL or ITEM.

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 type():String

uniqueId

property 
uniqueId:String  [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

uniqueId is a utility function that returns a unique Identifier that can be used for tracking purposes.

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 uniqueId():String
Method Detail

getDataReference

()method
public function getDataReference():String

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

getDataReference returns the model reference instance of the associated Guide PanelItem, Panel or Section.

Returns
String — String



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy