Detailed Description

An instance of an open window.

Inheritance diagram for Windows.Window:

Public Member Functions
void	close ()
	Closes the window and its kids. More...

void	sendBackward ()
	Sends this window to the back. More...

void	sendToBack ()
	Sends this window to the back. More...

void	bringForward ()
	Moves this window forward one place. More...

void	bringToFront ()
	Brings this window to the front. More...

void	Visibility (bool visible, Window hidBy)
	Hides/ shows the window (without actually closing it). More...

void	trigger (string name)
	Triggers a 'window{name}' event in the root document. More...

void	trigger (string name, Dictionary< string, object > globals)
	Triggers a '{name}' event on the window itself, and optionally on the source element. More...

HtmlElement	GetAnchor (Dictionary< string, object > globals)
	The anchor element that triggered a window to open. Null if there wasn't one. More...

Window	GetVisibleWindow ()
	When a window hides another, it may result in a linked list of hidden windows. This essentially finds the front of the linked list. More...

UnityEngine.Color	GetColour (string name, Dictionary< string, object > globals, UnityEngine.Color defaultValue)
	Gets a global of the given name as a colour. More...

int	GetInteger (string name, Dictionary< string, object > globals, int defaultValue)
	Gets a global of the given name as an integer. More...

double	GetDecimal (string name, Dictionary< string, object > globals, double defaultValue)
	Gets a global of the given name as a decimal. More...

T	Get< T > (string name, Dictionary< string, object > globals)
	Gets a global of the given name. More...

void	SetHtml (string html)
	Writes the windows HTML now. Collects element and optionally an iframe. More...

virtual void	Load (string url, Dictionary< string, object > globals)
	Loads the contents of this window now. More...

Public Member Functions inherited from Windows.WindowGroup
	WindowGroup (Manager manager)
	Creates a window group. More...

	WindowGroup ()

Window	get (string type, string url)
	Gets a window of the given type and pointing at the given URL. More...

Window	cycle (string type, string url, Dictionary< string, object > globals)
	Closes an open window or opens it if it wasn't already. More...

Window	open (string typeName, string url, Dictionary< string, object > globals)
	Opens a window. More...

Public Member Functions inherited from Dom.EventTarget
void	ClearEvents ()
	Clears all events on this document. More...

bool	dispatchEvent (Event e)
	Runs an event of the given name. More...

void	addEventListener (string name, EventListener listener)
	Adds an event listener to this document. More...

void	addEventListener (string name, EventListener listener, bool useCapture)
	Adds an event listener to this document. More...

void	removeEventListener (string name, object evtHandlerInternal)
	Removes an event listener from this document. More...

void	addEventListener (string name, AnimationEventDelegate method)

void	addEventListener (string name, AudioProcessingEventDelegate method)

void	addEventListener (string name, BeforeInputEventDelegate method)

void	addEventListener (string name, BeforeUnloadEventDelegate method)

void	addEventListener (string name, BlobEventDelegate method)

void	addEventListener (string name, ClipboardEventDelegate method)

void	addEventListener (string name, CloseEventDelegate method)

void	addEventListener (string name, CompositionEventDelegate method)

void	addEventListener (string name, CustomEventDelegate method)

void	addEventListener (string name, CSSFontFaceLoadEventDelegate method)

void	addEventListener (string name, DeviceLightEventDelegate method)

void	addEventListener (string name, DeviceMotionEventDelegate method)

void	addEventListener (string name, DeviceOrientationEventDelegate method)

void	addEventListener (string name, DeviceProximityEventDelegate method)

void	addEventListener (string name, DomEventDelegate method)

void	addEventListener (string name, DOMTransactionEventDelegate method)

void	addEventListener (string name, DragEventDelegate method)

void	addEventListener (string name, EditingBeforeInputEventDelegate method)

void	addEventListener (string name, ErrorEventDelegate method)

void	addEventListener (string name, FetchEventDelegate method)

void	addEventListener (string name, FocusEventDelegate method)

void	addEventListener (string name, GamepadEventDelegate method)

void	addEventListener (string name, HashChangeEventDelegate method)

void	addEventListener (string name, IDBVersionChangeEventDelegate method)

void	addEventListener (string name, InputEventDelegate method)

void	addEventListener (string name, KeyboardEventDelegate method)

void	addEventListener (string name, MediaStreamEventDelegate method)

void	addEventListener (string name, MessageEventDelegate method)

void	addEventListener (string name, MouseEventDelegate method)

void	addEventListener (string name, MutationEventDelegate method)

void	addEventListener (string name, OfflineAudioCompletionEventDelegate method)

void	addEventListener (string name, PageTransitionEventDelegate method)

void	addEventListener (string name, PointerEventDelegate method)

void	addEventListener (string name, PopStateEventDelegate method)

void	addEventListener (string name, ProgressEventDelegate method)

void	addEventListener (string name, RelatedEventDelegate method)

void	addEventListener (string name, RTCDataChannelEventDelegate method)

void	addEventListener (string name, RTCIdentityErrorEventDelegate method)

void	addEventListener (string name, RTCIdentityEventDelegate method)

void	addEventListener (string name, RTCPeerConnectionIceEventDelegate method)

void	addEventListener (string name, SensorEventDelegate method)

void	addEventListener (string name, StorageEventDelegate method)

void	addEventListener (string name, TextEventDelegate method)

void	addEventListener (string name, TimeEventDelegate method)

void	addEventListener (string name, TouchEventDelegate method)

void	addEventListener (string name, TrackEventDelegate method)

void	addEventListener (string name, TransitionEventDelegate method)

void	addEventListener (string name, UIEventDelegate method)

void	addEventListener (string name, UserProximityEventDelegate method)

void	addEventListener (string name, WebGLContextEventDelegate method)

void	addEventListener (string name, WheelEventDelegate method)

void	addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener)

void	addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener, bool capture)

void	addEventListener (string name, ContextEventDelegate method)

void	addEventListener (string name, SlideEventDelegate method)

void	addEventListener (string name, PowerUI.SpriteEventDelegate method)

void	addEventListener (string name, SVGEventDelegate method)
	Adds an event listener to this document. More...

void	addEventListener (string name, SVGZoomEventDelegate method)

Static Public Member Functions
static void	Cue (PowerUI.MouseEvent me)
	Cues dialogue within a window. More...

static void	CloseThis (UIEvent e)
	Closes the window that the given event originated from. More...

Protected Member Functions
override bool	HandleLocalEvent (Dom.Event e, bool bubblePhase)
	Handles events on the window itself. More...

virtual void	OnEvent (Dom.Event e)
	Called when the window receives an event. More...

virtual void	OnClose ()
	Called when the window is closing. More...

void	AddStyle ()
	Adds style if it was required. More...

Package Functions
virtual void	Goto (string url, Dictionary< string, object > globals)
	Navigates the window to the given URL. Should only be used once; close and open another window (or use links inside the iframe). More...

Package Functions inherited from Windows.WindowGroup
void	Remove (Window w)
	Removes the given window. More...

Package Attributes
string	Type
	The window type. E.g. "floating". More...

int	ActiveDepth
	This windows actual depth. More...

string	Location
	The location of this window. More...

HtmlElement	element
	The root element which contains this window. All templates must have one root only (watch out for comments and text!). More...

HtmlElement	frame
	The iframe. May be null. More...

Window	HidWindow
	If this window is in the 'hide other' stacking mode, this is the window it hid. More...

Window	HidBy
	If this window is hidden, the one that hid it. More...

HtmlDocument	contentDocument
	The document to load content into. May be null. More...

Properties
int	Index `[get, set]`
	Index in managers array. More...

HtmlDocument	document `[get]`
	The document this window is in. More...

Window	backSameDepth `[get]`
	The window at the back and same depth as this one. More...

Window	previousSameDepth `[get]`
	The window before this one (further back) of the same type. More...

Window	frontSameDepth `[get]`
	The window at the front and same depth as this one. More...

Window	nextSameDepth `[get]`
	The window after this one (further forward) of the same type. More...

virtual StackMode	StackMode `[get]`
	True if these windows stack. More...

virtual int	Depth `[get]`
	The depth that this type of window lives at. More...

HtmlElement	TitleElement `[get]`
	An element with the '-spark-title' attribute. More...

Properties inherited from Windows.WindowGroup
HtmlDocument	WindowHostDocument `[get]`
	The doc that hosts child windows. More...

HtmlElement	WindowHostElement `[get]`
	An element to parent child windows to. More...

Properties inherited from Dom.EventTarget
static DispatchStack	dispatchStackRef `[get]`
	The active dispatch stack. Use event.deepPath to access it (available during dispatch only). More...

virtual EventTarget	eventTargetParentNode `[get]`
	The parent node as used by EventTarget during capture. Can be null. More...

virtual NodeList	eventTargetChildren `[get]`
	The childNode set as used by EventTarget during capture. Can be null. More...

Private Member Functions
void	close (bool removeFrame)
	Closes the window and its kids, optionally avoiding removing the actual element. More...

void	Ignored (string name, string type)
	Called when a window parameter value was ignored. More...

Private Attributes
int	Index_
	Index in managers array. More...

Additional Inherited Members
Public Attributes inherited from Windows.WindowGroup
Manager	Manager
	The window manager. More...

WindowGroup	Parent
	The parent group, if any. More...

List< Window >	Windows =new List<Window>()
	All active windows, sorted by depth. More...

Static Package Attributes inherited from Dom.EventTarget
static DispatchStack	PooledStack
	The current head of the pooled dispatched stacks. More...

Member Function Documentation

void Windows.Window.AddStyle ( )

inlineprotected

Adds style if it was required.

void Windows.Window.bringForward ( )

inline

Moves this window forward one place.

void Windows.Window.bringToFront ( )

inline

Brings this window to the front.

void Windows.Window.close ( )

inline

Closes the window and its kids.

void Windows.Window.close ( bool removeFrame)

inlineprivate

Closes the window and its kids, optionally avoiding removing the actual element.

static void Windows.Window.CloseThis ( UIEvent e)

inlinestatic

Closes the window that the given event originated from.

static void Windows.Window.Cue ( PowerUI.MouseEvent me)

inlinestatic

Cues dialogue within a window.

T Windows.Window.Get< T >	(	string	name,
		Dictionary< string, object >	globals
	)

inline

Gets a global of the given name.

HtmlElement Windows.Window.GetAnchor ( Dictionary< string, object > globals)

inline

The anchor element that triggered a window to open. Null if there wasn't one.

UnityEngine.Color Windows.Window.GetColour	(	string	name,
		Dictionary< string, object >	globals,
		UnityEngine.Color	defaultValue
	)

inline

Gets a global of the given name as a colour.

double Windows.Window.GetDecimal	(	string	name,
		Dictionary< string, object >	globals,
		double	defaultValue
	)

inline

Gets a global of the given name as a decimal.

int Windows.Window.GetInteger	(	string	name,
		Dictionary< string, object >	globals,
		int	defaultValue
	)

inline

Gets a global of the given name as an integer.

Window Windows.Window.GetVisibleWindow ( )

inline

When a window hides another, it may result in a linked list of hidden windows. This essentially finds the front of the linked list.

virtual void Windows.Window.Goto	(	string	url,
		Dictionary< string, object >	globals
	)

inlinepackagevirtual

Navigates the window to the given URL. Should only be used once; close and open another window (or use links inside the iframe).

Reimplemented in Windows.DialogueWindow.

override bool Windows.Window.HandleLocalEvent	(	Dom.Event	e,
		bool	bubblePhase
	)

inlineprotectedvirtual

Handles events on the window itself.

Reimplemented from Dom.EventTarget.

void Windows.Window.Ignored	(	string	name,
		string	type
	)

inlineprivate

Called when a window parameter value was ignored.

virtual void Windows.Window.Load	(	string	url,
		Dictionary< string, object >	globals
	)

inlinevirtual

Loads the contents of this window now.

Reimplemented in Windows.ContextMenuWindow.

virtual void Windows.Window.OnClose ( )

inlineprotectedvirtual

Called when the window is closing.

virtual void Windows.Window.OnEvent ( Dom.Event e)

inlineprotectedvirtual

Called when the window receives an event.

void Windows.Window.sendBackward ( )

inline

Sends this window to the back.

void Windows.Window.sendToBack ( )

inline

Sends this window to the back.

void Windows.Window.SetHtml ( string html)

inline

Writes the windows HTML now. Collects element and optionally an iframe.

void Windows.Window.trigger ( string name)

inline

Triggers a 'window{name}' event in the root document.

void Windows.Window.trigger	(	string	name,
		Dictionary< string, object >	globals
	)

inline

Triggers a '{name}' event on the window itself, and optionally on the source element.

void Windows.Window.Visibility	(	bool	visible,
		Window	hidBy
	)

inline

Hides/ shows the window (without actually closing it).

Member Data Documentation

int Windows.Window.ActiveDepth

package

This windows actual depth.

HtmlDocument Windows.Window.contentDocument

package

The document to load content into. May be null.

HtmlElement Windows.Window.element

package

The root element which contains this window. All templates must have one root only (watch out for comments and text!).

HtmlElement Windows.Window.frame

package

The iframe. May be null.

Window Windows.Window.HidBy

package

If this window is hidden, the one that hid it.

Window Windows.Window.HidWindow

package

If this window is in the 'hide other' stacking mode, this is the window it hid.

int Windows.Window.Index_

private

Index in managers array.

string Windows.Window.Location

package

The location of this window.

string Windows.Window.Type

package

The window type. E.g. "floating".

Property Documentation

Window Windows.Window.backSameDepth

get

The window at the back and same depth as this one.

virtual int Windows.Window.Depth

get

The depth that this type of window lives at.

HtmlDocument Windows.Window.document

get

The document this window is in.

Window Windows.Window.frontSameDepth

get

The window at the front and same depth as this one.

int Windows.Window.Index

getsetpackage

Index in managers array.

Window Windows.Window.nextSameDepth

get

The window after this one (further forward) of the same type.

Window Windows.Window.previousSameDepth

get

The window before this one (further back) of the same type.

virtual StackMode Windows.Window.StackMode

get

True if these windows stack.

HtmlElement Windows.Window.TitleElement

get

An element with the '-spark-title' attribute.

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Package Functions

Package Attributes

Properties

Private Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation

Property Documentation