You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
172 lines
3.4 KiB
Plaintext
172 lines
3.4 KiB
Plaintext
# JSDE API Reference
|
|
|
|
{TOC}
|
|
|
|
## jQuery extensions
|
|
|
|
^ $.getWindow()
|
|
|
|
Returns the JsdeWindow that the applicable element exists in. Useful to
|
|
do things like dynamically updating windows from an AJAX response.
|
|
|
|
## JsdeWindow
|
|
|
|
### Member variables
|
|
|
|
^ JsdeWindow.id
|
|
|
|
Holds the unique ID of the window.
|
|
|
|
^ JsdeWindow.x
|
|
|
|
Holds the current X position of the window.
|
|
|
|
^ JsdeWindow.y
|
|
|
|
Holds the current Y position of the window.
|
|
|
|
^ JsdeWindow.z
|
|
|
|
Holds the current Z-index of the window.
|
|
|
|
^ JsdeWindow.width
|
|
|
|
Holds the current width of the window.
|
|
|
|
^ JsdeWindow.height
|
|
|
|
Holds the current height of the window.
|
|
|
|
^ JsdeWindow._inner
|
|
|
|
! Do __not__ use this to set the window contents, use JsdeWindow.SetContents() instead!
|
|
|
|
Holds a reference to the DOM element containing the window contents.
|
|
|
|
### Constructor
|
|
|
|
^ new JsdeWindow(options)
|
|
|
|
Creates a new window.
|
|
|
|
options::
|
|
A plain object that contains the options for this window. Options can be any of
|
|
the following.
|
|
|
|
title::
|
|
The title of the new window. You can use HTML here.
|
|
|
|
contents::
|
|
The contents of the new window. You can use HTML here.
|
|
|
|
visible::
|
|
A boolean indicating whether the window should be visible. Defaults to `true`.
|
|
|
|
x::
|
|
An integer specifying the X coordinate that the window should be spawned at.
|
|
|
|
y::
|
|
An integer specifying the Y coordinate that the window should be spawned at.
|
|
|
|
width::
|
|
An integer specifying the initial width of the window in pixels.
|
|
|
|
height::
|
|
An integer specifying the initial height of the window in pixels.
|
|
|
|
resizable::
|
|
A boolean indicating whether the user is allowed to resize the window.
|
|
Defaults to `true`.
|
|
|
|
min_width::
|
|
The minimum width of the window in pixels (used to restrict resizing). Defaults to `120`.
|
|
|
|
min_height::
|
|
The minimum height of the window in pixels (used to restrict resizing). Defaults to `120`.
|
|
|
|
max_width::
|
|
The maximum width of the window in pixels (used to restrict resizing). Defaults to unlimited.
|
|
|
|
max_height::
|
|
The maximum height of the window in pixels (used to restrict resizing). Defaults to unlimited.
|
|
|
|
|
|
|
|
### Member functions
|
|
|
|
^ JsdeWindow.SetPosition(**x**, **y**)
|
|
|
|
Sets the current position of a window.
|
|
|
|
x::
|
|
The X coordinate.
|
|
|
|
y::
|
|
The Y coordinate.
|
|
|
|
@ Setting the window position
|
|
|
|
$ win.SetPosition(100, 110);
|
|
|
|
^ JsdeWindow.GetPosition()
|
|
|
|
Retrieves the current position of a window.
|
|
|
|
Returns an object with an `x` and a `y` key.
|
|
|
|
^ JsdeWindow.SetSize(**width**, **height**)
|
|
|
|
Sets the current size of a window.
|
|
|
|
width::
|
|
The new width.
|
|
|
|
height::
|
|
The new height.
|
|
|
|
@ Setting the window size
|
|
|
|
$ win.SetSize(400, 350);
|
|
|
|
^ JsdeWindow.GetTitle()
|
|
|
|
Returns the current title of the window.
|
|
|
|
@ Retrieving the window title
|
|
|
|
$ console.log(win.GetTitle());
|
|
|
|
> "Example window title"
|
|
|
|
^ JsdeWindow.SetTitle(**title**)
|
|
|
|
Sets the current title of the window.
|
|
|
|
title::
|
|
The title to set.
|
|
|
|
@ Setting the window title
|
|
|
|
$ win.SetTitle("Fancy new window title");
|
|
|
|
^ JsdeWindow.GetContents()
|
|
|
|
Returns the current contents of the window.
|
|
|
|
@ Retrieving the window contents
|
|
|
|
$ console.log(win.GetContents());
|
|
|
|
> "These are some example contents that could hypothetically be in a <strong>JSDE window</strong>."
|
|
|
|
^ JsdeWindow.SetContents(**contents**)
|
|
|
|
Sets the contents of the window.
|
|
|
|
contents::
|
|
The new window contents.
|
|
|
|
@ Setting the window contents
|
|
|
|
$ win.SetContents("These are <em>new</em> hypothetical contents for a window.");
|