Packagecom.ucompass.ucompos.sdk.proxycomponents
Classpublic class UcompOSWindowProxy
InheritanceUcompOSWindowProxy Inheritance AbstractProxyComponent Inheritance SDKEventDispatcher Inheritance flash.events.EventDispatcher

The UcompOSWindowProxy is a class that enables virtual representations of UcompOSWindow instances on the UcompOS Main Container to exist on an application or WindowApplication and to be manipulated and managed remotely.



Public Properties
 PropertyDefined By
  alpha : Number
[write-only] Set alpha property.
UcompOSWindowProxy
 Inheriteddata : Object
Gets/sets the data property on the Proxy Component instance.
AbstractProxyComponent
 Inheriteddestination : String
[read-only] Get the endpoint (connectionId) of the Proxy Component instance.
AbstractProxyComponent
  editing : Boolean
[write-only] Indicate that the window has content that is being edited and before it is allowed to be closed, the user should be requested to confirm that they don't want to save the changes.
UcompOSWindowProxy
  height : uint
[write-only] Width.
UcompOSWindowProxy
  horizontalScrollPolicy : Boolean
[write-only]
UcompOSWindowProxy
  maxHeight : uint
[write-only] Maximum height.
UcompOSWindowProxy
  maxWidth : uint
[write-only] Maximum width.
UcompOSWindowProxy
  minHeight : uint
[write-only] Minimum height.
UcompOSWindowProxy
  minWidth : uint
[write-only] Minimum width.
UcompOSWindowProxy
 Inheritedorigin : String
AbstractProxyComponent
  resizable : Boolean
[write-only] Allow resize.
UcompOSWindowProxy
 Inheritedself : Boolean
Get/Set this as a self-reference.
AbstractProxyComponent
 Inheriteduuid : String
[read-only] Retrieve the unique ID that has been assigned to this ProxyComponent instance.
AbstractProxyComponent
  verticalScrollPolicy : Boolean
[write-only]
UcompOSWindowProxy
  visible : Boolean
[write-only] Make visible/invisible.
UcompOSWindowProxy
  width : uint
[write-only] Width.
UcompOSWindowProxy
  x : uint
[write-only] x.
UcompOSWindowProxy
  y : uint
[write-only] y.
UcompOSWindowProxy
Protected Properties
 PropertyDefined By
 Inherited_data : Object
AbstractProxyComponent
 Inherited_destination : String
AbstractProxyComponent
 Inherited_listeners : Array
SDKEventDispatcher
 Inherited_origin : String
AbstractProxyComponent
 Inherited_sdkClient : SDKClient
AbstractProxyComponent
 Inherited_sdkModel : SDKModel
AbstractProxyComponent
 Inherited_self : Boolean
AbstractProxyComponent
 Inherited_uuid : String
AbstractProxyComponent
Public Methods
 MethodDefined By
  
By convention, each AbstractProxyComponent instance should explicitly set a destination.
UcompOSWindowProxy
  
add(source:String, title:String = Untitled Window, width:uint = 400, height:uint = 300, x:uint = 0, y:uint = 0, suppressParameters:Boolean = false, sandbox:Boolean = true, preloaderTitle:String = null, format:String = null, preloaderName:String = null):void
The add method creates a new MDI window on the UcompOS Main Container.
UcompOSWindowProxy
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override]
SDKEventDispatcher
 Inherited
awake(data:Object = null):void
Utility method used to check if a player is responsive.
AbstractProxyComponent
 Inherited
call(method:String, data:Object):String
Any method provided by an IProxyComponent class that participates in SDK communication must call the call method which invokes the SDKClient infrastructure for SDK communication.
AbstractProxyComponent
  
close():void
Closes a window on the UcompOS Main Container that was created with add().
UcompOSWindowProxy
  
contentLoaded(connectionId:String = null):void
Causes the dispatchment of a CONTENT_LOADED Event - should be used once content or application has fully loaded into window and is ready for interaction.
UcompOSWindowProxy
  
Retrieves size and position info about an MDI window instance.
UcompOSWindowProxy
  
maximize():void
Maximize an MDI window.
UcompOSWindowProxy
  
minimize():void
Minimize an MDI window.
UcompOSWindowProxy
  
move(x:uint, y:uint):void
Position the window at a given x,y coordinate.
UcompOSWindowProxy
  
restore():void
Restore the window following a minimize/maximize operation.
UcompOSWindowProxy
  
setFocus():void
Sets the focus on the UcompOS Main Container to this window instance.
UcompOSWindowProxy
  
setMenuBar(model:XML):void
Establishes a menu bar to be displayed on the UcompOS Main Container Menu Bar when the MDI window instance receives focus.
UcompOSWindowProxy
  
setSize(width:uint, height:uint):void
Sets the size on a window.
UcompOSWindowProxy
  
setSource(source:String, suppressParameters:Boolean = false):void
Sets the URL for content that should be loaded into a window.
UcompOSWindowProxy
  
setStatusBar(text:String = null, showWorkingIndicator:Boolean = false):void
Set the status bar on the MDI window instance.
UcompOSWindowProxy
  
setTitle(title:String):void
Sets the title on the title bar of a window.
UcompOSWindowProxy
  
setWindowIcon(imageBytes:ByteArray, imageSource:String):void
Attaches an icon to the MDI window instance.
UcompOSWindowProxy
Protected Methods
 MethodDefined By
 Inherited
cleanup(event:SDKEvent = null):void
AbstractProxyComponent
Events
 Event Summary Defined By
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
  UcompOSWindowProxy
Public Constants
 ConstantDefined By
  CLOSE : String = close
[static] An event dispatched when the window instance has been closed.
UcompOSWindowProxy
  CONTENT_LOADED : String = contentLoaded
[static] Indicates the content/application loading into this window has fully loaded.
UcompOSWindowProxy
  FOCUS_END : String = focusEnd
[static] An event dispatched when the focus on the window instance has ended.
UcompOSWindowProxy
  FOCUS_START : String = focusStart
[static] An event dispatched when the focus on the window instance has started.
UcompOSWindowProxy
  MAXIMIZE : String = maximize
[static] An event dispatched when the window instance has been maximized.
UcompOSWindowProxy
  MINIMIZE : String = minimize
[static] An event dispatched when the window instance has been minimized.
UcompOSWindowProxy
  PROPERTY_CHANGE : String = propertyChange
[static] An event dispatched when a window property has changed.
UcompOSWindowProxy
  RESIZE_END : String = resizeEnd
[static] An event dispatched when the window instance has been resized.
UcompOSWindowProxy
  RESIZE_START : String = resizeStart
[static] An event dispatched when the window resize starts.
UcompOSWindowProxy
  RESTORE : String = restore
[static] An event dispatched when the window instance has been restored.
UcompOSWindowProxy
  SANDBOX : Boolean = true
[static] SWFLoader.loadForCompatability = true;
UcompOSWindowProxy
  SANDBOX_NONE : Boolean = false
[static] SWFLoader.trustContent = true;
UcompOSWindowProxy
  WINDOW_INFO : String = windowInfo
[static] An event that houses information about a window instance including size and positioning.
UcompOSWindowProxy
  WINDOW_READY : String = windowReady
[static] Indicates an UcompOSWindow instance on the UcompOS Main Container that was created by a call to MDI on the UcompOS Main Container has been successfully created and is ready for interaction.
UcompOSWindowProxy
Property Detail
alphaproperty
alpha:Number  [write-only]

Set alpha property.


Implementation
    public function set alpha(value:Number):void
editingproperty 
editing:Boolean  [write-only]

Indicate that the window has content that is being edited and before it is allowed to be closed, the user should be requested to confirm that they don't want to save the changes.


Implementation
    public function set editing(value:Boolean):void
heightproperty 
height:uint  [write-only]

Width.


Implementation
    public function set height(value:uint):void
horizontalScrollPolicyproperty 
horizontalScrollPolicy:Boolean  [write-only]


Implementation
    public function set horizontalScrollPolicy(value:Boolean):void
maxHeightproperty 
maxHeight:uint  [write-only]

Maximum height.


Implementation
    public function set maxHeight(value:uint):void
maxWidthproperty 
maxWidth:uint  [write-only]

Maximum width.


Implementation
    public function set maxWidth(value:uint):void
minHeightproperty 
minHeight:uint  [write-only]

Minimum height.


Implementation
    public function set minHeight(value:uint):void
minWidthproperty 
minWidth:uint  [write-only]

Minimum width.


Implementation
    public function set minWidth(value:uint):void
resizableproperty 
resizable:Boolean  [write-only]

Allow resize.


Implementation
    public function set resizable(value:Boolean):void
verticalScrollPolicyproperty 
verticalScrollPolicy:Boolean  [write-only]


Implementation
    public function set verticalScrollPolicy(value:Boolean):void
visibleproperty 
visible:Boolean  [write-only]

Make visible/invisible.


Implementation
    public function set visible(value:Boolean):void
widthproperty 
width:uint  [write-only]

Width.


Implementation
    public function set width(value:uint):void
xproperty 
x:uint  [write-only]

x.


Implementation
    public function set x(value:uint):void
yproperty 
y:uint  [write-only]

y.


Implementation
    public function set y(value:uint):void
Constructor Detail
UcompOSWindowProxy()Constructor
public function UcompOSWindowProxy()

By convention, each AbstractProxyComponent instance should explicitly set a destination. Set the destination to the UcompOS Main Container.

Method Detail
add()method
public function add(source:String, title:String = Untitled Window, width:uint = 400, height:uint = 300, x:uint = 0, y:uint = 0, suppressParameters:Boolean = false, sandbox:Boolean = true, preloaderTitle:String = null, format:String = null, preloaderName:String = null):void

The add method creates a new MDI window on the UcompOS Main Container.

Parameters

source:String — The URL to load into the window
 
title:String (default = Untitled Window) — The title on the window
 
width:uint (default = 400) — The width of the window
 
height:uint (default = 300) — The height of the window
 
x:uint (default = 0) — The x-coordinates of the window
 
y:uint (default = 0) — The y-coordinates of the window
 
suppressParameters:Boolean (default = false) — Indicates if SDK parameters should be appended to the source property of the window instance
 
sandbox:Boolean (default = true)
 
preloaderTitle:String (default = null)
 
format:String (default = null)
 
preloaderName:String (default = null)

close()method 
public function close():void

Closes a window on the UcompOS Main Container that was created with add().

contentLoaded()method 
public function contentLoaded(connectionId:String = null):void

Causes the dispatchment of a CONTENT_LOADED Event - should be used once content or application has fully loaded into window and is ready for interaction.

Parameters

connectionId:String (default = null)

getWindowInfo()method 
public function getWindowInfo():void

Retrieves size and position info about an MDI window instance.

maximize()method 
public function maximize():void

Maximize an MDI window.

minimize()method 
public function minimize():void

Minimize an MDI window.

move()method 
public function move(x:uint, y:uint):void

Position the window at a given x,y coordinate.

Parameters

x:uint — x-coordinate of the window
 
y:uint — y-coordinate of the widow

restore()method 
public function restore():void

Restore the window following a minimize/maximize operation.

setFocus()method 
public function setFocus():void

Sets the focus on the UcompOS Main Container to this window instance.

setMenuBar()method 
public function setMenuBar(model:XML):void

Establishes a menu bar to be displayed on the UcompOS Main Container Menu Bar when the MDI window instance receives focus.

Parameters

model:XML

setSize()method 
public function setSize(width:uint, height:uint):void

Sets the size on a window.

Parameters

width:uint — The width of the window
 
height:uint — The height of the window

setSource()method 
public function setSource(source:String, suppressParameters:Boolean = false):void

Sets the URL for content that should be loaded into a window. By convention, this should be content of type Window Application though this is not enforced and any content can be loaded though it will be passed a connectionId and a windowName parameter. Parameters can be suppressed by setting suppressParameters to true.

Parameters

source:String — The URL of the content to load to the window
 
suppressParameters:Boolean (default = false) — Indicates that the normal SDK Parameters should not be passed to the content via the URL query string

setStatusBar()method 
public function setStatusBar(text:String = null, showWorkingIndicator:Boolean = false):void

Set the status bar on the MDI window instance.

Parameters

text:String (default = null) — the textual message to display on the status bar
 
showWorkingIndicator:Boolean (default = false) — indicates whether the "whirling wheel" status indicator should be presented

setTitle()method 
public function setTitle(title:String):void

Sets the title on the title bar of a window.

Parameters

title:String — The title to use on the title bar of the window

setWindowIcon()method 
public function setWindowIcon(imageBytes:ByteArray, imageSource:String):void

Attaches an icon to the MDI window instance.

Parameters

imageBytes:ByteArray — the icon represented as a ByteArray
 
imageSource:String — the icon represented as the URL to a GIF, JPG, or PNG image

Event Detail
close Event
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

contentLoaded Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

focusEnd Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

focusStart Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

maximize Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

minimize Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

propertyChange Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

resizeEnd Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

resizeStart Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

restore Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

windowInfo Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

windowReady Event  
Event Object Type: com.ucompass.ucompos.sdk.proxycomponents.UcompOSWindowProxy

Constant Detail
CLOSEConstant
public static const CLOSE:String = close

An event dispatched when the window instance has been closed.

CONTENT_LOADEDConstant 
public static const CONTENT_LOADED:String = contentLoaded

Indicates the content/application loading into this window has fully loaded.

FOCUS_ENDConstant 
public static const FOCUS_END:String = focusEnd

An event dispatched when the focus on the window instance has ended.

FOCUS_STARTConstant 
public static const FOCUS_START:String = focusStart

An event dispatched when the focus on the window instance has started.

MAXIMIZEConstant 
public static const MAXIMIZE:String = maximize

An event dispatched when the window instance has been maximized.

MINIMIZEConstant 
public static const MINIMIZE:String = minimize

An event dispatched when the window instance has been minimized.

PROPERTY_CHANGEConstant 
public static const PROPERTY_CHANGE:String = propertyChange

An event dispatched when a window property has changed.

RESIZE_ENDConstant 
public static const RESIZE_END:String = resizeEnd

An event dispatched when the window instance has been resized.

RESIZE_STARTConstant 
public static const RESIZE_START:String = resizeStart

An event dispatched when the window resize starts.

RESTOREConstant 
public static const RESTORE:String = restore

An event dispatched when the window instance has been restored.

SANDBOXConstant 
public static const SANDBOX:Boolean = true

SWFLoader.loadForCompatability = true;

SANDBOX_NONEConstant 
public static const SANDBOX_NONE:Boolean = false

SWFLoader.trustContent = true;

WINDOW_INFOConstant 
public static const WINDOW_INFO:String = windowInfo

An event that houses information about a window instance including size and positioning.

WINDOW_READYConstant 
public static const WINDOW_READY:String = windowReady

Indicates an UcompOSWindow instance on the UcompOS Main Container that was created by a call to MDI on the UcompOS Main Container has been successfully created and is ready for interaction.