| Package | ga.controls |
| Class | public class Wrapper |
| Inheritance | Wrapper  Box Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IConnectionService, IWrapperHost |
| Subclasses | ButtonBar, CobaltBar, CobaltStandard, CobaltTree, LeftAccordion, LeftMultilevel, Workspace |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Wrapper class is the base class from which all Guide layouts are derived.
This class provides convenience methods for custom Guide application authors as well as methods for
managing the communication with an associated PDF, if available, as well as the methods for managing the
local connection with a host SWF application, if available.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| activeViewType : String
Indicates the type of communication expected, either DOR or interactive. | Wrapper | ||
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| autoLayout : Boolean
If true, measurement and layout are done
when the position or size of a child is changed. | Container | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | Container | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| childDescriptors : Array [read-only]
Array of UIComponentDescriptor objects produced by the MXML compiler. | Container | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| clipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes
of this container's children extend outside the borders of
this container. | Container | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [override] [read-only]
Returns the x position of the mouse, in the content coordinate system. | Container | |
| contentMouseY : Number [override] [read-only]
Returns the y position of the mouse, in the content coordinate system. | Container | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| creatingContentPane : Boolean
Containers use an internal content pane to control scrolling. | Container | |
| creationIndex : int Deprecated: Deprecated
Specifies the order to instantiate and draw the children
of the container. | Container | |
| creationPolicy : String
The child creation policy for this MX Container. | Container | |
| currentPage : Page
The current page which implements the IPanel interface. | Wrapper | ||
| currentPanel : Panel
The current panel. | Wrapper | ||
| currentPanelItem : PanelItem
The current panel item that has focus. | Wrapper | ||
| currentSection : Section
The current section. | Wrapper | ||
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| data : Object
The data property lets you pass a value
to the component when you use it in an item renderer or item editor. | Container | |
| defaultButton : IFlexDisplayObject
The Button control designated as the default button
for the container. | Container | |
| deferredContentCreated : Boolean [read-only]
IDeferredContentOwner equivalent of processedDescriptors
| Container | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| direction : String
The direction in which this Box container lays out its children. | Box | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| guideConnectionActive : Boolean
Indicates if a host SWF is communicating with the Guide through a local connection. | Wrapper | ||
| guideExternalInterfaceAvailable : Boolean
Indicates if the guides HTML wrapper exists and contains the required guide support. | Wrapper | ||
| guideView : Boolean
Indicates whether the Guide SWF or the PDF has current input and control. | Wrapper | ||
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| horizontalLineScrollSize : Number
Number of pixels to move when the left- or right-arrow
button in the horizontal scroll bar is pressed. | Container | |
| horizontalPageScrollSize : Number
Number of pixels to move when the track in the
horizontal scroll bar is pressed. | Container | |
| horizontalScrollBar : ScrollBar
The horizontal scrollbar used in this container. | Container | |
| horizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always present,
always absent, or automatically added when needed. | Container | |
| horizontalScrollPosition : Number
The current position of the horizontal scroll bar. | Container | |
| icon : Class
The Class of the icon displayed by some navigator
containers to represent this Container. | Container | |
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| includeNavigationMinHeight : int
Indicates the minimum height at which the Navigation part of the guide will still display. | Wrapper | ||
| includeNavigationMinWidth : int
Indicates the minimum width at which the Navigation part of the guide will still display. | Wrapper | ||
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instance : IWrapperHost [static]
The singleton instance of the Guide layout. | Wrapper | ||
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| interactivePdfBackgroundLoadDelay : int
Indicates the delay, in milliseconds, of a background load of the interactive pdf should be. | Wrapper | ||
| interactivePdfLoad : String
Indicates when the load of the interactive pdf should happen. | Wrapper | ||
| interactivePdfUrl : String
Provides the url to retreive the interactive pdf from. | Wrapper | ||
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isLoadingInteractivePdf : Boolean
Indicates an interactivePdf is in the process of being loaded. | Wrapper | ||
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| label : String
The text displayed by some navigator containers to represent
this Container. | Container | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| lcx : Lcx
Get or sets the guide deployment model. | Wrapper | ||
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxHorizontalScrollPosition : Number [read-only]
The largest possible value for the
horizontalScrollPosition property. | Container | |
| maxVerticalScrollPosition : Number [read-only]
The largest possible value for the
verticalScrollPosition property. | Container | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| model : IWrapperModel [read-only]
A instance of IWrapperMOdel. | Wrapper | ||
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [override] [read-only]
Number of child components in this container. | Container | |
| numElements : int [read-only]
The number of visual elements in this container. | Container | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| panelManager : PanelManager [read-only]
The panel manager. | Wrapper | ||
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| pdfActive : Boolean
Indicates that the Guide has successfully communicated with the PDF rendition. | Wrapper | ||
| pdfAvailable : Boolean
Indicates that a PDF may be available to communicate with. | Wrapper | ||
| pdfCommunicationActive : Boolean
Indicates that the form guide has successfully communicated with the PDF rendition
of the form. | Wrapper | ||
| pdfLoadErrorMessage : String
Holds the error message string that is displayed when the Guide times out trying to communicate with the PDF. | Wrapper | ||
| pdfProcessFocus : Boolean
Flag to be set by Custom Implementation based on this class to activate focus processing. | Wrapper | ||
| pdfRequiredFallbackUrl : String
Holds an optional Process URL to submit the Data to when "SubmitFromInteractivePDF" but the PDF can not be loaded. | Wrapper | ||
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| performanceLog : Boolean
Indicates that performance logging is active. | Wrapper | ||
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| previewAsset : String
Holds an optional Asset reference that will get mapped into the previewUrl. | Wrapper | ||
| previewAvailable : Boolean
Indicates that a PDF (or other document type) may be available to render and display. | Wrapper | ||
| previewUrl : String
Holds the Url to get a PDF (or other document type) to render and display. | Wrapper | ||
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| rawChildren : IChildList [read-only]
A container typically contains child components, which can be enumerated
using the Container.getChildAt() method and
Container.numChildren property. | Container | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| resizeToContent : Boolean
When set to true, the Guide will resize itself to take only
the space needed to display its content. | Wrapper | ||
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| showControlSection : Boolean
Show or hide the control sections. | Wrapper | ||
| showHeaderSection : Boolean
Show or hide the header section. | Wrapper | ||
| showHelpCenter : Boolean
Show or hide the help center. | Wrapper | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showNavHelpSection : Boolean
Show or hide the navigator help section. | Wrapper | ||
| showNavigator : Boolean
Show or hide the navigator. | Wrapper | ||
| showNextPrev : Boolean
Show or hide the next/previous Buttons. | Wrapper | ||
| showRepeaterControls : Boolean
Show or hide the repeater controls add/copy/remove. | Wrapper | ||
| showSubmitButton : Boolean
Show or hide the submit button. | Wrapper | ||
| showTitleBar : Boolean
Show or hide the title bar. | Wrapper | ||
| showToolBar : Boolean
Show or hide the tool bar. | Wrapper | ||
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| submitAll : Boolean
When false, field data in an optional panel is cleared when the panel is made invisible. | Wrapper | ||
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| verticalLineScrollSize : Number
Number of pixels to scroll when the up- or down-arrow
button in the vertical scroll bar is pressed,
or when you scroll by using the mouse wheel. | Container | |
| verticalPageScrollSize : Number
Number of pixels to scroll when the track
in the vertical scroll bar is pressed. | Container | |
| verticalScrollBar : ScrollBar
The vertical scrollbar used in this container. | Container | |
| verticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present,
always absent, or automatically added when needed. | Container | |
| verticalScrollPosition : Number
The current position of the vertical scroll bar. | Container | |
| viewMetrics : EdgeMetrics [read-only]
Returns an object that has four properties: left,
top, right, and bottom. | Container | |
| viewMetricsAndPadding : EdgeMetrics [read-only]
Returns an object that has four properties: left,
top, right, and bottom. | Container | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Wrapper()
Constructor. | Wrapper | ||
Call back indicating document view has activated. | Wrapper | ||
| [override]
Adds a child DisplayObject to this Container. | Container | |
| [override]
Adds a child DisplayObject to this Container. | Container | |
|
Adds a visual element to this container. | Container | |
|
Adds a visual element to this container. | Container | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
Pre-loads the PDF rendition of the form within the PDFBox control area on the Guide layout. | Wrapper | ||
Calls the html to passthrough message to the PDF or to specified function in the HTML. | Wrapper | ||
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
The connection was closed. | Wrapper | ||
The connection was made, if success=false, the connection attempt failed
| Wrapper | ||
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
| [override]
Converts a Point object from content coordinates to global coordinates. | Container | |
| [override]
Converts a Point object from content to local coordinates. | Container | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Given a single UIComponentDescriptor, create the corresponding
component and add the component as a child of this Container. | Container | |
|
Iterate through the Array of childDescriptors,
and call the createComponentFromDescriptor() method for each one. | Container | |
|
Performs the equivalent action of calling
the createComponentsFromDescriptors(true) method for containers
that implement the IDeferredContentOwner interface to support deferred instantiation. | Container | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
Default error message handler for communication with the PDF. | Wrapper | ||
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
Forwards the request to email the PDF rendition of the Guide. | Wrapper | ||
|
Ends all currently playing effects on the component. | UIComponent | |
| [override]
Executes all the data bindings on this Container. | Container | |
|
Executes the bindings into this Container's child UIComponent objects. | Container | |
|
Called after printing is complete. | UIComponent | |
Return the form's Active data, either from the Guide or the PDF. | Wrapper | ||
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| [override]
Gets the nth child component object. | Container | |
| [override]
Returns the child whose name property is the specified String. | Container | |
| [override]
Gets the zero-based index of a specific child. | Container | |
|
Returns an Array of DisplayObject objects consisting of the content children
of the container. | Container | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
Return the form's data
| Wrapper | ||
Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active. | Wrapper | ||
|
Returns the visual element at the specified index. | Container | |
|
Returns the index position of a visual element. | Container | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
Returns a field's value as an Object
| Wrapper | ||
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
Gets the ga/xml data from the PDF. | Wrapper | ||
Gets a fields data from the PDF. | Wrapper | ||
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
Return the requested property. | Wrapper | ||
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| [override]
Converts a Point object from global to content coordinates. | Container | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
Answer received from the PDF providing requested data. | Wrapper | ||
Called when a field in the interactive PDF get focus. | Wrapper | ||
Event handler called when the guide has been created. | Wrapper | ||
Called when validation of field data for a panel fails. | Wrapper | ||
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
Hides the Document of Record rendition and displays the Guide content. | Wrapper | ||
Hides the PDF rendition and displays the Guide content. | Wrapper | ||
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
Called when the guide is initalized. | Wrapper | ||
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
True if this guide is based off of a Fiber Model. | Wrapper | ||
Return whether or not the guide is initialized. | Wrapper | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
True if this guide is based off of a XFA Model. | Wrapper | ||
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
| [override]
Converts a Point object from local to content coordinates. | Container | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
Called when validation of page fails. | Wrapper | ||
This method is called whenever a panelItem in the Guide loses focus. | Wrapper | ||
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
This method is called when the PDF is initialized. | Wrapper | ||
|
Method used to convert number of pixels to a
percentage relative to the contents of this container. | Box | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
Forwards the request to print the PDF rendition of the Guide. | Wrapper | ||
Handles incoming messages from the PDF via the HTML. | Wrapper | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes all children from the child list of this container. | Container | |
|
Removes all visual elements from the container. | Container | |
| [override]
Removes a child DisplayObject from the child list of this Container. | Container | |
| [override]
Removes a child DisplayObject from the child list of this Container
at the specified index. | Container | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes the specified visual element from the child list of
this container. | Container | |
|
Removes a visual element from the specified index position
in the container. | Container | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
Reset the Model back to its initial load state. | Wrapper | ||
|
Resolves a child by using the id provided. | UIComponent | |
Resolves the preview URL. | Wrapper | ||
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
Forwards the request to save the PDF rendition of the Guide. | Wrapper | ||
Called when server validation fails. | Wrapper | ||
Sets the data in the active view. | Wrapper | ||
|
Sizes the object. | UIComponent | |
| [override]
Sets the index of a particular child. | Container | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
Set the data into the form - returns false if failed. | Wrapper | ||
|
Changes the position of an existing visual element in the visual container. | Container | |
Sets a field's value, returns success true or false
| Wrapper | ||
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
Sets the ga/xml data into the PDF. | Wrapper | ||
Sets a fields data into the PDF
| Wrapper | ||
Set the property, returns false if the operation failed
| Wrapper | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
Displays the Document of Record rendition of the form within the PDFBox control area on the Guide layout. | Wrapper | ||
Displays the PDF rendition of the form within the PDFBox control area on the Guide layout. | Wrapper | ||
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
Performs the submit action based on the value of the Submit From
option in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0. | Wrapper | ||
Submits the data to the server - return true if the submit was performed
- returns false if validations fail
| Wrapper | ||
This function displays the PDF rendition within the PDFBox control on the Guide layout. | Wrapper | ||
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Swaps the index of the two specified visual elements. | Container | |
|
Swaps the visual elements at the two specified index
positions in the container. | Container | |
Transfers data to or from and displays or hides the PDF or document
| Wrapper | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
Spark Theme Styles
Halo Theme Styles
Public Constants
Property Detail
activeViewType | property |
activeViewType: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 |
Indicates the type of communication expected, either DOR or interactive.
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 activeViewType():String public function set activeViewType(value:String):voidcurrentPage | property |
currentPage:Page| 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 current page which implements the IPanel interface.
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 currentPage():Page public function set currentPage(value:Page):voidcurrentPanel | property |
currentPanel:Panel| 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 current panel.
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 currentPanel():Panel public function set currentPanel(value:Panel):voidcurrentPanelItem | property |
currentPanelItem:PanelItem| 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 current panel item that has focus.
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 currentPanelItem():PanelItem public function set currentPanelItem(value:PanelItem):voidcurrentSection | property |
currentSection:Section| 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 current section.
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 currentSection():Section public function set currentSection(value:Section):voidguideConnectionActive | property |
guideConnectionActive: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 |
Indicates if a host SWF is communicating with the Guide through a local connection.
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 guideConnectionActive():Boolean public function set guideConnectionActive(value:Boolean):voidguideExternalInterfaceAvailable | property |
guideExternalInterfaceAvailable: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 |
Indicates if the guides HTML wrapper exists and contains the required guide support. This check should be used instead of 'ExternalInterface.available'.
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 guideExternalInterfaceAvailable():Boolean public function set guideExternalInterfaceAvailable(value:Boolean):voidguideView | property |
guideView: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 |
Indicates whether the Guide SWF or the PDF has current input and control.
The value of this flag is set according to the following rules:
- True when Guide has ownership.
- False when the PDF has ownership and is currently visible to a user.
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 guideView():Boolean public function set guideView(value:Boolean):voidincludeNavigationMinHeight | property |
includeNavigationMinHeight:int| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Indicates the minimum height at which the Navigation part of the guide will still display.
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 includeNavigationMinHeight():int public function set includeNavigationMinHeight(value:int):voidincludeNavigationMinWidth | property |
includeNavigationMinWidth:int| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Indicates the minimum width at which the Navigation part of the guide will still display.
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 includeNavigationMinWidth():int public function set includeNavigationMinWidth(value:int):voidinstance | property |
instance:IWrapperHost| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
The singleton instance of the Guide layout.
Implementation
public static function get instance():IWrapperHost public static function set instance(value:IWrapperHost):voidinteractivePdfBackgroundLoadDelay | property |
interactivePdfBackgroundLoadDelay:int| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Indicates the delay, in milliseconds, of a background load of the interactive pdf should be.
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 interactivePdfBackgroundLoadDelay():int public function set interactivePdfBackgroundLoadDelay(value:int):voidinteractivePdfLoad | property |
interactivePdfLoad: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 |
Indicates when the load of the interactive pdf should happen.
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 interactivePdfLoad():String public function set interactivePdfLoad(value:String):voidinteractivePdfUrl | property |
interactivePdfUrl: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 |
Provides the url to retreive the interactive pdf from.
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 interactivePdfUrl():String public function set interactivePdfUrl(value:String):voidisLoadingInteractivePdf | property |
isLoadingInteractivePdf: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 |
Indicates an interactivePdf is in the process of being loaded.
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 isLoadingInteractivePdf():Boolean public function set isLoadingInteractivePdf(value:Boolean):voidlcx | property |
lcx:Lcx| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Get or sets the guide deployment model.
Implementation
public function get lcx():Lcx public function set lcx(value:Lcx):voidmodel | property |
model:IWrapperModel [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
A instance of IWrapperMOdel.
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 model():IWrapperModelpanelManager | property |
panelManager:PanelManager [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 |
The panel manager.
Implementation
public function get panelManager():PanelManagerpdfActive | property |
pdfActive: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 |
Indicates that the Guide has successfully communicated with the PDF rendition. of the form.
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 pdfActive():Boolean public function set pdfActive(value:Boolean):voidpdfAvailable | property |
pdfAvailable: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 |
Indicates that a PDF may be available to communicate with.
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 pdfAvailable():Boolean public function set pdfAvailable(value:Boolean):voidpdfCommunicationActive | property |
pdfCommunicationActive: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 |
Indicates that the form guide has successfully communicated with the PDF rendition of the form.
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 pdfCommunicationActive():Boolean public function set pdfCommunicationActive(value:Boolean):voidpdfLoadErrorMessage | property |
pdfLoadErrorMessage: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 |
Holds the error message string that is displayed when the Guide times out trying to communicate with the PDF.
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 pdfLoadErrorMessage():String public function set pdfLoadErrorMessage(value:String):voidpdfProcessFocus | property |
pdfProcessFocus: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 |
Flag to be set by Custom Implementation based on this class to activate focus processing.
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 pdfProcessFocus():Boolean public function set pdfProcessFocus(value:Boolean):voidpdfRequiredFallbackUrl | property |
pdfRequiredFallbackUrl: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 |
Holds an optional Process URL to submit the Data to when "SubmitFromInteractivePDF" but the PDF can not be loaded. A Post to the Server URL is done and the Guide is replaced with the returned content.
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 pdfRequiredFallbackUrl():String public function set pdfRequiredFallbackUrl(value:String):voidperformanceLog | property |
performanceLog: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 |
Indicates that performance logging is active.
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 performanceLog():Boolean public function set performanceLog(value:Boolean):voidpreviewAsset | property |
previewAsset: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 |
Holds an optional Asset reference that will get mapped into the previewUrl.
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 previewAsset():String public function set previewAsset(value:String):voidpreviewAvailable | property |
previewAvailable: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 |
Indicates that a PDF (or other document type) may be available to render and display.
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 previewAvailable():Boolean public function set previewAvailable(value:Boolean):voidpreviewUrl | property |
previewUrl: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 |
Holds the Url to get a PDF (or other document type) to render and display.
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 previewUrl():String public function set previewUrl(value:String):voidresizeToContent | property |
resizeToContent: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 |
When set to true, the Guide will resize itself to take only the space needed to display its content. When set to false the Guide will attempt to take 100% of its parent size.
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 resizeToContent():Boolean public function set resizeToContent(value:Boolean):voidshowControlSection | property |
showControlSection: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 |
Show or hide the control sections.
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 showControlSection():Boolean public function set showControlSection(value:Boolean):voidshowHeaderSection | property |
showHeaderSection: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 |
Show or hide the header section.
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 showHeaderSection():Boolean public function set showHeaderSection(value:Boolean):voidshowHelpCenter | property |
showHelpCenter: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 |
Show or hide the help center.
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 showHelpCenter():Boolean public function set showHelpCenter(value:Boolean):voidshowNavHelpSection | property |
showNavHelpSection: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 |
Show or hide the navigator help section.
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 showNavHelpSection():Boolean public function set showNavHelpSection(value:Boolean):voidshowNavigator | property |
showNavigator: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 |
Show or hide the navigator.
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 showNavigator():Boolean public function set showNavigator(value:Boolean):voidshowNextPrev | property |
showNextPrev: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 |
Show or hide the next/previous Buttons.
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 showNextPrev():Boolean public function set showNextPrev(value:Boolean):voidshowRepeaterControls | property |
showRepeaterControls: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 |
Show or hide the repeater controls add/copy/remove.
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 showRepeaterControls():Boolean public function set showRepeaterControls(value:Boolean):voidshowSubmitButton | property |
showSubmitButton: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 |
Show or hide the submit button.
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 showSubmitButton():Boolean public function set showSubmitButton(value:Boolean):voidshowTitleBar | property |
showTitleBar: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 |
Show or hide the title bar.
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 showTitleBar():Boolean public function set showTitleBar(value:Boolean):voidshowToolBar | property |
showToolBar: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 |
Show or hide the tool bar.
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 showToolBar():Boolean public function set showToolBar(value:Boolean):voidsubmitAll | property |
submitAll: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 |
When false, field data in an optional panel is cleared when the panel is made invisible.
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 submitAll():Boolean public function set submitAll(value:Boolean):voidConstructor Detail
Wrapper | () | Constructor |
public function Wrapper()| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 9 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Constructor.
Method Detail
activateDocumentViewCB | () | method |
public function activateDocumentViewCB(error:FormBridgeError, data:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Call back indicating document view has activated.
Parameters
error:FormBridgeError — Specifies the form bridge error.
| |
data:String — Specifies the data received from the document view.
|
autoLoadPdf | () | method |
public function autoLoadPdf(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Pre-loads the PDF rendition of the form within the PDFBox control area on the Guide layout. If no PDF was rendered with the Guide, this function does not perform an action. This function is called automatically if the Guide is set to SubmitFrom InteractivePdf or PrintForm.
Parameters
event:Event (default = null) |
CallHtml | () | method |
public function CallHtml(exFunc:String, param1:String, param2:String, param3:String, param4:String):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 |
Calls the html to passthrough message to the PDF or to specified function in the HTML.
Parameters
exFunc:String — Specifies the function to execute.
| |
param1:String — Specifies the first parameter.
| |
param2:String — Specifies the second parameter.
| |
param3:String — Specifies the third parameter.
| |
param4:String — Specifies the forth parameter.
|
String — String
|
connectionClosed | () | method |
public function connectionClosed():void| 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 connection was closed.
connectionOpened | () | method |
public function connectionOpened(success:Boolean):void| 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 connection was made, if success=false, the connection attempt failed
Parameters
success:Boolean — the status of the open request
|
defaultCallback | () | method |
public function defaultCallback(msgId:int, request:String, error:FormBridgeError, parms:Array):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Default error message handler for communication with the PDF.
Parameters
msgId:int — Specifies the message identifier.
| |
request:String — Specifies the message request.
| |
error:FormBridgeError — Specifies the form bridge error.
| |
parms:Array — Specifies the message parameters.
|
emailPDF | () | method |
public function emailPDF(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Forwards the request to email the PDF rendition of the Guide. If no PDF was rendered with the Guide, this function does not perform an action.
Parameters
event:Event (default = null) |
getActiveData | () | method |
public function getActiveData(callback:Function = null):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 |
Return the form's Active data, either from the Guide or the PDF. PDF requires a callback.
Parameters
callback:Function (default = null) |
String — String
|
getData | () | method |
getDraftData | () | method |
public function getDraftData(callback:Function = null):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 |
Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active. PDF requires a callback).
Parameters
callback:Function (default = null) |
String — String
|
getFieldValue | () | method |
public function getFieldValue(som:String):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Returns a field's value as an Object
Parameters
som:String — the identifier of the field to retrieve the data from. eg. "EntityRoot.Client[1].Address.City" or for xfa - #som("form1.subform[1].Address.City")
|
Object — Object
|
getPdfData | () | method |
public function getPdfData(callback:Function = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Gets the ga/xml data from the PDF.
Parameters
callback:Function (default = null) |
getPdfFieldData | () | method |
public function getPdfFieldData(som:String, callback:Function = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Gets a fields data from the PDF.
Parameters
som:String — Specifies expression for the field data to be retrieved.
| |
callback:Function (default = null) |
getProperty | () | method |
public function getProperty(property:String):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Return the requested property. Sypported properties are: showSubmitButton = "true"|"false"
Parameters
property:String — the name of the property to retieve a value from
|
Object — Object
|
gotData | () | method |
public function gotData(error:FormBridgeError, data:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Answer received from the PDF providing requested data.
Parameters
error:FormBridgeError — Specifies the error received from FormBridge.
| |
data:String — Specifies the data received from the PDF file.
|
gotFocus | () | method |
public function gotFocus(error:FormBridgeError, somExpression:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Called when a field in the interactive PDF get focus.
Parameters
error:FormBridgeError — Specifies the form bridge error.
| |
somExpression:String — Specifies somExpression of the field with focus on the PDF.
|
guideCreationComplete | () | method |
public function guideCreationComplete(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Event handler called when the guide has been created.
Parameters
event:Event (default = null) |
guideValidationFailure | () | method |
public function guideValidationFailure(event:GAEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Called when validation of field data for a panel fails.
Parameters
event:GAEvent — Specifies the guideValidationFailure event.
|
hideDoc | () | method |
public function hideDoc(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Hides the Document of Record rendition and displays the Guide content. If no Document of Record was rendered with the Guide, this function does not perform an action.
Parameters
event:Event (default = null) |
hidePDF | () | method |
public function hidePDF(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Hides the PDF rendition and displays the Guide content. Any data the user entered into the fields on the PDF rendition automatically appear in the corresponding Guide fields. If no PDF was rendered with the Guide, this function does not perform an action.
Parameters
event:Event (default = null) |
init | () | method |
isFiberGuide | () | method |
isGuideInitialized | () | method |
isXfaGuide | () | method |
pageValidationFailure | () | method |
public function pageValidationFailure(event:GAEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Called when validation of page fails.
Parameters
event:GAEvent — Specifies a pageValidationFailure event.
|
panelItemFocusIn | () | method |
public function panelItemFocusIn(panelItem:PanelItem):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
This method is called whenever a panelItem in the Guide loses focus.
Parameters
panelItem:PanelItem — Specifies the panelItem that has received focus.
|
pdfActiveInit | () | method |
public function pdfActiveInit():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
This method is called when the PDF is initialized.
printPDF | () | method |
public function printPDF(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Forwards the request to print the PDF rendition of the Guide. If no PDF was rendered with the Guide, this function does not perform an action.
Parameters
event:Event (default = null) |
ProcessExtMessage | () | method |
public function ProcessExtMessage(msgparams:Array):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Handles incoming messages from the PDF via the HTML.
Parameters
msgparams:Array — Specifies the parameters coming from the PDF.
|
resetModel | () | method |
public function resetModel():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Reset the Model back to its initial load state.
resolvePreviewUrl | () | method |
public function resolvePreviewUrl(url:String, asset:String):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 |
Resolves the preview URL.
Parameters
url:String — Specifies the URL to be resolved.
| |
asset:String — Specifies the asset to be used for preview.
|
String — String
|
saveAsPDF | () | method |
public function saveAsPDF(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Forwards the request to save the PDF rendition of the Guide. If no PDF was rendered with the Guide, this function does not perform an action.
Parameters
event:Event (default = null) |
serverValidationFailure | () | method |
public function serverValidationFailure(validationResult:Array):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Called when server validation fails.
Parameters
validationResult:Array — Specifies an array of validation errors.
|
setActiveData | () | method |
public function setActiveData(data:String, callback:Function = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Sets the data in the active view.
If a callback function is provided, this method sets the data in the active view whether it's the Guide or the PDF. If no callback function is provided, this function immediately sets the data in the Guide. The callback function requires two string parameters, error:String and data:String. If error is not null, then the method failed. The data parameter is always null.
Parameters
data:String — Specifies the active data to be set.
| |
callback:Function (default = null) |
setData | () | method |
public function setData(data:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Set the data into the form - returns false if failed. Throws an exception if the data is not valid XML.
Parameters
data:String — the content to be used as the current data
|
setFieldValue | () | method |
public function setFieldValue(som:String, value:Object):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 |
Sets a field's value, returns success true or false
Parameters
som:String — the identifier of the field to retrieve the data from. eg. "EntityRoot.Client[1].Address.City" or for xfa - #som("form1.subform[1].Address.City")
| |
value:Object — the value to assign to the targeted item
|
Boolean — Boolean
|
setPdfData | () | method |
public function setPdfData(data:String, callback:Function = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Sets the ga/xml data into the PDF.
Parameters
data:String — Specifies the XML string containing the data for the PDF.
| |
callback:Function (default = null) |
setPdfFieldData | () | method |
public function setPdfFieldData(som:String, type:String, value:String, callback:Function = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Sets a fields data into the PDF
Parameters
som:String — Specifies the expression for the field data to be set.
| |
type:String — Specifies the type of data.
| |
value:String — Specifies the value of data.
| |
callback:Function (default = null) |
setProperty | () | method |
public function setProperty(property:String, value:Object):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 |
Set the property, returns false if the operation failed
Parameters
property:String — the name of the property to retieve a value from
| |
value:Object — the value to set the provided property with. Object types must match
|
Boolean — Boolean
|
showDoc | () | method |
public function showDoc(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Displays the Document of Record rendition of the form within the PDFBox control area on the Guide layout. If no DOR was rendered with the Guide, this function does not perform an action.
Parameters
event:Event (default = null) |
showPDF | () | method |
public function showPDF(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Displays the PDF rendition of the form within the PDFBox control area on the Guide layout. If no PDF was rendered with the Guide, this function does not perform an action.
Parameters
event:Event (default = null) |
submitData | () | method |
public function submitData():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 |
Performs the submit action based on the value of the Submit From option in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0. This method returns true if the submission performs successfully.
| SubmitFrom option | Behavior |
|---|---|
| Guide | Submits the Guide data to the Document Server. |
| Displays the PDF rendition of the Guide. A user then clicks the appropriate submit button on the PDF form. | |
| Printed Form | Displays the PDF rendition of the Guide. A user then prints the PDF and submits the form manually. |
| Hosted Application | The submit button does not display on the last panel of the Guide. This option transfer control of the Guide submission to the hosting application. In this case, a user clicks a button within the hosting application, for example the Complete button within Adobe Digital Enterprise Platform Document Services - Workspace 10.0, to submit the Guide data. |
Boolean — Boolean
|
submitDataWithCB | () | method |
public function submitDataWithCB(callback:Function):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 |
Submits the data to the server - return true if the submit was performed - returns false if validations fail
Parameters
callback:Function — the function to be called when the submit is an asynchronous operation (default)
|
Boolean — Boolean
|
submitFromPDF | () | method |
public function submitFromPDF():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
This function displays the PDF rendition within the PDFBox control on the Guide layout. A user must click the appropriate submit button to complete the data submission.
If no PDF was rendered with the Guide, this function sends the data to the Document Server which renders the form as a PDF, and returns it to the user to complete the submission.
toggleView2 | () | method |
public function toggleView2(type:String, callback:Function = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Guides 10 |
| Runtime Versions: | AIR 1.0, Flash Player 10.2 |
Transfers data to or from and displays or hides the PDF or document
Parameters
type:String (default = NaN) | |
callback:Function (default = null) |
Mon Apr 10 2017, 12:28 PM -07:00