(Beta)
| Package | ga.controls |
| Class | public class Wrapper |
| Inheritance | Wrapper  Box Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IConnectionService |
| Subclasses | ButtonBar, CobaltBar, CobaltStandard, CobaltTree, LeftAccordion, LeftMultilevel, Workspace |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 | |
| 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 [read-only]
The current page which implements the IPanel interface. | Wrapper | ||
| currentSection : Section [read-only]
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 [read-only]
Indicates if a host SWF is communicating with the Guide through a local connection. | Wrapper | ||
| guideView : Boolean [read-only]
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 [read-only] Indicates the minimum height at which the Navigation part of the guide will still display. | Wrapper | ||
| includeNavigationMinWidth : int [read-only] 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 : Wrapper [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 [read-only] Indicates the delay, in milliseconds, of a background load of the interactive pdf should be. | Wrapper | ||
| interactivePdfLoad : String [read-only] Indicates when the load of the interactive pdf should happen. | 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 | |
| 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 | |
| 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 : WrapperModel [read-only]
Model. | 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 [read-only]
Indicates that the Guide has successfully communicated with the PDF rendition
of the form. | Wrapper | ||
| pdfCommunicationActive : Boolean [read-only]
Indicates that the form guide has successfully communicated with the PDF rendition
of the form. | Wrapper | ||
| pdfLoadErrorMessage : String [read-only]
Holds the error message string that is displayed when the Guide times out trying to communicate with the PDF. | Wrapper | ||
| pdfLoadThreshold : int [read-only]
Holds the number of seconds the Guide should attempt to communicate with the PDF before stopping. | Wrapper | ||
| pdfRequiredFallbackUrl : String [read-only]
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 | |
| 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 | |
| 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 | |
| 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 [read-only]
Indicates whether to show the naviagation control buttons. | Wrapper | ||
| showHeaderSection : Boolean [read-only]
Indicates whether to show the header section that contains the title and toolbar components. | Wrapper | ||
| showHelpCenter : Boolean [read-only]
Indicates whether to show the help center component. | Wrapper | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showNavHelpSection : Boolean [read-only]
Indicates whether to show the naviagator and help center content. | Wrapper | ||
| showNavigator : Boolean [read-only]
Indicates whether to show the naviagator component. | Wrapper | ||
| showNextPrev : Boolean [read-only]
Indicates whether to show the next and previous buttons. | Wrapper | ||
| showRepeaterControls : Boolean [read-only]
Indicates whether to show the repeater control buttons. | Wrapper | ||
| showSubmitButton : Boolean [read-only]
Indicates whether to show the submit button on the last panel. | Wrapper | ||
| showTitleBar : Boolean [read-only]
Indicates whether to show the title bar component. | Wrapper | ||
| showToolBar : Boolean [read-only]
Indicates whether to show the toolbar component. | 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 = true
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 | ||
| [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 | ||
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
Dispatches a change event when the Guide's local connection with the host SWF has been closed. | Wrapper | ||
Dispatches a change event when a host SWF file opens a local connection to a Guide. | 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 | |
|
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 | |
Request and display the specified document of record url. | Wrapper | ||
Request and display the specified document of record url. | Wrapper | ||
|
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 | |
Retrieves the XML data from the active view. | 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 | |
|
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 the data value of a field. | 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 | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
This method is called when the host SWF gets a property from the Guide through a local
connection. | 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 | |
|
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 | |
|
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 | |
| Wrapper | |||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
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 | |
This method is called to adjust the data for the Flex environment. | Wrapper | ||
This method is called to adjust the data for the PDF environment. | Wrapper | ||
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
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 | ||
|
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 | |
|
Resolves a child by using the id provided. | UIComponent | |
| [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 | ||
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 | |
|
Changes the position of an existing visual element in the visual container. | Container | |
Sets the data value of a field. | 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 | |
This method is called when the host SWF sets a property on the Guide through a
local connection. | 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 LiveCycle Workbench ES2. | Wrapper | ||
| 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 | |
|
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
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle. | UIComponent | |
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
| [override]
Used internally by the Dissolve Effect to add the overlay to the chrome of a container. | Container | |
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Processes the properties set on the component. | UIComponent | |
|
Creates the container's border skin
if it is needed and does not already exist. | Container | |
|
Create child objects of the component. | UIComponent | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Respond to size changes by setting the positions and sizes
of this container's borders. | Container | |
| [override]
Calculates the default sizes and minimum and maximum values of the Box
container. | Box | |
|
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
|
Positions the container's content area relative to the viewable area
based on the horizontalScrollPosition and verticalScrollPosition properties. | Container | |
Display an alert when validation of field data for a panel fails. | Wrapper | ||
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
| [override]
Sets the size and position of each child of the Box container. | Box | |
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
currentPage | property |
currentPage:Page [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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():PageRelated API Elements
currentSection | property |
currentSection:Section [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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():SectionguideConnectionActive | property |
guideConnectionActive:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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():BooleanguideView | property |
guideView:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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():BooleanincludeNavigationMinHeight | property |
includeNavigationMinHeight:int [read-only] 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():intincludeNavigationMinWidth | property |
includeNavigationMinWidth:int [read-only] 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():intinstance | property |
instance:Wrapper| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The singleton instance of the Guide layout.
Implementation
public static function get instance():Wrapper public static function set instance(value:Wrapper):voidinteractivePdfBackgroundLoadDelay | property |
interactivePdfBackgroundLoadDelay:int [read-only] 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():intinteractivePdfLoad | property |
model | property |
model:WrapperModel [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Model.
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():WrapperModelpanelManager | property |
panelManager:PanelManager [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The panel manager.
Implementation
public function get panelManager():PanelManagerpdfActive | property |
pdfActive:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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():BooleanpdfCommunicationActive | property |
pdfCommunicationActive:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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():BooleanpdfLoadErrorMessage | property |
pdfLoadErrorMessage:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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():StringpdfLoadThreshold | property |
pdfLoadThreshold:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Holds the number of seconds the Guide should attempt to communicate with the PDF before stopping.
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 pdfLoadThreshold():intpdfRequiredFallbackUrl | property |
pdfRequiredFallbackUrl:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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():StringshowControlSection | property |
showControlSection:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the naviagation control 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 showControlSection():BooleanshowHeaderSection | property |
showHeaderSection:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the header section that contains the title and toolbar components.
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():BooleanshowHelpCenter | property |
showHelpCenter:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the help center component.
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():BooleanshowNavHelpSection | property |
showNavHelpSection:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the naviagator and help center 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 showNavHelpSection():BooleanshowNavigator | property |
showNavigator:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the naviagator component.
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():BooleanshowNextPrev | property |
showNextPrev:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the next and 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():BooleanshowRepeaterControls | property |
showRepeaterControls:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the repeater control 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 showRepeaterControls():BooleanshowSubmitButton | property |
showSubmitButton:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the submit button on the last panel. This variable is set through 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 showSubmitButton():BooleanshowTitleBar | property |
showTitleBar:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the title bar component.
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():BooleanshowToolBar | property |
showToolBar:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Indicates whether to show the toolbar component.
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():BooleansubmitAll | property |
public var submitAll:Boolean = true| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
When false, field data in an optional panel is cleared when the panel is made invisible.
Constructor Detail
Wrapper | () | Constructor |
public function Wrapper()| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
Method Detail
autoLoadPdf | () | method |
public function autoLoadPdf(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 SP1 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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) |
connectionClosed | () | method |
public function connectionClosed():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Dispatches a change event when the Guide's local connection with the host SWF has been closed.
connectionOpened | () | method |
public function connectionOpened(success:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Dispatches a change event when a host SWF file opens a local connection to a Guide.
Parameters
success:Boolean |
displayDocumentOfRecord | () | method |
displayInteractivePdf | () | method |
public function displayInteractivePdf():voidRequest and display the specified document of record url.
emailPDF | () | method |
public function emailPDF(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves the XML data from the active view.
If a callback function is provided, the data is retrieved from the active view whether it's the Guide or the PDF. If no calback function is provided, this function immediately returns the data from the Guide. The callback function requires two string parameters, error:String and data:String. If error is not null, then the data parameter is undefined.
Parameters
callback:Function (default = null) |
String |
getFieldValue | () | method |
public function getFieldValue(som:String):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns the data value of a field.
Parameters
som:String |
Object |
getProperty | () | method |
public function getProperty(property:String):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
This method is called when the host SWF gets a property from the Guide through a local
connection. The following properties are supported: ShowSubmitButton" and
SubmitFrom.
Parameters
property:String |
Object |
hideDoc | () | method |
public function hideDoc(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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) |
isGuideInitialized | () | method |
normalizeInputData | () | method |
public function normalizeInputData(data:String):String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
This method is called to adjust the data for the Flex environment.
Parameters
data:String |
String |
normalizeOutputData | () | method |
public function normalizeOutputData(data:String):String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
This method is called to adjust the data for the PDF environment.
Parameters
data:String |
String |
pdfActiveInit | () | method |
public function pdfActiveInit():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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) |
saveAsPDF | () | method |
public function saveAsPDF(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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) |
serverValidationFailed | () | method |
protected function serverValidationFailed(validationResult:Array):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Display an alert when validation of field data for a panel fails.
Parameters
validationResult:Array |
setActiveData | () | method |
public function setActiveData(data:String, callback:Function = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 | |
callback:Function (default = null) |
setFieldValue | () | method |
public function setFieldValue(som:String, value:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Sets the data value of a field.
Parameters
som:String | |
value:Object |
Boolean |
setProperty | () | method |
public function setProperty(property:String, value:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
This method is called when the host SWF sets a property on the Guide through a
local connection. The following properties are supported: ShowSubmitButton
and SubmitFrom.
Parameters
property:String | |
value:Object |
Boolean |
showDoc | () | method |
public function showDoc(event:Event = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Performs the submit action based on the value of the Submit From option in the Guide Design perspective within LiveCycle Workbench ES2. This method returns true if the submission performs successfully.
| SubmitFrom option | Behavior |
|---|---|
| Guide | Submits the Guide data to the LiveCycle ES2 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 LiveCycle WorkSpace ES2, to submit the Guide data. |
Boolean |
submitDataWithCB | () | method |
submitFromPDF | () | method |
public function submitFromPDF():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 LiveCycle ES2 server which renders the form as a PDF, and returns it to the user to complete the submission.
Wed Nov 21 2018, 06:34 AM -08:00