(Beta)
Package | lc.foundation.ui |
Interface | public interface IReconnect extends IUIComponent , IFlexDisplayObject , IBitmapDrawable , IEventDispatcher |
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 |
IReconnect
interface is implemented for permitting users to reconnect to
LiveCycle Workspace ES2
All login pages must implement the IReconnect
interface.
Related API Elements
Public Properties
Property | Defined By | ||
---|---|---|---|
accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | IFlexDisplayObject | ||
alpha : Number
Indicates the alpha transparency value of the object specified. | IFlexDisplayObject | ||
baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | IUIComponent | ||
blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | IFlexDisplayObject | ||
cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | IFlexDisplayObject | ||
document : Object
A reference to the document object associated with this component. | IUIComponent | ||
enabled : Boolean
Whether the component can accept user interaction. | IUIComponent | ||
explanation : String
A reason that describes why a reconnection is required. | IReconnect | ||
explicitHeight : Number
The explicitly specified height for the component,
in pixels, as the component's coordinates. | IUIComponent | ||
explicitMaxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
explicitMaxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
explicitMinHeight : Number [read-only]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
explicitMinWidth : Number [read-only]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
explicitWidth : Number
The explicitly specified width for the component,
in pixels, as the component's coordinates. | IUIComponent | ||
filters : Array
An indexed array that contains each filter object currently associated with the display object. | IFlexDisplayObject | ||
focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing the focus indicator. | IUIComponent | ||
height : Number
Indicates the height of the display object, in pixels. | IFlexDisplayObject | ||
includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | IUIComponent | ||
isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | IUIComponent | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | IFlexDisplayObject | ||
lostDate : Date
The date the connection was lost. | IReconnect | ||
mask : DisplayObject
The calling display object is masked by the specified mask object. | IFlexDisplayObject | ||
maxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
maxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
measuredHeight : Number [read-only]
The measured height of this object. | IFlexDisplayObject | ||
measuredMinHeight : Number
The default minimum height of the component, in pixels. | IUIComponent | ||
measuredMinWidth : Number
The default minimum width of the component, in pixels. | IUIComponent | ||
measuredWidth : Number [read-only]
The measured width of this object. | IFlexDisplayObject | ||
minHeight : Number [read-only]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
minWidth : Number [read-only]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject | ||
mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject | ||
name : String
Indicates the instance name of the DisplayObject. | IFlexDisplayObject | ||
opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | IFlexDisplayObject | ||
owner : DisplayObjectContainer
The owner of this IVisualElement object. | IUIComponent | ||
parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | IFlexDisplayObject | ||
percentHeight : Number
Number that specifies the height of a component as a
percentage of its parent's size. | IUIComponent | ||
percentWidth : Number
Number that specifies the width of a component as a
percentage of its parent's size. | IUIComponent | ||
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. | IFlexDisplayObject | ||
rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | IFlexDisplayObject | ||
scale9Grid : Rectangle
The current scaling grid that is in effect. | IFlexDisplayObject | ||
scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | IFlexDisplayObject | ||
scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | IFlexDisplayObject | ||
scrollRect : Rectangle
The scroll rectangle bounds of the display object. | IFlexDisplayObject | ||
session : SessionMap
Retrieves the session that is associated with the connection. | IReconnect | ||
stage : Stage [read-only]
The Stage of the display object. | IFlexDisplayObject | ||
systemManager : ISystemManager
A reference to the SystemManager object for this component. | IUIComponent | ||
title : String
A message that indicates that a reconnection to Workspace ES2 is required. | IReconnect | ||
transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | IFlexDisplayObject | ||
tweeningProperties : Array
Used by EffectManager. | IUIComponent | ||
visible : Boolean
Whether or not the display object is visible. | IFlexDisplayObject | ||
width : Number
Indicates the width of the display object, in pixels. | IFlexDisplayObject | ||
x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | IFlexDisplayObject | ||
y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | IFlexDisplayObject |
Public Methods
Method | Defined By | ||
---|---|---|---|
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. | IEventDispatcher | ||
Dispatches an event into the event flow. | IEventDispatcher | ||
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | IFlexDisplayObject | ||
A convenience method for determining whether to use the
explicit or measured height
| IUIComponent | ||
A convenience method for determining whether to use the
explicit or measured width
| IUIComponent | ||
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. | IFlexDisplayObject | ||
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | IFlexDisplayObject | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | ||
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | IFlexDisplayObject | ||
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | IFlexDisplayObject | ||
Initialize the object. | IUIComponent | ||
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | IFlexDisplayObject | ||
Moves this object to the specified x and y coordinates. | IFlexDisplayObject | ||
Returns true if the chain of owner properties
points from child to this UIComponent. | IUIComponent | ||
Called by Flex when a UIComponent object is added to or removed from a parent. | IUIComponent | ||
Indicates that the reconnection to Workspace ES2 failed. | IReconnect | ||
Removes a listener from the EventDispatcher object. | IEventDispatcher | ||
Sets the actual size of this object. | IFlexDisplayObject | ||
Called when the visible property changes. | IUIComponent | ||
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher |
Property Detail
explanation | property |
explanation: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 |
A reason that describes why a reconnection is required.
Implementation
public function get explanation():String
public function set explanation(value:String):void
lostDate | property |
lostDate:Date
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 date the connection was lost.
Implementation
public function get lostDate():Date
public function set lostDate(value:Date):void
session | property |
session:SessionMap
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 session that is associated with the connection. The SessionMap
object that is returned is initialized
after the user is authenticated.
Implementation
public function get session():SessionMap
public function set session(value:SessionMap):void
title | property |
title: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 |
A message that indicates that a reconnection to Workspace ES2 is required.
Implementation
public function get title():String
public function set title(value:String):void
Method Detail
reconnectFailed | () | method |
public function reconnectFailed():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 |
Indicates that the reconnection to Workspace ES2 failed.
Wed Nov 21 2018, 06:34 AM -08:00