| Package | lc.foundation.ui |
| Interface | public interface ILoginPage extends IUIComponent , IFlexDisplayObject , IBitmapDrawable , IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
ILoginPage interface is implemented for configuring and retrieving user login
information.
All login pages must implement the ILoginPage interface. Implement a login page
to allow a user to log in to Workspace.
For information about using this component to customize Workspace, see Customizing the Adobe Digital Enterprise Platform Document Services - Workspace User Interface .
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited 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 | |
| errorMessage : Message
The error message to be displayed. | ILoginPage | ||
| 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 | |
| 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 | |
| password : String
The password to use to log in to Workspace. | ILoginPage | ||
| 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 | |
| relogin : Boolean
A flag that specifies whether this login attempt is the first one. | ILoginPage | ||
| 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 | |
| serverUrl : String
The URL for to connect to Workspace. | ILoginPage | ||
| stage : Stage [read-only]
The Stage of the display object. | IFlexDisplayObject | |
| systemManager : ISystemManager
A reference to the SystemManager object for this component. | IUIComponent | |
| 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 | |
| userid : String
The user identifier. | ILoginPage | ||
| 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
Property Detail
errorMessage | property |
errorMessage:Message| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The error message to be displayed.
Implementation
public function get errorMessage():Message public function set errorMessage(value:Message):voidpassword | property |
password:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The password to use to log in to Workspace.
Implementation
public function get password():String public function set password(value:String):voidrelogin | property |
relogin:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A flag that specifies whether this login attempt is the first one.
For a subsequent login attempt, disable all fields except for the password field.
A value of false specifies that it is the first login attempt.
Implementation
public function get relogin():Boolean public function set relogin(value:Boolean):voidserverUrl | property |
serverUrl:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The URL for to connect to Workspace.
Implementation
public function get serverUrl():String public function set serverUrl(value:String):voiduserid | property |
userid:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user identifier.
Implementation
public function get userid():String public function set userid(value:String):voidMon Apr 10 2017, 12:28 PM -07:00