Packagecom.hippohx
Classpublic class Window
InheritanceWindow Inheritance HaxeBackendListener Inheritance flash.events.EventDispatcher

The Window class allows you to interact with the window that contains your application (size and position, minimize, maxime, etc.).


Protected Properties
 PropertyDefined by
 InheritedHAXE_BACKEND : String = ""
HAXE_BACKEND defines the ID that a Neko backend needs to use to call methods on this class (or the class extending this one).
HaxeBackendListener
Public Methods
 MethodDefined by
  
Window()
Do NOT call this constructor, please use getInstance method instead.
Window
 Inherited
getHaxeBackendId():String
Returns HAXE_BACKEND API identifier.
HaxeBackendListener
  
getHeight():int
Returns window's height.
Window
  
getInstance():Window
[static] Use this method to retrieve an instance of the class, do NOT call the constructor directly.
Window
  
getLeft():int
Returns window's left position.
Window
  
getTop():int
Returns window's top position.
Window
  
getWidth():int
Returns window's width.
Window
  
maximize():void
Maximizes the window.
Window
  
minimize():void
Minimizes the window.
Window
  
setPosition(left:int, top:int):void
Sets window's position from the top-left corner.
Window
  
setSize(width:uint, height:uint):void
Set the size of the window.
Window
  
setWindowTitle(title:String):void
Sets window's title.
Window
Events
 EventSummaryDefined by
  
onFilesDropped
Subscribe to this event if you want to get notified when a user drags and drops files to your application.Window
  
onRightClick
Subscribe to this event if you want to get notified when a user right clicks on you application.Window
Public Constants
 ConstantDefined by
  ONFILESDROPPED : String = "onFilesDropped"
[static] This constant defines the type of the com.hippohx.events.evOnFilesDropped object, use it subscribe to that event.
Window
  ONRIGHTCLICK : String = "onRightClick"
[static] This constant defines the type of the com.hippohx.events.evOnRightClick object, use it subscribe to that event.
Window
Constructor detail
Window()constructor
public function Window()

Do NOT call this constructor, please use getInstance method instead.

See also

getInstance()
Method detail
getHeight()method
public function getHeight():int

Returns window's height.

Returns
int
getInstance()method 
public static function getInstance():Window

Use this method to retrieve an instance of the class, do NOT call the constructor directly. Note that you don't need to store the instance to access its methods, you can simply do this:

Window.getInstance().minimize();

Returns
Window
getLeft()method 
public function getLeft():int

Returns window's left position.

Returns
int
getTop()method 
public function getTop():int

Returns window's top position.

Returns
int
getWidth()method 
public function getWidth():int

Returns window's width.

Returns
int
maximize()method 
public function maximize():void

Maximizes the window.

minimize()method 
public function minimize():void

Minimizes the window.

setPosition()method 
public function setPosition(left:int, top:int):void

Sets window's position from the top-left corner.

Parameters
left:int
 
top:int
setSize()method 
public function setSize(width:uint, height:uint):void

Set the size of the window.

Parameters
width:uint — New window width.
 
height:uint — New window height.
setWindowTitle()method 
public function setWindowTitle(title:String):void

Sets window's title.

Parameters
title:String
Event detail
onFilesDroppedevent 
Event object type: com.hippohx.events.evOnFilesDropped
evOnFilesDropped.type property = com.hippohx.Window.ONFILESDROPPED

Subscribe to this event if you want to get notified when a user drags and drops files to your application.

This constant defines the type of the com.hippohx.events.evOnFilesDropped object, use it subscribe to that event.

onRightClickevent  
Event object type: com.hippohx.events.evOnRightClick
evOnRightClick.type property = com.hippohx.Window.ONRIGHTCLICK

Subscribe to this event if you want to get notified when a user right clicks on you application.

This constant defines the type of the com.hippohx.events.evOnRightClick object, use it subscribe to that event.

Constant detail
ONFILESDROPPEDconstant
public static const ONFILESDROPPED:String = "onFilesDropped"

This constant defines the type of the com.hippohx.events.evOnFilesDropped object, use it subscribe to that event.

See also

com.hippohx.events.evOnFilesDropped
ONRIGHTCLICKconstant 
public static const ONRIGHTCLICK:String = "onRightClick"

This constant defines the type of the com.hippohx.events.evOnRightClick object, use it subscribe to that event.

See also

com.hippohx.events.evOnRightClick



HippoHX