Class Index | File Index

Classes


Class SweetDevRia.Window

Window
Defined in: Window.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
SweetDevRia.Window(id, x, y, width, height, minWidth, minHeight, maxWidth, maxHeight, url, modal, openAtStartup, loadAtStartup)
Field Summary
Field Attributes Field Name and Description
 
Name of the class
<static>  
SweetDevRia.Window.CLOSE_EVENT
This event type is fired when the window is closed
 
Instance counter
 
Is window maximized (default : false)
 
Is window minimized (default : false)
 
Is window open (default : true)
 
Is window resizable (default : true)
 
Maximum height of the Window (default : 800px)
<static>  
SweetDevRia.Window.MAXIMIZE_EVENT
This event type is fired when the window is maximized
 
Maximum width of the Window (default : 800px)
<static>  
SweetDevRia.Window.MINIMIZE_EVENT
This event type is fired when the window is minimized
 
Width of the window when it's minimized (default : 100px)
 
Is window modal (default : false)
<static>  
SweetDevRia.Window.OPEN_EVENT
This event type is fired when the window is opened
<static>  
SweetDevRia.Window.RESTORE_EVENT
This event type is fired when the window is restored
Method Summary
Method Attributes Method Name and Description
 
SWTRIA-964 Add Listener on Iframe when this is loaded
 
This method is called after closing a window To be overridden !!
 
This method is called after maximizing a window To be overridden !!
 
This method is called after minimizing a window To be overridden !!
 
This method is called after opening a window To be overridden !!
 
This method is called after restoring a window To be overridden !!
 
This method is called before closing a window To be overridden !!
 
This method is called before maximizing a window To be overridden !!
 
This method is called before minimizing a window To be overridden !!
 
This method is called before opening a window To be overridden !!
 
This method is called before restoring a window To be overridden !!
 
Center the window in the screen
 
Close window
<private>  
dock(windowDockingId)
Dock a window (docking layout)
 
Return the active window.
<private>  
Compute the position 0,0 of the window in the X axis to center the window vertically
<private>  
Compute the position 0,0 of the window in the Y axis to center the window vertically
 
Return the last saved X coordinate of the window, or compute it as the center on the screen
 
Return the last saved Y coordinate of the window, or compute it as the center on the screen
 
Return window internal subElement dom
 
Return height of the window
 
Return greatest height that the window can be
 
Return greatest width that the window can be
 
Return message of the statebar
 
Return smallest height that the window can be
 
Return width of the window when it's minimized
 
Return smallest width that the window can be
 
Return if the window is resizable
<private>  
Return all sister windows wich are the same parent
 
Return title of the window
 
Return the url of the window
 
Return window dom fragment
 
Return real window internal subElement name
 
Return width of the window
 
getX()
Return X position of the window
 
getY()
Return Y position of the window
 
Return window z-index
<private>  
handleEvent(Event)
Handle keyboard events.
 
Hide borders of the window for resize
<private>  
Hide the invisible panel
<private>  
Hide the invisibleWindowPanel
 
Hide the state bar
 
init()
Set good borders size, invisible panel and good z-index for the window at startup
<private>  
<private>  
Init z-index
 
Return if the window is active
 
Return if the window is modal
 
Return if is a modal window active
 
Return if the state bar is visible
 
SWTRIA-964 This method is called after load iframe To be overridden !!
 
Maximize window : 2nd button
 
menu()
Event call when user click on the menu button (abstract).
 
Minimize window : 1st button from left side
 
moveTo(x, y)
Move window to a new position
<private>  
Moving method.
 
open(callerId)
Open window SWTRIA-1019
<private>  
Render the invisible panel size
<private>  
Drag & Drop resizepanel for resize
 
resizeTo(width, height)
Resize window to a new size
 
restore(restorePosition)
Restore the window (not maximized and not minimized)
 
Save window's coordinates and size
 
setActive(init)
Set the window active
 
setHeight(height)
Set height of the window
 
Set the window inactive
 
setMaxHeight(height)
Set greatest height that the window can be
 
setMaxWidth(width)
Set greatest width that the window can be
 
setMessage(label)
Set message of the state bar
 
setMinHeight(height)
Set smallest height that the window can be
 
Set width of the window when it's minimized
 
setMinWidth(width)
Set smallest width that the window can be
 
setModal(bool)
Set if the window is modal
 
Set if the window is resizable
 
Set if the state bar is visible
 
setTitle(label)
Set title of the window
 
setUrl(url)
Set the url of the window
 
setWidth(width)
Set width of the window
 
setX(x)
Set X position of the window
 
setY(y)
Set Y position of the window
 
setZindex(zIndex)
Set window z-index
 
Show borders of the window for resize
<private>  
Show the invisibleWindowPanel
 
Show the state bar
<private>  
Update the z-index of the windows
<private>  
IE Hack for positioning
<private>  
Update window z-index
Class Detail
SweetDevRia.Window(id, x, y, width, height, minWidth, minHeight, maxWidth, maxHeight, url, modal, openAtStartup, loadAtStartup)
Parameters:
{String} id
Identifier of the window
{int} x
Left position of the Window
{int} y
Top position of the window
{int} width
Width of the window
{int} height
Height of the window
{int} minWidth
Minimal width of the window
{int} minHeight
Minimal height of the window
{int} maxWidth
Maximal width of the window
{int} maxHeight
Maximal height of the window
{String} url
Url to display in the window
{boolean} modal
Is the window modal
openAtStartup
loadAtStartup
Field Detail
{String} className
Name of the class

<static> SweetDevRia.Window.CLOSE_EVENT
This event type is fired when the window is closed

{int} indexIdCounter
Instance counter

{boolean} isMaximize
Is window maximized (default : false)

{boolean} isMinimize
Is window minimized (default : false)

{boolean} isOpen
Is window open (default : true)

{boolean} isResizable
Is window resizable (default : true)

{int} maxHeight
Maximum height of the Window (default : 800px)

<static> SweetDevRia.Window.MAXIMIZE_EVENT
This event type is fired when the window is maximized

{int} maxWidth
Maximum width of the Window (default : 800px)

<static> SweetDevRia.Window.MINIMIZE_EVENT
This event type is fired when the window is minimized

{int} minimizeWidth
Width of the window when it's minimized (default : 100px)

{boolean} modal
Is window modal (default : false)

<static> SweetDevRia.Window.OPEN_EVENT
This event type is fired when the window is opened

<static> SweetDevRia.Window.RESTORE_EVENT
This event type is fired when the window is restored
Method Detail
addIFrameEventLoad()
SWTRIA-964 Add Listener on Iframe when this is loaded

afterClose()
This method is called after closing a window To be overridden !!

afterMaximize()
This method is called after maximizing a window To be overridden !!

afterMinimize()
This method is called after minimizing a window To be overridden !!

afterOpen()
This method is called after opening a window To be overridden !!

afterRestore()
This method is called after restoring a window To be overridden !!

{boolean} beforeClose()
This method is called before closing a window To be overridden !!
Returns:
True if this method can be called, else false.

{boolean} beforeMaximize()
This method is called before maximizing a window To be overridden !!
Returns:
True if this method can be called, else false.

{boolean} beforeMinimize()
This method is called before minimizing a window To be overridden !!
Returns:
True if this method can be called, else false.

{boolean} beforeOpen()
This method is called before opening a window To be overridden !!
Returns:
True if this method can be called, else false.

{boolean} beforeRestore()
This method is called before restoring a window To be overridden !!
Returns:
True if this method can be called, else false.

centerOnScreen()
Center the window in the screen

close()
Close window

<private> dock(windowDockingId)
Dock a window (docking layout)
Parameters:
windowDockingId

{boolean} getActiveWindow()
Return the active window.

<private> {int} getCenterOnScreenX()
Compute the position 0,0 of the window in the X axis to center the window vertically
Returns:
the y coord to center the window in the X axis

<private> {int} getCenterOnScreenY()
Compute the position 0,0 of the window in the Y axis to center the window vertically
Returns:
the y coord to center the window in the Y axis

{int} getCoordX()
Return the last saved X coordinate of the window, or compute it as the center on the screen
Returns:
the last saved X coordinate of the window

{int} getCoordY()
Return the last saved Y coordinate of the window, or compute it as the center on the screen
Returns:
the last saved Y coordinate of the window

{HTMLElement} getDomView(id)
Return window internal subElement dom
Parameters:
{String} id
Generic name of a subElement of the window (Example : SweetDevRia.Window.prototype.dom.menu)

{int} getHeight()
Return height of the window

{int} getMaxHeight()
Return greatest height that the window can be

{int} getMaxWidth()
Return greatest width that the window can be

{String} getMessage()
Return message of the statebar

{int} getMinHeight()
Return smallest height that the window can be

{int} getMinimizeWidth()
Return width of the window when it's minimized

{int} getMinWidth()
Return smallest width that the window can be

{boolean} getReziable()
Return if the window is resizable

<private> getSisters()
Return all sister windows wich are the same parent

{String} getTitle()
Return title of the window

{String} getUrl()
Return the url of the window
Returns:
the url of the window

{Node} getView()
Return window dom fragment

{String} getViewName(name)
Return real window internal subElement name
Parameters:
{String} name
Generic name of a subElement of the window (Example : SweetDevRia.Window.prototype.dom.menu)

{int} getWidth()
Return width of the window

{int} getX()
Return X position of the window

{int} getY()
Return Y position of the window

{int} getZindex()
Return window z-index

<private> {boolean} handleEvent(Event)
Handle keyboard events.
Parameters:
Event
evt Event.
Returns:
{boolean} true if event is not active, false if component was closed.

hideBorders()
Hide borders of the window for resize

<private> hideInvisiblePanel()
Hide the invisible panel

<private> hideInvisibleWindowPanel()
Hide the invisibleWindowPanel

hideStateBar()
Hide the state bar

init()
Set good borders size, invisible panel and good z-index for the window at startup

<private> initialize()

<private> initZIndex()
Init z-index

{boolean} isActiveWindow()
Return if the window is active

{boolean} isModal()
Return if the window is modal

{boolean} isModalActiveWindow()
Return if is a modal window active

{boolean} isStateBar()
Return if the state bar is visible

loadIframe()
SWTRIA-964 This method is called after load iframe To be overridden !!

maximize()
Maximize window : 2nd button

menu()
Event call when user click on the menu button (abstract). Override this to have a custom behavior.

minimize()
Minimize window : 1st button from left side

moveTo(x, y)
Move window to a new position
Parameters:
{int} x
New X position of the window
{int} y
New Y position of the window

<private> onContainerMove(dx, dy)
Moving method.
Parameters:
{int} dx
delta X to move the component to
{int} dy
delta Y to move the component to
See:
Hookable.

open(callerId)
Open window SWTRIA-1019
Parameters:
callerId

<private> renderInvisiblePanelSize()
Render the invisible panel size

<private> resizePanel()
Drag & Drop resizepanel for resize

resizeTo(width, height)
Resize window to a new size
Parameters:
{int} width
New width of the window
{int} height
New height of the window

restore(restorePosition)
Restore the window (not maximized and not minimized)
Parameters:
{boolean} restorePosition
if true, restore the position before the modification

saveCoords()
Save window's coordinates and size

setActive(init)
Set the window active
Parameters:
init

setHeight(height)
Set height of the window
Parameters:
{int} height
New height of the window

setInactive()
Set the window inactive

setMaxHeight(height)
Set greatest height that the window can be
Parameters:
{int} height
New greatest height

setMaxWidth(width)
Set greatest width that the window can be
Parameters:
{int} width
New greatest width

setMessage(label)
Set message of the state bar
Parameters:
{String} label
New message of the state bar

setMinHeight(height)
Set smallest height that the window can be
Parameters:
{int} height
New smallest height

setMinimizeWidth(width)
Set width of the window when it's minimized
Parameters:
{int} width
New width of the window when it's minimized

setMinWidth(width)
Set smallest width that the window can be
Parameters:
{int} width
New smallest width

setModal(bool)
Set if the window is modal
Parameters:
{boolean} bool
Set if the window is modal

setReziable(bool)
Set if the window is resizable
Parameters:
{boolean} bool
The new resizable type.

setStateBar(bool)
Set if the state bar is visible
Parameters:
{boolean} bool
New state bar visibility

setTitle(label)
Set title of the window
Parameters:
{String} label
New title of the window

setUrl(url)
Set the url of the window
Parameters:
{String} url
the new url

setWidth(width)
Set width of the window
Parameters:
{int} width
New width of the window

setX(x)
Set X position of the window
Parameters:
{int} x
New X position of the window

setY(y)
Set Y position of the window
Parameters:
{int} y
New Y position of the window

setZindex(zIndex)
Set window z-index
Parameters:
{int} zIndex
New z-index for the window

showBorders()
Show borders of the window for resize

<private> showInvisibleWindowPanel()
Show the invisibleWindowPanel

showStateBar()
Show the state bar

<private> updateActiveWindow()
Update the z-index of the windows

<private> updateForIE()
IE Hack for positioning

<private> updateZIndex(obj)
Update window z-index
Parameters:
{Window} obj
Window to update

Documentation generated by JsDoc Toolkit 2.0.0 on Thu May 05 2011 12:20:34 GMT+0200 (CEST)