Package | com.adobe.guides.spark.wrappers.components |
Class | public class StandardWrapperHost |
Inheritance | StandardWrapperHost WrapperHostBase SkinnableContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher 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 |
Default MXML PropertymxmlContentFactory
Method | Defined By | ||
---|---|---|---|
Call back indicating document view has activated. | WrapperHostBase | ||
Adds a visual element to this container. | SkinnableContainer | ||
Adds a visual element to this container. | SkinnableContainer | ||
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. | WrapperHostBase | ||
Calls the html to passthrough message to the PDF or to specified function in the HTML. | WrapperHostBase | ||
Queues a function to be called later. | UIComponent | ||
Cleans up by releasing event listeners and zero out local variables. | WrapperHostBase | ||
Deletes a style property from this component instance. | UIComponent | ||
Called whenever a Repeater Panel adds/removes an instance. | WrapperHostBase | ||
The connection was closed. | WrapperHostBase | ||
The connection was made, if success=false, the connection attempt failed
| WrapperHostBase | ||
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | ||
Converts a Point object from content coordinates to global coordinates. | UIComponent | ||
Converts a Point object from content to local coordinates. | UIComponent | ||
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 | ||
Create the content for this component. | SkinnableContainer | ||
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
Default error message handler for communication with the PDF. | WrapperHostBase | ||
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. | WrapperHostBase | ||
Ends all currently playing effects on the component. | UIComponent | ||
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | ||
This method is called whenever a field in the PDF is changed
| WrapperHostBase | ||
This method is called whenever a field in the Guide gets the focus. | WrapperHostBase | ||
This method is called whenever a field in the Guide loses the focus. | WrapperHostBase | ||
Called after printing is complete. | UIComponent | ||
Return the form's Active data, either from the Guide or the PDF. | WrapperHostBase | ||
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 | ||
Returns the child display object that exists with the specified name. | DisplayObjectContainer | ||
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
| WrapperHostBase | ||
Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active. | WrapperHostBase | ||
Returns the visual element at the specified index. | SkinnableContainer | ||
Returns the index position of a visual element. | SkinnableContainer | ||
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
| WrapperHostBase | ||
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. | WrapperHostBase | ||
Gets a fields data from the PDF. | WrapperHostBase | ||
Returns the element's preferred height. | UIComponent | ||
Returns the element's preferred width. | UIComponent | ||
Return the requested property. | WrapperHostBase | ||
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 | ||
Return the model's root value object. | WrapperHostBase | ||
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | ||
Converts a Point object from global to content coordinates. | UIComponent | ||
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. | WrapperHostBase | ||
Called when a field in the interactive PDF get focus. | WrapperHostBase | ||
[override]
Event handler called when the guide has been created. | StandardWrapperHost | ||
Called when validation of field data for a panel fails. | WrapperHostBase | ||
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. | WrapperHostBase | ||
Hides the PDF rendition and displays the Guide content. | WrapperHostBase | ||
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. | WrapperHostBase | ||
Initializes the internal structure of this component. | UIComponent | ||
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | ||
Initializes the guide and prepares it for viewing. | WrapperHostBase | ||
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 | ||
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | ||
True if this guide is based off of a Fiber Model. | WrapperHostBase | ||
Return whether or not the guide is initialized. | WrapperHostBase | ||
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. | WrapperHostBase | ||
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 | ||
Converts a Point object from local to content coordinates. | UIComponent | ||
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. | WrapperHostBase | ||
This function is called when the panel item gains focus. | WrapperHostBase | ||
This method is called when the panel item looses focus. | WrapperHostBase | ||
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. | WrapperHostBase | ||
Prepares an IFlexDisplayObject for printing. | UIComponent | ||
Forwards the request to print the PDF rendition of the Guide. | WrapperHostBase | ||
Handles incoming messages from the PDF via the HTML. | WrapperHostBase | ||
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 visual elements from the container. | SkinnableContainer | ||
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. | SkinnableContainer | ||
Removes a visual element from the specified index position
in the container. | SkinnableContainer | ||
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. | WrapperHostBase | ||
Resolves a child by using the id provided. | UIComponent | ||
Resolves the preview URL. | WrapperHostBase | ||
[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. | WrapperHostBase | ||
Called when server validation fails. | WrapperHostBase | ||
Sets the data in the active view. | WrapperHostBase | ||
Sizes the object. | UIComponent | ||
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. | WrapperHostBase | ||
Changes the position of an existing visual element in the visual container. | SkinnableContainer | ||
Sets a field's value, returns success true or false
| WrapperHostBase | ||
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. | WrapperHostBase | ||
Sets a fields data into the PDF
| WrapperHostBase | ||
Set the property, returns false if the operation failed
| WrapperHostBase | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Sets the model's root value object. | WrapperHostBase | ||
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. | WrapperHostBase | ||
Return true if the panel request that the Guide is to show only panel content. | WrapperHostBase | ||
Displays the PDF rendition of the form within the PDFBox control area on the Guide layout. | WrapperHostBase | ||
Shows the PDF. | WrapperHostBase | ||
Lets the user drag the specified sprite. | Sprite | ||
Start rendering the pages of the guide. | WrapperHostBase | ||
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. | WrapperHostBase | ||
Submits the data to the server - return true if the submit was performed
- returns false if validations fail
| WrapperHostBase | ||
This function displays the PDF rendition within the PDFBox control on the Guide layout. | WrapperHostBase | ||
[static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | ||
Swaps the index of the two specified visual elements. | SkinnableContainer | ||
Swaps the visual elements at the two specified index
positions in the container. | SkinnableContainer | ||
Transfers data to or from and displays or hides the PDF or document
| WrapperHostBase | ||
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 |
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 | ||
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | ||
Create the skin for the component. | SkinnableComponent | ||
Determines if the call to the measure() method can be skipped. | UIComponent | ||
Performs any final processing after child objects are created. | UIComponent | ||
Clear out references to skin parts. | SkinnableComponent | ||
Processes the properties set on the component. | UIComponent | ||
[override]
Create content children, if the creationPolicy property
is not equal to none. | SkinnableContainer | ||
Create an instance of a dynamic skin part. | SkinnableComponent | ||
Creates a new object using a context
based on the embedded font being used. | UIComponent | ||
Creates the object using a given moduleFactory. | UIComponent | ||
Destroys and removes the skin for this component. | SkinnableComponent | ||
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | ||
Find the skin parts in the skin class and assign them to the properties of the component. | SkinnableComponent | ||
The event handler called when a UIComponent object gets focus. | UIComponent | ||
The event handler called when a UIComponent object loses focus. | UIComponent | ||
[override]
Returns the name of the state to be applied to the skin. | SkinnableContainerBase | ||
Returns a specific instance of a dynamic part. | SkinnableComponent | ||
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 | ||
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | ||
Returns the number of instances of a dynamic part. | SkinnableComponent | ||
[override]
Overridden to set the wrapper host on any guide skin part added. | StandardWrapperHost | ||
[override]
Called when an instance of a skin part is being removed. | SkinnableContainer | ||
Remove an instance of a dynamic part. | SkinnableComponent | ||
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 | ||
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 | ||
Draws the object and/or sizes and positions its children. | UIComponent |
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.
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
Skin Part | Description | Defined By | ||
---|---|---|---|---|
addPanelButton:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, The add panel button skin part. | StandardWrapperHost | ||
Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 An optional skin part that defines the Group where the content children get pushed into and laid out. | SkinnableContainer | |||
copyPanelButton:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, The copy panel button skin part. | StandardWrapperHost | ||
footer:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, footer skin part. | StandardWrapperHost | ||
header:IHeaderComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, header skin part. | StandardWrapperHost | ||
helpCenter:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, help center skin part. | StandardWrapperHost | ||
navigator:INavigatorComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, The guide navigator skin part. | StandardWrapperHost | ||
nextPanelButton:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, The next panel button skin part. | StandardWrapperHost | ||
panelLabel:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, panel label skin part. | StandardWrapperHost | ||
pdfBoxPosition:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, pdf skin part. | StandardWrapperHost | ||
previousPanelButton:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, The previous panel button skin part. | StandardWrapperHost | ||
progressBar:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, progress bar skin part. | StandardWrapperHost | ||
removeButton:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, remove button skin part. | StandardWrapperHost | ||
submitPanelButton:UIComponent | Required: false Part Type: Static Language Version: ActionScript 3.0 Product Version: AESGuides 10 Runtime Versions: Flash10.2, The submit panel button skin part. | StandardWrapperHost | ||
toolbar:UIComponent | Required: false Part Type: Static Language Version: ActionScript Product Version: Runtime Versions: , toolbar skin part. | StandardWrapperHost |
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
guideCreationComplete | () | method |
override 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 ) — Specifies the completion event.
|
partAdded | () | method |
override protected function partAdded(partName:String, instance:Object):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 |
Overridden to set the wrapper host on any guide skin part added.
Parameters
partName:String — name of the added part
| |
instance:Object — the instance of the part being added
|
Thu Dec 6 2018, 01:12 PM -08:00