Reference > AmiScript API > Classes

Window

Definition

Window var = .... ;

Extends

• Object
• DashboardResource

Extended By

None

Method Summary

Owner	Name	Return Type	Description
Window	bringToFront()	Object	Brings the window to the front of the desktop (in front of all other windows on the desktop).
DashboardResource	commit()	Object	Commits transient changes, promoting overrides to persisted values. If transient, makes permanent.
DashboardResource	getCallback(callbackName)	Callback	Returns a callback by name
DashboardResource	getCallbackNames()	List	Returns the callback names defined for this dashboard resource. Use session.getDevTools().getCallbackEditor(resource, callbackName) to edit one, and call editor.open() when you want to show the UI.
DashboardResource	getCallbacks()	Map	Returns a map of all callback definitions.
DashboardResource	getChildren()	List	Returns a list of the child dashboard resources.
Object	getClassName()	String	Returns the string name of this object's class type.
DashboardResource	getDRI()	String	Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of an object within the entire dashboard.
DashboardResource	getDashboardResourceType()	String	Returns the Dashboard Resource Type as a string
DashboardResource	getFormula(formulaName)	Formula	Returns a Formula given the formula name.
DashboardResource	getFormulaNames()	Set	Returns a set of the names of all formulas for this object.
DashboardResource	getFormulas()	Map	Returns a map of all available formulas for this object. The key is the formula name.
Window	getInnerPanel()	Panel	Returns the root panel.
DashboardResource	getLRI()	String	Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
Window	getLocation()	Rectangle	Returns the inner location of the window in pixels (not including header and border).
Window	getName()	String	Returns the name of the window.
DashboardResource	getOwner()	DashboardResource	Returns the DashboardResource that owns this object.
Window	getStatus()	String	Returns the status of the window, either: POPPEDOUT, MINIMIZED, MAXIMIZED, or FLOATING.
Window	getType()	String	Returns the current type, aka the behaviour of this window. Either HIDDEN, MAXIMIZED_NO_HEADER or REGULAR.
DashboardResource	invokeCallback(callbackName, args)	Object	Executes the specified callback definition and returns the result from the callback.
DashboardResource	isTransient()	Boolean	Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.
Window	maximize()	Object	Maximizes the window on the desktop.
Window	minimize()	Object	Minimizes the window (hide it from the desktop).
Window	popin()	Object	Restores the popped out window back to the browser's main window.
Window	popout()	Object	Pops the window out of the browser's main window.
Window	popout(position)	Object	Pops the window out of the browser's main window.
Window	resetType()	String	Resets the type to this window's default type. Returns the default mode.
Window	restore()	Object	Restore window to original dimensions.
Window	setLocation(location)	Object	Sets the inner location of the window (not including header and border).
Window	setName(name)	Boolean	Sets the name (title) of the window.
Window	setType(type)	Boolean	Sets the current type, aka the behaviour of this window. Either HIDDEN, MAXIMIZED_NO_HEADER or REGULAR. Case sensitive.
Object	toJson()	String	Returns a string of a json representation of this object.

Method Definitions

---

bringToFront()

Object Window::bringToFront()

Description

Brings the window to the front of the desktop (in front of all other windows on the desktop).

---

commit()

Object DashboardResource::commit()

Description

Commits transient changes, promoting overrides to persisted values. If transient, makes permanent.

---

getCallback(callbackName)

Callback DashboardResource::getCallback(String callbackName)

Description

Returns a callback by name

Parameter Definition

Name	Type	Description
callbackName	String	method name of callback

---

getCallbackNames()

List DashboardResource::getCallbackNames()

Description

Returns the callback names defined for this dashboard resource. Use session.getDevTools().getCallbackEditor(resource, callbackName) to edit one, and call editor.open() when you want to show the UI.

---

getCallbacks()

Map DashboardResource::getCallbacks()

Description

Returns a map of all callback definitions.

---

getChildren()

List DashboardResource::getChildren()

Description

Returns a list of the child dashboard resources.

---

getClassName()

String Object::getClassName()

Description

Returns the string name of this object's class type.

---

getDRI()

String DashboardResource::getDRI()

Description

Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of an object within the entire dashboard.

---

getDashboardResourceType()

String DashboardResource::getDashboardResourceType()

Description

Returns the Dashboard Resource Type as a string

---

getFormula(formulaName)

Formula DashboardResource::getFormula(String formulaName)

Description

Returns a Formula given the formula name.

Parameter Definition

Name	Type	Description
formulaName	String	name of the formula to return

---

getFormulaNames()

Set DashboardResource::getFormulaNames()

Description

Returns a set of the names of all formulas for this object.

---

getFormulas()

Map DashboardResource::getFormulas()

Description

Returns a map of all available formulas for this object. The key is the formula name.

---

getInnerPanel()

Panel Window::getInnerPanel()

Description

Returns the root panel.

---

getLRI()

String DashboardResource::getLRI()

Description

Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.

---

getLocation()

Rectangle Window::getLocation()

Description

Returns the inner location of the window in pixels (not including header and border).

---

getName()

String Window::getName()

Description

Returns the name of the window.

---

getOwner()

DashboardResource DashboardResource::getOwner()

Description

Returns the DashboardResource that owns this object.

---

getStatus()

String Window::getStatus()

Description

Returns the status of the window, either: POPPEDOUT, MINIMIZED, MAXIMIZED, or FLOATING.

---

getType()

String Window::getType()

Description

Returns the current type, aka the behaviour of this window. Either HIDDEN, MAXIMIZED_NO_HEADER or REGULAR.

---

invokeCallback(callbackName,args)

Object DashboardResource::invokeCallback(String callbackName, Object ... args)

Description

Executes the specified callback definition and returns the result from the callback.

Parameter Definition

Name	Type	Description
callbackName	String	method name of callback
args	Object ...	arguments

---

isTransient()

Boolean DashboardResource::isTransient()

Description

Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.

---

maximize()

Object Window::maximize()

Description

Maximizes the window on the desktop.

---

minimize()

Object Window::minimize()

Description

Minimizes the window (hide it from the desktop).

---

popin()

Object Window::popin()

Description

Restores the popped out window back to the browser's main window.

---

popout()

Object Window::popout()

Description

Pops the window out of the browser's main window.

---

popout(position)

Object Window::popout(Rectangle position)

Description

Pops the window out of the browser's main window.

Parameter Definition

Name	Type	Description
position	Rectangle	absolute position on the screen

---

resetType()

String Window::resetType()

Description

Resets the type to this window's default type. Returns the default mode.

---

restore()

Object Window::restore()

Description

Restore window to original dimensions.

---

setLocation(location)

Object Window::setLocation(Rectangle location)

Description

Sets the inner location of the window (not including header and border).

Parameter Definition

Name	Type	Description
location	Rectangle	location in pixels

---

setName(name)

Boolean Window::setName(String name)

Description

Sets the name (title) of the window.

Parameter Definition

Name	Type	Description
name	String	the new name (title) of the window

---

setType(type)

Boolean Window::setType(String type)

Description

Sets the current type, aka the behaviour of this window. Either HIDDEN, MAXIMIZED_NO_HEADER or REGULAR. Case sensitive.

Parameter Definition

Name	Type	Description
type	String	Either HIDDEN, MAXIMIZED_NO_HEADER or REGULAR

---

toJson()

String Object::toJson()

Description

Returns a string of a json representation of this object.