Class adf.Window

Defined in: Window.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	adf.Window(id, titleText, pageElement, container, isPopup) adf.Window is an out of the box dialog UI available for users.

Field Summary
Field Attributes	Field Name and Description
	bounds provides the page bounds of the divObject
	collapsed Provides the status whether the window is collapsed or not
	divObject The DOM Node of the window
	hidden Provides the status whether the window is hidden or not
	id The unique Id of the Window
	pageElement PageElement content that is displayed by this window object
	updateListenerNames Names of Listeners
	updateListeners Array of Functions Listening to updates on this window
	windowMgr Window Manager that this window is part of

Method Summary
Method Attributes	Method Name and Description
	addUpdateListener(name, listener) Adds a Listener function which listens to update events on the window
	center() Centers the window on screen
	collapse() Collapses the window, such that only title bar is visible.
	dispose(restore) Disposes the Window
	expand() Expands window to show content.
	fit() Fit Content within Window
	hide(override, skipSave) Hides the Window with arguments to override the current state and skip saving this new setting
	init(container) Initialize window.
	moveTo(x, y) Move Window to argument point
	removeUpdateListener(name) Removes a Listener function which listens to update events on the window
	resize(w, h) Resize the Window to argument Width and Height
	setStatus(msg) Sets the Status Message of the Window on the bottom
	setTitle(str) Sets the Title of the Window
	setWindowManager(wm) Sets Window Manager that this window is part of
	show(override, skipSave) Shows the Window with arguments to override the current state and skip saving this new setting
	toBack(zi) Sends the Window to the back
	toFront(zi) Brings the Window to the front
	toggleCollapse() Toggle Visibility of content of window
	toggleVisibility() Toggle Visibility of the Window
	update() Update Window state based on its properties

Event Summary
Event Attributes	Event Name and Description
	onCancel() Custom event happens when Close Button is clicked

Class Detail

adf.Window(id, titleText, pageElement, container, isPopup)

adf.Window is an out of the box dialog UI available for users. adf.Window is used by ADF Task Framework UI extensively. Any content placed inside the adf.window gets keybopard focus based on its tabindex attribute. The higher tabindex attribute gets the focus. In default implementation, if there is a textbox , it gets the first focus inside an adf.Window This constructor fnction creates a new window object with argument id and title. The argument page element is used to place the content that will be displayed within this window. Optionally this window can be created as a child element to the argument container This UI is built using dijit.Dialog

 var myDivWin = new adf.Window("myDivWin", "News", myPE, adfdojo.byId("winDiv"));
      myDivWin.init();

Parameters:
{String} id: The unique Id of the Window
{String} titleText: The titleText of the Window
{adf.PageElement} pageElement: This provides the content to be displayed on this window
{DOMElement} container: The DOMElement to which this window is render to
{boolean} isPopup: whether this window is a pop up window or not

Field Detail

{adf.Rectangle} bounds

provides the page bounds of the divObject

{Boolean} collapsed

Provides the status whether the window is collapsed or not

Default Value:: false

{DOM} divObject

The DOM Node of the window

{Boolean} hidden

Provides the status whether the window is hidden or not

Default Value:: false

{String} id

The unique Id of the Window

{adf.PageElement} pageElement

PageElement content that is displayed by this window object

{Array} updateListenerNames

Names of Listeners

 this.myListener = adfdojo.connect(this.myWin, "onCancel", this , function(){
  alert('Closing The Window');
  adfdojo.disconnect(this.myListener);
 });

Deprecated:
at 10.0, Use dojo.connect/disconnect event handling mechanism instead

{Array} updateListeners

Array of Functions Listening to updates on this window

adfdojo.connect(this.myWin, "onCancel", this , this.closeEditorWindowHandler);

Deprecated:
at 10.0, Use dojo.connect/disconnect event handling mechanism instead

{adf.WindowManager} windowMgr

Window Manager that this window is part of

Method Detail

addUpdateListener(name, listener)

Adds a Listener function which listens to update events on the window

Parameters:
name
listener

center()

Centers the window on screen

collapse()

Collapses the window, such that only title bar is visible. Sets collapsed to true

dispose(restore)

Disposes the Window

Parameters:
{Boolean} restore

expand()

Expands window to show content. Sets collapsed to false

fit()

Fit Content within Window

Deprecated:
This is doen automatically by the Dijit Widget System-

hide(override, skipSave)

Hides the Window with arguments to override the current state and skip saving this new setting

Parameters:
override
skipSave

init(container)

Initialize window. Optionally render window as child of argument container

Parameters:
{DOMElement} container: The DOMElement to which this window is render to

moveTo(x, y)

Move Window to argument point

Parameters:
{Number} x
{Number} y

removeUpdateListener(name)

Removes a Listener function which listens to update events on the window

Parameters:
name

resize(w, h)

Resize the Window to argument Width and Height

Parameters:
{Number} w
{Number} h

setStatus(msg)

Sets the Status Message of the Window on the bottom

Parameters:
msg

setTitle(str)

Sets the Title of the Window

Parameters:
{String} str

setWindowManager(wm)

Sets Window Manager that this window is part of

Parameters:
{adf.WindowManager} wm

show(override, skipSave)

Shows the Window with arguments to override the current state and skip saving this new setting

Parameters:
override
skipSave

toBack(zi)

Sends the Window to the back

Parameters:
{Number} zi

toFront(zi)

Brings the Window to the front

Parameters:
{Number} zi

toggleCollapse()

Toggle Visibility of content of window

toggleVisibility()

Toggle Visibility of the Window

update()

Update Window state based on its properties

Event Detail

onCancel()

Custom event happens when Close Button is clicked

Classes

Class adf.Window