Packagecom.adobe.csxs.types
Classpublic class StateInfo

Stores current state information for the window in which the extension runs. This information is updated each time the library receives an external event. The update does not occur when the request is made, but when the confirming event is received.



Public Properties
 PropertyDefined by
  appSkinInfo : AppSkinInfo
Retrieves the skin information of the hosting application.
StateInfo
  hasFocus : Boolean
Retrieves the focus status of the extension window.
StateInfo
  isAppOffline : Boolean
Retrieves the offline status of the hosting application.
StateInfo
  isLoaded : Boolean
Retrieves the loaded status of the extension window.
StateInfo
  isMinimized : Boolean
Retrieves the minimized status of the extension window.
StateInfo
  isVisible : Boolean
Retrieves the visibility status of the extension window.
StateInfo
  winGeom : WindowGeometry
Retrieves geometry information for the extension window.
StateInfo
Public Methods
 MethodDefined by
  
StateInfo(isVisible:Boolean = false, isMinimized:Boolean = false, isLoaded:Boolean = false, isAppOffline:Boolean = false, hasFocus:Boolean = false, winGeom:WindowGeometry = null, appSkinInfo:AppSkinInfo = null)
Creates a state information object.
StateInfo
  
toString():String
Creates a string that contains all the properties of this object.
StateInfo
Property detail
appSkinInfoproperty
appSkinInfo:AppSkinInfo  [read-write]

Retrieves the skin information of the hosting application.

This property can be used as the source for data binding.

Implementation
    public function get appSkinInfo():AppSkinInfo
    public function set appSkinInfo(value:AppSkinInfo):void

See also

hasFocusproperty 
hasFocus:Boolean  [read-write]

Retrieves the focus status of the extension window.

This property can be used as the source for data binding.

Implementation
    public function get hasFocus():Boolean
    public function set hasFocus(value:Boolean):void
isAppOfflineproperty 
isAppOffline:Boolean  [read-write]

Retrieves the offline status of the hosting application.

This property can be used as the source for data binding.

Implementation
    public function get isAppOffline():Boolean
    public function set isAppOffline(value:Boolean):void
isLoadedproperty 
isLoaded:Boolean  [read-write]

Retrieves the loaded status of the extension window.

This property can be used as the source for data binding.

Implementation
    public function get isLoaded():Boolean
    public function set isLoaded(value:Boolean):void
isMinimizedproperty 
isMinimized:Boolean  [read-write]

Retrieves the minimized status of the extension window.

This property can be used as the source for data binding.

Implementation
    public function get isMinimized():Boolean
    public function set isMinimized(value:Boolean):void
isVisibleproperty 
isVisible:Boolean  [read-write]

Retrieves the visibility status of the extension window.

This property can be used as the source for data binding.

Implementation
    public function get isVisible():Boolean
    public function set isVisible(value:Boolean):void
winGeomproperty 
winGeom:WindowGeometry  [read-write]

Retrieves geometry information for the extension window.

This property can be used as the source for data binding.

Implementation
    public function get winGeom():WindowGeometry
    public function set winGeom(value:WindowGeometry):void

See also

Constructor detail
StateInfo()constructor
public function StateInfo(isVisible:Boolean = false, isMinimized:Boolean = false, isLoaded:Boolean = false, isAppOffline:Boolean = false, hasFocus:Boolean = false, winGeom:WindowGeometry = null, appSkinInfo:AppSkinInfo = null)

Creates a state information object.

Parameters
isVisible:Boolean (default = false) — True if the extension window is shown, false if it is hidden.
 
isMinimized:Boolean (default = false) — True if the extension window is minimized/iconified.
 
isLoaded:Boolean (default = false) — True if the extension window is fully initialized.
 
isAppOffline:Boolean (default = false) — True if the hosting application is offline.
 
hasFocus:Boolean (default = false) — True if the extension window has the input focus.
 
winGeom:WindowGeometry (default = null) — A window geometry object containing the extension window's size and position.
 
appSkinInfo:AppSkinInfo (default = null) — An object containing the hosting application's default font and color values.
Method detail
toString()method
public function toString():String

Creates a string that contains all the properties of this object.

Returns
String — The properties string.