SUI.Window
SUI.Window is a component to create dialog boxes. Dialog boxes are container boxes that are displayed on top of the user interface. They can be either modal (disable the current interface) or modeless (still keeping the current user interface active). The windows are always movable and by default resizeable too.
Extends
SUI.AnchorLayout
Defined in:
Window.js
| Attr. | Name / Description |
|---|---|
| public |
SUI.Window(see, arg) Create a window, use show to show it in modal mode or draw to display as it modeless window. |
| Name | Description |
|---|---|
|
onClose |
onClose event handler. This event handler is called when the user clicks on the 'close' button on the window's caption. |
| Attr. | Type | Name | Description |
|---|---|---|---|
| private | SUI.Border |
The box's border. |
|
| private | int |
The bottom position of the box. |
|
| private | HTMLElementNode |
The box's element node. |
|
| private | int |
The height of the box. |
|
| private | int |
The left position of the box. |
|
| private | int |
The listeners array. |
|
| private | int |
The maximum height of the box. |
|
| private | int |
The maximum width of the box. |
|
| private | int |
The minimum height of the box. |
|
| private | int |
The minimum width of the box. |
|
| private | SUI.Padding |
The box's padding. |
|
| private | SUI.Box |
The box's parent element. |
|
| private | int |
The right position of the box. |
|
| private | int |
The top position of the box. |
|
| private | int |
The width of the box. |
|
| public |
The inner border width. |
||
| public |
Height of the caption bar (excluding borders). |
||
| public |
Padding left of the caption text in the caption bar. |
||
| public |
Padding top of the caption text in the caption bar. |
||
| public | SUI.Box[] |
The list of children of this container. |
|
| public |
Right offset of the close icon. |
||
| public |
Close icons size (width and height). |
||
| public |
Top offset of the close icon. |
||
| public |
Size of the corner draggers. |
||
| public |
Border width of border around the the inner window (without the caption bar). |
||
| public |
Border width of border around the whole window. |
| Attr. | Type | Name / Description |
|---|---|---|
| private |
Layout the children of the Container. Use the anchors of the children to place them on the client area of the Container. |
|
| public |
absPos() Get the absolute position (top/left) of this box on the page. Note: You can only use this function if the HTML content of the page is fully rendered. |
|
| public |
add(child) Add a box component to the window. |
|
| public |
addClass(cls) Add a CSS class name to the class list of the HTML element associated with the box. |
|
| public |
addListener(type, listener) Add/register a listener function. This way it is possible to register more than one listener function on one target. |
|
| public | SUI.Border |
border(b) Get or set the border definition of the box. |
| public | int |
bottom(b) Get or set the bottom of the box. |
| public |
callListener(type) Call a listener function. Execute the default and additional listener functions. Note: the framework should not execute the default listeners directly but always through this method to ensure the execution of additional listener functions. |
|
| public | String |
caption(text) Set or get the caption text. |
| public |
center() Set the top and left so that the window will be centered when it will be drawn. |
|
| public |
Get the top, left, right and bottom offset of the client area relative to the outer dimensions of the window. |
|
| public | int |
Get the client height of the box. The client height is the height of the box minus the top and bottom border and padding width. |
| public | int |
Get the client width of the box. The client width is the width of the box minus the left and right border and padding width. |
| public |
close() Close a modal window that was created buy calling 'show' |
|
| public |
display() Display the window control. Set the CSS size and position of the window's boxes. |
|
| public |
draw() Draw the box on the screen. It executes a two phase process: a layout phase in which the size and positions of the box (and of it's contents, for more complex derivatives) is calculated and a display phase in which the CSS size and position of the box's (and possible it's child elements) is set. |
|
| public | HTMLElementNode |
el() Get the HTML element node of the box. |
| public | int |
height(h) Get or set the height of the box. |
| public |
layOut() Lay out the the window. Calculate the sizes and positions of all the window's elements. |
|
| public | int |
left(l) Get or set the left of the box. |
| public | int |
maxHeight(mh) Get or set the maximum height of the box. |
| public | int |
maxWidth(mw) Get or set the maximum width of the box. |
| public | int |
minHeight(mh) Get or set the minimum height of the box. |
| public | int |
minWidth(mw) Get or set the minimum width of the box. |
| public | SUI.Padding |
padding(p) Get or set the padding definition of the box. |
| public | SUI.Box |
parent(p) Get or set the parent box of the box. When setting the parent the box's element node will be appended to the parent box's HTML element node. |
| public |
remove(child, parent) Remove a child box. |
|
| public |
Remove a box from the DOM tree. |
|
| public |
removeClass(cls) Remove a CSS class name from the class list of the HTML element associated with the box. |
|
| public | int |
right(r) Get or set the right of the box. |
| public |
setDim() Set the CSS dimensions of this box and it's borders and padding. This is typically used in display functions to display boxes at the size and position that was calculated during layout. |
|
| public |
setPos() Set the CSS postion of this box. This is typically used in display functions to display boxes at position that was calculated during layout. Note: use setDim if you want to set the position and size of the box. |
|
| public |
setRect(t, l, w, h) Set the top, left, width and height of a box in one go. |
|
| public |
show() Show a modal window. Before creating the window an overlay will be placed over the current window to disallow access to the other elements of the interface. |
|
| public | int |
top(t) Get or set the top of the box. |
| public | int |
width(w) Get or set the width of the box. |
Constructor
Members
- private SUI.Border _border
-
The box's border.
Inherited From: SUI.AnchorLayout#_border
- private int _bottom
-
The bottom position of the box.
Inherited From: SUI.AnchorLayout#_bottom
- private HTMLElementNode _el
-
The box's element node.
Inherited From: SUI.AnchorLayout#_el
- private int _height
-
The height of the box.
Inherited From: SUI.AnchorLayout#_height
- private int _left
-
The left position of the box.
Inherited From: SUI.AnchorLayout#_left
- private int _listeners
-
The listeners array.
Inherited From: SUI.AnchorLayout#_listeners
- private int _maxHeight
-
The maximum height of the box.
Inherited From: SUI.AnchorLayout#_maxHeight
- private int _maxWidth
-
The maximum width of the box.
Inherited From: SUI.AnchorLayout#_maxWidth
- private int _minHeight
-
The minimum height of the box.
Inherited From: SUI.AnchorLayout#_minHeight
- private int _minWidth
-
The minimum width of the box.
Inherited From: SUI.AnchorLayout#_minWidth
- private SUI.Padding _padding
-
The box's padding.
Inherited From: SUI.AnchorLayout#_padding
- private SUI.Box _parent
-
The box's parent element.
Inherited From: SUI.AnchorLayout#_parent
- private int _right
-
The right position of the box.
Inherited From: SUI.AnchorLayout#_right
- private int _top
-
The top position of the box.
Inherited From: SUI.AnchorLayout#_top
- private int _width
-
The width of the box.
Inherited From: SUI.AnchorLayout#_width
- public BORDER_WIDTH
-
The inner border width.
- public CAPTION_HEIGHT
-
Height of the caption bar (excluding borders).
- public CAPTION_PADDING_LEFT
-
Padding left of the caption text in the caption bar.
- public CAPTION_PADDING_TOP
-
Padding top of the caption text in the caption bar.
- public SUI.Box[] children
-
The list of children of this container.
Inherited From: SUI.AnchorLayout#children
View source: AnchorLayout.js, line 93
- public CLOSE_RIGHT
-
Right offset of the close icon.
- public CLOSE_SIZE
-
Close icons size (width and height).
- public CLOSE_TOP
-
Top offset of the close icon.
- public CORNER_SIZE
-
Size of the corner draggers.
- public INNER_BORDER_OUTLINE
-
Border width of border around the the inner window (without the caption bar).
- public OUTER_BORDER_OUTLINE
-
Border width of border around the whole window.
Methods
- private _layoutChildren()
-
Layout the children of the Container. Use the anchors of the children to place them on the client area of the Container.
Inherited From: SUI.AnchorLayout#_layoutChildren
View source: AnchorLayout.js, line 153
- public absPos()
-
Get the absolute position (top/left) of this box on the page. Note: You can only use this function if the HTML content of the page is fully rendered.
Inherited From: SUI.AnchorLayout#absPos
- public add( SUI.Box child)
-
Add a box component to the window.
Parameters:
Name Type Description SUI.Box child Child box to add - public addClass( String cls)
-
Add a CSS class name to the class list of the HTML element associated with the box.
Parameters:
Name Type Description String cls the CSS class name to add Inherited From: SUI.AnchorLayout#addClass
- public addListener( String type, Function listener)
-
Add/register a listener function. This way it is possible to register more than one listener function on one target.
Parameters:
Name Type Description String type The listener type (i.e. "onClick", "onOK", etc). Function listener The listener function. Inherited From: SUI.AnchorLayout#addListener
- public SUI.Border border( SUI.Border b)
-
Get or set the border definition of the box.
Parameters:
Name Type Argument Description SUI.Border b <optional>
The new border definition (or none to use this method as a getter). Returns:
SUI.Border the border definition of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#border
- public int bottom( int b)
-
Get or set the bottom of the box.
Parameters:
Name Type Argument Description int b <optional>
The new bottom of the box (or none to use this method as a getter). Returns:
int The bottom of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#bottom
- public callListener( String type)
-
Call a listener function. Execute the default and additional listener functions. Note: the framework should not execute the default listeners directly but always through this method to ensure the execution of additional listener functions.
Parameters:
Name Type Description String type The listener type (i.e. "onClick", "onOK", etc). Inherited From: SUI.AnchorLayout#callListener
- public String caption( String text)
-
Set or get the caption text.
Parameters:
Name Type Description String text The new caption text (null to use the method as getter) Returns:
String The caption text (null if the method was used as setter)
- public center()
-
Set the top and left so that the window will be centered when it will be drawn.
- public clientAreaPosition()
-
Get the top, left, right and bottom offset of the client area relative to the outer dimensions of the window.
- public int clientHeight()
-
Get the client height of the box. The client height is the height of the box minus the top and bottom border and padding width.
Returns:
int The client height of the box.
Inherited From: SUI.AnchorLayout#clientHeight
- public int clientWidth()
-
Get the client width of the box. The client width is the width of the box minus the left and right border and padding width.
Returns:
int The client width of the box.
Inherited From: SUI.AnchorLayout#clientWidth
- public close()
-
Close a modal window that was created buy calling 'show'
- public display()
-
Display the window control. Set the CSS size and position of the window's boxes.
- public draw()
-
Draw the box on the screen. It executes a two phase process: a layout phase in which the size and positions of the box (and of it's contents, for more complex derivatives) is calculated and a display phase in which the CSS size and position of the box's (and possible it's child elements) is set.
Inherited From: SUI.AnchorLayout#draw
- public HTMLElementNode el()
-
Get the HTML element node of the box.
Returns:
HTMLElementNode the HTML element node of the box.
Inherited From: SUI.AnchorLayout#el
- public int height( int h)
-
Get or set the height of the box.
Parameters:
Name Type Argument Description int h <optional>
The new height of the box (or none to use this method as a getter). Returns:
int The height of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#height
- public layOut()
-
Lay out the the window. Calculate the sizes and positions of all the window's elements.
- public int left( int l)
-
Get or set the left of the box.
Parameters:
Name Type Argument Description int l <optional>
The new left of the box (or none to use this method as a getter). Returns:
int The left of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#left
- public int maxHeight( int mh)
-
Get or set the maximum height of the box.
Parameters:
Name Type Argument Description int mh <optional>
The new maximum height of the box (or none to use this method as a getter). Returns:
int The maximum height of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#maxHeight
- public int maxWidth( int mw)
-
Get or set the maximum width of the box.
Parameters:
Name Type Argument Description int mw <optional>
The new maximum width of the box (or none to use this method as a getter). Returns:
int The maximum width of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#maxWidth
- public int minHeight( int mh)
-
Get or set the minimum height of the box.
Parameters:
Name Type Argument Description int mh <optional>
The new minimum height of the box (or none to use this method as a getter). Returns:
int The minimum height of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#minHeight
- public int minWidth( int mw)
-
Get or set the minimum width of the box.
Parameters:
Name Type Argument Description int mw <optional>
The new minimum width of the box (or none to use this method as a getter). Returns:
int The minimum width of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#minWidth
- public SUI.Padding padding( SUI.Padding p)
-
Get or set the padding definition of the box.
Parameters:
Name Type Argument Description SUI.Padding p <optional>
The new padding definition (or none to use this method as a getter). Returns:
SUI.Padding The padding definition of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#padding
- public SUI.Box parent( SUI.Box p)
-
Get or set the parent box of the box. When setting the parent the box's element node will be appended to the parent box's HTML element node.
Parameters:
Name Type Description SUI.Box p The parent box for this box (or none to use this method as a getter). Returns:
SUI.Box The parent box of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#parent
- public remove( SUI.Box child, SUI.AnchorLayout parent)
-
Remove a child box.
Parameters:
Name Type Description SUI.Box child a reference to the box to remove SUI.AnchorLayout parent Container to remove box from (none for this) Inherited From: SUI.AnchorLayout#remove
View source: AnchorLayout.js, line 134
- public removeBox()
-
Remove a box from the DOM tree.
Inherited From: SUI.AnchorLayout#removeBox
- public removeClass( String cls)
-
Remove a CSS class name from the class list of the HTML element associated with the box.
Parameters:
Name Type Description String cls The CSS class name to remove. Inherited From: SUI.AnchorLayout#removeClass
- public int right( int r)
-
Get or set the right of the box.
Parameters:
Name Type Description int r The new right of the box (or none to use this method as a getter). Returns:
int The right of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#right
- public setDim()
-
Set the CSS dimensions of this box and it's borders and padding. This is typically used in display functions to display boxes at the size and position that was calculated during layout.
Inherited From: SUI.AnchorLayout#setDim
- public setPos()
-
Set the CSS postion of this box. This is typically used in display functions to display boxes at position that was calculated during layout. Note: use setDim if you want to set the position and size of the box.
Inherited From: SUI.AnchorLayout#setPos
- public setRect( int | SUI.Box t, int l, int w, int h)
-
Set the top, left, width and height of a box in one go.
Parameters:
Name Type Argument Description int | SUI.Box t The new top of the box or another reference box to copy the values from. int l <optional>
The new left of the box (if the t parameter wasn't a reference Box). int w <optional>
The new width of the box (if the t parameter wasn't a reference Box). int h <optional>
The new length of the box (if the t parameter wasn't a reference Box). Inherited From: SUI.AnchorLayout#setRect
- public show()
-
Show a modal window. Before creating the window an overlay will be placed over the current window to disallow access to the other elements of the interface.
- public int top( int t)
-
Get or set the top of the box.
Parameters:
Name Type Argument Description int t <optional>
The new top of the box (or none to use this method as a getter). Returns:
int The top of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#top
- public int width( int w)
-
Get or set the width of the box.
Parameters:
Name Type Argument Description int w <optional>
The new width of the box (or none to use this method as a getter). Returns:
int The width of the box (or null if this method was used as a setter).
Inherited From: SUI.AnchorLayout#width
