Widgets (Web API) - Revision history

Bablakeluke at 16:41, 18 March 2017

2017-03-18T16:41:42Z

Bablakeluke: Bablakeluke moved page Windows (Web API) to Widgets (Web API): Renamed to 'widgets' instead of windows.

2017-03-18T16:37:35Z

Bablakeluke moved page Windows (Web API) to Widgets (Web API): Renamed to 'widgets' instead of windows.

Bablakeluke: /* Parameters */

2017-03-15T23:16:12Z

‎Parameters

Bablakeluke: /* Parameters */

2017-03-15T23:15:18Z

‎Parameters

Bablakeluke: /* Parameters */

2017-03-15T23:10:12Z

‎Parameters

Bablakeluke: /* Available methods */

2017-03-15T23:09:40Z

‎Available methods

Bablakeluke: /* Available methods */

2017-03-15T23:09:28Z

‎Available methods

Bablakeluke at 23:08, 15 March 2017

2017-03-15T23:08:36Z

151.229.186.156 at 10:28, 14 January 2017

2017-01-14T10:28:29Z

151.229.186.156 at 10:27, 14 January 2017

2017-01-14T10:27:31Z

@@ Line 1: / Line 1: @@
-'''Note: Not to be confused with the standard window object.''' In order to make the [[Window Manager|window system]] as useful as possible, it features a Web API available as '''document.sparkWindows'''. This is used to open, close, cycle, find etc windows within a document.
+In order to make the [[Widget Manager|widget system]] as useful as possible, it features a Web API available as '''document.widgets'''. This is used to open, close, cycle, find etc widgets within a document.
 == Available methods ==
-See the source documents for [http://powerui.kulestar.com/powerdocs-2_0/classWindows_1_1Manager.html Windows.Manager], or the source itself which is here:
+See the source documents for [http://powerui.kulestar.com/powerdocs-2_0/classWindows_1_1Manager.html Widgets.Manager], or the source itself which is here:
 <blockquote>
-PowerUI/Source/Extras/Window System/Manager.cs
+PowerUI/Source/Extras/Widgets/Manager.cs
 </blockquote>
-== Simple opening of a window ==
+== Simple opening of a widget ==
-You'll need a reference to the document you'd like to open the window in - that's typically either UI.document or aWorldUI.document. Then you use the sparkWindows API like this:
+You'll need a reference to the document you'd like to open the widget in - that's typically either UI.document or aWorldUI.document. Then you use the widgets API like this:
 <syntaxhighlight lang="csharp">
-// Open a bank window using the "floating" template:
+// Open a bank widget using the "floating" template:
-Window myWindow = document.sparkWindows.open("floating","UIs/Bank/index.html");
+Widgets.Widget myWidget = document.widgets.open("floating","UIs/Bank/index.html");
 </syntaxhighlight>
-== Opening a window using promise ==
+== Opening a widget using promise ==
-Some window templates perform some kind of animation whilst they open. When they're done, they fire the "onload" event. To catch that onload event as a convenient promise, use load instead:
+Some widget templates perform some kind of animation whilst they open. When they're done, they fire the "onload" event. To catch that onload event as a convenient promise, use load instead:
 <syntaxhighlight lang="csharp">
 // Open a bank window using the "floating" template:
-document.sparkWindows.load("floating","UIs/Bank/index.html").then(delegate(object o){
+document.widgets.load("floating","UIs/Bank/index.html").then(delegate(object o){
-     // o is the successfully opened window:
+     // o is the successfully opened widget:
-     Window myWindow = o as Window;
+     Widgets.Widget myWidget = o as Widgets.Widget;
-     // myWindow is ready to go!
+     // myWidget is ready to go!
 });
@@ Line 40: / Line 40: @@
 == Parameters ==
-You can pass extra parameters to an opening window via the globals dictionary:
+You can pass extra parameters to an opening widget via the globals dictionary:
 <syntaxhighlight lang="csharp">
-// Open a bank window using the "floating" template
+// Open a bank widget using the "floating" template
 // and an 'initial' parameter of '14':
 // (alternatively create a dictionary<string,object> and pass that instead)
-Window myWindow = document.sparkWindows.open("floating", "UIs/Bank/index.html", "initial", "14");
+Widgets.Widget myWidget = document.widgets.open("floating", "UIs/Bank/index.html", "initial", "14");
 </syntaxhighlight>
@@ Line 55: / Line 55: @@
 <syntaxhighlight lang="csharp">
-Window myWindow = document.sparkWindows.open(
+Widgets.Widget myWidget = document.widgets.open(
                                                "floating", "UIs/Bank/index.html",
                                                "initial", "14",
@@ Line 65: / Line 65: @@
-Just like with the [[Window Protocol|window:// protocol]], these parameters will be set as JavaScript globals for the content to use, and are also made available to the template.
+Just like with the [[Widget Protocol|widget:// protocol]], these parameters will be set as JavaScript globals for the content to use, and are also made available to the template.
-== Get the window that an element is in ==
+== Get the widget that an element is in ==
-It's often useful to obtain the window object that a particular element is in. It's as simple as this:
+It's often useful to obtain the widget object that a particular element is in. It's as simple as this:
 <syntaxhighlight lang="csharp">
@@ Line 75: / Line 75: @@
 // HtmlElement anElement;
-// Null if it's not in any window
+// Null if it's not in any widget
-Window myWindow=anElement.sparkWindow;
+Widgets.Widget myWidget=anElement.widget;
 </syntaxhighlight>
-== Opening a window relative to another ==
+== Opening a widget relative to another ==
-It's important to note that ''every'' window is also a window manager. This lets you open a window "on top" of another one, regardless of their defined stacking order. An example of where this is useful is, for example, [[Screen Fading (Fade to black/ Whiteouts)|fading the screen out]] and then displaying a pause menu.
+It's important to note that ''every'' widget is also a [[Widget Manager|widget manager]]. This lets you open a widget "on top" of another one, regardless of their defined stacking order. An example of where this is useful is, for example, [[Screen Fading (Fade to black/ Whiteouts)|fading the screen out]] and then displaying a pause menu.

@@ Line 46: / Line 46: @@
 // Open a bank window using the "floating" template
 // and an 'initial' parameter of '14':
-// (alternatively create a dictionary and pass that instead)
+// (alternatively create a dictionary<string,object> and pass that instead)
 Window myWindow = document.sparkWindows.open("floating", "UIs/Bank/index.html", "initial", "14");

@@ Line 47: / Line 47: @@
 // and an 'initial' parameter of '14':
 // (alternatively create a dictionary and pass that instead)
-Window myWindow = document.sparkWindows.open("floating","UIs/Bank/index.html","initial","14");
+Window myWindow = document.sparkWindows.open("floating", "UIs/Bank/index.html", "initial", "14");
 </syntaxhighlight>
 Just like with the [[Window Protocol|window:// protocol]], these parameters will be set as JavaScript globals for the content to use, and are also made available to the template.

@@ Line 46: / Line 46: @@
 // Open a bank window using the "floating" template
 // and an 'initial' parameter of '14':
 Window myWindow = document.sparkWindows.open("floating","UIs/Bank/index.html","initial","14");
@@ Line 51: / Line 52: @@
 Just like with the [[Window Protocol|window:// protocol]], these parameters will be set as JavaScript globals for the content to use, and are also made available to the template.
 == Get the window that an element is in ==

@@ Line 3: / Line 3: @@
 == Available methods ==
-See the source documents for [powerui.kulestar.com/powerdocs-2_0/classWindows_1_1Manager.html Windows.Manager], or the source itself which is here:
+See the source documents for [http://powerui.kulestar.com/powerdocs-2_0/classWindows_1_1Manager.html Windows.Manager], or the source itself which is here:
 <blockquote>

← Older revision	Revision as of 16:37, 18 March 2017
(No difference)